2021/12/02 - AWS Network Manager - 33 new 4 updated api methods
Changes This release adds API support for AWS Cloud WAN.
Disassociates a core network Connect peer from a device and a link.
See also: AWS API Documentation
Request Syntax
client.disassociate_connect_peer(
GlobalNetworkId='string',
ConnectPeerId='string'
)
string
[REQUIRED]
The ID of the global network.
string
[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.
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
client.create_connect_peer(
ConnectAttachmentId='string',
CoreNetworkAddress='string',
PeerAddress='string',
BgpOptions={
'PeerAsn': 123
},
InsideCidrBlocks=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientToken='string'
)
string
[REQUIRED]
The ID of the connection attachment.
string
A Connect peer core network address.
string
[REQUIRED]
The Connect peer address.
dict
The Connect peer BGP options.
PeerAsn (integer) --
The Peer ASN of the BGP.
list
[REQUIRED]
The inside IP addresses used for BGP peering.
(string) --
list
The tags associated with the peer request.
(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.
string
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.
(string) --
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.
Executes a change set on your core network. Deploys changes globally based on the policy submitted..
See also: AWS API Documentation
Request Syntax
client.execute_core_network_change_set(
CoreNetworkId='string',
PolicyVersionId=123
)
string
[REQUIRED]
The ID of a core network.
integer
[REQUIRED]
The ID of the policy version.
dict
Response Syntax
{}
Response Structure
(dict) --
Returns a list of core network policy versions.
See also: AWS API Documentation
Request Syntax
client.list_core_network_policy_versions(
CoreNetworkId='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ID of a core network.
integer
The maximum number of results to return.
string
The token for the next page of results.
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.
Returns information about a core network Connect peer.
See also: AWS API Documentation
Request Syntax
client.get_connect_peer(
ConnectPeerId='string'
)
string
[REQUIRED]
The ID of the Connect peer.
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) --
Returns information about a core network Connect peer.
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.
(string) --
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.
Creates or updates a resource policy.
See also: AWS API Documentation
Request Syntax
client.put_resource_policy(
PolicyDocument='string',
ResourceArn='string'
)
string
[REQUIRED]
The JSON resource policy document.
string
[REQUIRED]
The ARN of the resource policy.
dict
Response Syntax
{}
Response Structure
(dict) --
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
client.delete_resource_policy(
ResourceArn='string'
)
string
[REQUIRED]
The ARN of the policy to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
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
client.delete_core_network(
CoreNetworkId='string'
)
string
[REQUIRED]
The network ID of the deleted 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) --
Information about the deleted 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.
(string) --
SharedSegments (list) --
The shared segments of a core network.
(string) --
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.
(string) --
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.
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
client.restore_core_network_policy_version(
CoreNetworkId='string',
PolicyVersionId=123
)
string
[REQUIRED]
The ID of a core network.
integer
[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.
Returns information about a core network. By default it returns the LIVE policy.
See also: AWS API Documentation
Request Syntax
client.get_core_network(
CoreNetworkId='string'
)
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) --
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.
(string) --
SharedSegments (list) --
The shared segments of a core network.
(string) --
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.
(string) --
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.
Returns information about a resource policy.
See also: AWS API Documentation
Request Syntax
client.get_resource_policy(
ResourceArn='string'
)
string
[REQUIRED]
The ARN of the resource.
dict
Response Syntax
{
'PolicyDocument': 'string'
}
Response Structure
(dict) --
PolicyDocument (string) --
The resource policy document.
Returns information about a site-to-site VPN attachment.
See also: AWS API Documentation
Request Syntax
client.get_site_to_site_vpn_attachment(
AttachmentId='string'
)
string
[REQUIRED]
The ID of the attachment.
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) --
Describes the site-to-site 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.
Deletes an attachment. Supports all attachment types.
See also: AWS API Documentation
Request Syntax
client.delete_attachment(
AttachmentId='string'
)
string
[REQUIRED]
The ID of the attachment to delete.
dict
Response Syntax
{
'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
(dict) --
Attachment (dict) --
Information about the deleted 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.
Updates a VPC attachment.
See also: AWS API Documentation
Request Syntax
client.update_vpc_attachment(
AttachmentId='string',
AddSubnetArns=[
'string',
],
RemoveSubnetArns=[
'string',
],
Options={
'Ipv6Support': True|False
}
)
string
[REQUIRED]
The ID of the attachment.
list
Adds a subnet ARN to the VPC attachment.
(string) --
list
Removes a subnet ARN from the attachment.
(string) --
dict
Additional options for updating the VPC attachment.
Ipv6Support (boolean) --
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.
(string) --
Options (dict) --
Provides details about the VPC attachment.
Ipv6Support (boolean) --
Indicates whether IPv6 is supported.
Returns a list of core network attachments.
See also: AWS API Documentation
Request Syntax
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'
)
string
The ID of a core network.
string
The type of attachment.
string
The Region where the edge is located.
string
The state of the attachment.
integer
The maximum number of results to return.
string
The token for the next page of results.
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.
Creates a core network as part of your global network, and optionally, with a core network policy.
See also: AWS API Documentation
Request Syntax
client.create_core_network(
GlobalNetworkId='string',
Description='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
PolicyDocument='string',
ClientToken='string'
)
string
[REQUIRED]
The ID of the global network that a core network will be a part of.
string
The description of a core network.
list
Key-value tags associated with a core network request.
(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.
string
The policy document for creating a core network.
string
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.
(string) --
SharedSegments (list) --
The shared segments of a core network.
(string) --
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.
(string) --
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.
Creates a site-to-site VPN attachment on an edge location of a core network.
See also: AWS API Documentation
Request Syntax
client.create_site_to_site_vpn_attachment(
CoreNetworkId='string',
VpnConnectionArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientToken='string'
)
string
[REQUIRED]
The ID of a core network where you're creating a site-to-site VPN attachment.
string
[REQUIRED]
The ARN identifying the VPN attachment.
list
The tags associated with the request.
(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.
string
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.
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
client.get_core_network_policy(
CoreNetworkId='string',
PolicyVersionId=123,
Alias='LIVE'|'LATEST'
)
string
[REQUIRED]
The ID of a core network.
integer
The ID of a core network policy version.
string
The alias of a core network 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) --
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.
Returns a list of core network Connect peers.
See also: AWS API Documentation
Request Syntax
client.list_connect_peers(
CoreNetworkId='string',
ConnectAttachmentId='string',
MaxResults=123,
NextToken='string'
)
string
The ID of a core network.
string
The ID of the attachment.
integer
The maximum number of results to return.
string
The token for the next page of results.
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.
Returns a list of owned and shared core networks.
See also: AWS API Documentation
Request Syntax
client.list_core_networks(
MaxResults=123,
NextToken='string'
)
integer
The maximum number of results to return.
string
The token for the next page of results.
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.
Returns information about a core network Connect peer associations.
See also: AWS API Documentation
Request Syntax
client.get_connect_peer_associations(
GlobalNetworkId='string',
ConnectPeerIds=[
'string',
],
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ID of the global network.
list
The IDs of the Connect peers.
(string) --
integer
The maximum number of results to return.
string
The token for the next page of results.
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.
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
client.accept_attachment(
AttachmentId='string'
)
string
[REQUIRED]
The ID of the attachment.
dict
Response Syntax
{
'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
(dict) --
Attachment (dict) --
The response to the attachment request.
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.
Updates the description of a core network.
See also: AWS API Documentation
Request Syntax
client.update_core_network(
CoreNetworkId='string',
Description='string'
)
string
[REQUIRED]
The ID of a core network.
string
The description of the update.
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.
(string) --
SharedSegments (list) --
The shared segments of a core network.
(string) --
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.
(string) --
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.
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
client.put_core_network_policy(
CoreNetworkId='string',
PolicyDocument='string',
Description='string',
LatestVersionId=123,
ClientToken='string'
)
string
[REQUIRED]
The ID of a core network.
string
[REQUIRED]
The policy document.
string
a core network policy description.
integer
The ID of a core network policy.
string
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.
Creates a VPC attachment on an edge location of a core network.
See also: AWS API Documentation
Request Syntax
client.create_vpc_attachment(
CoreNetworkId='string',
VpcArn='string',
SubnetArns=[
'string',
],
Options={
'Ipv6Support': True|False
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientToken='string'
)
string
[REQUIRED]
The ID of a core network for the VPC attachment.
string
[REQUIRED]
The ARN of the VPC.
list
[REQUIRED]
The subnet ARN of the VPC attachment.
(string) --
dict
Options for the VPC attachment.
Ipv6Support (boolean) --
Indicates whether IPv6 is supported.
list
The key-value tags associated with the request.
(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.
string
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.
(string) --
Options (dict) --
Provides details about the VPC attachment.
Ipv6Support (boolean) --
Indicates whether IPv6 is supported.
Returns a change set between the LIVE core network policy and a submitted policy.
See also: AWS API Documentation
Request Syntax
client.get_core_network_change_set(
CoreNetworkId='string',
PolicyVersionId=123,
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ID of a core network.
integer
[REQUIRED]
The ID of the policy version.
integer
The maximum number of results to return.
string
The token for the next page of results.
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.
(string) --
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.
(string) --
SharedSegments (list) --
The shared segments for a core network change value.
(string) --
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.
(string) --
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.
(string) --
SharedSegments (list) --
The shared segments for a core network change value.
(string) --
NextToken (string) --
The token for the next page of results.
Returns information about a core network Connect attachment.
See also: AWS API Documentation
Request Syntax
client.get_connect_attachment(
AttachmentId='string'
)
string
[REQUIRED]
The ID of the attachment.
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) --
Details about the Connect attachment.
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.
Rejects a core network attachment request.
See also: AWS API Documentation
Request Syntax
client.reject_attachment(
AttachmentId='string'
)
string
[REQUIRED]
The ID of the attachment.
dict
Response Syntax
{
'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
(dict) --
Attachment (dict) --
Describes the rejected attachment request.
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.
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
client.associate_connect_peer(
GlobalNetworkId='string',
ConnectPeerId='string',
DeviceId='string',
LinkId='string'
)
string
[REQUIRED]
The ID of your global network.
string
[REQUIRED]
The ID of the Connect peer.
string
[REQUIRED]
The ID of the device.
string
The ID of the link.
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.
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
client.create_connect_attachment(
CoreNetworkId='string',
EdgeLocation='string',
TransportAttachmentId='string',
Options={
'Protocol': 'GRE'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientToken='string'
)
string
[REQUIRED]
The ID of a core network where you want to create the attachment.
string
[REQUIRED]
The Region where the edge is located.
string
[REQUIRED]
The ID of the attachment between the two connections.
dict
[REQUIRED]
Options for creating an attachment.
Protocol (string) --
The protocol used for the attachment connection.
list
The list of key-value tags associated with the request.
(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.
string
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.
Returns information about a VPC attachment.
See also: AWS API Documentation
Request Syntax
client.get_vpc_attachment(
AttachmentId='string'
)
string
[REQUIRED]
The ID of the attachment.
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) --
Returns details about a 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.
(string) --
Options (dict) --
Provides details about the VPC attachment.
Ipv6Support (boolean) --
Indicates whether IPv6 is supported.
Deletes a policy version from a core network. You can't delete the current LIVE policy.
See also: AWS API Documentation
Request Syntax
client.delete_core_network_policy_version(
CoreNetworkId='string',
PolicyVersionId=123
)
string
[REQUIRED]
The ID of a core network for the deleted policy.
integer
[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.
Deletes a Connect peer.
See also: AWS API Documentation
Request Syntax
client.delete_connect_peer(
ConnectPeerId='string'
)
string
[REQUIRED]
The ID of the deleted Connect peer.
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) --
Information about the deleted Connect peer.
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.
(string) --
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.
{'CoreNetworkId': 'string'}
Gets the network resource relationships for the specified global network.
See also: AWS API Documentation
Request Syntax
client.get_network_resource_relationships(
GlobalNetworkId='string',
CoreNetworkId='string',
RegisteredGatewayArn='string',
AwsRegion='string',
AccountId='string',
ResourceType='string',
ResourceArn='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ID of the global network.
string
The ID of a core network.
string
The ARN of the registered gateway.
string
The Amazon Web Services Region.
string
The Amazon Web Services account ID.
string
The resource type.
The following are the supported resource types for Direct Connect:
dxcon
dx-gateway
dx-vif
The following are the supported resource types for Network Manager:
connection
device
link
site
The following are the supported resource types for Amazon VPC:
customer-gateway
transit-gateway
transit-gateway-attachment
transit-gateway-connect-peer
transit-gateway-route-table
vpn-connection
string
The ARN of the gateway.
integer
The maximum number of results to return.
string
The token for the next page of results.
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.
{'CoreNetworkId': 'string'}
Response {'NetworkResources': {'CoreNetworkId': 'string'}}
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
client.get_network_resources(
GlobalNetworkId='string',
CoreNetworkId='string',
RegisteredGatewayArn='string',
AwsRegion='string',
AccountId='string',
ResourceType='string',
ResourceArn='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ID of the global network.
string
The ID of a core network.
string
The ARN of the gateway.
string
The Amazon Web Services Region.
string
The Amazon Web Services account ID.
string
The resource type.
The following are the supported resource types for Direct Connect:
dxcon - The definition model is Connection .
dx-gateway - The definition model is DirectConnectGateway .
dx-vif - The definition model is VirtualInterface .
The following are the supported resource types for Network Manager:
connection - The definition model is Connection .
device - The definition model is Device .
link - The definition model is Link .
site - The definition model is Site .
The following are the supported resource types for Amazon VPC:
customer-gateway - The definition model is CustomerGateway .
transit-gateway - The definition model is TransitGateway .
transit-gateway-attachment - The definition model is TransitGatewayAttachment .
transit-gateway-connect-peer - The definition model is TransitGatewayConnectPeer .
transit-gateway-route-table - The definition model is TransitGatewayRouteTable .
vpn-connection - The definition model is VpnConnection .
string
The ARN of the resource.
integer
The maximum number of results to return.
string
The token for the next page of results.
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:
dxcon
dx-gateway
dx-vif
The following are the supported resource types for Network Manager:
connection
device
link
site
The following are the supported resource types for Amazon VPC:
customer-gateway
transit-gateway
transit-gateway-attachment
transit-gateway-connect-peer
transit-gateway-route-table
vpn-connection
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.
(string) --
(string) --
NextToken (string) --
The token for the next page of results.
{'RouteTableIdentifier': {'CoreNetworkSegmentEdge': {'CoreNetworkId': 'string',
'EdgeLocation': 'string',
'SegmentName': 'string'}}}
Response {'CoreNetworkSegmentEdge': {'CoreNetworkId': 'string',
'EdgeLocation': 'string',
'SegmentName': 'string'},
'NetworkRoutes': {'Destinations': {'CoreNetworkAttachmentId': 'string',
'EdgeLocation': 'string',
'SegmentName': 'string'}},
'RouteTableType': {'CORE_NETWORK_SEGMENT'}}
Gets the network routes of the specified global network.
See also: AWS API Documentation
Request Syntax
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',
]
}
)
string
[REQUIRED]
The ID of the global network.
dict
[REQUIRED]
The ID of the route table.
TransitGatewayRouteTableArn (string) --
The ARN of the transit gateway route table.
CoreNetworkSegmentEdge (dict) --
The segment edge in a core network.
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.
list
An exact CIDR block.
(string) --
list
The most specific route that matches the traffic (longest prefix match).
(string) --
list
The routes with a subnet that match the specified CIDR filter.
(string) --
list
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.
(string) --
list
The IDs of the prefix lists.
(string) --
list
The route states.
(string) --
list
The route types.
(string) --
dict
Filter by route table destination. Possible Values: TRANSIT_GATEWAY_ATTACHMENT_ID, RESOURCE_ID, or RESOURCE_TYPE.
(string) --
(list) --
(string) --
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 .
{'CoreNetworkId': 'string'}
Response {'NetworkTelemetry': {'CoreNetworkId': 'string'}}
Gets the network telemetry of the specified global network.
See also: AWS API Documentation
Request Syntax
client.get_network_telemetry(
GlobalNetworkId='string',
CoreNetworkId='string',
RegisteredGatewayArn='string',
AwsRegion='string',
AccountId='string',
ResourceType='string',
ResourceArn='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ID of the global network.
string
The ID of a core network.
string
The ARN of the gateway.
string
The Amazon Web Services Region.
string
The Amazon Web Services account ID.
string
The resource type.
The following are the supported resource types for Direct Connect:
dxcon
dx-gateway
dx-vif
The following are the supported resource types for Network Manager:
connection
device
link
site
The following are the supported resource types for Amazon VPC:
customer-gateway
transit-gateway
transit-gateway-attachment
transit-gateway-connect-peer
transit-gateway-route-table
vpn-connection
string
The ARN of the resource.
integer
The maximum number of results to return.
string
The token for the next page of results.
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.