amazonka-networkmanager-2.0: Amazon Network Manager 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.NetworkManager.Lens

Contents

Description

 
Synopsis

Operations

AcceptAttachment

AssociateConnectPeer

AssociateCustomerGateway

associateCustomerGateway_customerGatewayArn :: Lens' AssociateCustomerGateway Text Source #

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

AssociateLink

AssociateTransitGatewayConnectPeer

CreateConnectAttachment

createConnectAttachment_clientToken :: Lens' CreateConnectAttachment (Maybe Text) Source #

The client token associated with the request.

createConnectAttachment_tags :: Lens' CreateConnectAttachment (Maybe [Tag]) Source #

The list of key-value tags associated with the request.

createConnectAttachment_coreNetworkId :: Lens' CreateConnectAttachment Text Source #

The ID of a core network where you want to create the attachment.

createConnectAttachment_transportAttachmentId :: Lens' CreateConnectAttachment Text Source #

The ID of the attachment between the two connections.

CreateConnectPeer

createConnectPeer_clientToken :: Lens' CreateConnectPeer (Maybe Text) Source #

The client token associated with the request.

createConnectPeer_tags :: Lens' CreateConnectPeer (Maybe [Tag]) Source #

The tags associated with the peer request.

createConnectPeer_insideCidrBlocks :: Lens' CreateConnectPeer [Text] Source #

The inside IP addresses used for BGP peering.

CreateConnection

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

The ID of the link for the second device.

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

A description of the connection.

Length Constraints: Maximum length of 256 characters.

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

The ID of the link for the first device.

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.

CreateCoreNetwork

createCoreNetwork_clientToken :: Lens' CreateCoreNetwork (Maybe Text) Source #

The client token associated with a core network request.

createCoreNetwork_description :: Lens' CreateCoreNetwork (Maybe Text) Source #

The description of a core network.

createCoreNetwork_policyDocument :: Lens' CreateCoreNetwork (Maybe Text) Source #

The policy document for creating a core network.

createCoreNetwork_tags :: Lens' CreateCoreNetwork (Maybe [Tag]) Source #

Key-value tags associated with a core network request.

createCoreNetwork_globalNetworkId :: Lens' CreateCoreNetwork Text Source #

The ID of the global network that a core network will be a part of.

CreateDevice

createDevice_aWSLocation :: Lens' CreateDevice (Maybe AWSLocation) Source #

The Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this parameter.

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

A description of the device.

Constraints: Maximum length of 256 characters.

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

The model of the device.

Constraints: Maximum length of 128 characters.

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

The serial number of the device.

Constraints: Maximum length of 128 characters.

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

The tags to apply to the resource during creation.

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

The type of the device.

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

The vendor of the device.

Constraints: Maximum length of 128 characters.

CreateGlobalNetwork

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

A description of the global network.

Constraints: Maximum length of 256 characters.

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

The tags to apply to the resource during creation.

CreateLink

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

A description of the link.

Constraints: Maximum length of 256 characters.

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

The provider of the link.

Constraints: Maximum length of 128 characters. Cannot include the following characters: | \ ^

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

The tags to apply to the resource during creation.

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

The type of the link.

Constraints: Maximum length of 128 characters. Cannot include the following characters: | \ ^

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.

CreateSite

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

A description of your site.

Constraints: Maximum length of 256 characters.

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_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.

CreateSiteToSiteVpnAttachment

createSiteToSiteVpnAttachment_coreNetworkId :: Lens' CreateSiteToSiteVpnAttachment Text Source #

The ID of a core network where you're creating a site-to-site VPN attachment.

CreateTransitGatewayPeering

createTransitGatewayPeering_tags :: Lens' CreateTransitGatewayPeering (Maybe [Tag]) Source #

The list of key-value tags associated with the request.

createTransitGatewayPeering_transitGatewayArn :: Lens' CreateTransitGatewayPeering Text Source #

The ARN of the transit gateway for the peering request.

CreateTransitGatewayRouteTableAttachment

CreateVpcAttachment

createVpcAttachment_clientToken :: Lens' CreateVpcAttachment (Maybe Text) Source #

The client token associated with the request.

createVpcAttachment_tags :: Lens' CreateVpcAttachment (Maybe [Tag]) Source #

The key-value tags associated with the request.

createVpcAttachment_coreNetworkId :: Lens' CreateVpcAttachment Text Source #

The ID of a core network for the VPC attachment.

createVpcAttachment_subnetArns :: Lens' CreateVpcAttachment [Text] Source #

The subnet ARN of the VPC attachment.

