amazonka-privatenetworks-2.0: Amazon Private 5G SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.PrivateNetworks.Lens

Description

 
Synopsis

Operations

AcknowledgeOrderReceipt

acknowledgeOrderReceipt_orderArn :: Lens' AcknowledgeOrderReceipt Text Source #

The Amazon Resource Name (ARN) of the order.

ActivateDeviceIdentifier

activateDeviceIdentifier_clientToken :: Lens' ActivateDeviceIdentifier (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

activateDeviceIdentifier_deviceIdentifierArn :: Lens' ActivateDeviceIdentifier Text Source #

The Amazon Resource Name (ARN) of the device identifier.

ActivateNetworkSite

activateNetworkSite_clientToken :: Lens' ActivateNetworkSite (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

activateNetworkSite_networkSiteArn :: Lens' ActivateNetworkSite Text Source #

The Amazon Resource Name (ARN) of the network site.

activateNetworkSite_shippingAddress :: Lens' ActivateNetworkSite Address Source #

The shipping address of the network site.

ConfigureAccessPoint

configureAccessPoint_cpiSecretKey :: Lens' ConfigureAccessPoint (Maybe Text) Source #

A Base64 encoded string of the CPI certificate associated with the CPI user who is certifying the coordinates of the network resource.

configureAccessPoint_cpiUserId :: Lens' ConfigureAccessPoint (Maybe Text) Source #

The CPI user ID of the CPI user who is certifying the coordinates of the network resource.

configureAccessPoint_cpiUserPassword :: Lens' ConfigureAccessPoint (Maybe Text) Source #

The CPI password associated with the CPI certificate in cpiSecretKey.

configureAccessPoint_cpiUsername :: Lens' ConfigureAccessPoint (Maybe Text) Source #

The CPI user name of the CPI user who is certifying the coordinates of the radio unit.

configureAccessPoint_accessPointArn :: Lens' ConfigureAccessPoint Text Source #

The Amazon Resource Name (ARN) of the network resource.

CreateNetwork

createNetwork_clientToken :: Lens' CreateNetwork (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

createNetwork_description :: Lens' CreateNetwork (Maybe Text) Source #

The description of the network.

createNetwork_tags :: Lens' CreateNetwork (Maybe (HashMap Text Text)) Source #

The tags to apply to the network.

createNetwork_networkName :: Lens' CreateNetwork Text Source #

The name of the network. You can't change the name after you create the network.

CreateNetworkSite

createNetworkSite_availabilityZone :: Lens' CreateNetworkSite (Maybe Text) Source #

The Availability Zone that is the parent of this site. You can't change the Availability Zone after you create the site.

createNetworkSite_availabilityZoneId :: Lens' CreateNetworkSite (Maybe Text) Source #

The ID of the Availability Zone that is the parent of this site. You can't change the Availability Zone after you create the site.

createNetworkSite_clientToken :: Lens' CreateNetworkSite (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

createNetworkSite_pendingPlan :: Lens' CreateNetworkSite (Maybe SitePlan) Source #

Information about the pending plan for this site.

createNetworkSite_tags :: Lens' CreateNetworkSite (Maybe (HashMap Text Text)) Source #

The tags to apply to the network site.

createNetworkSite_networkArn :: Lens' CreateNetworkSite Text Source #

The Amazon Resource Name (ARN) of the network.

createNetworkSite_networkSiteName :: Lens' CreateNetworkSite Text Source #

The name of the site. You can't change the name after you create the site.

DeactivateDeviceIdentifier

deactivateDeviceIdentifier_clientToken :: Lens' DeactivateDeviceIdentifier (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

deactivateDeviceIdentifier_deviceIdentifierArn :: Lens' DeactivateDeviceIdentifier Text Source #

The Amazon Resource Name (ARN) of the device identifier.

DeleteNetwork

deleteNetwork_clientToken :: Lens' DeleteNetwork (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

deleteNetwork_networkArn :: Lens' DeleteNetwork Text Source #

The Amazon Resource Name (ARN) of the network.

DeleteNetworkSite

deleteNetworkSite_clientToken :: Lens' DeleteNetworkSite (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

deleteNetworkSite_networkSiteArn :: Lens' DeleteNetworkSite Text Source #

