Table of Contents
A low-level client representing AWS Network Manager (NetworkManager)
Transit Gateway Network Manager (Network Manager) enables you to create a global network, in which you can monitor your Amazon Web Services and on-premises networks that are built around transit gateways.
import boto3
client = boto3.client('networkmanager')
These are the available methods:
Accepts a core network attachment request.
Once the attachment request is accepted by a core network owner, the attachment is created and connected to a core network.
See also: AWS API Documentation
Request Syntax
response = client.accept_attachment(
AttachmentId='string'
)
[REQUIRED]
The ID of the attachment.
{
'Attachment': {
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'AttachmentId': 'string',
'OwnerAccountId': 'string',
'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
}
}
Response Structure
The response to the attachment request.
A core network ID.
The ARN of a core network.
The ID of the attachment.
The ID of the attachment account owner.
The type of attachment.
The state of the attachment.
The Region where the edge is located.
The attachment resource ARN.
The policy rule number associated with the attachment.
The name of the segment attachment.
The tags associated with the attachment.
Describes a tag.
The tag key.
Constraints: Maximum length of 128 characters.
The tag value.
Constraints: Maximum length of 256 characters.
The attachment to move from one segment to another.
The key-value tags that changed for the segment.
Describes a tag.
The tag key.
Constraints: Maximum length of 128 characters.
The tag value.
Constraints: Maximum length of 256 characters.
The rule number in the policy document that applies to this change.
The name of the segment to change.
The timestamp when the attachment was created.
The timestamp when the attachment was last updated.
Exceptions
Associates a core network Connect peer with a device and optionally, with a link.
If you specify a link, it must be associated with the specified device. You can only associate core network Connect peers that have been created on a core network Connect attachment on a core network.
See also: AWS API Documentation
Request Syntax
response = client.associate_connect_peer(
GlobalNetworkId='string',
ConnectPeerId='string',
DeviceId='string',
LinkId='string'
)
[REQUIRED]
The ID of your global network.
[REQUIRED]
The ID of the Connect peer.
[REQUIRED]
The ID of the device.
dict
Response Syntax
{
'ConnectPeerAssociation': {
'ConnectPeerId': 'string',
'GlobalNetworkId': 'string',
'DeviceId': 'string',
'LinkId': 'string',
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
}
}
Response Structure
(dict) --
ConnectPeerAssociation (dict) --
The response to the Connect peer request.
ConnectPeerId (string) --
The ID of the Connect peer.
GlobalNetworkId (string) --
The ID of the global network.
DeviceId (string) --
The ID of the device to connect to.
LinkId (string) --
The ID of the link.
State (string) --
The state of the Connect peer association.
Exceptions
Associates a customer gateway with a device and optionally, with a link. If you specify a link, it must be associated with the specified device.
You can only associate customer gateways that are connected to a VPN attachment on a transit gateway. The transit gateway must be registered in your global network. When you register a transit gateway, customer gateways that are connected to the transit gateway are automatically included in the global network. To list customer gateways that are connected to a transit gateway, use the DescribeVpnConnections EC2 API and filter by transit-gateway-id .
You cannot associate a customer gateway with more than one device and link.
See also: AWS API Documentation
Request Syntax
response = client.associate_customer_gateway(
CustomerGatewayArn='string',
GlobalNetworkId='string',
DeviceId='string',
LinkId='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the customer gateway.
[REQUIRED]
The ID of the global network.
[REQUIRED]
The ID of the device.
dict
Response Syntax
{
'CustomerGatewayAssociation': {
'CustomerGatewayArn': 'string',
'GlobalNetworkId': 'string',
'DeviceId': 'string',
'LinkId': 'string',
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
}
}
Response Structure
(dict) --
CustomerGatewayAssociation (dict) --
The customer gateway association.
CustomerGatewayArn (string) --
The Amazon Resource Name (ARN) of the customer gateway.
GlobalNetworkId (string) --
The ID of the global network.
DeviceId (string) --
The ID of the device.
LinkId (string) --
The ID of the link.
State (string) --
The association state.
Exceptions
Associates a link to a device. A device can be associated to multiple links and a link can be associated to multiple devices. The device and link must be in the same global network and the same site.
See also: AWS API Documentation
Request Syntax
response = client.associate_link(
GlobalNetworkId='string',
DeviceId='string',
LinkId='string'
)
[REQUIRED]
The ID of the global network.
[REQUIRED]
The ID of the device.
[REQUIRED]
The ID of the link.
dict
Response Syntax
{
'LinkAssociation': {
'GlobalNetworkId': 'string',
'DeviceId': 'string',
'LinkId': 'string',
'LinkAssociationState': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
}
}
Response Structure
(dict) --
LinkAssociation (dict) --
The link association.
GlobalNetworkId (string) --
The ID of the global network.
DeviceId (string) --
The device ID for the link association.
LinkId (string) --
The ID of the link.
LinkAssociationState (string) --
The state of the association.
Exceptions
Associates a transit gateway Connect peer with a device, and optionally, with a link. If you specify a link, it must be associated with the specified device.
You can only associate transit gateway Connect peers that have been created on a transit gateway that's registered in your global network.
You cannot associate a transit gateway Connect peer with more than one device and link.
See also: AWS API Documentation
Request Syntax
response = client.associate_transit_gateway_connect_peer(
GlobalNetworkId='string',
TransitGatewayConnectPeerArn='string',
DeviceId='string',
LinkId='string'
)
[REQUIRED]
The ID of the global network.
[REQUIRED]
The Amazon Resource Name (ARN) of the Connect peer.
[REQUIRED]
The ID of the device.
dict
Response Syntax
{
'TransitGatewayConnectPeerAssociation': {
'TransitGatewayConnectPeerArn': 'string',
'GlobalNetworkId': 'string',
'DeviceId': 'string',
'LinkId': 'string',
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
}
}
Response Structure
(dict) --
TransitGatewayConnectPeerAssociation (dict) --
The transit gateway Connect peer association.
TransitGatewayConnectPeerArn (string) --
The Amazon Resource Name (ARN) of the transit gateway Connect peer.
GlobalNetworkId (string) --
The ID of the global network.
DeviceId (string) --
The ID of the device.
LinkId (string) --
The ID of the link.
State (string) --
The state of the association.
Exceptions
Check if an operation can be paginated.
Creates a core network Connect attachment from a specified core network attachment.
A core network Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a core network and an appliance. A core network Connect attachment uses an existing VPC attachment as the underlying transport mechanism.
See also: AWS API Documentation
Request Syntax
response = client.create_connect_attachment(
CoreNetworkId='string',
EdgeLocation='string',
TransportAttachmentId='string',
Options={
'Protocol': 'GRE'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientToken='string'
)
[REQUIRED]
The ID of a core network where you want to create the attachment.
[REQUIRED]
The Region where the edge is located.
[REQUIRED]
The ID of the attachment between the two connections.
[REQUIRED]
Options for creating an attachment.
The protocol used for the attachment connection.
The list of key-value tags associated with the request.
Describes a tag.
The tag key.
Constraints: Maximum length of 128 characters.
The tag value.
Constraints: Maximum length of 256 characters.
The client token associated with the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ConnectAttachment': {
'Attachment': {
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'AttachmentId': 'string',
'OwnerAccountId': 'string',
'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
},
'TransportAttachmentId': 'string',
'Options': {
'Protocol': 'GRE'
}
}
}
Response Structure
(dict) --
ConnectAttachment (dict) --
The response to a Connect attachment request.
Attachment (dict) --
The attachment details.
CoreNetworkId (string) --
A core network ID.
CoreNetworkArn (string) --
The ARN of a core network.
AttachmentId (string) --
The ID of the attachment.
OwnerAccountId (string) --
The ID of the attachment account owner.
AttachmentType (string) --
The type of attachment.
State (string) --
The state of the attachment.
EdgeLocation (string) --
The Region where the edge is located.
ResourceArn (string) --
The attachment resource ARN.
AttachmentPolicyRuleNumber (integer) --
The policy rule number associated with the attachment.
SegmentName (string) --
The name of the segment attachment.
Tags (list) --
The tags associated with the attachment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
ProposedSegmentChange (dict) --
The attachment to move from one segment to another.
Tags (list) --
The key-value tags that changed for the segment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
AttachmentPolicyRuleNumber (integer) --
The rule number in the policy document that applies to this change.
SegmentName (string) --
The name of the segment to change.
CreatedAt (datetime) --
The timestamp when the attachment was created.
UpdatedAt (datetime) --
The timestamp when the attachment was last updated.
TransportAttachmentId (string) --
The ID of the transport attachment.
Options (dict) --
Options for connecting an attachment.
Protocol (string) --
The protocol used for the attachment connection.
Exceptions
Creates a core network connect peer for a specified core network connect attachment between a core network and an appliance. The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).
See also: AWS API Documentation
Request Syntax
response = client.create_connect_peer(
ConnectAttachmentId='string',
CoreNetworkAddress='string',
PeerAddress='string',
BgpOptions={
'PeerAsn': 123
},
InsideCidrBlocks=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientToken='string'
)
[REQUIRED]
The ID of the connection attachment.
[REQUIRED]
The Connect peer address.
The Connect peer BGP options.
The Peer ASN of the BGP.
[REQUIRED]
The inside IP addresses used for BGP peering.
The tags associated with the peer request.
Describes a tag.
The tag key.
Constraints: Maximum length of 128 characters.
The tag value.
Constraints: Maximum length of 256 characters.
The client token associated with the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ConnectPeer': {
'CoreNetworkId': 'string',
'ConnectAttachmentId': 'string',
'ConnectPeerId': 'string',
'EdgeLocation': 'string',
'State': 'CREATING'|'FAILED'|'AVAILABLE'|'DELETING',
'CreatedAt': datetime(2015, 1, 1),
'Configuration': {
'CoreNetworkAddress': 'string',
'PeerAddress': 'string',
'InsideCidrBlocks': [
'string',
],
'Protocol': 'GRE',
'BgpConfigurations': [
{
'CoreNetworkAsn': 123,
'PeerAsn': 123,
'CoreNetworkAddress': 'string',
'PeerAddress': 'string'
},
]
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
ConnectPeer (dict) --
The response to the request.
CoreNetworkId (string) --
The ID of a core network.
ConnectAttachmentId (string) --
The ID of the attachment to connect.
ConnectPeerId (string) --
The ID of the Connect peer.
EdgeLocation (string) --
The Connect peer Regions where edges are located.
State (string) --
The state of the Connect peer.
CreatedAt (datetime) --
The timestamp when the Connect peer was created.
Configuration (dict) --
The configuration of the Connect peer.
CoreNetworkAddress (string) --
The IP address of a core network.
PeerAddress (string) --
The IP address of the Connect peer.
InsideCidrBlocks (list) --
The inside IP addresses used for a Connect peer configuration.
Protocol (string) --
The protocol used for a Connect peer configuration.
BgpConfigurations (list) --
The Connect peer BGP configurations.
(dict) --
Describes a core network BGP configuration.
CoreNetworkAsn (integer) --
The ASN of the Coret Network.
PeerAsn (integer) --
The ASN of the Connect peer.
CoreNetworkAddress (string) --
The address of a core network.
PeerAddress (string) --
The address of a core network Connect peer.
Tags (list) --
The tags associated with the Connect peer.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
Exceptions
Creates a connection between two devices. The devices can be a physical or virtual appliance that connects to a third-party appliance in a VPC, or a physical appliance that connects to another physical appliance in an on-premises network.
See also: AWS API Documentation
Request Syntax
response = client.create_connection(
GlobalNetworkId='string',
DeviceId='string',
ConnectedDeviceId='string',
LinkId='string',
ConnectedLinkId='string',
Description='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The ID of the global network.
[REQUIRED]
The ID of the first device in the connection.
[REQUIRED]
The ID of the second device in the connection.
A description of the connection.
Length Constraints: Maximum length of 256 characters.
The tags to apply to the resource during creation.
Describes a tag.
The tag key.
Constraints: Maximum length of 128 characters.
The tag value.
Constraints: Maximum length of 256 characters.
dict
Response Syntax
{
'Connection': {
'ConnectionId': 'string',
'ConnectionArn': 'string',
'GlobalNetworkId': 'string',
'DeviceId': 'string',
'ConnectedDeviceId': 'string',
'LinkId': 'string',
'ConnectedLinkId': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
Connection (dict) --
Information about the connection.
ConnectionId (string) --
The ID of the connection.
ConnectionArn (string) --
The Amazon Resource Name (ARN) of the connection.
GlobalNetworkId (string) --
The ID of the global network.
DeviceId (string) --
The ID of the first device in the connection.
ConnectedDeviceId (string) --
The ID of the second device in the connection.
LinkId (string) --
The ID of the link for the first device in the connection.
ConnectedLinkId (string) --
The ID of the link for the second device in the connection.
Description (string) --
The description of the connection.
CreatedAt (datetime) --
The date and time that the connection was created.
State (string) --
The state of the connection.
Tags (list) --
The tags for the connection.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
Exceptions
Creates a core network as part of your global network, and optionally, with a core network policy.
See also: AWS API Documentation
Request Syntax
response = client.create_core_network(
GlobalNetworkId='string',
Description='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
PolicyDocument='string',
ClientToken='string'
)
[REQUIRED]
The ID of the global network that a core network will be a part of.
Key-value tags associated with a core network request.
Describes a tag.
The tag key.
Constraints: Maximum length of 128 characters.
The tag value.
Constraints: Maximum length of 256 characters.
The client token associated with a core network request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'CoreNetwork': {
'GlobalNetworkId': 'string',
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'CREATING'|'UPDATING'|'AVAILABLE'|'DELETING',
'Segments': [
{
'Name': 'string',
'EdgeLocations': [
'string',
],
'SharedSegments': [
'string',
]
},
],
'Edges': [
{
'EdgeLocation': 'string',
'Asn': 123,
'InsideCidrBlocks': [
'string',
]
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
CoreNetwork (dict) --
Returns details about a core network.
GlobalNetworkId (string) --
The ID of the global network that your core network is a part of.
CoreNetworkId (string) --
The ID of a core network.
CoreNetworkArn (string) --
The ARN of a core network.
Description (string) --
The description of a core network.
CreatedAt (datetime) --
The timestamp when a core network was created.
State (string) --
The current state of a core network.
Segments (list) --
The segments within a core network.
(dict) --
Describes a core network segment, which are dedicated routes. Only attachments within this segment can communicate with each other.
Name (string) --
The name of a core network segment.
EdgeLocations (list) --
The Regions where the edges are located.
SharedSegments (list) --
The shared segments of a core network.
Edges (list) --
The edges within a core network.
(dict) --
Describes a core network edge.
EdgeLocation (string) --
The Region where a core network edge is located.
Asn (integer) --
The ASN of a core network edge.
InsideCidrBlocks (list) --
The inside IP addresses used for core network edges.
Tags (list) --
The tags associated with a core network.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
Exceptions
Creates a new device in a global network. If you specify both a site ID and a location, the location of the site is used for visualization in the Network Manager console.
See also: AWS API Documentation
Request Syntax
response = client.create_device(
GlobalNetworkId='string',
AWSLocation={
'Zone': 'string',
'SubnetArn': 'string'
},
Description='string',
Type='string',
Vendor='string',
Model='string',
SerialNumber='string',
Location={
'Address': 'string',
'Latitude': 'string',
'Longitude': 'string'
},
SiteId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The ID of the global network.
The Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this parameter.
The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.
The Amazon Resource Name (ARN) of the subnet that the device is located in.
A description of the device.
Constraints: Maximum length of 256 characters.
The vendor of the device.
Constraints: Maximum length of 128 characters.
The model of the device.
Constraints: Maximum length of 128 characters.
The serial number of the device.
Constraints: Maximum length of 128 characters.
The location of the device.
The physical address.
The latitude.
The longitude.
The tags to apply to the resource during creation.
Describes a tag.
The tag key.
Constraints: Maximum length of 128 characters.
The tag value.
Constraints: Maximum length of 256 characters.
dict
Response Syntax
{
'Device': {
'DeviceId': 'string',
'DeviceArn': 'string',
'GlobalNetworkId': 'string',
'AWSLocation': {
'Zone': 'string',
'SubnetArn': 'string'
},
'Description': 'string',
'Type': 'string',
'Vendor': 'string',
'Model': 'string',
'SerialNumber': 'string',
'Location': {
'Address': 'string',
'Latitude': 'string',
'Longitude': 'string'
},
'SiteId': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
Device (dict) --
Information about the device.
DeviceId (string) --
The ID of the device.
DeviceArn (string) --
The Amazon Resource Name (ARN) of the device.
GlobalNetworkId (string) --
The ID of the global network.
AWSLocation (dict) --
The Amazon Web Services location of the device.
Zone (string) --
The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.
SubnetArn (string) --
The Amazon Resource Name (ARN) of the subnet that the device is located in.
Description (string) --
The description of the device.
Type (string) --
The device type.
Vendor (string) --
The device vendor.
Model (string) --
The device model.
SerialNumber (string) --
The device serial number.
Location (dict) --
The site location.
Address (string) --
The physical address.
Latitude (string) --
The latitude.
Longitude (string) --
The longitude.
SiteId (string) --
The site ID.
CreatedAt (datetime) --
The date and time that the site was created.
State (string) --
The device state.
Tags (list) --
The tags for the device.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
Exceptions
Creates a new, empty global network.
See also: AWS API Documentation
Request Syntax
response = client.create_global_network(
Description='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
A description of the global network.
Constraints: Maximum length of 256 characters.
The tags to apply to the resource during creation.
Describes a tag.
The tag key.
Constraints: Maximum length of 128 characters.
The tag value.
Constraints: Maximum length of 256 characters.
dict
Response Syntax
{
'GlobalNetwork': {
'GlobalNetworkId': 'string',
'GlobalNetworkArn': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
GlobalNetwork (dict) --
Information about the global network object.
GlobalNetworkId (string) --
The ID of the global network.
GlobalNetworkArn (string) --
The Amazon Resource Name (ARN) of the global network.
Description (string) --
The description of the global network.
CreatedAt (datetime) --
The date and time that the global network was created.
State (string) --
The state of the global network.
Tags (list) --
The tags for the global network.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
Exceptions
Creates a new link for a specified site.
See also: AWS API Documentation
Request Syntax
response = client.create_link(
GlobalNetworkId='string',
Description='string',
Type='string',
Bandwidth={
'UploadSpeed': 123,
'DownloadSpeed': 123
},
Provider='string',
SiteId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The ID of the global network.
A description of the link.
Constraints: Maximum length of 256 characters.
The type of the link.
Constraints: Maximum length of 128 characters. Cannot include the following characters: | ^
[REQUIRED]
The upload speed and download speed in Mbps.
Upload speed in Mbps.
Download speed in Mbps.
The provider of the link.
Constraints: Maximum length of 128 characters. Cannot include the following characters: | ^
[REQUIRED]
The ID of the site.
The tags to apply to the resource during creation.
Describes a tag.
The tag key.
Constraints: Maximum length of 128 characters.
The tag value.
Constraints: Maximum length of 256 characters.
dict
Response Syntax
{
'Link': {
'LinkId': 'string',
'LinkArn': 'string',
'GlobalNetworkId': 'string',
'SiteId': 'string',
'Description': 'string',
'Type': 'string',
'Bandwidth': {
'UploadSpeed': 123,
'DownloadSpeed': 123
},
'Provider': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
Link (dict) --
Information about the link.
LinkId (string) --
The ID of the link.
LinkArn (string) --
The Amazon Resource Name (ARN) of the link.
GlobalNetworkId (string) --
The ID of the global network.
SiteId (string) --
The ID of the site.
Description (string) --
The description of the link.
Type (string) --
The type of the link.
Bandwidth (dict) --
The bandwidth for the link.
UploadSpeed (integer) --
Upload speed in Mbps.
DownloadSpeed (integer) --
Download speed in Mbps.
Provider (string) --
The provider of the link.
CreatedAt (datetime) --
The date and time that the link was created.
State (string) --
The state of the link.
Tags (list) --
The tags for the link.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
Exceptions
Creates a new site in a global network.
See also: AWS API Documentation
Request Syntax
response = client.create_site(
GlobalNetworkId='string',
Description='string',
Location={
'Address': 'string',
'Latitude': 'string',
'Longitude': 'string'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The ID of the global network.
A description of your site.
Constraints: Maximum length of 256 characters.
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.
The physical address.
The latitude.
The longitude.
The tags to apply to the resource during creation.
Describes a tag.
The tag key.
Constraints: Maximum length of 128 characters.
The tag value.
Constraints: Maximum length of 256 characters.
dict
Response Syntax
{
'Site': {
'SiteId': 'string',
'SiteArn': 'string',
'GlobalNetworkId': 'string',
'Description': 'string',
'Location': {
'Address': 'string',
'Latitude': 'string',
'Longitude': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
Site (dict) --
Information about the site.
SiteId (string) --
The ID of the site.
SiteArn (string) --
The Amazon Resource Name (ARN) of the site.
GlobalNetworkId (string) --
The ID of the global network.
Description (string) --
The description of the site.
Location (dict) --
The location of the site.
Address (string) --
The physical address.
Latitude (string) --
The latitude.
Longitude (string) --
The longitude.
CreatedAt (datetime) --
The date and time that the site was created.
State (string) --
The state of the site.
Tags (list) --
The tags for the site.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
Exceptions
Creates a site-to-site VPN attachment on an edge location of a core network.
See also: AWS API Documentation
Request Syntax
response = client.create_site_to_site_vpn_attachment(
CoreNetworkId='string',
VpnConnectionArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientToken='string'
)
[REQUIRED]
The ID of a core network where you're creating a site-to-site VPN attachment.
[REQUIRED]
The ARN identifying the VPN attachment.
The tags associated with the request.
Describes a tag.
The tag key.
Constraints: Maximum length of 128 characters.
The tag value.
Constraints: Maximum length of 256 characters.
The client token associated with the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'SiteToSiteVpnAttachment': {
'Attachment': {
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'AttachmentId': 'string',
'OwnerAccountId': 'string',
'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
},
'VpnConnectionArn': 'string'
}
}
Response Structure
(dict) --
SiteToSiteVpnAttachment (dict) --
Details about a site-to-site VPN attachment.
Attachment (dict) --
Provides details about a site-to-site VPN attachment.
CoreNetworkId (string) --
A core network ID.
CoreNetworkArn (string) --
The ARN of a core network.
AttachmentId (string) --
The ID of the attachment.
OwnerAccountId (string) --
The ID of the attachment account owner.
AttachmentType (string) --
The type of attachment.
State (string) --
The state of the attachment.
EdgeLocation (string) --
The Region where the edge is located.
ResourceArn (string) --
The attachment resource ARN.
AttachmentPolicyRuleNumber (integer) --
The policy rule number associated with the attachment.
SegmentName (string) --
The name of the segment attachment.
Tags (list) --
The tags associated with the attachment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
ProposedSegmentChange (dict) --
The attachment to move from one segment to another.
Tags (list) --
The key-value tags that changed for the segment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
AttachmentPolicyRuleNumber (integer) --
The rule number in the policy document that applies to this change.
SegmentName (string) --
The name of the segment to change.
CreatedAt (datetime) --
The timestamp when the attachment was created.
UpdatedAt (datetime) --
The timestamp when the attachment was last updated.
VpnConnectionArn (string) --
The ARN of the site-to-site VPN attachment.
Exceptions
Creates a VPC attachment on an edge location of a core network.
See also: AWS API Documentation
Request Syntax
response = client.create_vpc_attachment(
CoreNetworkId='string',
VpcArn='string',
SubnetArns=[
'string',
],
Options={
'Ipv6Support': True|False
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientToken='string'
)
[REQUIRED]
The ID of a core network for the VPC attachment.
[REQUIRED]
The ARN of the VPC.
[REQUIRED]
The subnet ARN of the VPC attachment.
Options for the VPC attachment.
Indicates whether IPv6 is supported.
The key-value tags associated with the request.
Describes a tag.
The tag key.
Constraints: Maximum length of 128 characters.
The tag value.
Constraints: Maximum length of 256 characters.
The client token associated with the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'VpcAttachment': {
'Attachment': {
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'AttachmentId': 'string',
'OwnerAccountId': 'string',
'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
},
'SubnetArns': [
'string',
],
'Options': {
'Ipv6Support': True|False
}
}
}
Response Structure
(dict) --
VpcAttachment (dict) --
Provides details about the VPC attachment.
Attachment (dict) --
Provides details about the VPC attachment.
CoreNetworkId (string) --
A core network ID.
CoreNetworkArn (string) --
The ARN of a core network.
AttachmentId (string) --
The ID of the attachment.
OwnerAccountId (string) --
The ID of the attachment account owner.
AttachmentType (string) --
The type of attachment.
State (string) --
The state of the attachment.
EdgeLocation (string) --
The Region where the edge is located.
ResourceArn (string) --
The attachment resource ARN.
AttachmentPolicyRuleNumber (integer) --
The policy rule number associated with the attachment.
SegmentName (string) --
The name of the segment attachment.
Tags (list) --
The tags associated with the attachment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
ProposedSegmentChange (dict) --
The attachment to move from one segment to another.
Tags (list) --
The key-value tags that changed for the segment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
AttachmentPolicyRuleNumber (integer) --
The rule number in the policy document that applies to this change.
SegmentName (string) --
The name of the segment to change.
CreatedAt (datetime) --
The timestamp when the attachment was created.
UpdatedAt (datetime) --
The timestamp when the attachment was last updated.
SubnetArns (list) --
The subnet ARNs.
Options (dict) --
Provides details about the VPC attachment.
Ipv6Support (boolean) --
Indicates whether IPv6 is supported.
Exceptions
Deletes an attachment. Supports all attachment types.
See also: AWS API Documentation
Request Syntax
response = client.delete_attachment(
AttachmentId='string'
)
[REQUIRED]
The ID of the attachment to delete.
{
'Attachment': {
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'AttachmentId': 'string',
'OwnerAccountId': 'string',
'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
}
}
Response Structure
Information about the deleted attachment.
A core network ID.
The ARN of a core network.
The ID of the attachment.
The ID of the attachment account owner.
The type of attachment.
The state of the attachment.
The Region where the edge is located.
The attachment resource ARN.
The policy rule number associated with the attachment.
The name of the segment attachment.
The tags associated with the attachment.
Describes a tag.
The tag key.
Constraints: Maximum length of 128 characters.
The tag value.
Constraints: Maximum length of 256 characters.
The attachment to move from one segment to another.
The key-value tags that changed for the segment.
Describes a tag.
The tag key.
Constraints: Maximum length of 128 characters.
The tag value.
Constraints: Maximum length of 256 characters.
The rule number in the policy document that applies to this change.
The name of the segment to change.
The timestamp when the attachment was created.
The timestamp when the attachment was last updated.
Exceptions
Deletes a Connect peer.
See also: AWS API Documentation
Request Syntax
response = client.delete_connect_peer(
ConnectPeerId='string'
)
[REQUIRED]
The ID of the deleted Connect peer.
{
'ConnectPeer': {
'CoreNetworkId': 'string',
'ConnectAttachmentId': 'string',
'ConnectPeerId': 'string',
'EdgeLocation': 'string',
'State': 'CREATING'|'FAILED'|'AVAILABLE'|'DELETING',
'CreatedAt': datetime(2015, 1, 1),
'Configuration': {
'CoreNetworkAddress': 'string',
'PeerAddress': 'string',
'InsideCidrBlocks': [
'string',
],
'Protocol': 'GRE',
'BgpConfigurations': [
{
'CoreNetworkAsn': 123,
'PeerAsn': 123,
'CoreNetworkAddress': 'string',
'PeerAddress': 'string'
},
]
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
Information about the deleted Connect peer.
The ID of a core network.
The ID of the attachment to connect.
The ID of the Connect peer.
The Connect peer Regions where edges are located.
The state of the Connect peer.
The timestamp when the Connect peer was created.
The configuration of the Connect peer.
The IP address of a core network.
The IP address of the Connect peer.
The inside IP addresses used for a Connect peer configuration.
The protocol used for a Connect peer configuration.
The Connect peer BGP configurations.
Describes a core network BGP configuration.
The ASN of the Coret Network.
The ASN of the Connect peer.
The address of a core network.
The address of a core network Connect peer.
The tags associated with the Connect peer.
Describes a tag.
The tag key.
Constraints: Maximum length of 128 characters.
The tag value.
Constraints: Maximum length of 256 characters.
Exceptions
Deletes the specified connection in your global network.
See also: AWS API Documentation
Request Syntax
response = client.delete_connection(
GlobalNetworkId='string',
ConnectionId='string'
)
[REQUIRED]
The ID of the global network.
[REQUIRED]
The ID of the connection.
dict
Response Syntax
{
'Connection': {
'ConnectionId': 'string',
'ConnectionArn': 'string',
'GlobalNetworkId': 'string',
'DeviceId': 'string',
'ConnectedDeviceId': 'string',
'LinkId': 'string',
'ConnectedLinkId': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
Connection (dict) --
Information about the connection.
ConnectionId (string) --
The ID of the connection.
ConnectionArn (string) --
The Amazon Resource Name (ARN) of the connection.
GlobalNetworkId (string) --
The ID of the global network.
DeviceId (string) --
The ID of the first device in the connection.
ConnectedDeviceId (string) --
The ID of the second device in the connection.
LinkId (string) --
The ID of the link for the first device in the connection.
ConnectedLinkId (string) --
The ID of the link for the second device in the connection.
Description (string) --
The description of the connection.
CreatedAt (datetime) --
The date and time that the connection was created.
State (string) --
The state of the connection.
Tags (list) --
The tags for the connection.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
Exceptions
Deletes a core network along with all core network policies. This can only be done if there are no attachments on a core network.
See also: AWS API Documentation
Request Syntax
response = client.delete_core_network(
CoreNetworkId='string'
)
[REQUIRED]
The network ID of the deleted core network.
{
'CoreNetwork': {
'GlobalNetworkId': 'string',
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'CREATING'|'UPDATING'|'AVAILABLE'|'DELETING',
'Segments': [
{
'Name': 'string',
'EdgeLocations': [
'string',
],
'SharedSegments': [
'string',
]
},
],
'Edges': [
{
'EdgeLocation': 'string',
'Asn': 123,
'InsideCidrBlocks': [
'string',
]
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
Information about the deleted core network.
The ID of the global network that your core network is a part of.
The ID of a core network.
The ARN of a core network.
The description of a core network.
The timestamp when a core network was created.
The current state of a core network.
The segments within a core network.
Describes a core network segment, which are dedicated routes. Only attachments within this segment can communicate with each other.
The name of a core network segment.
The Regions where the edges are located.
The shared segments of a core network.
The edges within a core network.
Describes a core network edge.
The Region where a core network edge is located.
The ASN of a core network edge.
The inside IP addresses used for core network edges.
The tags associated with a core network.
Describes a tag.
The tag key.
Constraints: Maximum length of 128 characters.
The tag value.
Constraints: Maximum length of 256 characters.
Exceptions
Deletes a policy version from a core network. You can't delete the current LIVE policy.
See also: AWS API Documentation
Request Syntax
response = client.delete_core_network_policy_version(
CoreNetworkId='string',
PolicyVersionId=123
)
[REQUIRED]
The ID of a core network for the deleted policy.
[REQUIRED]
The version ID of the deleted policy.
dict
Response Syntax
{
'CoreNetworkPolicy': {
'CoreNetworkId': 'string',
'PolicyVersionId': 123,
'Alias': 'LIVE'|'LATEST',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'ChangeSetState': 'PENDING_GENERATION'|'FAILED_GENERATION'|'READY_TO_EXECUTE'|'EXECUTING'|'EXECUTION_SUCCEEDED'|'OUT_OF_DATE',
'PolicyErrors': [
{
'ErrorCode': 'string',
'Message': 'string',
'Path': 'string'
},
],
'PolicyDocument': 'string'
}
}
Response Structure
(dict) --
CoreNetworkPolicy (dict) --
Returns information about the deleted policy version.
CoreNetworkId (string) --
The ID of a core network.
PolicyVersionId (integer) --
The ID of the policy version.
Alias (string) --
Whether a core network policy is the current LIVE policy or the most recently submitted policy.
Description (string) --
The description of a core network policy.
CreatedAt (datetime) --
The timestamp when a core network policy was created.
ChangeSetState (string) --
The state of a core network policy.
PolicyErrors (list) --
Describes any errors in a core network policy.
(dict) --
Provides details about an error in a core network policy.
ErrorCode (string) --
The error code associated with a core network policy error.
Message (string) --
The message associated with a core network policy error code.
Path (string) --
The JSON path where the error was discovered in the policy document.
PolicyDocument (string) --
Describes a core network policy.
Exceptions
Deletes an existing device. You must first disassociate the device from any links and customer gateways.
See also: AWS API Documentation
Request Syntax
response = client.delete_device(
GlobalNetworkId='string',
DeviceId='string'
)
[REQUIRED]
The ID of the global network.
[REQUIRED]
The ID of the device.
dict
Response Syntax
{
'Device': {
'DeviceId': 'string',
'DeviceArn': 'string',
'GlobalNetworkId': 'string',
'AWSLocation': {
'Zone': 'string',
'SubnetArn': 'string'
},
'Description': 'string',
'Type': 'string',
'Vendor': 'string',
'Model': 'string',
'SerialNumber': 'string',
'Location': {
'Address': 'string',
'Latitude': 'string',
'Longitude': 'string'
},
'SiteId': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
Device (dict) --
Information about the device.
DeviceId (string) --
The ID of the device.
DeviceArn (string) --
The Amazon Resource Name (ARN) of the device.
GlobalNetworkId (string) --
The ID of the global network.
AWSLocation (dict) --
The Amazon Web Services location of the device.
Zone (string) --
The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.
SubnetArn (string) --
The Amazon Resource Name (ARN) of the subnet that the device is located in.
Description (string) --
The description of the device.
Type (string) --
The device type.
Vendor (string) --
The device vendor.
Model (string) --
The device model.
SerialNumber (string) --
The device serial number.
Location (dict) --
The site location.
Address (string) --
The physical address.
Latitude (string) --
The latitude.
Longitude (string) --
The longitude.
SiteId (string) --
The site ID.
CreatedAt (datetime) --
The date and time that the site was created.
State (string) --
The device state.
Tags (list) --
The tags for the device.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
Exceptions
Deletes an existing global network. You must first delete all global network objects (devices, links, and sites) and deregister all transit gateways.
See also: AWS API Documentation
Request Syntax
response = client.delete_global_network(
GlobalNetworkId='string'
)
[REQUIRED]
The ID of the global network.
{
'GlobalNetwork': {
'GlobalNetworkId': 'string',
'GlobalNetworkArn': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
Information about the global network.
The ID of the global network.
The Amazon Resource Name (ARN) of the global network.
The description of the global network.
The date and time that the global network was created.
The state of the global network.
The tags for the global network.
Describes a tag.
The tag key.
Constraints: Maximum length of 128 characters.
The tag value.
Constraints: Maximum length of 256 characters.
Exceptions
Deletes an existing link. You must first disassociate the link from any devices and customer gateways.
See also: AWS API Documentation
Request Syntax
response = client.delete_link(
GlobalNetworkId='string',
LinkId='string'
)
[REQUIRED]
The ID of the global network.
[REQUIRED]
The ID of the link.
dict
Response Syntax
{
'Link': {
'LinkId': 'string',
'LinkArn': 'string',
'GlobalNetworkId': 'string',
'SiteId': 'string',
'Description': 'string',
'Type': 'string',
'Bandwidth': {
'UploadSpeed': 123,
'DownloadSpeed': 123
},
'Provider': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
Link (dict) --
Information about the link.
LinkId (string) --
The ID of the link.
LinkArn (string) --
The Amazon Resource Name (ARN) of the link.
GlobalNetworkId (string) --
The ID of the global network.
SiteId (string) --
The ID of the site.
Description (string) --
The description of the link.
Type (string) --
The type of the link.
Bandwidth (dict) --
The bandwidth for the link.
UploadSpeed (integer) --
Upload speed in Mbps.
DownloadSpeed (integer) --
Download speed in Mbps.
Provider (string) --
The provider of the link.
CreatedAt (datetime) --
The date and time that the link was created.
State (string) --
The state of the link.
Tags (list) --
The tags for the link.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
Exceptions
Deletes a resource policy for the specified resource. This revokes the access of the principals specified in the resource policy.
See also: AWS API Documentation
Request Syntax
response = client.delete_resource_policy(
ResourceArn='string'
)
[REQUIRED]
The ARN of the policy to delete.
{}
Response Structure
Exceptions
Deletes an existing site. The site cannot be associated with any device or link.
See also: AWS API Documentation
Request Syntax
response = client.delete_site(
GlobalNetworkId='string',
SiteId='string'
)
[REQUIRED]
The ID of the global network.
[REQUIRED]
The ID of the site.
dict
Response Syntax
{
'Site': {
'SiteId': 'string',
'SiteArn': 'string',
'GlobalNetworkId': 'string',
'Description': 'string',
'Location': {
'Address': 'string',
'Latitude': 'string',
'Longitude': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
Site (dict) --
Information about the site.
SiteId (string) --
The ID of the site.
SiteArn (string) --
The Amazon Resource Name (ARN) of the site.
GlobalNetworkId (string) --
The ID of the global network.
Description (string) --
The description of the site.
Location (dict) --
The location of the site.
Address (string) --
The physical address.
Latitude (string) --
The latitude.
Longitude (string) --
The longitude.
CreatedAt (datetime) --
The date and time that the site was created.
State (string) --
The state of the site.
Tags (list) --
The tags for the site.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
Exceptions
Deregisters a transit gateway from your global network. This action does not delete your transit gateway, or modify any of its attachments. This action removes any customer gateway associations.
See also: AWS API Documentation
Request Syntax
response = client.deregister_transit_gateway(
GlobalNetworkId='string',
TransitGatewayArn='string'
)
[REQUIRED]
The ID of the global network.
[REQUIRED]
The Amazon Resource Name (ARN) of the transit gateway.
dict
Response Syntax
{
'TransitGatewayRegistration': {
'GlobalNetworkId': 'string',
'TransitGatewayArn': 'string',
'State': {
'Code': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'|'FAILED',
'Message': 'string'
}
}
}
Response Structure
(dict) --
TransitGatewayRegistration (dict) --
The transit gateway registration information.
GlobalNetworkId (string) --
The ID of the global network.
TransitGatewayArn (string) --
The Amazon Resource Name (ARN) of the transit gateway.
State (dict) --
The state of the transit gateway registration.
Code (string) --
The code for the state reason.
Message (string) --
The message for the state reason.
Exceptions
Describes one or more global networks. By default, all global networks are described. To describe the objects in your global network, you must use the appropriate Get* action. For example, to list the transit gateways in your global network, use GetTransitGatewayRegistrations .
See also: AWS API Documentation
Request Syntax
response = client.describe_global_networks(
GlobalNetworkIds=[
'string',
],
MaxResults=123,
NextToken='string'
)
The IDs of one or more global networks. The maximum is 10.
dict
Response Syntax
{
'GlobalNetworks': [
{
'GlobalNetworkId': 'string',
'GlobalNetworkArn': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
GlobalNetworks (list) --
Information about the global networks.
(dict) --
Describes a global network. This is a single private network acting as a high-level container for your network objects, including an Amazon Web Services-manged Core Network.
GlobalNetworkId (string) --
The ID of the global network.
GlobalNetworkArn (string) --
The Amazon Resource Name (ARN) of the global network.
Description (string) --
The description of the global network.
CreatedAt (datetime) --
The date and time that the global network was created.
State (string) --
The state of the global network.
Tags (list) --
The tags for the global network.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
NextToken (string) --
The token for the next page of results.
Exceptions
Disassociates a core network Connect peer from a device and a link.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_connect_peer(
GlobalNetworkId='string',
ConnectPeerId='string'
)
[REQUIRED]
The ID of the global network.
[REQUIRED]
The ID of the Connect peer to disassociate from a device.
dict
Response Syntax
{
'ConnectPeerAssociation': {
'ConnectPeerId': 'string',
'GlobalNetworkId': 'string',
'DeviceId': 'string',
'LinkId': 'string',
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
}
}
Response Structure
(dict) --
ConnectPeerAssociation (dict) --
Describes the Connect peer association.
ConnectPeerId (string) --
The ID of the Connect peer.
GlobalNetworkId (string) --
The ID of the global network.
DeviceId (string) --
The ID of the device to connect to.
LinkId (string) --
The ID of the link.
State (string) --
The state of the Connect peer association.
Exceptions
Disassociates a customer gateway from a device and a link.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_customer_gateway(
GlobalNetworkId='string',
CustomerGatewayArn='string'
)
[REQUIRED]
The ID of the global network.
[REQUIRED]
The Amazon Resource Name (ARN) of the customer gateway.
dict
Response Syntax
{
'CustomerGatewayAssociation': {
'CustomerGatewayArn': 'string',
'GlobalNetworkId': 'string',
'DeviceId': 'string',
'LinkId': 'string',
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
}
}
Response Structure
(dict) --
CustomerGatewayAssociation (dict) --
Information about the customer gateway association.
CustomerGatewayArn (string) --
The Amazon Resource Name (ARN) of the customer gateway.
GlobalNetworkId (string) --
The ID of the global network.
DeviceId (string) --
The ID of the device.
LinkId (string) --
The ID of the link.
State (string) --
The association state.
Exceptions
Disassociates an existing device from a link. You must first disassociate any customer gateways that are associated with the link.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_link(
GlobalNetworkId='string',
DeviceId='string',
LinkId='string'
)
[REQUIRED]
The ID of the global network.
[REQUIRED]
The ID of the device.
[REQUIRED]
The ID of the link.
dict
Response Syntax
{
'LinkAssociation': {
'GlobalNetworkId': 'string',
'DeviceId': 'string',
'LinkId': 'string',
'LinkAssociationState': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
}
}
Response Structure
(dict) --
LinkAssociation (dict) --
Information about the link association.
GlobalNetworkId (string) --
The ID of the global network.
DeviceId (string) --
The device ID for the link association.
LinkId (string) --
The ID of the link.
LinkAssociationState (string) --
The state of the association.
Exceptions
Disassociates a transit gateway Connect peer from a device and link.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_transit_gateway_connect_peer(
GlobalNetworkId='string',
TransitGatewayConnectPeerArn='string'
)
[REQUIRED]
The ID of the global network.
[REQUIRED]
The Amazon Resource Name (ARN) of the transit gateway Connect peer.
dict
Response Syntax
{
'TransitGatewayConnectPeerAssociation': {
'TransitGatewayConnectPeerArn': 'string',
'GlobalNetworkId': 'string',
'DeviceId': 'string',
'LinkId': 'string',
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
}
}
Response Structure
(dict) --
TransitGatewayConnectPeerAssociation (dict) --
The transit gateway Connect peer association.
TransitGatewayConnectPeerArn (string) --
The Amazon Resource Name (ARN) of the transit gateway Connect peer.
GlobalNetworkId (string) --
The ID of the global network.
DeviceId (string) --
The ID of the device.
LinkId (string) --
The ID of the link.
State (string) --
The state of the association.
Exceptions
Executes a change set on your core network. Deploys changes globally based on the policy submitted..
See also: AWS API Documentation
Request Syntax
response = client.execute_core_network_change_set(
CoreNetworkId='string',
PolicyVersionId=123
)
[REQUIRED]
The ID of a core network.
[REQUIRED]
The ID of the policy version.
dict
Response Syntax
{}
Response Structure
Exceptions
Returns information about a core network Connect attachment.
See also: AWS API Documentation
Request Syntax
response = client.get_connect_attachment(
AttachmentId='string'
)
[REQUIRED]
The ID of the attachment.
{
'ConnectAttachment': {
'Attachment': {
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'AttachmentId': 'string',
'OwnerAccountId': 'string',
'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
},
'TransportAttachmentId': 'string',
'Options': {
'Protocol': 'GRE'
}
}
}
Response Structure
Details about the Connect attachment.
The attachment details.
A core network ID.
The ARN of a core network.
The ID of the attachment.
The ID of the attachment account owner.
The type of attachment.
The state of the attachment.
The Region where the edge is located.
The attachment resource ARN.
The policy rule number associated with the attachment.
The name of the segment attachment.
The tags associated with the attachment.
Describes a tag.
The tag key.
Constraints: Maximum length of 128 characters.
The tag value.
Constraints: Maximum length of 256 characters.
The attachment to move from one segment to another.
The key-value tags that changed for the segment.
Describes a tag.
The tag key.
Constraints: Maximum length of 128 characters.
The tag value.
Constraints: Maximum length of 256 characters.
The rule number in the policy document that applies to this change.
The name of the segment to change.
The timestamp when the attachment was created.
The timestamp when the attachment was last updated.
The ID of the transport attachment.
Options for connecting an attachment.
The protocol used for the attachment connection.
Exceptions
Returns information about a core network Connect peer.
See also: AWS API Documentation
Request Syntax
response = client.get_connect_peer(
ConnectPeerId='string'
)
[REQUIRED]
The ID of the Connect peer.
{
'ConnectPeer': {
'CoreNetworkId': 'string',
'ConnectAttachmentId': 'string',
'ConnectPeerId': 'string',
'EdgeLocation': 'string',
'State': 'CREATING'|'FAILED'|'AVAILABLE'|'DELETING',
'CreatedAt': datetime(2015, 1, 1),
'Configuration': {
'CoreNetworkAddress': 'string',
'PeerAddress': 'string',
'InsideCidrBlocks': [
'string',
],
'Protocol': 'GRE',
'BgpConfigurations': [
{
'CoreNetworkAsn': 123,
'PeerAsn': 123,
'CoreNetworkAddress': 'string',
'PeerAddress': 'string'
},
]
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
Returns information about a core network Connect peer.
The ID of a core network.
The ID of the attachment to connect.
The ID of the Connect peer.
The Connect peer Regions where edges are located.
The state of the Connect peer.
The timestamp when the Connect peer was created.
The configuration of the Connect peer.
The IP address of a core network.
The IP address of the Connect peer.
The inside IP addresses used for a Connect peer configuration.
The protocol used for a Connect peer configuration.
The Connect peer BGP configurations.
Describes a core network BGP configuration.
The ASN of the Coret Network.
The ASN of the Connect peer.
The address of a core network.
The address of a core network Connect peer.
The tags associated with the Connect peer.
Describes a tag.
The tag key.
Constraints: Maximum length of 128 characters.
The tag value.
Constraints: Maximum length of 256 characters.
Exceptions
Returns information about a core network Connect peer associations.
See also: AWS API Documentation
Request Syntax
response = client.get_connect_peer_associations(
GlobalNetworkId='string',
ConnectPeerIds=[
'string',
],
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The ID of the global network.
The IDs of the Connect peers.
dict
Response Syntax
{
'ConnectPeerAssociations': [
{
'ConnectPeerId': 'string',
'GlobalNetworkId': 'string',
'DeviceId': 'string',
'LinkId': 'string',
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ConnectPeerAssociations (list) --
Displays a list of Connect peer associations.
(dict) --
Describes a core network Connect peer association.
ConnectPeerId (string) --
The ID of the Connect peer.
GlobalNetworkId (string) --
The ID of the global network.
DeviceId (string) --
The ID of the device to connect to.
LinkId (string) --
The ID of the link.
State (string) --
The state of the Connect peer association.
NextToken (string) --
The token for the next page of results.
Exceptions
Gets information about one or more of your connections in a global network.
See also: AWS API Documentation
Request Syntax
response = client.get_connections(
GlobalNetworkId='string',
ConnectionIds=[
'string',
],
DeviceId='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The ID of the global network.
One or more connection IDs.
dict
Response Syntax
{
'Connections': [
{
'ConnectionId': 'string',
'ConnectionArn': 'string',
'GlobalNetworkId': 'string',
'DeviceId': 'string',
'ConnectedDeviceId': 'string',
'LinkId': 'string',
'ConnectedLinkId': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Connections (list) --
Information about the connections.
(dict) --
Describes a connection.
ConnectionId (string) --
The ID of the connection.
ConnectionArn (string) --
The Amazon Resource Name (ARN) of the connection.
GlobalNetworkId (string) --
The ID of the global network.
DeviceId (string) --
The ID of the first device in the connection.
ConnectedDeviceId (string) --
The ID of the second device in the connection.
LinkId (string) --
The ID of the link for the first device in the connection.
ConnectedLinkId (string) --
The ID of the link for the second device in the connection.
Description (string) --
The description of the connection.
CreatedAt (datetime) --
The date and time that the connection was created.
State (string) --
The state of the connection.
Tags (list) --
The tags for the connection.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
NextToken (string) --
The token to use for the next page of results.
Exceptions
Returns information about a core network. By default it returns the LIVE policy.
See also: AWS API Documentation
Request Syntax
response = client.get_core_network(
CoreNetworkId='string'
)
[REQUIRED]
The ID of a core network.
{
'CoreNetwork': {
'GlobalNetworkId': 'string',
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'CREATING'|'UPDATING'|'AVAILABLE'|'DELETING',
'Segments': [
{
'Name': 'string',
'EdgeLocations': [
'string',
],
'SharedSegments': [
'string',
]
},
],
'Edges': [
{
'EdgeLocation': 'string',
'Asn': 123,
'InsideCidrBlocks': [
'string',
]
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
Details about a core network.
The ID of the global network that your core network is a part of.
The ID of a core network.
The ARN of a core network.
The description of a core network.
The timestamp when a core network was created.
The current state of a core network.
The segments within a core network.
Describes a core network segment, which are dedicated routes. Only attachments within this segment can communicate with each other.
The name of a core network segment.
The Regions where the edges are located.
The shared segments of a core network.
The edges within a core network.
Describes a core network edge.
The Region where a core network edge is located.
The ASN of a core network edge.
The inside IP addresses used for core network edges.
The tags associated with a core network.
Describes a tag.
The tag key.
Constraints: Maximum length of 128 characters.
The tag value.
Constraints: Maximum length of 256 characters.
Exceptions
Returns a change set between the LIVE core network policy and a submitted policy.
See also: AWS API Documentation
Request Syntax
response = client.get_core_network_change_set(
CoreNetworkId='string',
PolicyVersionId=123,
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The ID of a core network.
[REQUIRED]
The ID of the policy version.
dict
Response Syntax
{
'CoreNetworkChanges': [
{
'Type': 'CORE_NETWORK_SEGMENT'|'CORE_NETWORK_EDGE'|'ATTACHMENT_MAPPING'|'ATTACHMENT_ROUTE_PROPAGATION'|'ATTACHMENT_ROUTE_STATIC',
'Action': 'ADD'|'MODIFY'|'REMOVE',
'Identifier': 'string',
'PreviousValues': {
'SegmentName': 'string',
'EdgeLocations': [
'string',
],
'Asn': 123,
'Cidr': 'string',
'DestinationIdentifier': 'string',
'InsideCidrBlocks': [
'string',
],
'SharedSegments': [
'string',
]
},
'NewValues': {
'SegmentName': 'string',
'EdgeLocations': [
'string',
],
'Asn': 123,
'Cidr': 'string',
'DestinationIdentifier': 'string',
'InsideCidrBlocks': [
'string',
],
'SharedSegments': [
'string',
]
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
CoreNetworkChanges (list) --
Describes a core network changes.
(dict) --
Details describing a core network change.
Type (string) --
The type of change.
Action (string) --
The action to take for a core network.
Identifier (string) --
The resource identifier.
PreviousValues (dict) --
The previous values for a core network.
SegmentName (string) --
The names of the segments in a core network.
EdgeLocations (list) --
The Regions where edges are located in a core network.
Asn (integer) --
The ASN of a core network.
Cidr (string) --
The IP addresses used for a core network.
DestinationIdentifier (string) --
The ID of the destination.
InsideCidrBlocks (list) --
The inside IP addresses used for core network change values.
SharedSegments (list) --
The shared segments for a core network change value.
NewValues (dict) --
The new value for a core network
SegmentName (string) --
The names of the segments in a core network.
EdgeLocations (list) --
The Regions where edges are located in a core network.
Asn (integer) --
The ASN of a core network.
Cidr (string) --
The IP addresses used for a core network.
DestinationIdentifier (string) --
The ID of the destination.
InsideCidrBlocks (list) --
The inside IP addresses used for core network change values.
SharedSegments (list) --
The shared segments for a core network change value.
NextToken (string) --
The token for the next page of results.
Exceptions
Gets details about a core network policy. You can get details about your current live policy or any previous policy version.
See also: AWS API Documentation
Request Syntax
response = client.get_core_network_policy(
CoreNetworkId='string',
PolicyVersionId=123,
Alias='LIVE'|'LATEST'
)
[REQUIRED]
The ID of a core network.
dict
Response Syntax
{
'CoreNetworkPolicy': {
'CoreNetworkId': 'string',
'PolicyVersionId': 123,
'Alias': 'LIVE'|'LATEST',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'ChangeSetState': 'PENDING_GENERATION'|'FAILED_GENERATION'|'READY_TO_EXECUTE'|'EXECUTING'|'EXECUTION_SUCCEEDED'|'OUT_OF_DATE',
'PolicyErrors': [
{
'ErrorCode': 'string',
'Message': 'string',
'Path': 'string'
},
],
'PolicyDocument': 'string'
}
}
Response Structure
(dict) --
CoreNetworkPolicy (dict) --
The details about a core network policy.
CoreNetworkId (string) --
The ID of a core network.
PolicyVersionId (integer) --
The ID of the policy version.
Alias (string) --
Whether a core network policy is the current LIVE policy or the most recently submitted policy.
Description (string) --
The description of a core network policy.
CreatedAt (datetime) --
The timestamp when a core network policy was created.
ChangeSetState (string) --
The state of a core network policy.
PolicyErrors (list) --
Describes any errors in a core network policy.
(dict) --
Provides details about an error in a core network policy.
ErrorCode (string) --
The error code associated with a core network policy error.
Message (string) --
The message associated with a core network policy error code.
Path (string) --
The JSON path where the error was discovered in the policy document.
PolicyDocument (string) --
Describes a core network policy.
Exceptions
Gets the association information for customer gateways that are associated with devices and links in your global network.
See also: AWS API Documentation
Request Syntax
response = client.get_customer_gateway_associations(
GlobalNetworkId='string',
CustomerGatewayArns=[
'string',
],
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The ID of the global network.
One or more customer gateway Amazon Resource Names (ARNs). The maximum is 10.
dict
Response Syntax
{
'CustomerGatewayAssociations': [
{
'CustomerGatewayArn': 'string',
'GlobalNetworkId': 'string',
'DeviceId': 'string',
'LinkId': 'string',
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
CustomerGatewayAssociations (list) --
The customer gateway associations.
(dict) --
Describes the association between a customer gateway, a device, and a link.
CustomerGatewayArn (string) --
The Amazon Resource Name (ARN) of the customer gateway.
GlobalNetworkId (string) --
The ID of the global network.
DeviceId (string) --
The ID of the device.
LinkId (string) --
The ID of the link.
State (string) --
The association state.
NextToken (string) --
The token for the next page of results.
Exceptions
Gets information about one or more of your devices in a global network.
See also: AWS API Documentation
Request Syntax
response = client.get_devices(
GlobalNetworkId='string',
DeviceIds=[
'string',
],
SiteId='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The ID of the global network.
One or more device IDs. The maximum is 10.
dict
Response Syntax
{
'Devices': [
{
'DeviceId': 'string',
'DeviceArn': 'string',
'GlobalNetworkId': 'string',
'AWSLocation': {
'Zone': 'string',
'SubnetArn': 'string'
},
'Description': 'string',
'Type': 'string',
'Vendor': 'string',
'Model': 'string',
'SerialNumber': 'string',
'Location': {
'Address': 'string',
'Latitude': 'string',
'Longitude': 'string'
},
'SiteId': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Devices (list) --
The devices.
(dict) --
Describes a device.
DeviceId (string) --
The ID of the device.
DeviceArn (string) --
The Amazon Resource Name (ARN) of the device.
GlobalNetworkId (string) --
The ID of the global network.
AWSLocation (dict) --
The Amazon Web Services location of the device.
Zone (string) --
The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.
SubnetArn (string) --
The Amazon Resource Name (ARN) of the subnet that the device is located in.
Description (string) --
The description of the device.
Type (string) --
The device type.
Vendor (string) --
The device vendor.
Model (string) --
The device model.
SerialNumber (string) --
The device serial number.
Location (dict) --
The site location.
Address (string) --
The physical address.
Latitude (string) --
The latitude.
Longitude (string) --
The longitude.
SiteId (string) --
The site ID.
CreatedAt (datetime) --
The date and time that the site was created.
State (string) --
The device state.
Tags (list) --
The tags for the device.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
NextToken (string) --
The token for the next page of results.
Exceptions
Gets the link associations for a device or a link. Either the device ID or the link ID must be specified.
See also: AWS API Documentation
Request Syntax
response = client.get_link_associations(
GlobalNetworkId='string',
DeviceId='string',
LinkId='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The ID of the global network.
dict
Response Syntax
{
'LinkAssociations': [
{
'GlobalNetworkId': 'string',
'DeviceId': 'string',
'LinkId': 'string',
'LinkAssociationState': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
LinkAssociations (list) --
The link associations.
(dict) --
Describes the association between a device and a link.
GlobalNetworkId (string) --
The ID of the global network.
DeviceId (string) --
The device ID for the link association.
LinkId (string) --
The ID of the link.
LinkAssociationState (string) --
The state of the association.
NextToken (string) --
The token for the next page of results.
Exceptions
Gets information about one or more links in a specified global network.
If you specify the site ID, you cannot specify the type or provider in the same request. You can specify the type and provider in the same request.
See also: AWS API Documentation
Request Syntax
response = client.get_links(
GlobalNetworkId='string',
LinkIds=[
'string',
],
SiteId='string',
Type='string',
Provider='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The ID of the global network.
One or more link IDs. The maximum is 10.
dict
Response Syntax
{
'Links': [
{
'LinkId': 'string',
'LinkArn': 'string',
'GlobalNetworkId': 'string',
'SiteId': 'string',
'Description': 'string',
'Type': 'string',
'Bandwidth': {
'UploadSpeed': 123,
'DownloadSpeed': 123
},
'Provider': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Links (list) --
The links.
(dict) --
Describes a link.
LinkId (string) --
The ID of the link.
LinkArn (string) --
The Amazon Resource Name (ARN) of the link.
GlobalNetworkId (string) --
The ID of the global network.
SiteId (string) --
The ID of the site.
Description (string) --
The description of the link.
Type (string) --
The type of the link.
Bandwidth (dict) --
The bandwidth for the link.
UploadSpeed (integer) --
Upload speed in Mbps.
DownloadSpeed (integer) --
Download speed in Mbps.
Provider (string) --
The provider of the link.
CreatedAt (datetime) --
The date and time that the link was created.
State (string) --
The state of the link.
Tags (list) --
The tags for the link.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
NextToken (string) --
The token for the next page of results.
Exceptions
Gets the count of network resources, by resource type, for the specified global network.
See also: AWS API Documentation
Request Syntax
response = client.get_network_resource_counts(
GlobalNetworkId='string',
ResourceType='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The ID of the global network.
The resource type.
The following are the supported resource types for Direct Connect:
The following are the supported resource types for Network Manager:
The following are the supported resource types for Amazon VPC:
dict
Response Syntax
{
'NetworkResourceCounts': [
{
'ResourceType': 'string',
'Count': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
NetworkResourceCounts (list) --
The count of resources.
(dict) --
Describes a resource count.
ResourceType (string) --
The resource type.
Count (integer) --
The resource count.
NextToken (string) --
The token for the next page of results.
Exceptions
Gets the network resource relationships for the specified global network.
See also: AWS API Documentation
Request Syntax
response = client.get_network_resource_relationships(
GlobalNetworkId='string',
CoreNetworkId='string',
RegisteredGatewayArn='string',
AwsRegion='string',
AccountId='string',
ResourceType='string',
ResourceArn='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The ID of the global network.
The resource type.
The following are the supported resource types for Direct Connect:
The following are the supported resource types for Network Manager:
The following are the supported resource types for Amazon VPC:
dict
Response Syntax
{
'Relationships': [
{
'From': 'string',
'To': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Relationships (list) --
The resource relationships.
(dict) --
Describes a resource relationship.
From (string) --
The ARN of the resource.
To (string) --
The ARN of the resource.
NextToken (string) --
The token for the next page of results.
Exceptions
Describes the network resources for the specified global network.
The results include information from the corresponding Describe call for the resource, minus any sensitive information such as pre-shared keys.
See also: AWS API Documentation
Request Syntax
response = client.get_network_resources(
GlobalNetworkId='string',
CoreNetworkId='string',
RegisteredGatewayArn='string',
AwsRegion='string',
AccountId='string',
ResourceType='string',
ResourceArn='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The ID of the global network.
The resource type.
The following are the supported resource types for Direct Connect:
The following are the supported resource types for Network Manager:
The following are the supported resource types for Amazon VPC:
dict
Response Syntax
{
'NetworkResources': [
{
'RegisteredGatewayArn': 'string',
'CoreNetworkId': 'string',
'AwsRegion': 'string',
'AccountId': 'string',
'ResourceType': 'string',
'ResourceId': 'string',
'ResourceArn': 'string',
'Definition': 'string',
'DefinitionTimestamp': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'Metadata': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
NetworkResources (list) --
The network resources.
(dict) --
Describes a network resource.
RegisteredGatewayArn (string) --
The ARN of the gateway.
CoreNetworkId (string) --
a core network ID.
AwsRegion (string) --
The Amazon Web Services Region.
AccountId (string) --
The Amazon Web Services account ID.
ResourceType (string) --
The resource type.
The following are the supported resource types for Direct Connect:
The following are the supported resource types for Network Manager:
The following are the supported resource types for Amazon VPC:
ResourceId (string) --
The ID of the resource.
ResourceArn (string) --
The ARN of the resource.
Definition (string) --
Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.
DefinitionTimestamp (datetime) --
The time that the resource definition was retrieved.
Tags (list) --
The tags.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
Metadata (dict) --
The resource metadata.
NextToken (string) --
The token for the next page of results.
Exceptions
Gets the network routes of the specified global network.
See also: AWS API Documentation
Request Syntax
response = client.get_network_routes(
GlobalNetworkId='string',
RouteTableIdentifier={
'TransitGatewayRouteTableArn': 'string',
'CoreNetworkSegmentEdge': {
'CoreNetworkId': 'string',
'SegmentName': 'string',
'EdgeLocation': 'string'
}
},
ExactCidrMatches=[
'string',
],
LongestPrefixMatches=[
'string',
],
SubnetOfMatches=[
'string',
],
SupernetOfMatches=[
'string',
],
PrefixListIds=[
'string',
],
States=[
'ACTIVE'|'BLACKHOLE',
],
Types=[
'PROPAGATED'|'STATIC',
],
DestinationFilters={
'string': [
'string',
]
}
)
[REQUIRED]
The ID of the global network.
[REQUIRED]
The ID of the route table.
The ARN of the transit gateway route table.
The segment edge in a core network.
The ID of a core network.
The name of the segment edge.
The Region where the segment edge is located.
An exact CIDR block.
The most specific route that matches the traffic (longest prefix match).
The routes with a subnet that match the specified CIDR filter.
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.
The IDs of the prefix lists.
The route states.
The route types.
Filter by route table destination. Possible Values: TRANSIT_GATEWAY_ATTACHMENT_ID, RESOURCE_ID, or RESOURCE_TYPE.
dict
Response Syntax
{
'RouteTableArn': 'string',
'CoreNetworkSegmentEdge': {
'CoreNetworkId': 'string',
'SegmentName': 'string',
'EdgeLocation': 'string'
},
'RouteTableType': 'TRANSIT_GATEWAY_ROUTE_TABLE'|'CORE_NETWORK_SEGMENT',
'RouteTableTimestamp': datetime(2015, 1, 1),
'NetworkRoutes': [
{
'DestinationCidrBlock': 'string',
'Destinations': [
{
'CoreNetworkAttachmentId': 'string',
'TransitGatewayAttachmentId': 'string',
'SegmentName': 'string',
'EdgeLocation': 'string',
'ResourceType': 'string',
'ResourceId': 'string'
},
],
'PrefixListId': 'string',
'State': 'ACTIVE'|'BLACKHOLE',
'Type': 'PROPAGATED'|'STATIC'
},
]
}
Response Structure
(dict) --
RouteTableArn (string) --
The ARN of the route table.
CoreNetworkSegmentEdge (dict) --
Describes a core network segment edge.
CoreNetworkId (string) --
The ID of a core network.
SegmentName (string) --
The name of the segment edge.
EdgeLocation (string) --
The Region where the segment edge is located.
RouteTableType (string) --
The route table type.
RouteTableTimestamp (datetime) --
The route table creation time.
NetworkRoutes (list) --
The network routes.
(dict) --
Describes a network route.
DestinationCidrBlock (string) --
A unique identifier for the route, such as a CIDR block.
Destinations (list) --
The destinations.
(dict) --
Describes the destination of a network route.
CoreNetworkAttachmentId (string) --
The ID of a core network attachment.
TransitGatewayAttachmentId (string) --
The ID of the transit gateway attachment.
SegmentName (string) --
The name of the segment.
EdgeLocation (string) --
The edge location for the network destination.
ResourceType (string) --
The resource type.
ResourceId (string) --
The ID of the resource.
PrefixListId (string) --
The ID of the prefix list.
State (string) --
The route state. The possible values are active and blackhole .
Type (string) --
The route type. The possible values are propagated and static .
Exceptions
Gets the network telemetry of the specified global network.
See also: AWS API Documentation
Request Syntax
response = client.get_network_telemetry(
GlobalNetworkId='string',
CoreNetworkId='string',
RegisteredGatewayArn='string',
AwsRegion='string',
AccountId='string',
ResourceType='string',
ResourceArn='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The ID of the global network.
The resource type.
The following are the supported resource types for Direct Connect:
The following are the supported resource types for Network Manager:
The following are the supported resource types for Amazon VPC:
dict
Response Syntax
{
'NetworkTelemetry': [
{
'RegisteredGatewayArn': 'string',
'CoreNetworkId': 'string',
'AwsRegion': 'string',
'AccountId': 'string',
'ResourceType': 'string',
'ResourceId': 'string',
'ResourceArn': 'string',
'Address': 'string',
'Health': {
'Type': 'BGP'|'IPSEC',
'Status': 'UP'|'DOWN',
'Timestamp': datetime(2015, 1, 1)
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
NetworkTelemetry (list) --
The network telemetry.
(dict) --
Describes the telemetry information for a resource.
RegisteredGatewayArn (string) --
The ARN of the gateway.
CoreNetworkId (string) --
The ID of a core network.
AwsRegion (string) --
The Amazon Web Services Region.
AccountId (string) --
The Amazon Web Services account ID.
ResourceType (string) --
The resource type.
ResourceId (string) --
The ID of the resource.
ResourceArn (string) --
The ARN of the resource.
Address (string) --
The address.
Health (dict) --
The connection health.
Type (string) --
The connection type.
Status (string) --
The connection status.
Timestamp (datetime) --
The time the status was last updated.
NextToken (string) --
The token for the next page of results.
Exceptions
Create a paginator for an operation.
Returns information about a resource policy.
See also: AWS API Documentation
Request Syntax
response = client.get_resource_policy(
ResourceArn='string'
)
[REQUIRED]
The ARN of the resource.
{
'PolicyDocument': 'string'
}
Response Structure
The resource policy document.
Exceptions
Gets information about the specified route analysis.
See also: AWS API Documentation
Request Syntax
response = client.get_route_analysis(
GlobalNetworkId='string',
RouteAnalysisId='string'
)
[REQUIRED]
The ID of the global network.
[REQUIRED]
The ID of the route analysis.
dict
Response Syntax
{
'RouteAnalysis': {
'GlobalNetworkId': 'string',
'OwnerAccountId': 'string',
'RouteAnalysisId': 'string',
'StartTimestamp': datetime(2015, 1, 1),
'Status': 'RUNNING'|'COMPLETED'|'FAILED',
'Source': {
'TransitGatewayAttachmentArn': 'string',
'TransitGatewayArn': 'string',
'IpAddress': 'string'
},
'Destination': {
'TransitGatewayAttachmentArn': 'string',
'TransitGatewayArn': 'string',
'IpAddress': 'string'
},
'IncludeReturnPath': True|False,
'UseMiddleboxes': True|False,
'ForwardPath': {
'CompletionStatus': {
'ResultCode': 'CONNECTED'|'NOT_CONNECTED',
'ReasonCode': 'TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND'|'TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY'|'CYCLIC_PATH_DETECTED'|'TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND'|'ROUTE_NOT_FOUND'|'BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND'|'INACTIVE_ROUTE_FOR_DESTINATION_FOUND'|'TRANSIT_GATEWAY_ATTACHMENT_ATTACH_ARN_NO_MATCH'|'MAX_HOPS_EXCEEDED'|'POSSIBLE_MIDDLEBOX'|'NO_DESTINATION_ARN_PROVIDED',
'ReasonContext': {
'string': 'string'
}
},
'Path': [
{
'Sequence': 123,
'Resource': {
'RegisteredGatewayArn': 'string',
'ResourceArn': 'string',
'ResourceType': 'string',
'Definition': 'string',
'NameTag': 'string',
'IsMiddlebox': True|False
},
'DestinationCidrBlock': 'string'
},
]
},
'ReturnPath': {
'CompletionStatus': {
'ResultCode': 'CONNECTED'|'NOT_CONNECTED',
'ReasonCode': 'TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND'|'TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY'|'CYCLIC_PATH_DETECTED'|'TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND'|'ROUTE_NOT_FOUND'|'BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND'|'INACTIVE_ROUTE_FOR_DESTINATION_FOUND'|'TRANSIT_GATEWAY_ATTACHMENT_ATTACH_ARN_NO_MATCH'|'MAX_HOPS_EXCEEDED'|'POSSIBLE_MIDDLEBOX'|'NO_DESTINATION_ARN_PROVIDED',
'ReasonContext': {
'string': 'string'
}
},
'Path': [
{
'Sequence': 123,
'Resource': {
'RegisteredGatewayArn': 'string',
'ResourceArn': 'string',
'ResourceType': 'string',
'Definition': 'string',
'NameTag': 'string',
'IsMiddlebox': True|False
},
'DestinationCidrBlock': 'string'
},
]
}
}
}
Response Structure
(dict) --
RouteAnalysis (dict) --
The route analysis.
GlobalNetworkId (string) --
The ID of the global network.
OwnerAccountId (string) --
The ID of the AWS account that created the route analysis.
RouteAnalysisId (string) --
The ID of the route analysis.
StartTimestamp (datetime) --
The time that the analysis started.
Status (string) --
The status of the route analysis.
Source (dict) --
The source.
TransitGatewayAttachmentArn (string) --
The ARN of the transit gateway attachment.
TransitGatewayArn (string) --
The ARN of the transit gateway.
IpAddress (string) --
The IP address.
Destination (dict) --
The destination.
TransitGatewayAttachmentArn (string) --
The ARN of the transit gateway attachment.
TransitGatewayArn (string) --
The ARN of the transit gateway.
IpAddress (string) --
The IP address.
IncludeReturnPath (boolean) --
Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does not succeed.
UseMiddleboxes (boolean) --
Indicates whether to include the location of middlebox appliances in the route analysis.
ForwardPath (dict) --
The forward path.
CompletionStatus (dict) --
The status of the analysis at completion.
ResultCode (string) --
The result of the analysis. If the status is NOT_CONNECTED , check the reason code.
ReasonCode (string) --
The reason code. Available only if a connection is not found.
ReasonContext (dict) --
Additional information about the path. Available only if a connection is not found.
Path (list) --
The route analysis path.
(dict) --
Describes a path component.
Sequence (integer) --
The sequence number in the path. The destination is 0.
Resource (dict) --
The resource.
RegisteredGatewayArn (string) --
The ARN of the gateway.
ResourceArn (string) --
The ARN of the resource.
ResourceType (string) --
The resource type.
Definition (string) --
Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.
NameTag (string) --
The value for the Name tag.
IsMiddlebox (boolean) --
Indicates whether this is a middlebox appliance.
DestinationCidrBlock (string) --
The destination CIDR block in the route table.
ReturnPath (dict) --
The return path.
CompletionStatus (dict) --
The status of the analysis at completion.
ResultCode (string) --
The result of the analysis. If the status is NOT_CONNECTED , check the reason code.
ReasonCode (string) --
The reason code. Available only if a connection is not found.
ReasonContext (dict) --
Additional information about the path. Available only if a connection is not found.
Path (list) --
The route analysis path.
(dict) --
Describes a path component.
Sequence (integer) --
The sequence number in the path. The destination is 0.
Resource (dict) --
The resource.
RegisteredGatewayArn (string) --
The ARN of the gateway.
ResourceArn (string) --
The ARN of the resource.
ResourceType (string) --
The resource type.
Definition (string) --
Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.
NameTag (string) --
The value for the Name tag.
IsMiddlebox (boolean) --
Indicates whether this is a middlebox appliance.
DestinationCidrBlock (string) --
The destination CIDR block in the route table.
Exceptions
Returns information about a site-to-site VPN attachment.
See also: AWS API Documentation
Request Syntax
response = client.get_site_to_site_vpn_attachment(
AttachmentId='string'
)
[REQUIRED]
The ID of the attachment.
{
'SiteToSiteVpnAttachment': {
'Attachment': {
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'AttachmentId': 'string',
'OwnerAccountId': 'string',
'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
},
'VpnConnectionArn': 'string'
}
}
Response Structure
Describes the site-to-site attachment.
Provides details about a site-to-site VPN attachment.
A core network ID.
The ARN of a core network.
The ID of the attachment.
The ID of the attachment account owner.
The type of attachment.
The state of the attachment.
The Region where the edge is located.
The attachment resource ARN.
The policy rule number associated with the attachment.
The name of the segment attachment.
The tags associated with the attachment.
Describes a tag.
The tag key.
Constraints: Maximum length of 128 characters.
The tag value.
Constraints: Maximum length of 256 characters.
The attachment to move from one segment to another.
The key-value tags that changed for the segment.
Describes a tag.
The tag key.
Constraints: Maximum length of 128 characters.
The tag value.
Constraints: Maximum length of 256 characters.
The rule number in the policy document that applies to this change.
The name of the segment to change.
The timestamp when the attachment was created.
The timestamp when the attachment was last updated.
The ARN of the site-to-site VPN attachment.
Exceptions
Gets information about one or more of your sites in a global network.
See also: AWS API Documentation
Request Syntax
response = client.get_sites(
GlobalNetworkId='string',
SiteIds=[
'string',
],
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The ID of the global network.
One or more site IDs. The maximum is 10.
dict
Response Syntax
{
'Sites': [
{
'SiteId': 'string',
'SiteArn': 'string',
'GlobalNetworkId': 'string',
'Description': 'string',
'Location': {
'Address': 'string',
'Latitude': 'string',
'Longitude': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Sites (list) --
The sites.
(dict) --
Describes a site.
SiteId (string) --
The ID of the site.
SiteArn (string) --
The Amazon Resource Name (ARN) of the site.
GlobalNetworkId (string) --
The ID of the global network.
Description (string) --
The description of the site.
Location (dict) --
The location of the site.
Address (string) --
The physical address.
Latitude (string) --
The latitude.
Longitude (string) --
The longitude.
CreatedAt (datetime) --
The date and time that the site was created.
State (string) --
The state of the site.
Tags (list) --
The tags for the site.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
NextToken (string) --
The token for the next page of results.
Exceptions
Gets information about one or more of your transit gateway Connect peer associations in a global network.
See also: AWS API Documentation
Request Syntax
response = client.get_transit_gateway_connect_peer_associations(
GlobalNetworkId='string',
TransitGatewayConnectPeerArns=[
'string',
],
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The ID of the global network.
One or more transit gateway Connect peer Amazon Resource Names (ARNs).
dict
Response Syntax
{
'TransitGatewayConnectPeerAssociations': [
{
'TransitGatewayConnectPeerArn': 'string',
'GlobalNetworkId': 'string',
'DeviceId': 'string',
'LinkId': 'string',
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TransitGatewayConnectPeerAssociations (list) --
Information about the transit gateway Connect peer associations.
(dict) --
Describes a transit gateway Connect peer association.
TransitGatewayConnectPeerArn (string) --
The Amazon Resource Name (ARN) of the transit gateway Connect peer.
GlobalNetworkId (string) --
The ID of the global network.
DeviceId (string) --
The ID of the device.
LinkId (string) --
The ID of the link.
State (string) --
The state of the association.
NextToken (string) --
The token to use for the next page of results.
Exceptions
Gets information about the transit gateway registrations in a specified global network.
See also: AWS API Documentation
Request Syntax
response = client.get_transit_gateway_registrations(
GlobalNetworkId='string',
TransitGatewayArns=[
'string',
],
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The ID of the global network.
The Amazon Resource Names (ARNs) of one or more transit gateways. The maximum is 10.
dict
Response Syntax
{
'TransitGatewayRegistrations': [
{
'GlobalNetworkId': 'string',
'TransitGatewayArn': 'string',
'State': {
'Code': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'|'FAILED',
'Message': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TransitGatewayRegistrations (list) --
The transit gateway registrations.
(dict) --
Describes the registration of a transit gateway to a global network.
GlobalNetworkId (string) --
The ID of the global network.
TransitGatewayArn (string) --
The Amazon Resource Name (ARN) of the transit gateway.
State (dict) --
The state of the transit gateway registration.
Code (string) --
The code for the state reason.
Message (string) --
The message for the state reason.
NextToken (string) --
The token for the next page of results.
Exceptions
Returns information about a VPC attachment.
See also: AWS API Documentation
Request Syntax
response = client.get_vpc_attachment(
AttachmentId='string'
)
[REQUIRED]
The ID of the attachment.
{
'VpcAttachment': {
'Attachment': {
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'AttachmentId': 'string',
'OwnerAccountId': 'string',
'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
},
'SubnetArns': [
'string',
],
'Options': {
'Ipv6Support': True|False
}
}
}
Response Structure
Returns details about a VPC attachment.
Provides details about the VPC attachment.
A core network ID.
The ARN of a core network.
The ID of the attachment.
The ID of the attachment account owner.
The type of attachment.
The state of the attachment.
The Region where the edge is located.
The attachment resource ARN.
The policy rule number associated with the attachment.
The name of the segment attachment.
The tags associated with the attachment.
Describes a tag.
The tag key.
Constraints: Maximum length of 128 characters.
The tag value.
Constraints: Maximum length of 256 characters.
The attachment to move from one segment to another.
The key-value tags that changed for the segment.
Describes a tag.
The tag key.
Constraints: Maximum length of 128 characters.
The tag value.
Constraints: Maximum length of 256 characters.
The rule number in the policy document that applies to this change.
The name of the segment to change.
The timestamp when the attachment was created.
The timestamp when the attachment was last updated.
The subnet ARNs.
Provides details about the VPC attachment.
Indicates whether IPv6 is supported.
Exceptions
Returns an object that can wait for some condition.
Returns a list of core network attachments.
See also: AWS API Documentation
Request Syntax
response = client.list_attachments(
CoreNetworkId='string',
AttachmentType='CONNECT'|'SITE_TO_SITE_VPN'|'VPC',
EdgeLocation='string',
State='REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'Attachments': [
{
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'AttachmentId': 'string',
'OwnerAccountId': 'string',
'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Attachments (list) --
Describes the list of attachments.
(dict) --
Describes a core network attachment.
CoreNetworkId (string) --
A core network ID.
CoreNetworkArn (string) --
The ARN of a core network.
AttachmentId (string) --
The ID of the attachment.
OwnerAccountId (string) --
The ID of the attachment account owner.
AttachmentType (string) --
The type of attachment.
State (string) --
The state of the attachment.
EdgeLocation (string) --
The Region where the edge is located.
ResourceArn (string) --
The attachment resource ARN.
AttachmentPolicyRuleNumber (integer) --
The policy rule number associated with the attachment.
SegmentName (string) --
The name of the segment attachment.
Tags (list) --
The tags associated with the attachment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
ProposedSegmentChange (dict) --
The attachment to move from one segment to another.
Tags (list) --
The key-value tags that changed for the segment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
AttachmentPolicyRuleNumber (integer) --
The rule number in the policy document that applies to this change.
SegmentName (string) --
The name of the segment to change.
CreatedAt (datetime) --
The timestamp when the attachment was created.
UpdatedAt (datetime) --
The timestamp when the attachment was last updated.
NextToken (string) --
The token for the next page of results.
Exceptions
Returns a list of core network Connect peers.
See also: AWS API Documentation
Request Syntax
response = client.list_connect_peers(
CoreNetworkId='string',
ConnectAttachmentId='string',
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'ConnectPeers': [
{
'CoreNetworkId': 'string',
'ConnectAttachmentId': 'string',
'ConnectPeerId': 'string',
'EdgeLocation': 'string',
'ConnectPeerState': 'CREATING'|'FAILED'|'AVAILABLE'|'DELETING',
'CreatedAt': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ConnectPeers (list) --
Describes the Connect peers.
(dict) --
Summary description of a Connect peer.
CoreNetworkId (string) --
The ID of a core network.
ConnectAttachmentId (string) --
The ID of a Connect peer attachment.
ConnectPeerId (string) --
The ID of a Connect peer.
EdgeLocation (string) --
The Region where the edge is located.
ConnectPeerState (string) --
The state of a Connect peer.
CreatedAt (datetime) --
The timestamp when a Connect peer was created.
Tags (list) --
The tags associated with a Connect peer summary.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
NextToken (string) --
The token for the next page of results.
Exceptions
Returns a list of core network policy versions.
See also: AWS API Documentation
Request Syntax
response = client.list_core_network_policy_versions(
CoreNetworkId='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The ID of a core network.
dict
Response Syntax
{
'CoreNetworkPolicyVersions': [
{
'CoreNetworkId': 'string',
'PolicyVersionId': 123,
'Alias': 'LIVE'|'LATEST',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'ChangeSetState': 'PENDING_GENERATION'|'FAILED_GENERATION'|'READY_TO_EXECUTE'|'EXECUTING'|'EXECUTION_SUCCEEDED'|'OUT_OF_DATE'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
CoreNetworkPolicyVersions (list) --
Describes core network policy versions.
(dict) --
Describes a core network policy version.
CoreNetworkId (string) --
The ID of a core network.
PolicyVersionId (integer) --
The ID of the policy version.
Alias (string) --
Whether a core network policy is the current policy or the most recently submitted policy.
Description (string) --
The description of a core network policy version.
CreatedAt (datetime) --
The timestamp when a core network policy version was created.
ChangeSetState (string) --
The status of the policy version change set.
NextToken (string) --
The token for the next page of results.
Exceptions
Returns a list of owned and shared core networks.
See also: AWS API Documentation
Request Syntax
response = client.list_core_networks(
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'CoreNetworks': [
{
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'GlobalNetworkId': 'string',
'OwnerAccountId': 'string',
'State': 'CREATING'|'UPDATING'|'AVAILABLE'|'DELETING',
'Description': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
CoreNetworks (list) --
Describes the list of core networks.
(dict) --
Returns summary information about a core network.
CoreNetworkId (string) --
The ID of a core network.
CoreNetworkArn (string) --
a core network ARN.
GlobalNetworkId (string) --
The global network ID.
OwnerAccountId (string) --
The ID of the account owner.
State (string) --
The state of a core network.
Description (string) --
The description of a core network.
Tags (list) --
The key-value tags associated with a core network summary.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
NextToken (string) --
The token for the next page of results.
Exceptions
Lists the tags for a specified resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
{
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
The list of tags.
Describes a tag.
The tag key.
Constraints: Maximum length of 128 characters.
The tag value.
Constraints: Maximum length of 256 characters.
Exceptions
Creates a new, immutable version of a core network policy. A subsequent change set is created showing the differences between the LIVE policy and the submitted policy.
See also: AWS API Documentation
Request Syntax
response = client.put_core_network_policy(
CoreNetworkId='string',
PolicyDocument='string',
Description='string',
LatestVersionId=123,
ClientToken='string'
)
[REQUIRED]
The ID of a core network.
[REQUIRED]
The policy document.
The client token associated with the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'CoreNetworkPolicy': {
'CoreNetworkId': 'string',
'PolicyVersionId': 123,
'Alias': 'LIVE'|'LATEST',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'ChangeSetState': 'PENDING_GENERATION'|'FAILED_GENERATION'|'READY_TO_EXECUTE'|'EXECUTING'|'EXECUTION_SUCCEEDED'|'OUT_OF_DATE',
'PolicyErrors': [
{
'ErrorCode': 'string',
'Message': 'string',
'Path': 'string'
},
],
'PolicyDocument': 'string'
}
}
Response Structure
(dict) --
CoreNetworkPolicy (dict) --
Describes the changed core network policy.
CoreNetworkId (string) --
The ID of a core network.
PolicyVersionId (integer) --
The ID of the policy version.
Alias (string) --
Whether a core network policy is the current LIVE policy or the most recently submitted policy.
Description (string) --
The description of a core network policy.
CreatedAt (datetime) --
The timestamp when a core network policy was created.
ChangeSetState (string) --
The state of a core network policy.
PolicyErrors (list) --
Describes any errors in a core network policy.
(dict) --
Provides details about an error in a core network policy.
ErrorCode (string) --
The error code associated with a core network policy error.
Message (string) --
The message associated with a core network policy error code.
Path (string) --
The JSON path where the error was discovered in the policy document.
PolicyDocument (string) --
Describes a core network policy.
Exceptions
Creates or updates a resource policy.
See also: AWS API Documentation
Request Syntax
response = client.put_resource_policy(
PolicyDocument='string',
ResourceArn='string'
)
[REQUIRED]
The JSON resource policy document.
[REQUIRED]
The ARN of the resource policy.
dict
Response Syntax
{}
Response Structure
Exceptions
Registers a transit gateway in your global network. The transit gateway can be in any Amazon Web Services Region, but it must be owned by the same Amazon Web Services account that owns the global network. You cannot register a transit gateway in more than one global network.
See also: AWS API Documentation
Request Syntax
response = client.register_transit_gateway(
GlobalNetworkId='string',
TransitGatewayArn='string'
)
[REQUIRED]
The ID of the global network.
[REQUIRED]
The Amazon Resource Name (ARN) of the transit gateway.
dict
Response Syntax
{
'TransitGatewayRegistration': {
'GlobalNetworkId': 'string',
'TransitGatewayArn': 'string',
'State': {
'Code': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'|'FAILED',
'Message': 'string'
}
}
}
Response Structure
(dict) --
TransitGatewayRegistration (dict) --
Information about the transit gateway registration.
GlobalNetworkId (string) --
The ID of the global network.
TransitGatewayArn (string) --
The Amazon Resource Name (ARN) of the transit gateway.
State (dict) --
The state of the transit gateway registration.
Code (string) --
The code for the state reason.
Message (string) --
The message for the state reason.
Exceptions
Rejects a core network attachment request.
See also: AWS API Documentation
Request Syntax
response = client.reject_attachment(
AttachmentId='string'
)
[REQUIRED]
The ID of the attachment.
{
'Attachment': {
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'AttachmentId': 'string',
'OwnerAccountId': 'string',
'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
}
}
Response Structure
Describes the rejected attachment request.
A core network ID.
The ARN of a core network.
The ID of the attachment.
The ID of the attachment account owner.
The type of attachment.
The state of the attachment.
The Region where the edge is located.
The attachment resource ARN.
The policy rule number associated with the attachment.
The name of the segment attachment.
The tags associated with the attachment.
Describes a tag.
The tag key.
Constraints: Maximum length of 128 characters.
The tag value.
Constraints: Maximum length of 256 characters.
The attachment to move from one segment to another.
The key-value tags that changed for the segment.
Describes a tag.
The tag key.
Constraints: Maximum length of 128 characters.
The tag value.
Constraints: Maximum length of 256 characters.
The rule number in the policy document that applies to this change.
The name of the segment to change.
The timestamp when the attachment was created.
The timestamp when the attachment was last updated.
Exceptions
Restores a previous policy version as a new, immutable version of a core network policy. A subsequent change set is created showing the differences between the LIVE policy and restored policy.
See also: AWS API Documentation
Request Syntax
response = client.restore_core_network_policy_version(
CoreNetworkId='string',
PolicyVersionId=123
)
[REQUIRED]
The ID of a core network.
[REQUIRED]
The ID of the policy version to restore.
dict
Response Syntax
{
'CoreNetworkPolicy': {
'CoreNetworkId': 'string',
'PolicyVersionId': 123,
'Alias': 'LIVE'|'LATEST',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'ChangeSetState': 'PENDING_GENERATION'|'FAILED_GENERATION'|'READY_TO_EXECUTE'|'EXECUTING'|'EXECUTION_SUCCEEDED'|'OUT_OF_DATE',
'PolicyErrors': [
{
'ErrorCode': 'string',
'Message': 'string',
'Path': 'string'
},
],
'PolicyDocument': 'string'
}
}
Response Structure
(dict) --
CoreNetworkPolicy (dict) --
Describes the restored core network policy.
CoreNetworkId (string) --
The ID of a core network.
PolicyVersionId (integer) --
The ID of the policy version.
Alias (string) --
Whether a core network policy is the current LIVE policy or the most recently submitted policy.
Description (string) --
The description of a core network policy.
CreatedAt (datetime) --
The timestamp when a core network policy was created.
ChangeSetState (string) --
The state of a core network policy.
PolicyErrors (list) --
Describes any errors in a core network policy.
(dict) --
Provides details about an error in a core network policy.
ErrorCode (string) --
The error code associated with a core network policy error.
Message (string) --
The message associated with a core network policy error code.
Path (string) --
The JSON path where the error was discovered in the policy document.
PolicyDocument (string) --
Describes a core network policy.
Exceptions
Starts analyzing the routing path between the specified source and destination. For more information, see Route Analyzer .
See also: AWS API Documentation
Request Syntax
response = client.start_route_analysis(
GlobalNetworkId='string',
Source={
'TransitGatewayAttachmentArn': 'string',
'IpAddress': 'string'
},
Destination={
'TransitGatewayAttachmentArn': 'string',
'IpAddress': 'string'
},
IncludeReturnPath=True|False,
UseMiddleboxes=True|False
)
[REQUIRED]
The ID of the global network.
[REQUIRED]
The source from which traffic originates.
The ARN of the transit gateway attachment.
The IP address.
[REQUIRED]
The destination.
The ARN of the transit gateway attachment.
The IP address.
dict
Response Syntax
{
'RouteAnalysis': {
'GlobalNetworkId': 'string',
'OwnerAccountId': 'string',
'RouteAnalysisId': 'string',
'StartTimestamp': datetime(2015, 1, 1),
'Status': 'RUNNING'|'COMPLETED'|'FAILED',
'Source': {
'TransitGatewayAttachmentArn': 'string',
'TransitGatewayArn': 'string',
'IpAddress': 'string'
},
'Destination': {
'TransitGatewayAttachmentArn': 'string',
'TransitGatewayArn': 'string',
'IpAddress': 'string'
},
'IncludeReturnPath': True|False,
'UseMiddleboxes': True|False,
'ForwardPath': {
'CompletionStatus': {
'ResultCode': 'CONNECTED'|'NOT_CONNECTED',
'ReasonCode': 'TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND'|'TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY'|'CYCLIC_PATH_DETECTED'|'TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND'|'ROUTE_NOT_FOUND'|'BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND'|'INACTIVE_ROUTE_FOR_DESTINATION_FOUND'|'TRANSIT_GATEWAY_ATTACHMENT_ATTACH_ARN_NO_MATCH'|'MAX_HOPS_EXCEEDED'|'POSSIBLE_MIDDLEBOX'|'NO_DESTINATION_ARN_PROVIDED',
'ReasonContext': {
'string': 'string'
}
},
'Path': [
{
'Sequence': 123,
'Resource': {
'RegisteredGatewayArn': 'string',
'ResourceArn': 'string',
'ResourceType': 'string',
'Definition': 'string',
'NameTag': 'string',
'IsMiddlebox': True|False
},
'DestinationCidrBlock': 'string'
},
]
},
'ReturnPath': {
'CompletionStatus': {
'ResultCode': 'CONNECTED'|'NOT_CONNECTED',
'ReasonCode': 'TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND'|'TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY'|'CYCLIC_PATH_DETECTED'|'TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND'|'ROUTE_NOT_FOUND'|'BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND'|'INACTIVE_ROUTE_FOR_DESTINATION_FOUND'|'TRANSIT_GATEWAY_ATTACHMENT_ATTACH_ARN_NO_MATCH'|'MAX_HOPS_EXCEEDED'|'POSSIBLE_MIDDLEBOX'|'NO_DESTINATION_ARN_PROVIDED',
'ReasonContext': {
'string': 'string'
}
},
'Path': [
{
'Sequence': 123,
'Resource': {
'RegisteredGatewayArn': 'string',
'ResourceArn': 'string',
'ResourceType': 'string',
'Definition': 'string',
'NameTag': 'string',
'IsMiddlebox': True|False
},
'DestinationCidrBlock': 'string'
},
]
}
}
}
Response Structure
(dict) --
RouteAnalysis (dict) --
The route analysis.
GlobalNetworkId (string) --
The ID of the global network.
OwnerAccountId (string) --
The ID of the AWS account that created the route analysis.
RouteAnalysisId (string) --
The ID of the route analysis.
StartTimestamp (datetime) --
The time that the analysis started.
Status (string) --
The status of the route analysis.
Source (dict) --
The source.
TransitGatewayAttachmentArn (string) --
The ARN of the transit gateway attachment.
TransitGatewayArn (string) --
The ARN of the transit gateway.
IpAddress (string) --
The IP address.
Destination (dict) --
The destination.
TransitGatewayAttachmentArn (string) --
The ARN of the transit gateway attachment.
TransitGatewayArn (string) --
The ARN of the transit gateway.
IpAddress (string) --
The IP address.
IncludeReturnPath (boolean) --
Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does not succeed.
UseMiddleboxes (boolean) --
Indicates whether to include the location of middlebox appliances in the route analysis.
ForwardPath (dict) --
The forward path.
CompletionStatus (dict) --
The status of the analysis at completion.
ResultCode (string) --
The result of the analysis. If the status is NOT_CONNECTED , check the reason code.
ReasonCode (string) --
The reason code. Available only if a connection is not found.
ReasonContext (dict) --
Additional information about the path. Available only if a connection is not found.
Path (list) --
The route analysis path.
(dict) --
Describes a path component.
Sequence (integer) --
The sequence number in the path. The destination is 0.
Resource (dict) --
The resource.
RegisteredGatewayArn (string) --
The ARN of the gateway.
ResourceArn (string) --
The ARN of the resource.
ResourceType (string) --
The resource type.
Definition (string) --
Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.
NameTag (string) --
The value for the Name tag.
IsMiddlebox (boolean) --
Indicates whether this is a middlebox appliance.
DestinationCidrBlock (string) --
The destination CIDR block in the route table.
ReturnPath (dict) --
The return path.
CompletionStatus (dict) --
The status of the analysis at completion.
ResultCode (string) --
The result of the analysis. If the status is NOT_CONNECTED , check the reason code.
ReasonCode (string) --
The reason code. Available only if a connection is not found.
ReasonContext (dict) --
Additional information about the path. Available only if a connection is not found.
Path (list) --
The route analysis path.
(dict) --
Describes a path component.
Sequence (integer) --
The sequence number in the path. The destination is 0.
Resource (dict) --
The resource.
RegisteredGatewayArn (string) --
The ARN of the gateway.
ResourceArn (string) --
The ARN of the resource.
ResourceType (string) --
The resource type.
Definition (string) --
Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.
NameTag (string) --
The value for the Name tag.
IsMiddlebox (boolean) --
Indicates whether this is a middlebox appliance.
DestinationCidrBlock (string) --
The destination CIDR block in the route table.
Exceptions
Tags a specified resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
[REQUIRED]
The tags to apply to the specified resource.
Describes a tag.
The tag key.
Constraints: Maximum length of 128 characters.
The tag value.
Constraints: Maximum length of 256 characters.
dict
Response Syntax
{}
Response Structure
Exceptions
Removes tags from a specified resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
[REQUIRED]
The tag keys to remove from the specified resource.
dict
Response Syntax
{}
Response Structure
Exceptions
Updates the information for an existing connection. To remove information for any of the parameters, specify an empty string.
See also: AWS API Documentation
Request Syntax
response = client.update_connection(
GlobalNetworkId='string',
ConnectionId='string',
LinkId='string',
ConnectedLinkId='string',
Description='string'
)
[REQUIRED]
The ID of the global network.
[REQUIRED]
The ID of the connection.
A description of the connection.
Length Constraints: Maximum length of 256 characters.
dict
Response Syntax
{
'Connection': {
'ConnectionId': 'string',
'ConnectionArn': 'string',
'GlobalNetworkId': 'string',
'DeviceId': 'string',
'ConnectedDeviceId': 'string',
'LinkId': 'string',
'ConnectedLinkId': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
Connection (dict) --
Information about the connection.
ConnectionId (string) --
The ID of the connection.
ConnectionArn (string) --
The Amazon Resource Name (ARN) of the connection.
GlobalNetworkId (string) --
The ID of the global network.
DeviceId (string) --
The ID of the first device in the connection.
ConnectedDeviceId (string) --
The ID of the second device in the connection.
LinkId (string) --
The ID of the link for the first device in the connection.
ConnectedLinkId (string) --
The ID of the link for the second device in the connection.
Description (string) --
The description of the connection.
CreatedAt (datetime) --
The date and time that the connection was created.
State (string) --
The state of the connection.
Tags (list) --
The tags for the connection.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
Exceptions
Updates the description of a core network.
See also: AWS API Documentation
Request Syntax
response = client.update_core_network(
CoreNetworkId='string',
Description='string'
)
[REQUIRED]
The ID of a core network.
dict
Response Syntax
{
'CoreNetwork': {
'GlobalNetworkId': 'string',
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'CREATING'|'UPDATING'|'AVAILABLE'|'DELETING',
'Segments': [
{
'Name': 'string',
'EdgeLocations': [
'string',
],
'SharedSegments': [
'string',
]
},
],
'Edges': [
{
'EdgeLocation': 'string',
'Asn': 123,
'InsideCidrBlocks': [
'string',
]
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
CoreNetwork (dict) --
Returns information about a core network update.
GlobalNetworkId (string) --
The ID of the global network that your core network is a part of.
CoreNetworkId (string) --
The ID of a core network.
CoreNetworkArn (string) --
The ARN of a core network.
Description (string) --
The description of a core network.
CreatedAt (datetime) --
The timestamp when a core network was created.
State (string) --
The current state of a core network.
Segments (list) --
The segments within a core network.
(dict) --
Describes a core network segment, which are dedicated routes. Only attachments within this segment can communicate with each other.
Name (string) --
The name of a core network segment.
EdgeLocations (list) --
The Regions where the edges are located.
SharedSegments (list) --
The shared segments of a core network.
Edges (list) --
The edges within a core network.
(dict) --
Describes a core network edge.
EdgeLocation (string) --
The Region where a core network edge is located.
Asn (integer) --
The ASN of a core network edge.
InsideCidrBlocks (list) --
The inside IP addresses used for core network edges.
Tags (list) --
The tags associated with a core network.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
Exceptions
Updates the details for an existing device. To remove information for any of the parameters, specify an empty string.
See also: AWS API Documentation
Request Syntax
response = client.update_device(
GlobalNetworkId='string',
DeviceId='string',
AWSLocation={
'Zone': 'string',
'SubnetArn': 'string'
},
Description='string',
Type='string',
Vendor='string',
Model='string',
SerialNumber='string',
Location={
'Address': 'string',
'Latitude': 'string',
'Longitude': 'string'
},
SiteId='string'
)
[REQUIRED]
The ID of the global network.
[REQUIRED]
The ID of the device.
The Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this parameter.
The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.
The Amazon Resource Name (ARN) of the subnet that the device is located in.
A description of the device.
Constraints: Maximum length of 256 characters.
The vendor of the device.
Constraints: Maximum length of 128 characters.
The model of the device.
Constraints: Maximum length of 128 characters.
The serial number of the device.
Constraints: Maximum length of 128 characters.
Describes a location.
The physical address.
The latitude.
The longitude.
dict
Response Syntax
{
'Device': {
'DeviceId': 'string',
'DeviceArn': 'string',
'GlobalNetworkId': 'string',
'AWSLocation': {
'Zone': 'string',
'SubnetArn': 'string'
},
'Description': 'string',
'Type': 'string',
'Vendor': 'string',
'Model': 'string',
'SerialNumber': 'string',
'Location': {
'Address': 'string',
'Latitude': 'string',
'Longitude': 'string'
},
'SiteId': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
Device (dict) --
Information about the device.
DeviceId (string) --
The ID of the device.
DeviceArn (string) --
The Amazon Resource Name (ARN) of the device.
GlobalNetworkId (string) --
The ID of the global network.
AWSLocation (dict) --
The Amazon Web Services location of the device.
Zone (string) --
The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.
SubnetArn (string) --
The Amazon Resource Name (ARN) of the subnet that the device is located in.
Description (string) --
The description of the device.
Type (string) --
The device type.
Vendor (string) --
The device vendor.
Model (string) --
The device model.
SerialNumber (string) --
The device serial number.
Location (dict) --
The site location.
Address (string) --
The physical address.
Latitude (string) --
The latitude.
Longitude (string) --
The longitude.
SiteId (string) --
The site ID.
CreatedAt (datetime) --
The date and time that the site was created.
State (string) --
The device state.
Tags (list) --
The tags for the device.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
Exceptions
Updates an existing global network. To remove information for any of the parameters, specify an empty string.
See also: AWS API Documentation
Request Syntax
response = client.update_global_network(
GlobalNetworkId='string',
Description='string'
)
[REQUIRED]
The ID of your global network.
A description of the global network.
Constraints: Maximum length of 256 characters.
dict
Response Syntax
{
'GlobalNetwork': {
'GlobalNetworkId': 'string',
'GlobalNetworkArn': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
GlobalNetwork (dict) --
Information about the global network object.
GlobalNetworkId (string) --
The ID of the global network.
GlobalNetworkArn (string) --
The Amazon Resource Name (ARN) of the global network.
Description (string) --
The description of the global network.
CreatedAt (datetime) --
The date and time that the global network was created.
State (string) --
The state of the global network.
Tags (list) --
The tags for the global network.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
Exceptions
Updates the details for an existing link. To remove information for any of the parameters, specify an empty string.
See also: AWS API Documentation
Request Syntax
response = client.update_link(
GlobalNetworkId='string',
LinkId='string',
Description='string',
Type='string',
Bandwidth={
'UploadSpeed': 123,
'DownloadSpeed': 123
},
Provider='string'
)
[REQUIRED]
The ID of the global network.
[REQUIRED]
The ID of the link.
A description of the link.
Constraints: Maximum length of 256 characters.
The type of the link.
Constraints: Maximum length of 128 characters.
The upload and download speed in Mbps.
Upload speed in Mbps.
Download speed in Mbps.
The provider of the link.
Constraints: Maximum length of 128 characters.
dict
Response Syntax
{
'Link': {
'LinkId': 'string',
'LinkArn': 'string',
'GlobalNetworkId': 'string',
'SiteId': 'string',
'Description': 'string',
'Type': 'string',
'Bandwidth': {
'UploadSpeed': 123,
'DownloadSpeed': 123
},
'Provider': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
Link (dict) --
Information about the link.
LinkId (string) --
The ID of the link.
LinkArn (string) --
The Amazon Resource Name (ARN) of the link.
GlobalNetworkId (string) --
The ID of the global network.
SiteId (string) --
The ID of the site.
Description (string) --
The description of the link.
Type (string) --
The type of the link.
Bandwidth (dict) --
The bandwidth for the link.
UploadSpeed (integer) --
Upload speed in Mbps.
DownloadSpeed (integer) --
Download speed in Mbps.
Provider (string) --
The provider of the link.
CreatedAt (datetime) --
The date and time that the link was created.
State (string) --
The state of the link.
Tags (list) --
The tags for the link.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
Exceptions
Updates the resource metadata for the specified global network.
See also: AWS API Documentation
Request Syntax
response = client.update_network_resource_metadata(
GlobalNetworkId='string',
ResourceArn='string',
Metadata={
'string': 'string'
}
)
[REQUIRED]
The ID of the global network.
[REQUIRED]
The ARN of the resource.
[REQUIRED]
The resource metadata.
dict
Response Syntax
{
'ResourceArn': 'string',
'Metadata': {
'string': 'string'
}
}
Response Structure
(dict) --
ResourceArn (string) --
The ARN of the resource.
Metadata (dict) --
The updated resource metadata.
Exceptions
Updates the information for an existing site. To remove information for any of the parameters, specify an empty string.
See also: AWS API Documentation
Request Syntax
response = client.update_site(
GlobalNetworkId='string',
SiteId='string',
Description='string',
Location={
'Address': 'string',
'Latitude': 'string',
'Longitude': 'string'
}
)
[REQUIRED]
The ID of the global network.
[REQUIRED]
The ID of your site.
A description of your site.
Constraints: Maximum length of 256 characters.
The site location:
The physical address.
The latitude.
The longitude.
dict
Response Syntax
{
'Site': {
'SiteId': 'string',
'SiteArn': 'string',
'GlobalNetworkId': 'string',
'Description': 'string',
'Location': {
'Address': 'string',
'Latitude': 'string',
'Longitude': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
Site (dict) --
Information about the site.
SiteId (string) --
The ID of the site.
SiteArn (string) --
The Amazon Resource Name (ARN) of the site.
GlobalNetworkId (string) --
The ID of the global network.
Description (string) --
The description of the site.
Location (dict) --
The location of the site.
Address (string) --
The physical address.
Latitude (string) --
The latitude.
Longitude (string) --
The longitude.
CreatedAt (datetime) --
The date and time that the site was created.
State (string) --
The state of the site.
Tags (list) --
The tags for the site.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
Exceptions
Updates a VPC attachment.
See also: AWS API Documentation
Request Syntax
response = client.update_vpc_attachment(
AttachmentId='string',
AddSubnetArns=[
'string',
],
RemoveSubnetArns=[
'string',
],
Options={
'Ipv6Support': True|False
}
)
[REQUIRED]
The ID of the attachment.
Adds a subnet ARN to the VPC attachment.
Removes a subnet ARN from the attachment.
Additional options for updating the VPC attachment.
Indicates whether IPv6 is supported.
dict
Response Syntax
{
'VpcAttachment': {
'Attachment': {
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'AttachmentId': 'string',
'OwnerAccountId': 'string',
'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
},
'SubnetArns': [
'string',
],
'Options': {
'Ipv6Support': True|False
}
}
}
Response Structure
(dict) --
VpcAttachment (dict) --
Describes the updated VPC attachment.
Attachment (dict) --
Provides details about the VPC attachment.
CoreNetworkId (string) --
A core network ID.
CoreNetworkArn (string) --
The ARN of a core network.
AttachmentId (string) --
The ID of the attachment.
OwnerAccountId (string) --
The ID of the attachment account owner.
AttachmentType (string) --
The type of attachment.
State (string) --
The state of the attachment.
EdgeLocation (string) --
The Region where the edge is located.
ResourceArn (string) --
The attachment resource ARN.
AttachmentPolicyRuleNumber (integer) --
The policy rule number associated with the attachment.
SegmentName (string) --
The name of the segment attachment.
Tags (list) --
The tags associated with the attachment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
ProposedSegmentChange (dict) --
The attachment to move from one segment to another.
Tags (list) --
The key-value tags that changed for the segment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
AttachmentPolicyRuleNumber (integer) --
The rule number in the policy document that applies to this change.
SegmentName (string) --
The name of the segment to change.
CreatedAt (datetime) --
The timestamp when the attachment was created.
UpdatedAt (datetime) --
The timestamp when the attachment was last updated.
SubnetArns (list) --
The subnet ARNs.
Options (dict) --
Provides details about the VPC attachment.
Ipv6Support (boolean) --
Indicates whether IPv6 is supported.
Exceptions
The available paginators are:
paginator = client.get_paginator('describe_global_networks')
Creates an iterator that will paginate through responses from NetworkManager.Client.describe_global_networks().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GlobalNetworkIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The IDs of one or more global networks. The maximum is 10.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'GlobalNetworks': [
{
'GlobalNetworkId': 'string',
'GlobalNetworkArn': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
GlobalNetworks (list) --
Information about the global networks.
(dict) --
Describes a global network. This is a single private network acting as a high-level container for your network objects, including an Amazon Web Services-manged Core Network.
GlobalNetworkId (string) --
The ID of the global network.
GlobalNetworkArn (string) --
The Amazon Resource Name (ARN) of the global network.
Description (string) --
The description of the global network.
CreatedAt (datetime) --
The date and time that the global network was created.
State (string) --
The state of the global network.
Tags (list) --
The tags for the global network.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
paginator = client.get_paginator('get_connect_peer_associations')
Creates an iterator that will paginate through responses from NetworkManager.Client.get_connect_peer_associations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GlobalNetworkId='string',
ConnectPeerIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the global network.
The IDs of the Connect peers.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ConnectPeerAssociations': [
{
'ConnectPeerId': 'string',
'GlobalNetworkId': 'string',
'DeviceId': 'string',
'LinkId': 'string',
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
},
],
}
Response Structure
(dict) --
ConnectPeerAssociations (list) --
Displays a list of Connect peer associations.
(dict) --
Describes a core network Connect peer association.
ConnectPeerId (string) --
The ID of the Connect peer.
GlobalNetworkId (string) --
The ID of the global network.
DeviceId (string) --
The ID of the device to connect to.
LinkId (string) --
The ID of the link.
State (string) --
The state of the Connect peer association.
paginator = client.get_paginator('get_connections')
Creates an iterator that will paginate through responses from NetworkManager.Client.get_connections().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GlobalNetworkId='string',
ConnectionIds=[
'string',
],
DeviceId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the global network.
One or more connection IDs.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Connections': [
{
'ConnectionId': 'string',
'ConnectionArn': 'string',
'GlobalNetworkId': 'string',
'DeviceId': 'string',
'ConnectedDeviceId': 'string',
'LinkId': 'string',
'ConnectedLinkId': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
Connections (list) --
Information about the connections.
(dict) --
Describes a connection.
ConnectionId (string) --
The ID of the connection.
ConnectionArn (string) --
The Amazon Resource Name (ARN) of the connection.
GlobalNetworkId (string) --
The ID of the global network.
DeviceId (string) --
The ID of the first device in the connection.
ConnectedDeviceId (string) --
The ID of the second device in the connection.
LinkId (string) --
The ID of the link for the first device in the connection.
ConnectedLinkId (string) --
The ID of the link for the second device in the connection.
Description (string) --
The description of the connection.
CreatedAt (datetime) --
The date and time that the connection was created.
State (string) --
The state of the connection.
Tags (list) --
The tags for the connection.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
paginator = client.get_paginator('get_core_network_change_set')
Creates an iterator that will paginate through responses from NetworkManager.Client.get_core_network_change_set().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
CoreNetworkId='string',
PolicyVersionId=123,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of a core network.
[REQUIRED]
The ID of the policy version.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'CoreNetworkChanges': [
{
'Type': 'CORE_NETWORK_SEGMENT'|'CORE_NETWORK_EDGE'|'ATTACHMENT_MAPPING'|'ATTACHMENT_ROUTE_PROPAGATION'|'ATTACHMENT_ROUTE_STATIC',
'Action': 'ADD'|'MODIFY'|'REMOVE',
'Identifier': 'string',
'PreviousValues': {
'SegmentName': 'string',
'EdgeLocations': [
'string',
],
'Asn': 123,
'Cidr': 'string',
'DestinationIdentifier': 'string',
'InsideCidrBlocks': [
'string',
],
'SharedSegments': [
'string',
]
},
'NewValues': {
'SegmentName': 'string',
'EdgeLocations': [
'string',
],
'Asn': 123,
'Cidr': 'string',
'DestinationIdentifier': 'string',
'InsideCidrBlocks': [
'string',
],
'SharedSegments': [
'string',
]
}
},
],
}
Response Structure
(dict) --
CoreNetworkChanges (list) --
Describes a core network changes.
(dict) --
Details describing a core network change.
Type (string) --
The type of change.
Action (string) --
The action to take for a core network.
Identifier (string) --
The resource identifier.
PreviousValues (dict) --
The previous values for a core network.
SegmentName (string) --
The names of the segments in a core network.
EdgeLocations (list) --
The Regions where edges are located in a core network.
Asn (integer) --
The ASN of a core network.
Cidr (string) --
The IP addresses used for a core network.
DestinationIdentifier (string) --
The ID of the destination.
InsideCidrBlocks (list) --
The inside IP addresses used for core network change values.
SharedSegments (list) --
The shared segments for a core network change value.
NewValues (dict) --
The new value for a core network
SegmentName (string) --
The names of the segments in a core network.
EdgeLocations (list) --
The Regions where edges are located in a core network.
Asn (integer) --
The ASN of a core network.
Cidr (string) --
The IP addresses used for a core network.
DestinationIdentifier (string) --
The ID of the destination.
InsideCidrBlocks (list) --
The inside IP addresses used for core network change values.
SharedSegments (list) --
The shared segments for a core network change value.
paginator = client.get_paginator('get_customer_gateway_associations')
Creates an iterator that will paginate through responses from NetworkManager.Client.get_customer_gateway_associations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GlobalNetworkId='string',
CustomerGatewayArns=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the global network.
One or more customer gateway Amazon Resource Names (ARNs). The maximum is 10.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'CustomerGatewayAssociations': [
{
'CustomerGatewayArn': 'string',
'GlobalNetworkId': 'string',
'DeviceId': 'string',
'LinkId': 'string',
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
},
],
}
Response Structure
(dict) --
CustomerGatewayAssociations (list) --
The customer gateway associations.
(dict) --
Describes the association between a customer gateway, a device, and a link.
CustomerGatewayArn (string) --
The Amazon Resource Name (ARN) of the customer gateway.
GlobalNetworkId (string) --
The ID of the global network.
DeviceId (string) --
The ID of the device.
LinkId (string) --
The ID of the link.
State (string) --
The association state.
paginator = client.get_paginator('get_devices')
Creates an iterator that will paginate through responses from NetworkManager.Client.get_devices().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GlobalNetworkId='string',
DeviceIds=[
'string',
],
SiteId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the global network.
One or more device IDs. The maximum is 10.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Devices': [
{
'DeviceId': 'string',
'DeviceArn': 'string',
'GlobalNetworkId': 'string',
'AWSLocation': {
'Zone': 'string',
'SubnetArn': 'string'
},
'Description': 'string',
'Type': 'string',
'Vendor': 'string',
'Model': 'string',
'SerialNumber': 'string',
'Location': {
'Address': 'string',
'Latitude': 'string',
'Longitude': 'string'
},
'SiteId': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
Devices (list) --
The devices.
(dict) --
Describes a device.
DeviceId (string) --
The ID of the device.
DeviceArn (string) --
The Amazon Resource Name (ARN) of the device.
GlobalNetworkId (string) --
The ID of the global network.
AWSLocation (dict) --
The Amazon Web Services location of the device.
Zone (string) --
The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.
SubnetArn (string) --
The Amazon Resource Name (ARN) of the subnet that the device is located in.
Description (string) --
The description of the device.
Type (string) --
The device type.
Vendor (string) --
The device vendor.
Model (string) --
The device model.
SerialNumber (string) --
The device serial number.
Location (dict) --
The site location.
Address (string) --
The physical address.
Latitude (string) --
The latitude.
Longitude (string) --
The longitude.
SiteId (string) --
The site ID.
CreatedAt (datetime) --
The date and time that the site was created.
State (string) --
The device state.
Tags (list) --
The tags for the device.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
paginator = client.get_paginator('get_link_associations')
Creates an iterator that will paginate through responses from NetworkManager.Client.get_link_associations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GlobalNetworkId='string',
DeviceId='string',
LinkId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the global network.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'LinkAssociations': [
{
'GlobalNetworkId': 'string',
'DeviceId': 'string',
'LinkId': 'string',
'LinkAssociationState': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
},
],
}
Response Structure
(dict) --
LinkAssociations (list) --
The link associations.
(dict) --
Describes the association between a device and a link.
GlobalNetworkId (string) --
The ID of the global network.
DeviceId (string) --
The device ID for the link association.
LinkId (string) --
The ID of the link.
LinkAssociationState (string) --
The state of the association.
paginator = client.get_paginator('get_links')
Creates an iterator that will paginate through responses from NetworkManager.Client.get_links().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GlobalNetworkId='string',
LinkIds=[
'string',
],
SiteId='string',
Type='string',
Provider='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the global network.
One or more link IDs. The maximum is 10.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Links': [
{
'LinkId': 'string',
'LinkArn': 'string',
'GlobalNetworkId': 'string',
'SiteId': 'string',
'Description': 'string',
'Type': 'string',
'Bandwidth': {
'UploadSpeed': 123,
'DownloadSpeed': 123
},
'Provider': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
Links (list) --
The links.
(dict) --
Describes a link.
LinkId (string) --
The ID of the link.
LinkArn (string) --
The Amazon Resource Name (ARN) of the link.
GlobalNetworkId (string) --
The ID of the global network.
SiteId (string) --
The ID of the site.
Description (string) --
The description of the link.
Type (string) --
The type of the link.
Bandwidth (dict) --
The bandwidth for the link.
UploadSpeed (integer) --
Upload speed in Mbps.
DownloadSpeed (integer) --
Download speed in Mbps.
Provider (string) --
The provider of the link.
CreatedAt (datetime) --
The date and time that the link was created.
State (string) --
The state of the link.
Tags (list) --
The tags for the link.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
paginator = client.get_paginator('get_network_resource_counts')
Creates an iterator that will paginate through responses from NetworkManager.Client.get_network_resource_counts().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GlobalNetworkId='string',
ResourceType='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the global network.
The resource type.
The following are the supported resource types for Direct Connect:
The following are the supported resource types for Network Manager:
The following are the supported resource types for Amazon VPC:
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'NetworkResourceCounts': [
{
'ResourceType': 'string',
'Count': 123
},
],
}
Response Structure
(dict) --
NetworkResourceCounts (list) --
The count of resources.
(dict) --
Describes a resource count.
ResourceType (string) --
The resource type.
Count (integer) --
The resource count.
paginator = client.get_paginator('get_network_resource_relationships')
Creates an iterator that will paginate through responses from NetworkManager.Client.get_network_resource_relationships().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GlobalNetworkId='string',
CoreNetworkId='string',
RegisteredGatewayArn='string',
AwsRegion='string',
AccountId='string',
ResourceType='string',
ResourceArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the global network.
The resource type.
The following are the supported resource types for Direct Connect:
The following are the supported resource types for Network Manager:
The following are the supported resource types for Amazon VPC:
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Relationships': [
{
'From': 'string',
'To': 'string'
},
],
}
Response Structure
(dict) --
Relationships (list) --
The resource relationships.
(dict) --
Describes a resource relationship.
From (string) --
The ARN of the resource.
To (string) --
The ARN of the resource.
paginator = client.get_paginator('get_network_resources')
Creates an iterator that will paginate through responses from NetworkManager.Client.get_network_resources().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GlobalNetworkId='string',
CoreNetworkId='string',
RegisteredGatewayArn='string',
AwsRegion='string',
AccountId='string',
ResourceType='string',
ResourceArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the global network.
The resource type.
The following are the supported resource types for Direct Connect:
The following are the supported resource types for Network Manager:
The following are the supported resource types for Amazon VPC:
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'NetworkResources': [
{
'RegisteredGatewayArn': 'string',
'CoreNetworkId': 'string',
'AwsRegion': 'string',
'AccountId': 'string',
'ResourceType': 'string',
'ResourceId': 'string',
'ResourceArn': 'string',
'Definition': 'string',
'DefinitionTimestamp': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'Metadata': {
'string': 'string'
}
},
],
}
Response Structure
(dict) --
NetworkResources (list) --
The network resources.
(dict) --
Describes a network resource.
RegisteredGatewayArn (string) --
The ARN of the gateway.
CoreNetworkId (string) --
a core network ID.
AwsRegion (string) --
The Amazon Web Services Region.
AccountId (string) --
The Amazon Web Services account ID.
ResourceType (string) --
The resource type.
The following are the supported resource types for Direct Connect:
The following are the supported resource types for Network Manager:
The following are the supported resource types for Amazon VPC:
ResourceId (string) --
The ID of the resource.
ResourceArn (string) --
The ARN of the resource.
Definition (string) --
Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.
DefinitionTimestamp (datetime) --
The time that the resource definition was retrieved.
Tags (list) --
The tags.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
Metadata (dict) --
The resource metadata.
paginator = client.get_paginator('get_network_telemetry')
Creates an iterator that will paginate through responses from NetworkManager.Client.get_network_telemetry().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GlobalNetworkId='string',
CoreNetworkId='string',
RegisteredGatewayArn='string',
AwsRegion='string',
AccountId='string',
ResourceType='string',
ResourceArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the global network.
The resource type.
The following are the supported resource types for Direct Connect:
The following are the supported resource types for Network Manager:
The following are the supported resource types for Amazon VPC:
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'NetworkTelemetry': [
{
'RegisteredGatewayArn': 'string',
'CoreNetworkId': 'string',
'AwsRegion': 'string',
'AccountId': 'string',
'ResourceType': 'string',
'ResourceId': 'string',
'ResourceArn': 'string',
'Address': 'string',
'Health': {
'Type': 'BGP'|'IPSEC',
'Status': 'UP'|'DOWN',
'Timestamp': datetime(2015, 1, 1)
}
},
],
}
Response Structure
(dict) --
NetworkTelemetry (list) --
The network telemetry.
(dict) --
Describes the telemetry information for a resource.
RegisteredGatewayArn (string) --
The ARN of the gateway.
CoreNetworkId (string) --
The ID of a core network.
AwsRegion (string) --
The Amazon Web Services Region.
AccountId (string) --
The Amazon Web Services account ID.
ResourceType (string) --
The resource type.
ResourceId (string) --
The ID of the resource.
ResourceArn (string) --
The ARN of the resource.
Address (string) --
The address.
Health (dict) --
The connection health.
Type (string) --
The connection type.
Status (string) --
The connection status.
Timestamp (datetime) --
The time the status was last updated.
paginator = client.get_paginator('get_sites')
Creates an iterator that will paginate through responses from NetworkManager.Client.get_sites().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GlobalNetworkId='string',
SiteIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the global network.
One or more site IDs. The maximum is 10.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Sites': [
{
'SiteId': 'string',
'SiteArn': 'string',
'GlobalNetworkId': 'string',
'Description': 'string',
'Location': {
'Address': 'string',
'Latitude': 'string',
'Longitude': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
Sites (list) --
The sites.
(dict) --
Describes a site.
SiteId (string) --
The ID of the site.
SiteArn (string) --
The Amazon Resource Name (ARN) of the site.
GlobalNetworkId (string) --
The ID of the global network.
Description (string) --
The description of the site.
Location (dict) --
The location of the site.
Address (string) --
The physical address.
Latitude (string) --
The latitude.
Longitude (string) --
The longitude.
CreatedAt (datetime) --
The date and time that the site was created.
State (string) --
The state of the site.
Tags (list) --
The tags for the site.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
paginator = client.get_paginator('get_transit_gateway_connect_peer_associations')
Creates an iterator that will paginate through responses from NetworkManager.Client.get_transit_gateway_connect_peer_associations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GlobalNetworkId='string',
TransitGatewayConnectPeerArns=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the global network.
One or more transit gateway Connect peer Amazon Resource Names (ARNs).
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'TransitGatewayConnectPeerAssociations': [
{
'TransitGatewayConnectPeerArn': 'string',
'GlobalNetworkId': 'string',
'DeviceId': 'string',
'LinkId': 'string',
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
},
],
}
Response Structure
(dict) --
TransitGatewayConnectPeerAssociations (list) --
Information about the transit gateway Connect peer associations.
(dict) --
Describes a transit gateway Connect peer association.
TransitGatewayConnectPeerArn (string) --
The Amazon Resource Name (ARN) of the transit gateway Connect peer.
GlobalNetworkId (string) --
The ID of the global network.
DeviceId (string) --
The ID of the device.
LinkId (string) --
The ID of the link.
State (string) --
The state of the association.
paginator = client.get_paginator('get_transit_gateway_registrations')
Creates an iterator that will paginate through responses from NetworkManager.Client.get_transit_gateway_registrations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GlobalNetworkId='string',
TransitGatewayArns=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the global network.
The Amazon Resource Names (ARNs) of one or more transit gateways. The maximum is 10.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'TransitGatewayRegistrations': [
{
'GlobalNetworkId': 'string',
'TransitGatewayArn': 'string',
'State': {
'Code': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'|'FAILED',
'Message': 'string'
}
},
],
}
Response Structure
(dict) --
TransitGatewayRegistrations (list) --
The transit gateway registrations.
(dict) --
Describes the registration of a transit gateway to a global network.
GlobalNetworkId (string) --
The ID of the global network.
TransitGatewayArn (string) --
The Amazon Resource Name (ARN) of the transit gateway.
State (dict) --
The state of the transit gateway registration.
Code (string) --
The code for the state reason.
Message (string) --
The message for the state reason.
paginator = client.get_paginator('list_attachments')
Creates an iterator that will paginate through responses from NetworkManager.Client.list_attachments().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
CoreNetworkId='string',
AttachmentType='CONNECT'|'SITE_TO_SITE_VPN'|'VPC',
EdgeLocation='string',
State='REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Attachments': [
{
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'AttachmentId': 'string',
'OwnerAccountId': 'string',
'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
Attachments (list) --
Describes the list of attachments.
(dict) --
Describes a core network attachment.
CoreNetworkId (string) --
A core network ID.
CoreNetworkArn (string) --
The ARN of a core network.
AttachmentId (string) --
The ID of the attachment.
OwnerAccountId (string) --
The ID of the attachment account owner.
AttachmentType (string) --
The type of attachment.
State (string) --
The state of the attachment.
EdgeLocation (string) --
The Region where the edge is located.
ResourceArn (string) --
The attachment resource ARN.
AttachmentPolicyRuleNumber (integer) --
The policy rule number associated with the attachment.
SegmentName (string) --
The name of the segment attachment.
Tags (list) --
The tags associated with the attachment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
ProposedSegmentChange (dict) --
The attachment to move from one segment to another.
Tags (list) --
The key-value tags that changed for the segment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
AttachmentPolicyRuleNumber (integer) --
The rule number in the policy document that applies to this change.
SegmentName (string) --
The name of the segment to change.
CreatedAt (datetime) --
The timestamp when the attachment was created.
UpdatedAt (datetime) --
The timestamp when the attachment was last updated.
paginator = client.get_paginator('list_connect_peers')
Creates an iterator that will paginate through responses from NetworkManager.Client.list_connect_peers().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
CoreNetworkId='string',
ConnectAttachmentId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ConnectPeers': [
{
'CoreNetworkId': 'string',
'ConnectAttachmentId': 'string',
'ConnectPeerId': 'string',
'EdgeLocation': 'string',
'ConnectPeerState': 'CREATING'|'FAILED'|'AVAILABLE'|'DELETING',
'CreatedAt': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
ConnectPeers (list) --
Describes the Connect peers.
(dict) --
Summary description of a Connect peer.
CoreNetworkId (string) --
The ID of a core network.
ConnectAttachmentId (string) --
The ID of a Connect peer attachment.
ConnectPeerId (string) --
The ID of a Connect peer.
EdgeLocation (string) --
The Region where the edge is located.
ConnectPeerState (string) --
The state of a Connect peer.
CreatedAt (datetime) --
The timestamp when a Connect peer was created.
Tags (list) --
The tags associated with a Connect peer summary.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
paginator = client.get_paginator('list_core_network_policy_versions')
Creates an iterator that will paginate through responses from NetworkManager.Client.list_core_network_policy_versions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
CoreNetworkId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of a core network.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'CoreNetworkPolicyVersions': [
{
'CoreNetworkId': 'string',
'PolicyVersionId': 123,
'Alias': 'LIVE'|'LATEST',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'ChangeSetState': 'PENDING_GENERATION'|'FAILED_GENERATION'|'READY_TO_EXECUTE'|'EXECUTING'|'EXECUTION_SUCCEEDED'|'OUT_OF_DATE'
},
],
}
Response Structure
(dict) --
CoreNetworkPolicyVersions (list) --
Describes core network policy versions.
(dict) --
Describes a core network policy version.
CoreNetworkId (string) --
The ID of a core network.
PolicyVersionId (integer) --
The ID of the policy version.
Alias (string) --
Whether a core network policy is the current policy or the most recently submitted policy.
Description (string) --
The description of a core network policy version.
CreatedAt (datetime) --
The timestamp when a core network policy version was created.
ChangeSetState (string) --
The status of the policy version change set.
paginator = client.get_paginator('list_core_networks')
Creates an iterator that will paginate through responses from NetworkManager.Client.list_core_networks().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'CoreNetworks': [
{
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'GlobalNetworkId': 'string',
'OwnerAccountId': 'string',
'State': 'CREATING'|'UPDATING'|'AVAILABLE'|'DELETING',
'Description': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
Describes the list of core networks.
Returns summary information about a core network.
The ID of a core network.
a core network ARN.
The global network ID.
The ID of the account owner.
The state of a core network.
The description of a core network.
The key-value tags associated with a core network summary.
Describes a tag.
The tag key.
Constraints: Maximum length of 128 characters.
The tag value.
Constraints: Maximum length of 256 characters.