DeleteAttachment

deleteAttachment_attachmentId :: Lens' DeleteAttachment Text Source #

The ID of the attachment to delete.

DeleteConnectPeer

deleteConnectPeer_connectPeerId :: Lens' DeleteConnectPeer Text Source #

The ID of the deleted Connect peer.

DeleteConnection

DeleteCoreNetwork

deleteCoreNetwork_coreNetworkId :: Lens' DeleteCoreNetwork Text Source #

The network ID of the deleted core network.

DeleteCoreNetworkPolicyVersion

DeleteDevice

DeleteGlobalNetwork

DeleteLink

deleteLink_globalNetworkId :: Lens' DeleteLink Text Source #

The ID of the global network.

DeletePeering

deletePeering_peeringId :: Lens' DeletePeering Text Source #

The ID of the peering connection to delete.

deletePeeringResponse_peering :: Lens' DeletePeeringResponse (Maybe Peering) Source #

Information about a deleted peering connection.

DeleteResourcePolicy

DeleteSite

deleteSite_globalNetworkId :: Lens' DeleteSite Text Source #

The ID of the global network.

DeregisterTransitGateway

deregisterTransitGateway_transitGatewayArn :: Lens' DeregisterTransitGateway Text Source #

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

DescribeGlobalNetworks

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

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

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

The token for the next page of results.

DisassociateConnectPeer

disassociateConnectPeer_connectPeerId :: Lens' DisassociateConnectPeer Text Source #

The ID of the Connect peer to disassociate from a device.

DisassociateCustomerGateway

disassociateCustomerGateway_customerGatewayArn :: Lens' DisassociateCustomerGateway Text Source #

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

DisassociateLink

DisassociateTransitGatewayConnectPeer

ExecuteCoreNetworkChangeSet

GetConnectAttachment

GetConnectPeer

getConnectPeerResponse_connectPeer :: Lens' GetConnectPeerResponse (Maybe ConnectPeer) Source #

Returns information about a core network Connect peer.

GetConnectPeerAssociations

GetConnections

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

The maximum number of results to return.

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

The token for the next page of results.

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

The token to use for the next page of results.

GetCoreNetwork

GetCoreNetworkChangeEvents

GetCoreNetworkChangeSet

GetCoreNetworkPolicy

getCoreNetworkPolicy_policyVersionId :: Lens' GetCoreNetworkPolicy (Maybe Int) Source #

The ID of a core network policy version.

GetCustomerGatewayAssociations

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

One or more customer gateway Amazon Resource Names (ARNs). The maximum is 10.

GetDevices

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

One or more device IDs. The maximum is 10.

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

The maximum number of results to return.

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

The token for the next page of results.

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.

GetLinkAssociations

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

The maximum number of results to return.

getLinkAssociations_nextToken :: Lens' GetLinkAssociations (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_maxResults :: Lens' GetLinks (Maybe Natural) Source #

The maximum number of results to return.

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_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.

GetNetworkResourceCounts

getNetworkResourceCounts_resourceType :: Lens' GetNetworkResourceCounts (Maybe Text) Source #

The resource type.

The following are the supported resource types for Direct Connect:

  • dxcon
  • dx-gateway
  • dx-vif

The following are the supported resource types for Network Manager:

  • connection
  • device
  • link
  • site

The following are the supported resource types for Amazon VPC:

  • customer-gateway
  • transit-gateway
  • transit-gateway-attachment
  • transit-gateway-connect-peer
  • transit-gateway-route-table
  • vpn-connection

GetNetworkResourceRelationships

getNetworkResourceRelationships_resourceType :: Lens' GetNetworkResourceRelationships (Maybe Text) Source #

The resource type.

The following are the supported resource types for Direct Connect:

  • dxcon
  • dx-gateway
  • dx-vif

The following are the supported resource types for Network Manager:

  • connection
  • device
  • link
  • site

The following are the supported resource types for Amazon VPC:

  • customer-gateway
  • transit-gateway
  • transit-gateway-attachment
  • transit-gateway-connect-peer
  • transit-gateway-route-table
  • vpn-connection

GetNetworkResources

getNetworkResources_accountId :: Lens' GetNetworkResources (Maybe Text) Source #

The Amazon Web Services account ID.

getNetworkResources_maxResults :: Lens' GetNetworkResources (Maybe Natural) Source #

The maximum number of results to return.

getNetworkResources_nextToken :: Lens' GetNetworkResources (Maybe Text) Source #

The token for the next page of results.

getNetworkResources_resourceType :: Lens' GetNetworkResources (Maybe Text) Source #

