libZSservicesZSamazonka-networkmanagerZSamazonka-networkmanager
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.NetworkManager.Lens

Description

 
Synopsis

Operations

GetLinkAssociations

getLinkAssociations_nextToken :: Lens' GetLinkAssociations (Maybe Text) Source #

The token for the next page of results.

getLinkAssociations_maxResults :: Lens' GetLinkAssociations (Maybe Natural) Source #

The maximum number of results to return.

AssociateLink

AssociateTransitGatewayConnectPeer

CreateSite

createSite_location :: Lens' CreateSite (Maybe Location) Source #

The site location. This information is used for visualization in the Network Manager console. If you specify the address, the latitude and longitude are automatically calculated.

  • Address: The physical address of the site.
  • Latitude: The latitude of the site.
  • Longitude: The longitude of the site.

createSite_description :: Lens' CreateSite (Maybe Text) Source #

A description of your site.

Length Constraints: Maximum length of 256 characters.

createSite_tags :: Lens' CreateSite (Maybe [Tag]) Source #

The tags to apply to the resource during creation.

createSite_globalNetworkId :: Lens' CreateSite Text Source #

The ID of the global network.

DeleteConnection

UpdateConnection

updateConnection_connectedLinkId :: Lens' UpdateConnection (Maybe Text) Source #

The ID of the link for the second device in the connection.

updateConnection_linkId :: Lens' UpdateConnection (Maybe Text) Source #

The ID of the link for the first device in the connection.

updateConnection_description :: Lens' UpdateConnection (Maybe Text) Source #

A description of the connection.

Length Constraints: Maximum length of 256 characters.

DeregisterTransitGateway

deregisterTransitGateway_transitGatewayArn :: Lens' DeregisterTransitGateway Text Source #

The Amazon Resource Name (ARN) of the transit gateway.

GetTransitGatewayConnectPeerAssociations

UpdateSite

updateSite_location :: Lens' UpdateSite (Maybe Location) Source #

The site location:

  • Address: The physical address of the site.
  • Latitude: The latitude of the site.
  • Longitude: The longitude of the site.

updateSite_description :: Lens' UpdateSite (Maybe Text) Source #

A description of your site.

Length Constraints: Maximum length of 256 characters.

updateSite_globalNetworkId :: Lens' UpdateSite Text Source #

The ID of the global network.

DeleteSite

deleteSite_globalNetworkId :: Lens' DeleteSite Text Source #

The ID of the global network.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the resource.

DisassociateLink

CreateConnection

createConnection_connectedLinkId :: Lens' CreateConnection (Maybe Text) Source #

The ID of the link for the second device.

createConnection_linkId :: Lens' CreateConnection (Maybe Text) Source #

The ID of the link for the first device.

createConnection_description :: Lens' CreateConnection (Maybe Text) Source #

A description of the connection.

Length Constraints: Maximum length of 256 characters.

createConnection_tags :: Lens' CreateConnection (Maybe [Tag]) Source #

The tags to apply to the resource during creation.

createConnection_deviceId :: Lens' CreateConnection Text Source #

The ID of the first device in the connection.

createConnection_connectedDeviceId :: Lens' CreateConnection Text Source #

The ID of the second device in the connection.

GetDevices

getDevices_deviceIds :: Lens' GetDevices (Maybe [Text]) Source #

One or more device IDs. The maximum is 10.

getDevices_nextToken :: Lens' GetDevices (Maybe Text) Source #

The token for the next page of results.

getDevices_maxResults :: Lens' GetDevices (Maybe Natural) Source #

The maximum number of results to return.

getDevices_globalNetworkId :: Lens' GetDevices Text Source #

The ID of the global network.

getDevicesResponse_nextToken :: Lens' GetDevicesResponse (Maybe Text) Source #

The token for the next page of results.

GetLinks

getLinks_linkIds :: Lens' GetLinks (Maybe [Text]) Source #

One or more link IDs. The maximum is 10.

getLinks_nextToken :: Lens' GetLinks (Maybe Text) Source #

The token for the next page of results.

getLinks_siteId :: Lens' GetLinks (Maybe Text) Source #

The ID of the site.

getLinks_maxResults :: Lens' GetLinks (Maybe Natural) Source #

The maximum number of results to return.

