2024/06/25 - AWS Network Manager - 20 updated api methods
Changes This is model changes & documentation update for the Asynchronous Error Reporting feature for AWS Cloud WAN. This feature allows customers to view errors that occur while their resources are being provisioned, enabling customers to fix their resources without needing external support.
{'Attachment': {'LastModificationErrors': [{'Code': 'VPC_NOT_FOUND | '
'SUBNET_NOT_FOUND | '
'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE '
'| '
'SUBNET_NO_FREE_ADDRESSES '
'| '
'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE '
'| SUBNET_NO_IPV6_CIDRS | '
'VPN_CONNECTION_NOT_FOUND '
'| '
'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
'Message': 'string',
'RequestId': 'string',
'ResourceArn': 'string'}]}}
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'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'ProposedNetworkFunctionGroupChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'NetworkFunctionGroupName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'LastModificationErrors': [
{
'Code': 'VPC_NOT_FOUND'|'SUBNET_NOT_FOUND'|'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE'|'SUBNET_NO_FREE_ADDRESSES'|'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE'|'SUBNET_NO_IPV6_CIDRS'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
'Message': 'string',
'ResourceArn': 'string',
'RequestId': 'string'
},
]
}
}
Response Structure
(dict) --
Attachment (dict) --
The response to the attachment request.
CoreNetworkId (string) --
The ID of a core network.
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.
NetworkFunctionGroupName (string) --
The name of the network function group.
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 list of 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.
ProposedNetworkFunctionGroupChange (dict) --
Describes a proposed change to a network function group associated with the attachment.
Tags (list) --
The list of proposed changes to the key-value tags associated with the network function group.
(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 proposed new attachment policy rule number for the network function group.
NetworkFunctionGroupName (string) --
The proposed name change for the network function group name.
CreatedAt (datetime) --
The timestamp when the attachment was created.
UpdatedAt (datetime) --
The timestamp when the attachment was last updated.
LastModificationErrors (list) --
Describes the error associated with the attachment request.
(dict) --
Describes the error associated with an attachment request.
Code (string) --
The error code for the attachment request.
Message (string) --
The message associated with the error code.
ResourceArn (string) --
The ARN of the requested attachment resource.
RequestId (string) --
The ID of the attachment request.
{'ConnectAttachment': {'Attachment': {'LastModificationErrors': [{'Code': 'VPC_NOT_FOUND '
'| '
'SUBNET_NOT_FOUND '
'| '
'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE '
'| '
'SUBNET_NO_FREE_ADDRESSES '
'| '
'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE '
'| '
'SUBNET_NO_IPV6_CIDRS '
'| '
'VPN_CONNECTION_NOT_FOUND '
'| '
'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
'Message': 'string',
'RequestId': 'string',
'ResourceArn': 'string'}]}}}
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'|'NO_ENCAP'
},
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'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'ProposedNetworkFunctionGroupChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'NetworkFunctionGroupName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'LastModificationErrors': [
{
'Code': 'VPC_NOT_FOUND'|'SUBNET_NOT_FOUND'|'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE'|'SUBNET_NO_FREE_ADDRESSES'|'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE'|'SUBNET_NO_IPV6_CIDRS'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
'Message': 'string',
'ResourceArn': 'string',
'RequestId': 'string'
},
]
},
'TransportAttachmentId': 'string',
'Options': {
'Protocol': 'GRE'|'NO_ENCAP'
}
}
}
Response Structure
(dict) --
ConnectAttachment (dict) --
The response to a Connect attachment request.
Attachment (dict) --
The attachment details.
CoreNetworkId (string) --
The ID of a core network.
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.
NetworkFunctionGroupName (string) --
The name of the network function group.
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 list of 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.
ProposedNetworkFunctionGroupChange (dict) --
Describes a proposed change to a network function group associated with the attachment.
Tags (list) --
The list of proposed changes to the key-value tags associated with the network function group.
(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 proposed new attachment policy rule number for the network function group.
NetworkFunctionGroupName (string) --
The proposed name change for the network function group name.
CreatedAt (datetime) --
The timestamp when the attachment was created.
UpdatedAt (datetime) --
The timestamp when the attachment was last updated.
LastModificationErrors (list) --
Describes the error associated with the attachment request.
(dict) --
Describes the error associated with an attachment request.
Code (string) --
The error code for the attachment request.
Message (string) --
The message associated with the error code.
ResourceArn (string) --
The ARN of the requested attachment resource.
RequestId (string) --
The ID of the attachment request.
TransportAttachmentId (string) --
The ID of the transport attachment.
Options (dict) --
Options for connecting an attachment.
Protocol (string) --
The protocol used for the attachment connection.
{'ConnectPeer': {'LastModificationErrors': [{'Code': 'EDGE_LOCATION_NO_FREE_IPS '
'| '
'EDGE_LOCATION_PEER_DUPLICATE '
'| SUBNET_NOT_FOUND | '
'IP_OUTSIDE_SUBNET_CIDR_RANGE '
'| '
'INVALID_INSIDE_CIDR_BLOCK '
'| '
'NO_ASSOCIATED_CIDR_BLOCK',
'Message': 'string',
'RequestId': 'string',
'ResourceArn': 'string'}]}}
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',
SubnetArn='string'
)
string
[REQUIRED]
The ID of the connection attachment.
string
A Connect peer core network address. This only applies only when the protocol is GRE.
string
[REQUIRED]
The Connect peer address.
dict
The Connect peer BGP options. This only applies only when the protocol is GRE.
PeerAsn (integer) --
The Peer ASN of the BGP.
list
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.
string
The subnet ARN for the Connect peer. This only applies only when the protocol is NO_ENCAP.
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'|'NO_ENCAP',
'BgpConfigurations': [
{
'CoreNetworkAsn': 123,
'PeerAsn': 123,
'CoreNetworkAddress': 'string',
'PeerAddress': 'string'
},
]
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'SubnetArn': 'string',
'LastModificationErrors': [
{
'Code': 'EDGE_LOCATION_NO_FREE_IPS'|'EDGE_LOCATION_PEER_DUPLICATE'|'SUBNET_NOT_FOUND'|'IP_OUTSIDE_SUBNET_CIDR_RANGE'|'INVALID_INSIDE_CIDR_BLOCK'|'NO_ASSOCIATED_CIDR_BLOCK',
'Message': 'string',
'ResourceArn': 'string',
'RequestId': '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 list of key-value 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.
SubnetArn (string) --
The subnet ARN for the Connect peer. This only applies only when the protocol is NO_ENCAP.
LastModificationErrors (list) --
Describes the error associated with the attachment request.
(dict) --
Describes an error associated with a Connect peer request
Code (string) --
The error code for the Connect peer request.
Message (string) --
The message associated with the error code.
ResourceArn (string) --
The ARN of the requested Connect peer resource.
RequestId (string) --
The ID of the Connect peer request.
{'SiteToSiteVpnAttachment': {'Attachment': {'LastModificationErrors': [{'Code': 'VPC_NOT_FOUND '
'| '
'SUBNET_NOT_FOUND '
'| '
'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE '
'| '
'SUBNET_NO_FREE_ADDRESSES '
'| '
'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE '
'| '
'SUBNET_NO_IPV6_CIDRS '
'| '
'VPN_CONNECTION_NOT_FOUND '
'| '
'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
'Message': 'string',
'RequestId': 'string',
'ResourceArn': 'string'}]}}}
Creates an Amazon Web Services 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'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'ProposedNetworkFunctionGroupChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'NetworkFunctionGroupName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'LastModificationErrors': [
{
'Code': 'VPC_NOT_FOUND'|'SUBNET_NOT_FOUND'|'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE'|'SUBNET_NO_FREE_ADDRESSES'|'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE'|'SUBNET_NO_IPV6_CIDRS'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
'Message': 'string',
'ResourceArn': 'string',
'RequestId': 'string'
},
]
},
'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) --
The ID of a core network.
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.
NetworkFunctionGroupName (string) --
The name of the network function group.
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 list of 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.
ProposedNetworkFunctionGroupChange (dict) --
Describes a proposed change to a network function group associated with the attachment.
Tags (list) --
The list of proposed changes to the key-value tags associated with the network function group.
(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 proposed new attachment policy rule number for the network function group.
NetworkFunctionGroupName (string) --
The proposed name change for the network function group name.
CreatedAt (datetime) --
The timestamp when the attachment was created.
UpdatedAt (datetime) --
The timestamp when the attachment was last updated.
LastModificationErrors (list) --
Describes the error associated with the attachment request.
(dict) --
Describes the error associated with an attachment request.
Code (string) --
The error code for the attachment request.
Message (string) --
The message associated with the error code.
ResourceArn (string) --
The ARN of the requested attachment resource.
RequestId (string) --
The ID of the attachment request.
VpnConnectionArn (string) --
The ARN of the site-to-site VPN attachment.
{'TransitGatewayPeering': {'Peering': {'LastModificationErrors': [{'Code': 'TRANSIT_GATEWAY_NOT_FOUND '
'| '
'TRANSIT_GATEWAY_PEERS_LIMIT_EXCEEDED '
'| '
'MISSING_PERMISSIONS '
'| '
'INTERNAL_ERROR '
'| '
'EDGE_LOCATION_PEER_DUPLICATE '
'| '
'INVALID_TRANSIT_GATEWAY_STATE',
'Message': 'string',
'MissingPermissionsContext': {'MissingPermission': 'string'},
'RequestId': 'string',
'ResourceArn': 'string'}]}}}
Creates a transit gateway peering connection.
See also: AWS API Documentation
Request Syntax
client.create_transit_gateway_peering(
CoreNetworkId='string',
TransitGatewayArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientToken='string'
)
string
[REQUIRED]
The ID of a core network.
string
[REQUIRED]
The ARN of the transit gateway for the peering request.
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
{
'TransitGatewayPeering': {
'Peering': {
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'PeeringId': 'string',
'OwnerAccountId': 'string',
'PeeringType': 'TRANSIT_GATEWAY',
'State': 'CREATING'|'FAILED'|'AVAILABLE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'CreatedAt': datetime(2015, 1, 1),
'LastModificationErrors': [
{
'Code': 'TRANSIT_GATEWAY_NOT_FOUND'|'TRANSIT_GATEWAY_PEERS_LIMIT_EXCEEDED'|'MISSING_PERMISSIONS'|'INTERNAL_ERROR'|'EDGE_LOCATION_PEER_DUPLICATE'|'INVALID_TRANSIT_GATEWAY_STATE',
'Message': 'string',
'ResourceArn': 'string',
'RequestId': 'string',
'MissingPermissionsContext': {
'MissingPermission': 'string'
}
},
]
},
'TransitGatewayArn': 'string',
'TransitGatewayPeeringAttachmentId': 'string'
}
}
Response Structure
(dict) --
TransitGatewayPeering (dict) --
Returns information about the transit gateway peering connection request.
Peering (dict) --
Describes a transit gateway peer connection.
CoreNetworkId (string) --
The ID of the core network for the peering request.
CoreNetworkArn (string) --
The ARN of a core network.
PeeringId (string) --
The ID of the peering attachment.
OwnerAccountId (string) --
The ID of the account owner.
PeeringType (string) --
The type of peering. This will be TRANSIT_GATEWAY.
State (string) --
The current state of the peering connection.
EdgeLocation (string) --
The edge location for the peer.
ResourceArn (string) --
The resource ARN of the peer.
Tags (list) --
The list of key-value tags associated with the peering.
(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.
CreatedAt (datetime) --
The timestamp when the attachment peer was created.
LastModificationErrors (list) --
Describes the error associated with the Connect peer request.
(dict) --
Describes an error associated with a peering request.
Code (string) --
The error code for the peering request.
Message (string) --
The message associated with the error code.
ResourceArn (string) --
The ARN of the requested peering resource.
RequestId (string) --
The ID of the Peering request.
MissingPermissionsContext (dict) --
Provides additional information about missing permissions for the peering error.
MissingPermission (string) --
The missing permissions.
TransitGatewayArn (string) --
The ARN of the transit gateway.
TransitGatewayPeeringAttachmentId (string) --
The ID of the transit gateway peering attachment.
{'TransitGatewayRouteTableAttachment': {'Attachment': {'LastModificationErrors': [{'Code': 'VPC_NOT_FOUND '
'| '
'SUBNET_NOT_FOUND '
'| '
'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE '
'| '
'SUBNET_NO_FREE_ADDRESSES '
'| '
'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE '
'| '
'SUBNET_NO_IPV6_CIDRS '
'| '
'VPN_CONNECTION_NOT_FOUND '
'| '
'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
'Message': 'string',
'RequestId': 'string',
'ResourceArn': 'string'}]}}}
Creates a transit gateway route table attachment.
See also: AWS API Documentation
Request Syntax
client.create_transit_gateway_route_table_attachment(
PeeringId='string',
TransitGatewayRouteTableArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientToken='string'
)
string
[REQUIRED]
The ID of the peer for the
string
[REQUIRED]
The ARN of the transit gateway route table for the attachment request. For example, "TransitGatewayRouteTableArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway-route-table/tgw-rtb-9876543210123456".
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
{
'TransitGatewayRouteTableAttachment': {
'Attachment': {
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'AttachmentId': 'string',
'OwnerAccountId': 'string',
'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'ProposedNetworkFunctionGroupChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'NetworkFunctionGroupName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'LastModificationErrors': [
{
'Code': 'VPC_NOT_FOUND'|'SUBNET_NOT_FOUND'|'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE'|'SUBNET_NO_FREE_ADDRESSES'|'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE'|'SUBNET_NO_IPV6_CIDRS'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
'Message': 'string',
'ResourceArn': 'string',
'RequestId': 'string'
},
]
},
'PeeringId': 'string',
'TransitGatewayRouteTableArn': 'string'
}
}
Response Structure
(dict) --
TransitGatewayRouteTableAttachment (dict) --
The route table associated with the create transit gateway route table attachment request.
Attachment (dict) --
Describes a core network attachment.
CoreNetworkId (string) --
The ID of a core network.
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.
NetworkFunctionGroupName (string) --
The name of the network function group.
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 list of 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.
ProposedNetworkFunctionGroupChange (dict) --
Describes a proposed change to a network function group associated with the attachment.
Tags (list) --
The list of proposed changes to the key-value tags associated with the network function group.
(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 proposed new attachment policy rule number for the network function group.
NetworkFunctionGroupName (string) --
The proposed name change for the network function group name.
CreatedAt (datetime) --
The timestamp when the attachment was created.
UpdatedAt (datetime) --
The timestamp when the attachment was last updated.
LastModificationErrors (list) --
Describes the error associated with the attachment request.
(dict) --
Describes the error associated with an attachment request.
Code (string) --
The error code for the attachment request.
Message (string) --
The message associated with the error code.
ResourceArn (string) --
The ARN of the requested attachment resource.
RequestId (string) --
The ID of the attachment request.
PeeringId (string) --
The ID of the peering attachment.
TransitGatewayRouteTableArn (string) --
The ARN of the transit gateway attachment route table. For example, "TransitGatewayRouteTableArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway-route-table/tgw-rtb-9876543210123456".
{'VpcAttachment': {'Attachment': {'LastModificationErrors': [{'Code': 'VPC_NOT_FOUND '
'| '
'SUBNET_NOT_FOUND '
'| '
'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE '
'| '
'SUBNET_NO_FREE_ADDRESSES '
'| '
'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE '
'| '
'SUBNET_NO_IPV6_CIDRS '
'| '
'VPN_CONNECTION_NOT_FOUND '
'| '
'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
'Message': 'string',
'RequestId': 'string',
'ResourceArn': 'string'}]}}}
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,
'ApplianceModeSupport': 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.
ApplianceModeSupport (boolean) --
Indicates whether appliance mode is supported. If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow. The default value is false.
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'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'ProposedNetworkFunctionGroupChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'NetworkFunctionGroupName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'LastModificationErrors': [
{
'Code': 'VPC_NOT_FOUND'|'SUBNET_NOT_FOUND'|'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE'|'SUBNET_NO_FREE_ADDRESSES'|'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE'|'SUBNET_NO_IPV6_CIDRS'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
'Message': 'string',
'ResourceArn': 'string',
'RequestId': 'string'
},
]
},
'SubnetArns': [
'string',
],
'Options': {
'Ipv6Support': True|False,
'ApplianceModeSupport': True|False
}
}
}
Response Structure
(dict) --
VpcAttachment (dict) --
Provides details about the VPC attachment.
Attachment (dict) --
Provides details about the VPC attachment.
CoreNetworkId (string) --
The ID of a core network.
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.
NetworkFunctionGroupName (string) --
The name of the network function group.
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 list of 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.
ProposedNetworkFunctionGroupChange (dict) --
Describes a proposed change to a network function group associated with the attachment.
Tags (list) --
The list of proposed changes to the key-value tags associated with the network function group.
(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 proposed new attachment policy rule number for the network function group.
NetworkFunctionGroupName (string) --
The proposed name change for the network function group name.
CreatedAt (datetime) --
The timestamp when the attachment was created.
UpdatedAt (datetime) --
The timestamp when the attachment was last updated.
LastModificationErrors (list) --
Describes the error associated with the attachment request.
(dict) --
Describes the error associated with an attachment request.
Code (string) --
The error code for the attachment request.
Message (string) --
The message associated with the error code.
ResourceArn (string) --
The ARN of the requested attachment resource.
RequestId (string) --
The ID of the attachment request.
SubnetArns (list) --
The subnet ARNs.
(string) --
Options (dict) --
Provides details about the VPC attachment.
Ipv6Support (boolean) --
Indicates whether IPv6 is supported.
ApplianceModeSupport (boolean) --
Indicates whether appliance mode is supported. If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow. The default value is false.
{'Attachment': {'LastModificationErrors': [{'Code': 'VPC_NOT_FOUND | '
'SUBNET_NOT_FOUND | '
'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE '
'| '
'SUBNET_NO_FREE_ADDRESSES '
'| '
'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE '
'| SUBNET_NO_IPV6_CIDRS | '
'VPN_CONNECTION_NOT_FOUND '
'| '
'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
'Message': 'string',
'RequestId': 'string',
'ResourceArn': 'string'}]}}
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'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'ProposedNetworkFunctionGroupChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'NetworkFunctionGroupName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'LastModificationErrors': [
{
'Code': 'VPC_NOT_FOUND'|'SUBNET_NOT_FOUND'|'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE'|'SUBNET_NO_FREE_ADDRESSES'|'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE'|'SUBNET_NO_IPV6_CIDRS'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
'Message': 'string',
'ResourceArn': 'string',
'RequestId': 'string'
},
]
}
}
Response Structure
(dict) --
Attachment (dict) --
Information about the deleted attachment.
CoreNetworkId (string) --
The ID of a core network.
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.
NetworkFunctionGroupName (string) --
The name of the network function group.
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 list of 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.
ProposedNetworkFunctionGroupChange (dict) --
Describes a proposed change to a network function group associated with the attachment.
Tags (list) --
The list of proposed changes to the key-value tags associated with the network function group.
(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 proposed new attachment policy rule number for the network function group.
NetworkFunctionGroupName (string) --
The proposed name change for the network function group name.
CreatedAt (datetime) --
The timestamp when the attachment was created.
UpdatedAt (datetime) --
The timestamp when the attachment was last updated.
LastModificationErrors (list) --
Describes the error associated with the attachment request.
(dict) --
Describes the error associated with an attachment request.
Code (string) --
The error code for the attachment request.
Message (string) --
The message associated with the error code.
ResourceArn (string) --
The ARN of the requested attachment resource.
RequestId (string) --
The ID of the attachment request.
{'ConnectPeer': {'LastModificationErrors': [{'Code': 'EDGE_LOCATION_NO_FREE_IPS '
'| '
'EDGE_LOCATION_PEER_DUPLICATE '
'| SUBNET_NOT_FOUND | '
'IP_OUTSIDE_SUBNET_CIDR_RANGE '
'| '
'INVALID_INSIDE_CIDR_BLOCK '
'| '
'NO_ASSOCIATED_CIDR_BLOCK',
'Message': 'string',
'RequestId': 'string',
'ResourceArn': 'string'}]}}
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'|'NO_ENCAP',
'BgpConfigurations': [
{
'CoreNetworkAsn': 123,
'PeerAsn': 123,
'CoreNetworkAddress': 'string',
'PeerAddress': 'string'
},
]
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'SubnetArn': 'string',
'LastModificationErrors': [
{
'Code': 'EDGE_LOCATION_NO_FREE_IPS'|'EDGE_LOCATION_PEER_DUPLICATE'|'SUBNET_NOT_FOUND'|'IP_OUTSIDE_SUBNET_CIDR_RANGE'|'INVALID_INSIDE_CIDR_BLOCK'|'NO_ASSOCIATED_CIDR_BLOCK',
'Message': 'string',
'ResourceArn': 'string',
'RequestId': '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 list of key-value 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.
SubnetArn (string) --
The subnet ARN for the Connect peer. This only applies only when the protocol is NO_ENCAP.
LastModificationErrors (list) --
Describes the error associated with the attachment request.
(dict) --
Describes an error associated with a Connect peer request
Code (string) --
The error code for the Connect peer request.
Message (string) --
The message associated with the error code.
ResourceArn (string) --
The ARN of the requested Connect peer resource.
RequestId (string) --
The ID of the Connect peer request.
{'Peering': {'LastModificationErrors': [{'Code': 'TRANSIT_GATEWAY_NOT_FOUND | '
'TRANSIT_GATEWAY_PEERS_LIMIT_EXCEEDED '
'| MISSING_PERMISSIONS | '
'INTERNAL_ERROR | '
'EDGE_LOCATION_PEER_DUPLICATE '
'| '
'INVALID_TRANSIT_GATEWAY_STATE',
'Message': 'string',
'MissingPermissionsContext': {'MissingPermission': 'string'},
'RequestId': 'string',
'ResourceArn': 'string'}]}}
Deletes an existing peering connection.
See also: AWS API Documentation
Request Syntax
client.delete_peering(
PeeringId='string'
)
string
[REQUIRED]
The ID of the peering connection to delete.
dict
Response Syntax
{
'Peering': {
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'PeeringId': 'string',
'OwnerAccountId': 'string',
'PeeringType': 'TRANSIT_GATEWAY',
'State': 'CREATING'|'FAILED'|'AVAILABLE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'CreatedAt': datetime(2015, 1, 1),
'LastModificationErrors': [
{
'Code': 'TRANSIT_GATEWAY_NOT_FOUND'|'TRANSIT_GATEWAY_PEERS_LIMIT_EXCEEDED'|'MISSING_PERMISSIONS'|'INTERNAL_ERROR'|'EDGE_LOCATION_PEER_DUPLICATE'|'INVALID_TRANSIT_GATEWAY_STATE',
'Message': 'string',
'ResourceArn': 'string',
'RequestId': 'string',
'MissingPermissionsContext': {
'MissingPermission': 'string'
}
},
]
}
}
Response Structure
(dict) --
Peering (dict) --
Information about a deleted peering connection.
CoreNetworkId (string) --
The ID of the core network for the peering request.
CoreNetworkArn (string) --
The ARN of a core network.
PeeringId (string) --
The ID of the peering attachment.
OwnerAccountId (string) --
The ID of the account owner.
PeeringType (string) --
The type of peering. This will be TRANSIT_GATEWAY.
State (string) --
The current state of the peering connection.
EdgeLocation (string) --
The edge location for the peer.
ResourceArn (string) --
The resource ARN of the peer.
Tags (list) --
The list of key-value tags associated with the peering.
(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.
CreatedAt (datetime) --
The timestamp when the attachment peer was created.
LastModificationErrors (list) --
Describes the error associated with the Connect peer request.
(dict) --
Describes an error associated with a peering request.
Code (string) --
The error code for the peering request.
Message (string) --
The message associated with the error code.
ResourceArn (string) --
The ARN of the requested peering resource.
RequestId (string) --
The ID of the Peering request.
MissingPermissionsContext (dict) --
Provides additional information about missing permissions for the peering error.
MissingPermission (string) --
The missing permissions.
{'ConnectAttachment': {'Attachment': {'LastModificationErrors': [{'Code': 'VPC_NOT_FOUND '
'| '
'SUBNET_NOT_FOUND '
'| '
'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE '
'| '
'SUBNET_NO_FREE_ADDRESSES '
'| '
'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE '
'| '
'SUBNET_NO_IPV6_CIDRS '
'| '
'VPN_CONNECTION_NOT_FOUND '
'| '
'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
'Message': 'string',
'RequestId': 'string',
'ResourceArn': 'string'}]}}}
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'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'ProposedNetworkFunctionGroupChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'NetworkFunctionGroupName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'LastModificationErrors': [
{
'Code': 'VPC_NOT_FOUND'|'SUBNET_NOT_FOUND'|'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE'|'SUBNET_NO_FREE_ADDRESSES'|'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE'|'SUBNET_NO_IPV6_CIDRS'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
'Message': 'string',
'ResourceArn': 'string',
'RequestId': 'string'
},
]
},
'TransportAttachmentId': 'string',
'Options': {
'Protocol': 'GRE'|'NO_ENCAP'
}
}
}
Response Structure
(dict) --
ConnectAttachment (dict) --
Details about the Connect attachment.
Attachment (dict) --
The attachment details.
CoreNetworkId (string) --
The ID of a core network.
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.
NetworkFunctionGroupName (string) --
The name of the network function group.
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 list of 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.
ProposedNetworkFunctionGroupChange (dict) --
Describes a proposed change to a network function group associated with the attachment.
Tags (list) --
The list of proposed changes to the key-value tags associated with the network function group.
(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 proposed new attachment policy rule number for the network function group.
NetworkFunctionGroupName (string) --
The proposed name change for the network function group name.
CreatedAt (datetime) --
The timestamp when the attachment was created.
UpdatedAt (datetime) --
The timestamp when the attachment was last updated.
LastModificationErrors (list) --
Describes the error associated with the attachment request.
(dict) --
Describes the error associated with an attachment request.
Code (string) --
The error code for the attachment request.
Message (string) --
The message associated with the error code.
ResourceArn (string) --
The ARN of the requested attachment resource.
RequestId (string) --
The ID of the attachment request.
TransportAttachmentId (string) --
The ID of the transport attachment.
Options (dict) --
Options for connecting an attachment.
Protocol (string) --
The protocol used for the attachment connection.
{'ConnectPeer': {'LastModificationErrors': [{'Code': 'EDGE_LOCATION_NO_FREE_IPS '
'| '
'EDGE_LOCATION_PEER_DUPLICATE '
'| SUBNET_NOT_FOUND | '
'IP_OUTSIDE_SUBNET_CIDR_RANGE '
'| '
'INVALID_INSIDE_CIDR_BLOCK '
'| '
'NO_ASSOCIATED_CIDR_BLOCK',
'Message': 'string',
'RequestId': 'string',
'ResourceArn': 'string'}]}}
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'|'NO_ENCAP',
'BgpConfigurations': [
{
'CoreNetworkAsn': 123,
'PeerAsn': 123,
'CoreNetworkAddress': 'string',
'PeerAddress': 'string'
},
]
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'SubnetArn': 'string',
'LastModificationErrors': [
{
'Code': 'EDGE_LOCATION_NO_FREE_IPS'|'EDGE_LOCATION_PEER_DUPLICATE'|'SUBNET_NOT_FOUND'|'IP_OUTSIDE_SUBNET_CIDR_RANGE'|'INVALID_INSIDE_CIDR_BLOCK'|'NO_ASSOCIATED_CIDR_BLOCK',
'Message': 'string',
'ResourceArn': 'string',
'RequestId': '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 list of key-value 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.
SubnetArn (string) --
The subnet ARN for the Connect peer. This only applies only when the protocol is NO_ENCAP.
LastModificationErrors (list) --
Describes the error associated with the attachment request.
(dict) --
Describes an error associated with a Connect peer request
Code (string) --
The error code for the Connect peer request.
Message (string) --
The message associated with the error code.
ResourceArn (string) --
The ARN of the requested Connect peer resource.
RequestId (string) --
The ID of the Connect peer request.
{'SiteToSiteVpnAttachment': {'Attachment': {'LastModificationErrors': [{'Code': 'VPC_NOT_FOUND '
'| '
'SUBNET_NOT_FOUND '
'| '
'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE '
'| '
'SUBNET_NO_FREE_ADDRESSES '
'| '
'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE '
'| '
'SUBNET_NO_IPV6_CIDRS '
'| '
'VPN_CONNECTION_NOT_FOUND '
'| '
'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
'Message': 'string',
'RequestId': 'string',
'ResourceArn': 'string'}]}}}
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'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'ProposedNetworkFunctionGroupChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'NetworkFunctionGroupName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'LastModificationErrors': [
{
'Code': 'VPC_NOT_FOUND'|'SUBNET_NOT_FOUND'|'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE'|'SUBNET_NO_FREE_ADDRESSES'|'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE'|'SUBNET_NO_IPV6_CIDRS'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
'Message': 'string',
'ResourceArn': 'string',
'RequestId': 'string'
},
]
},
'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) --
The ID of a core network.
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.
NetworkFunctionGroupName (string) --
The name of the network function group.
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 list of 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.
ProposedNetworkFunctionGroupChange (dict) --
Describes a proposed change to a network function group associated with the attachment.
Tags (list) --
The list of proposed changes to the key-value tags associated with the network function group.
(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 proposed new attachment policy rule number for the network function group.
NetworkFunctionGroupName (string) --
The proposed name change for the network function group name.
CreatedAt (datetime) --
The timestamp when the attachment was created.
UpdatedAt (datetime) --
The timestamp when the attachment was last updated.
LastModificationErrors (list) --
Describes the error associated with the attachment request.
(dict) --
Describes the error associated with an attachment request.
Code (string) --
The error code for the attachment request.
Message (string) --
The message associated with the error code.
ResourceArn (string) --
The ARN of the requested attachment resource.
RequestId (string) --
The ID of the attachment request.
VpnConnectionArn (string) --
The ARN of the site-to-site VPN attachment.
{'TransitGatewayPeering': {'Peering': {'LastModificationErrors': [{'Code': 'TRANSIT_GATEWAY_NOT_FOUND '
'| '
'TRANSIT_GATEWAY_PEERS_LIMIT_EXCEEDED '
'| '
'MISSING_PERMISSIONS '
'| '
'INTERNAL_ERROR '
'| '
'EDGE_LOCATION_PEER_DUPLICATE '
'| '
'INVALID_TRANSIT_GATEWAY_STATE',
'Message': 'string',
'MissingPermissionsContext': {'MissingPermission': 'string'},
'RequestId': 'string',
'ResourceArn': 'string'}]}}}
Returns information about a transit gateway peer.
See also: AWS API Documentation
Request Syntax
client.get_transit_gateway_peering(
PeeringId='string'
)
string
[REQUIRED]
The ID of the peering request.
dict
Response Syntax
{
'TransitGatewayPeering': {
'Peering': {
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'PeeringId': 'string',
'OwnerAccountId': 'string',
'PeeringType': 'TRANSIT_GATEWAY',
'State': 'CREATING'|'FAILED'|'AVAILABLE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'CreatedAt': datetime(2015, 1, 1),
'LastModificationErrors': [
{
'Code': 'TRANSIT_GATEWAY_NOT_FOUND'|'TRANSIT_GATEWAY_PEERS_LIMIT_EXCEEDED'|'MISSING_PERMISSIONS'|'INTERNAL_ERROR'|'EDGE_LOCATION_PEER_DUPLICATE'|'INVALID_TRANSIT_GATEWAY_STATE',
'Message': 'string',
'ResourceArn': 'string',
'RequestId': 'string',
'MissingPermissionsContext': {
'MissingPermission': 'string'
}
},
]
},
'TransitGatewayArn': 'string',
'TransitGatewayPeeringAttachmentId': 'string'
}
}
Response Structure
(dict) --
TransitGatewayPeering (dict) --
Returns information about a transit gateway peering.
Peering (dict) --
Describes a transit gateway peer connection.
CoreNetworkId (string) --
The ID of the core network for the peering request.
CoreNetworkArn (string) --
The ARN of a core network.
PeeringId (string) --
The ID of the peering attachment.
OwnerAccountId (string) --
The ID of the account owner.
PeeringType (string) --
The type of peering. This will be TRANSIT_GATEWAY.
State (string) --
The current state of the peering connection.
EdgeLocation (string) --
The edge location for the peer.
ResourceArn (string) --
The resource ARN of the peer.
Tags (list) --
The list of key-value tags associated with the peering.
(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.
CreatedAt (datetime) --
The timestamp when the attachment peer was created.
LastModificationErrors (list) --
Describes the error associated with the Connect peer request.
(dict) --
Describes an error associated with a peering request.
Code (string) --
The error code for the peering request.
Message (string) --
The message associated with the error code.
ResourceArn (string) --
The ARN of the requested peering resource.
RequestId (string) --
The ID of the Peering request.
MissingPermissionsContext (dict) --
Provides additional information about missing permissions for the peering error.
MissingPermission (string) --
The missing permissions.
TransitGatewayArn (string) --
The ARN of the transit gateway.
TransitGatewayPeeringAttachmentId (string) --
The ID of the transit gateway peering attachment.
{'TransitGatewayRouteTableAttachment': {'Attachment': {'LastModificationErrors': [{'Code': 'VPC_NOT_FOUND '
'| '
'SUBNET_NOT_FOUND '
'| '
'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE '
'| '
'SUBNET_NO_FREE_ADDRESSES '
'| '
'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE '
'| '
'SUBNET_NO_IPV6_CIDRS '
'| '
'VPN_CONNECTION_NOT_FOUND '
'| '
'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
'Message': 'string',
'RequestId': 'string',
'ResourceArn': 'string'}]}}}
Returns information about a transit gateway route table attachment.
See also: AWS API Documentation
Request Syntax
client.get_transit_gateway_route_table_attachment(
AttachmentId='string'
)
string
[REQUIRED]
The ID of the transit gateway route table attachment.
dict
Response Syntax
{
'TransitGatewayRouteTableAttachment': {
'Attachment': {
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'AttachmentId': 'string',
'OwnerAccountId': 'string',
'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'ProposedNetworkFunctionGroupChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'NetworkFunctionGroupName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'LastModificationErrors': [
{
'Code': 'VPC_NOT_FOUND'|'SUBNET_NOT_FOUND'|'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE'|'SUBNET_NO_FREE_ADDRESSES'|'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE'|'SUBNET_NO_IPV6_CIDRS'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
'Message': 'string',
'ResourceArn': 'string',
'RequestId': 'string'
},
]
},
'PeeringId': 'string',
'TransitGatewayRouteTableArn': 'string'
}
}
Response Structure
(dict) --
TransitGatewayRouteTableAttachment (dict) --
Returns information about the transit gateway route table attachment.
Attachment (dict) --
Describes a core network attachment.
CoreNetworkId (string) --
The ID of a core network.
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.
NetworkFunctionGroupName (string) --
The name of the network function group.
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 list of 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.
ProposedNetworkFunctionGroupChange (dict) --
Describes a proposed change to a network function group associated with the attachment.
Tags (list) --
The list of proposed changes to the key-value tags associated with the network function group.
(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 proposed new attachment policy rule number for the network function group.
NetworkFunctionGroupName (string) --
The proposed name change for the network function group name.
CreatedAt (datetime) --
The timestamp when the attachment was created.
UpdatedAt (datetime) --
The timestamp when the attachment was last updated.
LastModificationErrors (list) --
Describes the error associated with the attachment request.
(dict) --
Describes the error associated with an attachment request.
Code (string) --
The error code for the attachment request.
Message (string) --
The message associated with the error code.
ResourceArn (string) --
The ARN of the requested attachment resource.
RequestId (string) --
The ID of the attachment request.
PeeringId (string) --
The ID of the peering attachment.
TransitGatewayRouteTableArn (string) --
The ARN of the transit gateway attachment route table. For example, "TransitGatewayRouteTableArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway-route-table/tgw-rtb-9876543210123456".
{'VpcAttachment': {'Attachment': {'LastModificationErrors': [{'Code': 'VPC_NOT_FOUND '
'| '
'SUBNET_NOT_FOUND '
'| '
'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE '
'| '
'SUBNET_NO_FREE_ADDRESSES '
'| '
'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE '
'| '
'SUBNET_NO_IPV6_CIDRS '
'| '
'VPN_CONNECTION_NOT_FOUND '
'| '
'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
'Message': 'string',
'RequestId': 'string',
'ResourceArn': 'string'}]}}}
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'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'ProposedNetworkFunctionGroupChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'NetworkFunctionGroupName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'LastModificationErrors': [
{
'Code': 'VPC_NOT_FOUND'|'SUBNET_NOT_FOUND'|'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE'|'SUBNET_NO_FREE_ADDRESSES'|'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE'|'SUBNET_NO_IPV6_CIDRS'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
'Message': 'string',
'ResourceArn': 'string',
'RequestId': 'string'
},
]
},
'SubnetArns': [
'string',
],
'Options': {
'Ipv6Support': True|False,
'ApplianceModeSupport': True|False
}
}
}
Response Structure
(dict) --
VpcAttachment (dict) --
Returns details about a VPC attachment.
Attachment (dict) --
Provides details about the VPC attachment.
CoreNetworkId (string) --
The ID of a core network.
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.
NetworkFunctionGroupName (string) --
The name of the network function group.
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 list of 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.
ProposedNetworkFunctionGroupChange (dict) --
Describes a proposed change to a network function group associated with the attachment.
Tags (list) --
The list of proposed changes to the key-value tags associated with the network function group.
(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 proposed new attachment policy rule number for the network function group.
NetworkFunctionGroupName (string) --
The proposed name change for the network function group name.
CreatedAt (datetime) --
The timestamp when the attachment was created.
UpdatedAt (datetime) --
The timestamp when the attachment was last updated.
LastModificationErrors (list) --
Describes the error associated with the attachment request.
(dict) --
Describes the error associated with an attachment request.
Code (string) --
The error code for the attachment request.
Message (string) --
The message associated with the error code.
ResourceArn (string) --
The ARN of the requested attachment resource.
RequestId (string) --
The ID of the attachment request.
SubnetArns (list) --
The subnet ARNs.
(string) --
Options (dict) --
Provides details about the VPC attachment.
Ipv6Support (boolean) --
Indicates whether IPv6 is supported.
ApplianceModeSupport (boolean) --
Indicates whether appliance mode is supported. If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow. The default value is false.
{'Attachments': {'LastModificationErrors': [{'Code': 'VPC_NOT_FOUND | '
'SUBNET_NOT_FOUND | '
'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE '
'| '
'SUBNET_NO_FREE_ADDRESSES '
'| '
'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE '
'| SUBNET_NO_IPV6_CIDRS | '
'VPN_CONNECTION_NOT_FOUND '
'| '
'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
'Message': 'string',
'RequestId': 'string',
'ResourceArn': 'string'}]}}
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'|'TRANSIT_GATEWAY_ROUTE_TABLE',
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'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'ProposedNetworkFunctionGroupChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'NetworkFunctionGroupName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'LastModificationErrors': [
{
'Code': 'VPC_NOT_FOUND'|'SUBNET_NOT_FOUND'|'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE'|'SUBNET_NO_FREE_ADDRESSES'|'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE'|'SUBNET_NO_IPV6_CIDRS'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
'Message': 'string',
'ResourceArn': 'string',
'RequestId': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Attachments (list) --
Describes the list of attachments.
(dict) --
Describes a core network attachment.
CoreNetworkId (string) --
The ID of a core network.
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.
NetworkFunctionGroupName (string) --
The name of the network function group.
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 list of 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.
ProposedNetworkFunctionGroupChange (dict) --
Describes a proposed change to a network function group associated with the attachment.
Tags (list) --
The list of proposed changes to the key-value tags associated with the network function group.
(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 proposed new attachment policy rule number for the network function group.
NetworkFunctionGroupName (string) --
The proposed name change for the network function group name.
CreatedAt (datetime) --
The timestamp when the attachment was created.
UpdatedAt (datetime) --
The timestamp when the attachment was last updated.
LastModificationErrors (list) --
Describes the error associated with the attachment request.
(dict) --
Describes the error associated with an attachment request.
Code (string) --
The error code for the attachment request.
Message (string) --
The message associated with the error code.
ResourceArn (string) --
The ARN of the requested attachment resource.
RequestId (string) --
The ID of the attachment request.
NextToken (string) --
The token for the next page of results.
{'Peerings': {'LastModificationErrors': [{'Code': 'TRANSIT_GATEWAY_NOT_FOUND | '
'TRANSIT_GATEWAY_PEERS_LIMIT_EXCEEDED '
'| MISSING_PERMISSIONS | '
'INTERNAL_ERROR | '
'EDGE_LOCATION_PEER_DUPLICATE '
'| '
'INVALID_TRANSIT_GATEWAY_STATE',
'Message': 'string',
'MissingPermissionsContext': {'MissingPermission': 'string'},
'RequestId': 'string',
'ResourceArn': 'string'}]}}
Lists the peerings for a core network.
See also: AWS API Documentation
Request Syntax
client.list_peerings(
CoreNetworkId='string',
PeeringType='TRANSIT_GATEWAY',
EdgeLocation='string',
State='CREATING'|'FAILED'|'AVAILABLE'|'DELETING',
MaxResults=123,
NextToken='string'
)
string
The ID of a core network.
string
Returns a list of a peering requests.
string
Returns a list edge locations for the
string
Returns a list of the peering request states.
integer
The maximum number of results to return.
string
The token for the next page of results.
dict
Response Syntax
{
'Peerings': [
{
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'PeeringId': 'string',
'OwnerAccountId': 'string',
'PeeringType': 'TRANSIT_GATEWAY',
'State': 'CREATING'|'FAILED'|'AVAILABLE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'CreatedAt': datetime(2015, 1, 1),
'LastModificationErrors': [
{
'Code': 'TRANSIT_GATEWAY_NOT_FOUND'|'TRANSIT_GATEWAY_PEERS_LIMIT_EXCEEDED'|'MISSING_PERMISSIONS'|'INTERNAL_ERROR'|'EDGE_LOCATION_PEER_DUPLICATE'|'INVALID_TRANSIT_GATEWAY_STATE',
'Message': 'string',
'ResourceArn': 'string',
'RequestId': 'string',
'MissingPermissionsContext': {
'MissingPermission': 'string'
}
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Peerings (list) --
Lists the transit gateway peerings for the ListPeerings request.
(dict) --
Describes a peering connection.
CoreNetworkId (string) --
The ID of the core network for the peering request.
CoreNetworkArn (string) --
The ARN of a core network.
PeeringId (string) --
The ID of the peering attachment.
OwnerAccountId (string) --
The ID of the account owner.
PeeringType (string) --
The type of peering. This will be TRANSIT_GATEWAY.
State (string) --
The current state of the peering connection.
EdgeLocation (string) --
The edge location for the peer.
ResourceArn (string) --
The resource ARN of the peer.
Tags (list) --
The list of key-value tags associated with the peering.
(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.
CreatedAt (datetime) --
The timestamp when the attachment peer was created.
LastModificationErrors (list) --
Describes the error associated with the Connect peer request.
(dict) --
Describes an error associated with a peering request.
Code (string) --
The error code for the peering request.
Message (string) --
The message associated with the error code.
ResourceArn (string) --
The ARN of the requested peering resource.
RequestId (string) --
The ID of the Peering request.
MissingPermissionsContext (dict) --
Provides additional information about missing permissions for the peering error.
MissingPermission (string) --
The missing permissions.
NextToken (string) --
The token for the next page of results.
{'Attachment': {'LastModificationErrors': [{'Code': 'VPC_NOT_FOUND | '
'SUBNET_NOT_FOUND | '
'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE '
'| '
'SUBNET_NO_FREE_ADDRESSES '
'| '
'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE '
'| SUBNET_NO_IPV6_CIDRS | '
'VPN_CONNECTION_NOT_FOUND '
'| '
'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
'Message': 'string',
'RequestId': 'string',
'ResourceArn': 'string'}]}}
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'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'ProposedNetworkFunctionGroupChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'NetworkFunctionGroupName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'LastModificationErrors': [
{
'Code': 'VPC_NOT_FOUND'|'SUBNET_NOT_FOUND'|'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE'|'SUBNET_NO_FREE_ADDRESSES'|'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE'|'SUBNET_NO_IPV6_CIDRS'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
'Message': 'string',
'ResourceArn': 'string',
'RequestId': 'string'
},
]
}
}
Response Structure
(dict) --
Attachment (dict) --
Describes the rejected attachment request.
CoreNetworkId (string) --
The ID of a core network.
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.
NetworkFunctionGroupName (string) --
The name of the network function group.
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 list of 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.
ProposedNetworkFunctionGroupChange (dict) --
Describes a proposed change to a network function group associated with the attachment.
Tags (list) --
The list of proposed changes to the key-value tags associated with the network function group.
(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 proposed new attachment policy rule number for the network function group.
NetworkFunctionGroupName (string) --
The proposed name change for the network function group name.
CreatedAt (datetime) --
The timestamp when the attachment was created.
UpdatedAt (datetime) --
The timestamp when the attachment was last updated.
LastModificationErrors (list) --
Describes the error associated with the attachment request.
(dict) --
Describes the error associated with an attachment request.
Code (string) --
The error code for the attachment request.
Message (string) --
The message associated with the error code.
ResourceArn (string) --
The ARN of the requested attachment resource.
RequestId (string) --
The ID of the attachment request.
{'VpcAttachment': {'Attachment': {'LastModificationErrors': [{'Code': 'VPC_NOT_FOUND '
'| '
'SUBNET_NOT_FOUND '
'| '
'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE '
'| '
'SUBNET_NO_FREE_ADDRESSES '
'| '
'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE '
'| '
'SUBNET_NO_IPV6_CIDRS '
'| '
'VPN_CONNECTION_NOT_FOUND '
'| '
'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
'Message': 'string',
'RequestId': 'string',
'ResourceArn': 'string'}]}}}
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,
'ApplianceModeSupport': 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.
ApplianceModeSupport (boolean) --
Indicates whether appliance mode is supported. If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow. The default value is false.
dict
Response Syntax
{
'VpcAttachment': {
'Attachment': {
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'AttachmentId': 'string',
'OwnerAccountId': 'string',
'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'ProposedNetworkFunctionGroupChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'NetworkFunctionGroupName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'LastModificationErrors': [
{
'Code': 'VPC_NOT_FOUND'|'SUBNET_NOT_FOUND'|'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE'|'SUBNET_NO_FREE_ADDRESSES'|'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE'|'SUBNET_NO_IPV6_CIDRS'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
'Message': 'string',
'ResourceArn': 'string',
'RequestId': 'string'
},
]
},
'SubnetArns': [
'string',
],
'Options': {
'Ipv6Support': True|False,
'ApplianceModeSupport': True|False
}
}
}
Response Structure
(dict) --
VpcAttachment (dict) --
Describes the updated VPC attachment.
Attachment (dict) --
Provides details about the VPC attachment.
CoreNetworkId (string) --
The ID of a core network.
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.
NetworkFunctionGroupName (string) --
The name of the network function group.
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 list of 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.
ProposedNetworkFunctionGroupChange (dict) --
Describes a proposed change to a network function group associated with the attachment.
Tags (list) --
The list of proposed changes to the key-value tags associated with the network function group.
(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 proposed new attachment policy rule number for the network function group.
NetworkFunctionGroupName (string) --
The proposed name change for the network function group name.
CreatedAt (datetime) --
The timestamp when the attachment was created.
UpdatedAt (datetime) --
The timestamp when the attachment was last updated.
LastModificationErrors (list) --
Describes the error associated with the attachment request.
(dict) --
Describes the error associated with an attachment request.
Code (string) --
The error code for the attachment request.
Message (string) --
The message associated with the error code.
ResourceArn (string) --
The ARN of the requested attachment resource.
RequestId (string) --
The ID of the attachment request.
SubnetArns (list) --
The subnet ARNs.
(string) --
Options (dict) --
Provides details about the VPC attachment.
Ipv6Support (boolean) --
Indicates whether IPv6 is supported.
ApplianceModeSupport (boolean) --
Indicates whether appliance mode is supported. If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow. The default value is false.