The resource type.

The following are the supported resource types for Direct Connect:

The following are the supported resource types for Network Manager:

  • connection - The definition model is Connection.
  • device - The definition model is Device.
  • link - The definition model is Link.
  • site - The definition model is Site.

The following are the supported resource types for Amazon VPC:

GetNetworkRoutes

getNetworkRoutes_destinationFilters :: Lens' GetNetworkRoutes (Maybe (HashMap Text [Text])) Source #

Filter by route table destination. Possible Values: TRANSIT_GATEWAY_ATTACHMENT_ID, RESOURCE_ID, or RESOURCE_TYPE.

getNetworkRoutes_longestPrefixMatches :: Lens' GetNetworkRoutes (Maybe [Text]) Source #

The most specific route that matches the traffic (longest prefix match).

getNetworkRoutes_subnetOfMatches :: Lens' GetNetworkRoutes (Maybe [Text]) Source #

The routes with a subnet that match the specified CIDR filter.

getNetworkRoutes_supernetOfMatches :: Lens' GetNetworkRoutes (Maybe [Text]) Source #

The routes with a CIDR that encompasses the CIDR filter. Example: If you specify 10.0.1.0/30, then the result returns 10.0.1.0/29.

GetNetworkTelemetry

getNetworkTelemetry_accountId :: Lens' GetNetworkTelemetry (Maybe Text) Source #

The Amazon Web Services account ID.

getNetworkTelemetry_maxResults :: Lens' GetNetworkTelemetry (Maybe Natural) Source #

The maximum number of results to return.

getNetworkTelemetry_nextToken :: Lens' GetNetworkTelemetry (Maybe Text) Source #

The token for the next page of results.

getNetworkTelemetry_resourceType :: Lens' GetNetworkTelemetry (Maybe Text) Source #

The resource type.

The following are the supported resource types for Direct Connect:

  • dxcon
  • dx-gateway
  • dx-vif

The following are the supported resource types for Network Manager:

  • connection
  • device
  • link
  • site

The following are the supported resource types for Amazon VPC:

  • customer-gateway
  • transit-gateway
  • transit-gateway-attachment
  • transit-gateway-connect-peer
  • transit-gateway-route-table
  • vpn-connection

GetResourcePolicy

GetRouteAnalysis

GetSiteToSiteVpnAttachment

GetSites

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

The maximum number of results to return.

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_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.

GetTransitGatewayConnectPeerAssociations

GetTransitGatewayPeering

GetTransitGatewayRegistrations

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

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

GetTransitGatewayRouteTableAttachment

GetVpcAttachment

ListAttachments

listAttachments_edgeLocation :: Lens' ListAttachments (Maybe Text) Source #

The Region where the edge is located.

listAttachments_maxResults :: Lens' ListAttachments (Maybe Natural) Source #

The maximum number of results to return.

listAttachments_nextToken :: Lens' ListAttachments (Maybe Text) Source #

The token for the next page of results.

ListConnectPeers

listConnectPeers_maxResults :: Lens' ListConnectPeers (Maybe Natural) Source #

The maximum number of results to return.

listConnectPeers_nextToken :: Lens' ListConnectPeers (Maybe Text) Source #

The token for the next page of results.

ListCoreNetworkPolicyVersions

ListCoreNetworks

listCoreNetworks_maxResults :: Lens' ListCoreNetworks (Maybe Natural) Source #

The maximum number of results to return.

listCoreNetworks_nextToken :: Lens' ListCoreNetworks (Maybe Text) Source #

The token for the next page of results.

ListOrganizationServiceAccessStatus

ListPeerings

listPeerings_edgeLocation :: Lens' ListPeerings (Maybe Text) Source #

Returns a list edge locations for the

listPeerings_maxResults :: Lens' ListPeerings (Maybe Natural) Source #

The maximum number of results to return.

listPeerings_nextToken :: Lens' ListPeerings (Maybe Text) Source #

The token for the next page of results.

listPeerings_peeringType :: Lens' ListPeerings (Maybe PeeringType) Source #

Returns a list of a peering requests.

listPeerings_state :: Lens' ListPeerings (Maybe PeeringState) Source #

Returns a list of the peering request states.

listPeeringsResponse_nextToken :: Lens' ListPeeringsResponse (Maybe Text) Source #

The token for the next page of results.

listPeeringsResponse_peerings :: Lens' ListPeeringsResponse (Maybe [Peering]) Source #

Lists the transit gateway peerings for the ListPeerings request.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the resource.

PutCoreNetworkPolicy