getLinks_globalNetworkId :: Lens' GetLinks Text Source #

The ID of the global network.

getLinksResponse_nextToken :: Lens' GetLinksResponse (Maybe Text) Source #

The token for the next page of results.

getLinksResponse_httpStatus :: Lens' GetLinksResponse Int Source #

The response's http status code.

DescribeGlobalNetworks

describeGlobalNetworks_nextToken :: Lens' DescribeGlobalNetworks (Maybe Text) Source #

The token for the next page of results.

describeGlobalNetworks_globalNetworkIds :: Lens' DescribeGlobalNetworks (Maybe [Text]) Source #

The IDs of one or more global networks. The maximum is 10.

DisassociateCustomerGateway

disassociateCustomerGateway_customerGatewayArn :: Lens' DisassociateCustomerGateway Text Source #

The Amazon Resource Name (ARN) of the customer gateway. For more information, see Resources Defined by Amazon EC2.

DisassociateTransitGatewayConnectPeer

CreateGlobalNetwork

createGlobalNetwork_description :: Lens' CreateGlobalNetwork (Maybe Text) Source #

A description of the global network.

Length Constraints: Maximum length of 256 characters.

createGlobalNetwork_tags :: Lens' CreateGlobalNetwork (Maybe [Tag]) Source #

The tags to apply to the resource during creation.

CreateLink

createLink_type :: Lens' CreateLink (Maybe Text) Source #

The type of the link.

Constraints: Cannot include the following characters: | \ ^

Length Constraints: Maximum length of 128 characters.

createLink_description :: Lens' CreateLink (Maybe Text) Source #

A description of the link.

Length Constraints: Maximum length of 256 characters.

createLink_provider :: Lens' CreateLink (Maybe Text) Source #

The provider of the link.

Constraints: Cannot include the following characters: | \ ^

Length Constraints: Maximum length of 128 characters.

createLink_tags :: Lens' CreateLink (Maybe [Tag]) Source #

The tags to apply to the resource during creation.

createLink_globalNetworkId :: Lens' CreateLink Text Source #

The ID of the global network.

createLink_bandwidth :: Lens' CreateLink Bandwidth Source #

The upload speed and download speed in Mbps.

DeleteGlobalNetwork

UpdateGlobalNetwork

updateGlobalNetwork_description :: Lens' UpdateGlobalNetwork (Maybe Text) Source #

A description of the global network.

Length Constraints: Maximum length of 256 characters.

CreateDevice

createDevice_vendor :: Lens' CreateDevice (Maybe Text) Source #

The vendor of the device.

Length Constraints: Maximum length of 128 characters.

createDevice_model :: Lens' CreateDevice (Maybe Text) Source #

The model of the device.

Length Constraints: Maximum length of 128 characters.

createDevice_type :: Lens' CreateDevice (Maybe Text) Source #

The type of the device.

createDevice_serialNumber :: Lens' CreateDevice (Maybe Text) Source #

The serial number of the device.

Length Constraints: Maximum length of 128 characters.

createDevice_description :: Lens' CreateDevice (Maybe Text) Source #

A description of the device.

Length Constraints: Maximum length of 256 characters.

createDevice_tags :: Lens' CreateDevice (Maybe [Tag]) Source #

The tags to apply to the resource during creation.

AssociateCustomerGateway

associateCustomerGateway_customerGatewayArn :: Lens' AssociateCustomerGateway Text Source #

The Amazon Resource Name (ARN) of the customer gateway. For more information, see Resources Defined by Amazon EC2.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the resource.

tagResource_tags :: Lens' TagResource [Tag] Source #

The tags to apply to the specified resource.

GetCustomerGatewayAssociations

getCustomerGatewayAssociations_customerGatewayArns :: Lens' GetCustomerGatewayAssociations (Maybe [Text]) Source #

One or more customer gateway Amazon Resource Names (ARNs). For more information, see Resources Defined by Amazon EC2. The maximum is 10.

GetTransitGatewayRegistrations

getTransitGatewayRegistrations_transitGatewayArns :: Lens' GetTransitGatewayRegistrations (Maybe [Text]) Source #

The Amazon Resource Names (ARNs) of one or more transit gateways. The maximum is 10.

GetConnections