The Amazon Resource Name (ARN) of the network site.

GetDeviceIdentifier

getDeviceIdentifier_deviceIdentifierArn :: Lens' GetDeviceIdentifier Text Source #

The Amazon Resource Name (ARN) of the device identifier.

GetNetwork

getNetwork_networkArn :: Lens' GetNetwork Text Source #

The Amazon Resource Name (ARN) of the network.

GetNetworkResource

getNetworkResource_networkResourceArn :: Lens' GetNetworkResource Text Source #

The Amazon Resource Name (ARN) of the network resource.

GetNetworkSite

getNetworkSite_networkSiteArn :: Lens' GetNetworkSite Text Source #

The Amazon Resource Name (ARN) of the network site.

GetOrder

getOrder_orderArn :: Lens' GetOrder Text Source #

The Amazon Resource Name (ARN) of the order.

getOrderResponse_httpStatus :: Lens' GetOrderResponse Int Source #

The response's http status code.

ListDeviceIdentifiers

listDeviceIdentifiers_filters :: Lens' ListDeviceIdentifiers (Maybe (HashMap DeviceIdentifierFilterKeys [Text])) Source #

The filters.

  • ORDER - The Amazon Resource Name (ARN) of the order.
  • STATUS - The status (ACTIVE | INACTIVE).
  • TRAFFIC_GROUP - The Amazon Resource Name (ARN) of the traffic group.

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

listDeviceIdentifiers_startToken :: Lens' ListDeviceIdentifiers (Maybe Text) Source #

The token for the next page of results.

listDeviceIdentifiers_networkArn :: Lens' ListDeviceIdentifiers Text Source #

The Amazon Resource Name (ARN) of the network.

ListNetworkResources

listNetworkResources_filters :: Lens' ListNetworkResources (Maybe (HashMap NetworkResourceFilterKeys [Text])) Source #

The filters.

  • ORDER - The Amazon Resource Name (ARN) of the order.
  • STATUS - The status (AVAILABLE | DELETED | DELETING | PENDING | PENDING_RETURN | PROVISIONING | SHIPPED).

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

listNetworkResources_maxResults :: Lens' ListNetworkResources (Maybe Natural) Source #

The maximum number of results to return.

listNetworkResources_startToken :: Lens' ListNetworkResources (Maybe Text) Source #

The token for the next page of results.

listNetworkResources_networkArn :: Lens' ListNetworkResources Text Source #

The Amazon Resource Name (ARN) of the network.

ListNetworkSites

listNetworkSites_filters :: Lens' ListNetworkSites (Maybe (HashMap NetworkSiteFilterKeys [Text])) Source #

The filters. Add filters to your request to return a more specific list of results. Use filters to match the status of the network sites.

  • STATUS - The status (AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING).

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

listNetworkSites_maxResults :: Lens' ListNetworkSites (Maybe Natural) Source #

The maximum number of results to return.

listNetworkSites_startToken :: Lens' ListNetworkSites (Maybe Text) Source #

The token for the next page of results.

listNetworkSites_networkArn :: Lens' ListNetworkSites Text Source #

The Amazon Resource Name (ARN) of the network.

ListNetworks

listNetworks_filters :: Lens' ListNetworks (Maybe (HashMap NetworkFilterKeys [Text])) Source #

The filters.

  • STATUS - The status (AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING).

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

listNetworks_maxResults :: Lens' ListNetworks (Maybe Natural) Source #

The maximum number of results to return.

listNetworks_startToken :: Lens' ListNetworks (Maybe Text) Source #

The token for the next page of results.

listNetworksResponse_nextToken :: Lens' ListNetworksResponse (Maybe Text) Source #

The token for the next page of results.

ListOrders

listOrders_filters :: Lens' ListOrders (Maybe (HashMap OrderFilterKeys [Text])) Source #

The filters.

  • NETWORK_SITE - The Amazon Resource Name (ARN) of the network site.
  • STATUS - The status (ACKNOWLEDGING | ACKNOWLEDGED | UNACKNOWLEDGED).

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

listOrders_maxResults :: Lens' ListOrders (Maybe Natural) Source #

The maximum number of results to return.

listOrders_startToken :: Lens' ListOrders (Maybe Text) Source #