putCoreNetworkPolicy_clientToken :: Lens' PutCoreNetworkPolicy (Maybe Text) Source #

The client token associated with the request.

PutResourcePolicy

RegisterTransitGateway

registerTransitGateway_transitGatewayArn :: Lens' RegisterTransitGateway Text Source #

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

RejectAttachment

RestoreCoreNetworkPolicyVersion

StartOrganizationServiceAccessUpdate

startOrganizationServiceAccessUpdate_action :: Lens' StartOrganizationServiceAccessUpdate Text Source #

The action to take for the update request. This can be either ENABLE or DISABLE.

startOrganizationServiceAccessUpdateResponse_organizationStatus :: Lens' StartOrganizationServiceAccessUpdateResponse (Maybe OrganizationStatus) Source #

The status of the service access update request for an Amazon Web Services Organization.

StartRouteAnalysis

startRouteAnalysis_includeReturnPath :: Lens' StartRouteAnalysis (Maybe Bool) Source #

Indicates whether to analyze the return path. The default is false.

startRouteAnalysis_useMiddleboxes :: Lens' StartRouteAnalysis (Maybe Bool) Source #

Indicates whether to include the location of middlebox appliances in the route analysis. The default is false.

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.

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.

UpdateConnection

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

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

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

A description of the connection.

Length Constraints: Maximum length of 256 characters.

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

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

UpdateCoreNetwork

UpdateDevice

updateDevice_aWSLocation :: Lens' UpdateDevice (Maybe AWSLocation) Source #

The Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this parameter.

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

A description of the device.

Constraints: Maximum length of 256 characters.

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

The model of the device.

Constraints: Maximum length of 128 characters.

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

The serial number of the device.

Constraints: Maximum length of 128 characters.

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

The type of the device.

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

The vendor of the device.

Constraints: Maximum length of 128 characters.

UpdateGlobalNetwork

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

A description of the global network.

Constraints: Maximum length of 256 characters.

UpdateLink

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

The upload and download speed in Mbps.

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

A description of the link.

Constraints: Maximum length of 256 characters.

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

The provider of the link.

Constraints: Maximum length of 128 characters.

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

The type of the link.

Constraints: Maximum length of 128 characters.

updateLink_globalNetworkId :: Lens' UpdateLink Text Source #

The ID of the global network.

UpdateNetworkResourceMetadata

UpdateSite

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

A description of your site.

Constraints: Maximum length of 256 characters.

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_globalNetworkId :: Lens' UpdateSite Text Source #

The ID of the global network.

UpdateVpcAttachment

updateVpcAttachment_addSubnetArns :: Lens' UpdateVpcAttachment (Maybe [Text]) Source #

Adds a subnet ARN to the VPC attachment.

updateVpcAttachment_options :: Lens' UpdateVpcAttachment (Maybe VpcOptions) Source #

Additional options for updating the VPC attachment.

updateVpcAttachment_removeSubnetArns :: Lens' UpdateVpcAttachment (Maybe [Text]) Source #

Removes a subnet ARN from the attachment.

Types

AWSLocation

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

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

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

The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.

AccountStatus

accountStatus_accountId :: Lens' AccountStatus (Maybe Text) Source #

The ID of an account within the Amazon Web Services Organization.

accountStatus_sLRDeploymentStatus :: Lens' AccountStatus (Maybe Text) Source #

The status of SLR deployment for the account.

Attachment

attachment_attachmentId :: Lens' Attachment (Maybe Text) Source #

The ID of the attachment.

attachment_attachmentPolicyRuleNumber :: Lens' Attachment (Maybe Int) Source #

The policy rule number associated with the attachment.

attachment_createdAt :: Lens' Attachment (Maybe UTCTime) Source #

The timestamp when the attachment was created.

attachment_edgeLocation :: Lens' Attachment (Maybe Text) Source #

The Region where the edge is located.

attachment_ownerAccountId :: Lens' Attachment (Maybe Text) Source #

The ID of the attachment account owner.

attachment_proposedSegmentChange :: Lens' Attachment (Maybe ProposedSegmentChange) Source #

The attachment to move from one segment to another.

attachment_resourceArn :: Lens' Attachment (Maybe Text) Source #

The attachment resource ARN.

attachment_segmentName :: Lens' Attachment (Maybe Text) Source #

The name of the segment attachment.

attachment_state :: Lens' Attachment (Maybe AttachmentState) Source #

The state of the attachment.

attachment_tags :: Lens' Attachment (Maybe [Tag]) Source #

The tags associated with the attachment.