getConnections_nextToken :: Lens' GetConnections (Maybe Text) Source #

The token for the next page of results.

getConnections_maxResults :: Lens' GetConnections (Maybe Natural) Source #

The maximum number of results to return.

getConnectionsResponse_nextToken :: Lens' GetConnectionsResponse (Maybe Text) Source #

The token to use for the next page of results.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the resource.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

The tag keys to remove from the specified resource.

GetSites

getSites_nextToken :: Lens' GetSites (Maybe Text) Source #

The token for the next page of results.

getSites_siteIds :: Lens' GetSites (Maybe [Text]) Source #

One or more site IDs. The maximum is 10.

getSites_maxResults :: Lens' GetSites (Maybe Natural) Source #

The maximum number of results to return.

getSites_globalNetworkId :: Lens' GetSites Text Source #

The ID of the global network.

getSitesResponse_nextToken :: Lens' GetSitesResponse (Maybe Text) Source #

The token for the next page of results.

getSitesResponse_httpStatus :: Lens' GetSitesResponse Int Source #

The response's http status code.

RegisterTransitGateway

registerTransitGateway_transitGatewayArn :: Lens' RegisterTransitGateway Text Source #

The Amazon Resource Name (ARN) of the transit gateway. For more information, see Resources Defined by Amazon EC2.

DeleteDevice

UpdateDevice

updateDevice_vendor :: Lens' UpdateDevice (Maybe Text) Source #

The vendor of the device.

Length Constraints: Maximum length of 128 characters.

updateDevice_model :: Lens' UpdateDevice (Maybe Text) Source #

The model of the device.

Length Constraints: Maximum length of 128 characters.

updateDevice_type :: Lens' UpdateDevice (Maybe Text) Source #

The type of the device.

updateDevice_serialNumber :: Lens' UpdateDevice (Maybe Text) Source #

The serial number of the device.

Length Constraints: Maximum length of 128 characters.

updateDevice_description :: Lens' UpdateDevice (Maybe Text) Source #

A description of the device.

Length Constraints: Maximum length of 256 characters.

DeleteLink

deleteLink_globalNetworkId :: Lens' DeleteLink Text Source #

The ID of the global network.

UpdateLink

updateLink_bandwidth :: Lens' UpdateLink (Maybe Bandwidth) Source #

The upload and download speed in Mbps.

updateLink_type :: Lens' UpdateLink (Maybe Text) Source #

The type of the link.

Length Constraints: Maximum length of 128 characters.

updateLink_description :: Lens' UpdateLink (Maybe Text) Source #

A description of the link.

Length Constraints: Maximum length of 256 characters.

updateLink_provider :: Lens' UpdateLink (Maybe Text) Source #

The provider of the link.

Length Constraints: Maximum length of 128 characters.

updateLink_globalNetworkId :: Lens' UpdateLink Text Source #

The ID of the global network.

Types

AWSLocation

aWSLocation_zone :: Lens' AWSLocation (Maybe Text) Source #

The Zone the device is located in. This can be the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.

aWSLocation_subnetArn :: Lens' AWSLocation (Maybe Text) Source #

The Amazon Resource Name (ARN) of the subnet the device is located in.

Bandwidth

Connection

connection_state :: Lens' Connection (Maybe ConnectionState) Source #

The state of the connection.

connection_createdAt :: Lens' Connection (Maybe UTCTime) Source #

The date and time that the connection was created.

connection_globalNetworkId :: Lens' Connection (Maybe Text) Source #

The ID of the global network.

connection_connectionId :: Lens' Connection (Maybe Text) Source #

The ID of the connection.

connection_connectedDeviceId :: Lens' Connection (Maybe Text) Source #

The ID of the second device in the connection.

connection_connectedLinkId :: Lens' Connection (Maybe Text) Source #

The ID of the link for the second device in the connection.

connection_linkId :: Lens' Connection (Maybe Text) Source #

The ID of the link for the first device in the connection.

connection_deviceId :: Lens' Connection (Maybe Text) Source #

The ID of the first device in the connection.

connection_connectionArn :: Lens' Connection (Maybe Text) Source #

The Amazon Resource Name (ARN) of the connection.

connection_description :: Lens' Connection (Maybe Text) Source #

The description of the connection.