The token for the next page of results.

listOrders_networkArn :: Lens' ListOrders Text Source #

The Amazon Resource Name (ARN) of the network.

listOrdersResponse_nextToken :: Lens' ListOrdersResponse (Maybe Text) Source #

The token for the next page of results.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the resource.

Ping

pingResponse_status :: Lens' PingResponse (Maybe Text) Source #

Information about the health of the service.

pingResponse_httpStatus :: Lens' PingResponse Int Source #

The response's http status code.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the resource.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

The tags to add to the resource.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the resource.

UpdateNetworkSite

updateNetworkSite_clientToken :: Lens' UpdateNetworkSite (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

updateNetworkSite_networkSiteArn :: Lens' UpdateNetworkSite Text Source #

The Amazon Resource Name (ARN) of the network site.

UpdateNetworkSitePlan

updateNetworkSitePlan_clientToken :: Lens' UpdateNetworkSitePlan (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

updateNetworkSitePlan_networkSiteArn :: Lens' UpdateNetworkSitePlan Text Source #

The Amazon Resource Name (ARN) of the network site.

Types

Address

address_company :: Lens' Address (Maybe Text) Source #

The company name for this address.

address_phoneNumber :: Lens' Address (Maybe Text) Source #

The phone number for this address.

address_street2 :: Lens' Address (Maybe Text) Source #

The second line of the street address.

address_street3 :: Lens' Address (Maybe Text) Source #

The third line of the street address.

address_city :: Lens' Address Text Source #

The city for this address.

address_country :: Lens' Address Text Source #

The country for this address.

address_name :: Lens' Address Text Source #

The recipient's name for this address.

address_postalCode :: Lens' Address Text Source #

The postal code for this address.

address_stateOrProvince :: Lens' Address Text Source #

The state or province for this address.

address_street1 :: Lens' Address Text Source #

The first line of the street address.

DeviceIdentifier

deviceIdentifier_createdAt :: Lens' DeviceIdentifier (Maybe UTCTime) Source #

The creation time of this device identifier.

deviceIdentifier_deviceIdentifierArn :: Lens' DeviceIdentifier (Maybe Text) Source #

The Amazon Resource Name (ARN) of the device identifier.

deviceIdentifier_iccid :: Lens' DeviceIdentifier (Maybe Text) Source #

The Integrated Circuit Card Identifier of the device identifier.

deviceIdentifier_imsi :: Lens' DeviceIdentifier (Maybe Text) Source #

The International Mobile Subscriber Identity of the device identifier.

deviceIdentifier_networkArn :: Lens' DeviceIdentifier (Maybe Text) Source #

The Amazon Resource Name (ARN) of the network on which the device identifier appears.

deviceIdentifier_orderArn :: Lens' DeviceIdentifier (Maybe Text) Source #

The Amazon Resource Name (ARN) of the order used to purchase the device identifier.

deviceIdentifier_trafficGroupArn :: Lens' DeviceIdentifier (Maybe Text) Source #

The Amazon Resource Name (ARN) of the traffic group to which the device identifier belongs.

deviceIdentifier_vendor :: Lens' DeviceIdentifier (Maybe Text) Source #

The vendor of the device identifier.

NameValuePair

Network

network_createdAt :: Lens' Network (Maybe UTCTime) Source #

The creation time of the network.

network_description :: Lens' Network (Maybe Text) Source #

The description of the network.

network_statusReason :: Lens' Network (Maybe Text) Source #

The status reason of the network.

network_networkArn :: Lens' Network Text Source #

The Amazon Resource Name (ARN) of the network.

network_networkName :: Lens' Network Text Source #

The name of the network.

network_status :: Lens' Network NetworkStatus Source #

The status of the network.

NetworkResource

networkResource_attributes :: Lens' NetworkResource (Maybe [NameValuePair]) Source #

The attributes of the network resource.

networkResource_createdAt :: Lens' NetworkResource (Maybe UTCTime) Source #

The creation time of the network resource.

networkResource_description :: Lens' NetworkResource (Maybe Text) Source #

The description of the network resource.

networkResource_health :: Lens' NetworkResource (Maybe HealthStatus) Source #

The health of the network resource.

networkResource_model :: Lens' NetworkResource (Maybe Text) Source #