attachment_updatedAt :: Lens' Attachment (Maybe UTCTime) Source #

The timestamp when the attachment was last updated.

Bandwidth

BgpOptions

bgpOptions_peerAsn :: Lens' BgpOptions (Maybe Integer) Source #

The Peer ASN of the BGP.

ConnectAttachment

ConnectAttachmentOptions

connectAttachmentOptions_protocol :: Lens' ConnectAttachmentOptions (Maybe TunnelProtocol) Source #

The protocol used for the attachment connection.

ConnectPeer

connectPeer_connectAttachmentId :: Lens' ConnectPeer (Maybe Text) Source #

The ID of the attachment to connect.

connectPeer_connectPeerId :: Lens' ConnectPeer (Maybe Text) Source #

The ID of the Connect peer.

connectPeer_createdAt :: Lens' ConnectPeer (Maybe UTCTime) Source #

The timestamp when the Connect peer was created.

connectPeer_edgeLocation :: Lens' ConnectPeer (Maybe Text) Source #

The Connect peer Regions where edges are located.

connectPeer_state :: Lens' ConnectPeer (Maybe ConnectPeerState) Source #

The state of the Connect peer.

connectPeer_tags :: Lens' ConnectPeer (Maybe [Tag]) Source #

The list of key-value tags associated with the Connect peer.

ConnectPeerAssociation

ConnectPeerBgpConfiguration

ConnectPeerConfiguration

connectPeerConfiguration_insideCidrBlocks :: Lens' ConnectPeerConfiguration (Maybe [Text]) Source #

The inside IP addresses used for a Connect peer configuration.

connectPeerConfiguration_protocol :: Lens' ConnectPeerConfiguration (Maybe TunnelProtocol) Source #

The protocol used for a Connect peer configuration.

ConnectPeerSummary

connectPeerSummary_createdAt :: Lens' ConnectPeerSummary (Maybe UTCTime) Source #

The timestamp when a Connect peer was created.

connectPeerSummary_edgeLocation :: Lens' ConnectPeerSummary (Maybe Text) Source #

The Region where the edge is located.

connectPeerSummary_tags :: Lens' ConnectPeerSummary (Maybe [Tag]) Source #

The list of key-value tags associated with the Connect peer summary.

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_connectionArn :: Lens' Connection (Maybe Text) Source #

The Amazon Resource Name (ARN) of the connection.

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

The ID of the connection.

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

The date and time that the connection was created.

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

The description of the connection.

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

The ID of the first device in the connection.

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

The ID of the global network.

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

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

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

The state of the connection.

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

The tags for the connection.

ConnectionHealth

connectionHealth_timestamp :: Lens' ConnectionHealth (Maybe UTCTime) Source #

The time the status was last updated.

CoreNetwork

coreNetwork_createdAt :: Lens' CoreNetwork (Maybe UTCTime) Source #

The timestamp when a core network was created.

coreNetwork_description :: Lens' CoreNetwork (Maybe Text) Source #

The description of a core network.

coreNetwork_edges :: Lens' CoreNetwork (Maybe [CoreNetworkEdge]) Source #

The edges within a core network.

coreNetwork_globalNetworkId :: Lens' CoreNetwork (Maybe Text) Source #

The ID of the global network that your core network is a part of.

coreNetwork_segments :: Lens' CoreNetwork (Maybe [CoreNetworkSegment]) Source #

The segments within a core network.

coreNetwork_state :: Lens' CoreNetwork (Maybe CoreNetworkState) Source #

The current state of a core network.

coreNetwork_tags :: Lens' CoreNetwork (Maybe [Tag]) Source #

The list of key-value tags associated with a core network.

CoreNetworkChange

coreNetworkChange_action :: Lens' CoreNetworkChange (Maybe ChangeAction) Source #

The action to take for a core network.

coreNetworkChange_identifierPath :: Lens' CoreNetworkChange (Maybe Text) Source #

Uniquely identifies the path for a change within the changeset. For example, the IdentifierPath for a core network segment change might be "CORE_NETWORK_SEGMENT/us-east-1/devsegment".

CoreNetworkChangeEvent

coreNetworkChangeEvent_eventTime :: Lens' CoreNetworkChangeEvent (Maybe UTCTime) Source #

The timestamp for an event change in status.

coreNetworkChangeEvent_identifierPath :: Lens' CoreNetworkChangeEvent (Maybe Text) Source #

Uniquely identifies the path for a change within the changeset. For example, the IdentifierPath for a core network segment change might be "CORE_NETWORK_SEGMENT/us-east-1/devsegment".