connection_tags :: Lens' Connection (Maybe [Tag]) Source #

The tags for the connection.

CustomerGatewayAssociation

customerGatewayAssociation_customerGatewayArn :: Lens' CustomerGatewayAssociation (Maybe Text) Source #

The Amazon Resource Name (ARN) of the customer gateway.

Device

device_vendor :: Lens' Device (Maybe Text) Source #

The device vendor.

device_createdAt :: Lens' Device (Maybe UTCTime) Source #

The date and time that the site was created.

device_deviceArn :: Lens' Device (Maybe Text) Source #

The Amazon Resource Name (ARN) of the device.

device_aWSLocation :: Lens' Device (Maybe AWSLocation) Source #

The AWS location of the device.

device_globalNetworkId :: Lens' Device (Maybe Text) Source #

The ID of the global network.

device_model :: Lens' Device (Maybe Text) Source #

The device model.

device_deviceId :: Lens' Device (Maybe Text) Source #

The ID of the device.

device_type :: Lens' Device (Maybe Text) Source #

The device type.

device_serialNumber :: Lens' Device (Maybe Text) Source #

The device serial number.

device_description :: Lens' Device (Maybe Text) Source #

The description of the device.

device_tags :: Lens' Device (Maybe [Tag]) Source #

The tags for the device.

GlobalNetwork

globalNetwork_createdAt :: Lens' GlobalNetwork (Maybe UTCTime) Source #

The date and time that the global network was created.

globalNetwork_globalNetworkArn :: Lens' GlobalNetwork (Maybe Text) Source #

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

globalNetwork_description :: Lens' GlobalNetwork (Maybe Text) Source #

The description of the global network.

globalNetwork_tags :: Lens' GlobalNetwork (Maybe [Tag]) Source #

The tags for the global network.

Link

link_state :: Lens' Link (Maybe LinkState) Source #

The state of the link.

link_linkArn :: Lens' Link (Maybe Text) Source #

The Amazon Resource Name (ARN) of the link.

link_createdAt :: Lens' Link (Maybe UTCTime) Source #

The date and time that the link was created.

link_globalNetworkId :: Lens' Link (Maybe Text) Source #

The ID of the global network.

link_bandwidth :: Lens' Link (Maybe Bandwidth) Source #

The bandwidth for the link.

link_linkId :: Lens' Link (Maybe Text) Source #

The ID of the link.

link_type :: Lens' Link (Maybe Text) Source #

The type of the link.

link_siteId :: Lens' Link (Maybe Text) Source #

The ID of the site.

link_description :: Lens' Link (Maybe Text) Source #

The description of the link.

link_provider :: Lens' Link (Maybe Text) Source #

The provider of the link.

link_tags :: Lens' Link (Maybe [Tag]) Source #

The tags for the link.

LinkAssociation

linkAssociation_deviceId :: Lens' LinkAssociation (Maybe Text) Source #

The device ID for the link association.

Location

location_address :: Lens' Location (Maybe Text) Source #

The physical address.

Site

site_state :: Lens' Site (Maybe SiteState) Source #

The state of the site.

site_location :: Lens' Site (Maybe Location) Source #

The location of the site.

site_createdAt :: Lens' Site (Maybe UTCTime) Source #

The date and time that the site was created.

site_globalNetworkId :: Lens' Site (Maybe Text) Source #

The ID of the global network.

site_siteId :: Lens' Site (Maybe Text) Source #

The ID of the site.

site_siteArn :: Lens' Site (Maybe Text) Source #

The Amazon Resource Name (ARN) of the site.

site_description :: Lens' Site (Maybe Text) Source #

The description of the site.

site_tags :: Lens' Site (Maybe [Tag]) Source #

The tags for the site.

Tag

tag_value :: Lens' Tag (Maybe Text) Source #

The tag value.

Length Constraints: Maximum length of 256 characters.

tag_key :: Lens' Tag (Maybe Text) Source #

The tag key.

Length Constraints: Maximum length of 128 characters.

TransitGatewayConnectPeerAssociation

TransitGatewayRegistration

transitGatewayRegistration_transitGatewayArn :: Lens' TransitGatewayRegistration (Maybe Text) Source #

The Amazon Resource Name (ARN) of the transit gateway.

TransitGatewayRegistrationStateReason