The model of the network resource.

networkResource_networkArn :: Lens' NetworkResource (Maybe Text) Source #

The Amazon Resource Name (ARN) of the network on which this network resource appears.

networkResource_networkResourceArn :: Lens' NetworkResource (Maybe Text) Source #

The Amazon Resource Name (ARN) of the network resource.

networkResource_networkSiteArn :: Lens' NetworkResource (Maybe Text) Source #

The Amazon Resource Name (ARN) of the network site on which this network resource appears.

networkResource_orderArn :: Lens' NetworkResource (Maybe Text) Source #

The Amazon Resource Name (ARN) of the order used to purchase this network resource.

networkResource_position :: Lens' NetworkResource (Maybe Position) Source #

The position of the network resource.

networkResource_serialNumber :: Lens' NetworkResource (Maybe Text) Source #

The serial number of the network resource.

networkResource_statusReason :: Lens' NetworkResource (Maybe Text) Source #

The status reason of the network resource.

networkResource_vendor :: Lens' NetworkResource (Maybe Text) Source #

The vendor of the network resource.

NetworkResourceDefinition

networkResourceDefinition_options :: Lens' NetworkResourceDefinition (Maybe [NameValuePair]) Source #

The options in the network resource definition.

networkResourceDefinition_count :: Lens' NetworkResourceDefinition Natural Source #

The count in the network resource definition.

NetworkSite

networkSite_availabilityZone :: Lens' NetworkSite (Maybe Text) Source #

The parent Availability Zone for the network site.

networkSite_availabilityZoneId :: Lens' NetworkSite (Maybe Text) Source #

The parent Availability Zone ID for the network site.

networkSite_createdAt :: Lens' NetworkSite (Maybe UTCTime) Source #

The creation time of the network site.

networkSite_currentPlan :: Lens' NetworkSite (Maybe SitePlan) Source #

The current plan of the network site.

networkSite_description :: Lens' NetworkSite (Maybe Text) Source #

The description of the network site.

networkSite_pendingPlan :: Lens' NetworkSite (Maybe SitePlan) Source #

The pending plan of the network site.

networkSite_statusReason :: Lens' NetworkSite (Maybe Text) Source #

The status reason of the network site.

networkSite_networkArn :: Lens' NetworkSite Text Source #

The Amazon Resource Name (ARN) of the network to which the network site belongs.

networkSite_networkSiteArn :: Lens' NetworkSite Text Source #

The Amazon Resource Name (ARN) of the network site.

networkSite_networkSiteName :: Lens' NetworkSite Text Source #

The name of the network site.

networkSite_status :: Lens' NetworkSite NetworkSiteStatus Source #

The status of the network site.

Order

order_acknowledgmentStatus :: Lens' Order (Maybe AcknowledgmentStatus) Source #

The acknowledgement status of the order.

order_createdAt :: Lens' Order (Maybe UTCTime) Source #

The creation time of the order.

order_networkArn :: Lens' Order (Maybe Text) Source #

The Amazon Resource Name (ARN) of the network associated with this order.

order_networkSiteArn :: Lens' Order (Maybe Text) Source #

The Amazon Resource Name (ARN) of the network site associated with this order.

order_orderArn :: Lens' Order (Maybe Text) Source #

The Amazon Resource Name (ARN) of the order.

order_shippingAddress :: Lens' Order (Maybe Address) Source #

The shipping address of the order.

order_trackingInformation :: Lens' Order (Maybe [TrackingInformation]) Source #

The tracking information of the order.

Position

position_elevation :: Lens' Position (Maybe Double) Source #

The elevation of the equipment at this position.

position_elevationReference :: Lens' Position (Maybe ElevationReference) Source #

The reference point from which elevation is reported.

position_elevationUnit :: Lens' Position (Maybe ElevationUnit) Source #

The units used to measure the elevation of the position.

position_latitude :: Lens' Position (Maybe Double) Source #

The latitude of the position.

position_longitude :: Lens' Position (Maybe Double) Source #

The longitude of the position.

SitePlan

sitePlan_options :: Lens' SitePlan (Maybe [NameValuePair]) Source #

The options of the plan.

TrackingInformation

UpdateNetworkSiteResponse