coreNetworkChangeEvent_status :: Lens' CoreNetworkChangeEvent (Maybe ChangeStatus) Source #

The status of the core network change event.

CoreNetworkChangeEventValues

coreNetworkChangeEventValues_attachmentId :: Lens' CoreNetworkChangeEventValues (Maybe Text) Source #

The ID of the attachment if the change event is associated with an attachment.

coreNetworkChangeEventValues_cidr :: Lens' CoreNetworkChangeEventValues (Maybe Text) Source #

For a STATIC_ROUTE event, this is the IP address.

coreNetworkChangeEventValues_edgeLocation :: Lens' CoreNetworkChangeEventValues (Maybe Text) Source #

The edge location for the core network change event.

coreNetworkChangeEventValues_segmentName :: Lens' CoreNetworkChangeEventValues (Maybe Text) Source #

The segment name if the change event is associated with a segment.

CoreNetworkChangeValues

coreNetworkChangeValues_cidr :: Lens' CoreNetworkChangeValues (Maybe Text) Source #

The IP addresses used for a core network.

coreNetworkChangeValues_edgeLocations :: Lens' CoreNetworkChangeValues (Maybe [Text]) Source #

The Regions where edges are located in a core network.

coreNetworkChangeValues_insideCidrBlocks :: Lens' CoreNetworkChangeValues (Maybe [Text]) Source #

The inside IP addresses used for core network change values.

coreNetworkChangeValues_segmentName :: Lens' CoreNetworkChangeValues (Maybe Text) Source #

The names of the segments in a core network.

coreNetworkChangeValues_sharedSegments :: Lens' CoreNetworkChangeValues (Maybe [Text]) Source #

The shared segments for a core network change value.

CoreNetworkEdge

coreNetworkEdge_asn :: Lens' CoreNetworkEdge (Maybe Integer) Source #

The ASN of a core network edge.

coreNetworkEdge_edgeLocation :: Lens' CoreNetworkEdge (Maybe Text) Source #

The Region where a core network edge is located.

coreNetworkEdge_insideCidrBlocks :: Lens' CoreNetworkEdge (Maybe [Text]) Source #

The inside IP addresses used for core network edges.

CoreNetworkPolicy

coreNetworkPolicy_alias :: Lens' CoreNetworkPolicy (Maybe CoreNetworkPolicyAlias) Source #

Whether a core network policy is the current LIVE policy or the most recently submitted policy.

coreNetworkPolicy_createdAt :: Lens' CoreNetworkPolicy (Maybe UTCTime) Source #

The timestamp when a core network policy was created.

coreNetworkPolicy_description :: Lens' CoreNetworkPolicy (Maybe Text) Source #

The description of a core network policy.

coreNetworkPolicy_policyErrors :: Lens' CoreNetworkPolicy (Maybe [CoreNetworkPolicyError]) Source #

Describes any errors in a core network policy.

CoreNetworkPolicyError

coreNetworkPolicyError_path :: Lens' CoreNetworkPolicyError (Maybe Text) Source #

The JSON path where the error was discovered in the policy document.

coreNetworkPolicyError_errorCode :: Lens' CoreNetworkPolicyError Text Source #

The error code associated with a core network policy error.

coreNetworkPolicyError_message :: Lens' CoreNetworkPolicyError Text Source #

The message associated with a core network policy error code.

CoreNetworkPolicyVersion

coreNetworkPolicyVersion_alias :: Lens' CoreNetworkPolicyVersion (Maybe CoreNetworkPolicyAlias) Source #

Whether a core network policy is the current policy or the most recently submitted policy.

coreNetworkPolicyVersion_createdAt :: Lens' CoreNetworkPolicyVersion (Maybe UTCTime) Source #

The timestamp when a core network policy version was created.

coreNetworkPolicyVersion_description :: Lens' CoreNetworkPolicyVersion (Maybe Text) Source #

The description of a core network policy version.

CoreNetworkSegment

coreNetworkSegment_edgeLocations :: Lens' CoreNetworkSegment (Maybe [Text]) Source #

The Regions where the edges are located.

coreNetworkSegment_name :: Lens' CoreNetworkSegment (Maybe Text) Source #

The name of a core network segment.

coreNetworkSegment_sharedSegments :: Lens' CoreNetworkSegment (Maybe [Text]) Source #

The shared segments of a core network.

CoreNetworkSegmentEdgeIdentifier

CoreNetworkSummary

coreNetworkSummary_tags :: Lens' CoreNetworkSummary (Maybe [Tag]) Source #

The key-value tags associated with a core network summary.

CustomerGatewayAssociation

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

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

Device

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

The Amazon Web Services location of the device.

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

The date and time that the site was created.

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

The description of the device.

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

The Amazon Resource Name (ARN) of the device.

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

The ID 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_serialNumber :: Lens' Device (Maybe Text) Source #

The device serial number.

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

The tags for the device.

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

The device type.

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

The device vendor.

GlobalNetwork

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

The date and time that the global network was created.

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

The description of the global network.

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

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

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

The tags for the global network.

Link

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

The bandwidth for the link.

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

The date and time that the link was created.

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

The description of the link.

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

The ID of the global network.

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

The Amazon Resource Name (ARN) of the link.

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

The ID of the link.

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

The provider of the link.

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

The ID of the site.

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

The state of the link.

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

The tags for the link.

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

The type of 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.

NetworkResource

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

The Amazon Web Services account ID.

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

The Amazon Web Services Region.

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

Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.

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

The time that the resource definition was retrieved.

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

The resource type.

The following are the supported resource types for Direct Connect:

  • dxcon
  • dx-gateway
  • dx-vif

The following are the supported resource types for Network Manager:

  • connection
  • device
  • link
  • site

The following are the supported resource types for Amazon VPC:

  • customer-gateway
  • transit-gateway
  • transit-gateway-attachment
  • transit-gateway-connect-peer
  • transit-gateway-route-table
  • vpn-connection

NetworkResourceCount

NetworkResourceSummary

networkResourceSummary_definition :: Lens' NetworkResourceSummary (Maybe Text) Source #

Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.

networkResourceSummary_isMiddlebox :: Lens' NetworkResourceSummary (Maybe Bool) Source #

Indicates whether this is a middlebox appliance.

NetworkRoute

networkRoute_destinationCidrBlock :: Lens' NetworkRoute (Maybe Text) Source #

A unique identifier for the route, such as a CIDR block.

networkRoute_state :: Lens' NetworkRoute (Maybe RouteState) Source #

The route state. The possible values are active and blackhole.

networkRoute_type :: Lens' NetworkRoute (Maybe RouteType) Source #

The route type. The possible values are propagated and static.

NetworkRouteDestination

networkRouteDestination_edgeLocation :: Lens' NetworkRouteDestination (Maybe Text) Source #

The edge location for the network destination.

NetworkTelemetry

networkTelemetry_accountId :: Lens' NetworkTelemetry (Maybe Text) Source #

The Amazon Web Services account ID.

networkTelemetry_awsRegion :: Lens' NetworkTelemetry (Maybe Text) Source #

The Amazon Web Services Region.

OrganizationStatus

organizationStatus_accountStatusList :: Lens' OrganizationStatus (Maybe [AccountStatus]) Source #

The current service-linked role (SLR) deployment status for an Amazon Web Services Organization's accounts. This will be either SUCCEEDED or IN_PROGRESS.

organizationStatus_organizationAwsServiceAccessStatus :: Lens' OrganizationStatus (Maybe Text) Source #

The status of the organization's AWS service access. This will be ENABLED or DISABLED.

organizationStatus_organizationId :: Lens' OrganizationStatus (Maybe Text) Source #

The ID of an Amazon Web Services Organization.

organizationStatus_sLRDeploymentStatus :: Lens' OrganizationStatus (Maybe Text) Source #

The status of the SLR deployment for the account. This will be either SUCCEEDED or IN_PROGRESS.

PathComponent

pathComponent_destinationCidrBlock :: Lens' PathComponent (Maybe Text) Source #

The destination CIDR block in the route table.

pathComponent_sequence :: Lens' PathComponent (Maybe Int) Source #

The sequence number in the path. The destination is 0.

Peering

peering_coreNetworkArn :: Lens' Peering (Maybe Text) Source #

The ARN of a core network.

peering_coreNetworkId :: Lens' Peering (Maybe Text) Source #

The ID of the core network for the peering request.

peering_createdAt :: Lens' Peering (Maybe UTCTime) Source #

The timestamp when the attachment peer was created.

peering_edgeLocation :: Lens' Peering (Maybe Text) Source #

The edge location for the peer.

peering_ownerAccountId :: Lens' Peering (Maybe Text) Source #

The ID of the account owner.

peering_peeringId :: Lens' Peering (Maybe Text) Source #

The ID of the peering attachment.

peering_peeringType :: Lens' Peering (Maybe PeeringType) Source #

The type of peering. This will be TRANSIT_GATEWAY.

peering_resourceArn :: Lens' Peering (Maybe Text) Source #

The resource ARN of the peer.

peering_state :: Lens' Peering (Maybe PeeringState) Source #

The current state of the peering connection.

peering_tags :: Lens' Peering (Maybe [Tag]) Source #

The list of key-value tags associated with the peering.

ProposedSegmentChange

proposedSegmentChange_attachmentPolicyRuleNumber :: Lens' ProposedSegmentChange (Maybe Int) Source #

The rule number in the policy document that applies to this change.

proposedSegmentChange_tags :: Lens' ProposedSegmentChange (Maybe [Tag]) Source #

The list of key-value tags that changed for the segment.

Relationship

relationship_from :: Lens' Relationship (Maybe Text) Source #

The ARN of the resource.

relationship_to :: Lens' Relationship (Maybe Text) Source #

The ARN of the resource.

RouteAnalysis

routeAnalysis_includeReturnPath :: Lens' RouteAnalysis (Maybe Bool) Source #

Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does not succeed.

routeAnalysis_ownerAccountId :: Lens' RouteAnalysis (Maybe Text) Source #

The ID of the AWS account that created the route analysis.

routeAnalysis_startTimestamp :: Lens' RouteAnalysis (Maybe UTCTime) Source #

The time that the analysis started.

routeAnalysis_useMiddleboxes :: Lens' RouteAnalysis (Maybe Bool) Source #

Indicates whether to include the location of middlebox appliances in the route analysis.

RouteAnalysisCompletion

routeAnalysisCompletion_reasonCode :: Lens' RouteAnalysisCompletion (Maybe RouteAnalysisCompletionReasonCode) Source #

The reason code. Available only if a connection is not found.

  • BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND - Found a black hole route with the destination CIDR block.
  • CYCLIC_PATH_DETECTED - Found the same resource multiple times while traversing the path.
  • INACTIVE_ROUTE_FOR_DESTINATION_FOUND - Found an inactive route with the destination CIDR block.
  • MAX_HOPS_EXCEEDED - Analysis exceeded 64 hops without finding the destination.
  • ROUTE_NOT_FOUND - Cannot find a route table with the destination CIDR block.
  • TGW_ATTACH_ARN_NO_MATCH - Found an attachment, but not with the correct destination ARN.
  • TGW_ATTACH_NOT_FOUND - Cannot find an attachment.
  • TGW_ATTACH_NOT_IN_TGW - Found an attachment, but not to the correct transit gateway.
  • TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND - The state of the route table association is not associated.

routeAnalysisCompletion_reasonContext :: Lens' RouteAnalysisCompletion (Maybe (HashMap Text Text)) Source #

Additional information about the path. Available only if a connection is not found.

routeAnalysisCompletion_resultCode :: Lens' RouteAnalysisCompletion (Maybe RouteAnalysisCompletionResultCode) Source #

The result of the analysis. If the status is NOT_CONNECTED, check the reason code.

RouteAnalysisEndpointOptions

RouteAnalysisEndpointOptionsSpecification

RouteAnalysisPath

RouteTableIdentifier

Site

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

The date and time that the site was created.

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

The description of the site.

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

The ID of the global network.

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

The location of the site.

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

The Amazon Resource Name (ARN) of the site.

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

The ID of the site.

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

The state of the site.

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

The tags for the site.

SiteToSiteVpnAttachment

siteToSiteVpnAttachment_attachment :: Lens' SiteToSiteVpnAttachment (Maybe Attachment) Source #

Provides details about a site-to-site VPN attachment.

Tag

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

The tag key.

Constraints: Maximum length of 128 characters.

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

The tag value.

Constraints: Maximum length of 256 characters.

TransitGatewayConnectPeerAssociation

TransitGatewayPeering

transitGatewayPeering_peering :: Lens' TransitGatewayPeering (Maybe Peering) Source #

Describes a transit gateway peer connection.

TransitGatewayRegistration

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

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

TransitGatewayRegistrationStateReason

TransitGatewayRouteTableAttachment

VpcAttachment

vpcAttachment_attachment :: Lens' VpcAttachment (Maybe Attachment) Source #

Provides details about the VPC attachment.

vpcAttachment_options :: Lens' VpcAttachment (Maybe VpcOptions) Source #

Provides details about the VPC attachment.

VpcOptions

vpcOptions_applianceModeSupport :: Lens' VpcOptions (Maybe Bool) Source #

Indicates whether appliance mode is supported. If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow. The default value is false.

vpcOptions_ipv6Support :: Lens' VpcOptions (Maybe Bool) Source #

Indicates whether IPv6 is supported.