2026/10/22 - AWS Network Manager - 2 new 25 updated api methods
Changes AWS Cloud WAN now provides managed one-to-one NAT directly on it's core network attachments, through integration with Regional Private NAT Gateway. Use UpdateAttachmentNatConfiguration to enable NAT and configure NAT rules, and ListAttachmentNatConfigurations to view them.
Updates the NAT configuration of a core network attachment. You can enable or disable NAT gateway support, specify whether the core network installs system routes for the NAT CIDR blocks, and replace the NAT rules of the attachment. Specify at least one of NatGatewaySupport, NatSystemRouteSupport, or NatGatewayRules.
Only the core network owner can update the NAT configuration of an attachment. The attachment must be in the AVAILABLE, PENDING_ATTACHMENT_ACCEPTANCE, or PENDING_TAG_ACCEPTANCE state. Changes are applied asynchronously, and the attachment is in the UPDATING state while they are applied. If the attachment is pending acceptance, the NAT configuration is stored and is applied after the attachment is accepted.
See also: AWS API Documentation
Request Syntax
client.update_attachment_nat_configuration(
AttachmentId='string',
NatGatewaySupport='ENABLE'|'DISABLE',
NatSystemRouteSupport=True|False,
NatGatewayRules=[
{
'RuleNumber': 123,
'MatchSourceCidr': 'string',
'NatCidr': 'string'
},
],
ClientToken='string'
)
string
[REQUIRED]
The ID of the attachment to update the NAT configuration for.
string
Specifies whether to enable or disable NAT gateway support on the attachment. When you disable NAT gateway support, the attachment keeps its NAT rules but doesn't apply them. To enable NAT gateway support, the attachment must have at least one NAT rule, either specified in this request or already configured on the attachment. If you omit this parameter, NAT gateway support is unchanged.
boolean
Specifies whether the core network installs system routes for the NAT CIDR blocks of the attachment's NAT rules. System routes have a route type of SYSTEM. NAT is applied to traffic whether or not this option is enabled. If you omit this parameter, the current value is unchanged.
list
The complete set of NAT rules for the attachment, up to 50 rules. The rules that you specify replace the existing rules of the attachment, matched by rule number. Existing rules that aren't included in the request are deleted. To delete all NAT rules, specify an empty list. You can delete all NAT rules only when NAT gateway support is disabled, or when you disable it in the same request. If you omit this parameter, the existing rules are unchanged.
(dict) --
Describes a NAT rule to configure on an attachment. Source addresses in the source CIDR block of traffic from the attachment are translated to the same host addresses in the NAT CIDR block. Traffic to an address in the NAT CIDR block is translated back to the matching address in the source CIDR block.
RuleNumber (integer) -- [REQUIRED]
The rule number, from 1 to 32766. Each rule number must be unique for the attachment.
MatchSourceCidr (string) -- [REQUIRED]
The IPv4 CIDR block to match against the source address of traffic from the attachment. The CIDR block can't overlap with the multicast range (224.0.0.0/4).
NatCidr (string) -- [REQUIRED]
The IPv4 CIDR block to translate matching source addresses to. The prefix length must be the same as the prefix length of MatchSourceCidr. The CIDR block must be within a private (RFC 1918) or shared address space (RFC 6598) range. The CIDR blocks of the NAT rules of an attachment can't overlap with each other.
string
The client token associated with the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'AttachmentId': 'string',
'NatGatewaySupport': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'|'PENDING_ATTACHMENT_ACCEPTANCE',
'NatSystemRouteSupport': True|False,
'NatGatewayRules': [
{
'RuleNumber': 123,
'MatchSourceCidr': 'string',
'NatCidr': 'string',
'State': 'CREATING'|'MODIFYING'|'DELETING'|'ACTIVATED'|'ACTIVATING'|'DEACTIVATED'|'DEACTIVATING'|'FAILED'|'PENDING_ATTACHMENT_ACCEPTANCE'
},
]
}
Response Structure
(dict) --
AttachmentId (string) --
The ID of the attachment.
NatGatewaySupport (string) --
The state of NAT gateway support on the attachment. The transitional states ENABLING and DISABLING change to ENABLED or DISABLED after the update is applied. The state is PENDING_ATTACHMENT_ACCEPTANCE when NAT gateway support is enabled on an attachment that is pending acceptance.
NatSystemRouteSupport (boolean) --
Indicates whether the core network installs system routes for the NAT CIDR blocks of the attachment's NAT rules.
NatGatewayRules (list) --
The NAT rules of the attachment, including rules that are being deleted.
(dict) --
Describes a NAT rule of an attachment.
RuleNumber (integer) --
The rule number. Rule numbers identify the rules of an attachment and don't set the order in which rules are evaluated.
MatchSourceCidr (string) --
The source CIDR block that the rule matches for traffic from the attachment.
NatCidr (string) --
The CIDR block that matching source addresses are translated to.
State (string) --
The state of the NAT rule. The possible values are the following:
CREATING: The rule is being created.
MODIFYING: The rule is being modified.
DELETING: The rule is being deleted.
ACTIVATING: NAT gateway support is being enabled, and the rule is being applied.
ACTIVATED: NAT gateway support is enabled, and the rule is applied.
DEACTIVATING: NAT gateway support is being disabled, and the rule is being removed from use.
DEACTIVATED: NAT gateway support is disabled, and the rule isn't applied.
FAILED: The attachment failed to be created, and the rule isn't applied.
PENDING_ATTACHMENT_ACCEPTANCE: The attachment is pending acceptance. The rule is applied after the attachment is accepted.
Returns the NAT configurations of core network attachments. You must specify either a core network ID or an attachment ID. Only the core network owner can list NAT configurations.
See also: AWS API Documentation
Request Syntax
client.list_attachment_nat_configurations(
CoreNetworkId='string',
AttachmentId='string',
Filters={
'string': [
'string',
]
},
MaxResults=123,
NextToken='string'
)
string
The ID of a core network. Returns the NAT configurations of attachments in the core network that support NAT.
string
The ID of an attachment. Returns the NAT configuration of the specified attachment. If you specify both an attachment ID and a core network ID, the attachment ID is used.
dict
The filters to apply to the results. Values for the same filter are joined with OR, and different filters are joined with AND. You can specify up to 10 filter values in total. The following filters are supported:
nat-gateway-support: The state of NAT gateway support on the attachment, for example ENABLED.
nat-system-route-support: Whether system routes are installed for the attachment, true or false.
rule-number: The rule number of a NAT rule.
match-source-cidr: The source CIDR block of a NAT rule. The value must exactly match the CIDR block of the rule.
nat-cidr: The NAT CIDR block of a NAT rule. The value must exactly match the CIDR block of the rule.
nat-rule-state: The state of a NAT rule, for example ACTIVATED.
(string) --
(list) --
(string) --
integer
The maximum number of results to return.
string
The token for the next page of results.
dict
Response Syntax
{
'AttachmentNatConfigurations': [
{
'AttachmentId': 'string',
'NatGatewaySupport': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'|'PENDING_ATTACHMENT_ACCEPTANCE',
'NatSystemRouteSupport': True|False,
'NatGatewayRules': [
{
'RuleNumber': 123,
'MatchSourceCidr': 'string',
'NatCidr': 'string',
'State': 'CREATING'|'MODIFYING'|'DELETING'|'ACTIVATED'|'ACTIVATING'|'DEACTIVATED'|'DEACTIVATING'|'FAILED'|'PENDING_ATTACHMENT_ACCEPTANCE'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AttachmentNatConfigurations (list) --
The NAT configurations of the attachments.
(dict) --
Describes the NAT configuration of a core network attachment.
AttachmentId (string) --
The ID of the attachment.
NatGatewaySupport (string) --
The state of NAT gateway support on the attachment.
NatSystemRouteSupport (boolean) --
Indicates whether the core network installs system routes for the NAT CIDR blocks of the attachment's NAT rules.
NatGatewayRules (list) --
The NAT rules of the attachment.
(dict) --
Describes a NAT rule of an attachment.
RuleNumber (integer) --
The rule number. Rule numbers identify the rules of an attachment and don't set the order in which rules are evaluated.
MatchSourceCidr (string) --
The source CIDR block that the rule matches for traffic from the attachment.
NatCidr (string) --
The CIDR block that matching source addresses are translated to.
State (string) --
The state of the NAT rule. The possible values are the following:
CREATING: The rule is being created.
MODIFYING: The rule is being modified.
DELETING: The rule is being deleted.
ACTIVATING: NAT gateway support is being enabled, and the rule is being applied.
ACTIVATED: NAT gateway support is enabled, and the rule is applied.
DEACTIVATING: NAT gateway support is being disabled, and the rule is being removed from use.
DEACTIVATED: NAT gateway support is disabled, and the rule isn't applied.
FAILED: The attachment failed to be created, and the rule isn't applied.
PENDING_ATTACHMENT_ACCEPTANCE: The attachment is pending acceptance. The rule is applied after the attachment is accepted.
NextToken (string) --
The token for the next page of results.
{'Attachment': {'LastModificationErrors': {'Code': {'CREATION_FAILED',
'DELETION_FAILED',
'DIRECT_CONNECT_GATEWAY_TOPOLOGY_RESTRICTIONS',
'SECURITY_GROUP_REFERENCING_UNSUPPORTED_AVAILABILITY_ZONE',
'UPDATE_FAILED',
'VPN_STATIC_ROUTES_NAT_UNSUPPORTED'}},
'NatGatewaySupport': 'ENABLED | ENABLING | DISABLED | '
'DISABLING | '
'PENDING_ATTACHMENT_ACCEPTANCE',
'NatSystemRouteSupport': 'boolean'}}
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'|'DIRECT_CONNECT_GATEWAY'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'EdgeLocations': [
'string',
],
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'NatGatewaySupport': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'|'PENDING_ATTACHMENT_ACCEPTANCE',
'NatSystemRouteSupport': True|False,
'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'|'SECURITY_GROUP_REFERENCING_UNSUPPORTED_AVAILABILITY_ZONE'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED'|'DIRECT_CONNECT_GATEWAY_NOT_FOUND'|'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS'|'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF'|'VPN_EXISTING_ASSOCIATIONS'|'VPN_STATIC_ROUTES_NAT_UNSUPPORTED'|'VPC_UNSUPPORTED_FEATURES'|'DIRECT_CONNECT_GATEWAY_TOPOLOGY_RESTRICTIONS'|'CREATION_FAILED'|'UPDATE_FAILED'|'DELETION_FAILED',
'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. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.
EdgeLocations (list) --
The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.
(string) --
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.
NatGatewaySupport (string) --
The state of NAT gateway support on the attachment. This is returned only to the core network owner for attachment types that support NAT.
NatSystemRouteSupport (boolean) --
Indicates whether the core network installs system routes for the NAT CIDR blocks of the attachment's NAT rules. This is returned only to the core network owner for attachment types that support NAT.
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.
{'NatGatewayRules': [{'MatchSourceCidr': 'string',
'NatCidr': 'string',
'RuleNumber': 'integer'}],
'NatGatewaySupport': 'ENABLE | DISABLE'}
Response {'ConnectAttachment': {'Attachment': {'LastModificationErrors': {'Code': {'CREATION_FAILED',
'DELETION_FAILED',
'DIRECT_CONNECT_GATEWAY_TOPOLOGY_RESTRICTIONS',
'SECURITY_GROUP_REFERENCING_UNSUPPORTED_AVAILABILITY_ZONE',
'UPDATE_FAILED',
'VPN_STATIC_ROUTES_NAT_UNSUPPORTED'}},
'NatGatewaySupport': 'ENABLED | ENABLING '
'| DISABLED | '
'DISABLING | '
'PENDING_ATTACHMENT_ACCEPTANCE',
'NatSystemRouteSupport': 'boolean'}}}
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',
RoutingPolicyLabel='string',
NatGatewaySupport='ENABLE'|'DISABLE',
NatGatewayRules=[
{
'RuleNumber': 123,
'MatchSourceCidr': 'string',
'NatCidr': '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.
string
The routing policy label to apply to the Connect attachment for traffic routing decisions.
string
Specifies whether to enable NAT gateway support on the Connect attachment. NAT is supported only on Connect attachments that use the GRE tunnel protocol. Tunnel-less Connect attachments aren't supported. To enable NAT gateway support, you must also specify at least one NAT rule. If you don't specify a value, NAT gateway support is disabled. Only the core network owner can configure NAT on an attachment.
list
The NAT rules for the Connect attachment, up to 50 rules.
(dict) --
Describes a NAT rule to configure on an attachment. Source addresses in the source CIDR block of traffic from the attachment are translated to the same host addresses in the NAT CIDR block. Traffic to an address in the NAT CIDR block is translated back to the matching address in the source CIDR block.
RuleNumber (integer) -- [REQUIRED]
The rule number, from 1 to 32766. Each rule number must be unique for the attachment.
MatchSourceCidr (string) -- [REQUIRED]
The IPv4 CIDR block to match against the source address of traffic from the attachment. The CIDR block can't overlap with the multicast range (224.0.0.0/4).
NatCidr (string) -- [REQUIRED]
The IPv4 CIDR block to translate matching source addresses to. The prefix length must be the same as the prefix length of MatchSourceCidr. The CIDR block must be within a private (RFC 1918) or shared address space (RFC 6598) range. The CIDR blocks of the NAT rules of an attachment can't overlap with each other.
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'|'DIRECT_CONNECT_GATEWAY'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'EdgeLocations': [
'string',
],
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'NatGatewaySupport': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'|'PENDING_ATTACHMENT_ACCEPTANCE',
'NatSystemRouteSupport': True|False,
'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'|'SECURITY_GROUP_REFERENCING_UNSUPPORTED_AVAILABILITY_ZONE'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED'|'DIRECT_CONNECT_GATEWAY_NOT_FOUND'|'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS'|'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF'|'VPN_EXISTING_ASSOCIATIONS'|'VPN_STATIC_ROUTES_NAT_UNSUPPORTED'|'VPC_UNSUPPORTED_FEATURES'|'DIRECT_CONNECT_GATEWAY_TOPOLOGY_RESTRICTIONS'|'CREATION_FAILED'|'UPDATE_FAILED'|'DELETION_FAILED',
'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. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.
EdgeLocations (list) --
The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.
(string) --
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.
NatGatewaySupport (string) --
The state of NAT gateway support on the attachment. This is returned only to the core network owner for attachment types that support NAT.
NatSystemRouteSupport (boolean) --
Indicates whether the core network installs system routes for the NAT CIDR blocks of the attachment's NAT rules. This is returned only to the core network owner for attachment types that support NAT.
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': {'CREATION_FAILED',
'DELETION_FAILED'}}}}
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'|'CREATION_FAILED'|'DELETION_FAILED',
'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.
{'NatGatewayRules': [{'MatchSourceCidr': 'string',
'NatCidr': 'string',
'RuleNumber': 'integer'}],
'NatGatewaySupport': 'ENABLE | DISABLE',
'NatSystemRouteSupport': 'boolean'}
Response {'DirectConnectGatewayAttachment': {'Attachment': {'LastModificationErrors': {'Code': {'CREATION_FAILED',
'DELETION_FAILED',
'DIRECT_CONNECT_GATEWAY_TOPOLOGY_RESTRICTIONS',
'SECURITY_GROUP_REFERENCING_UNSUPPORTED_AVAILABILITY_ZONE',
'UPDATE_FAILED',
'VPN_STATIC_ROUTES_NAT_UNSUPPORTED'}},
'NatGatewaySupport': 'ENABLED '
'| '
'ENABLING '
'| '
'DISABLED '
'| '
'DISABLING '
'| '
'PENDING_ATTACHMENT_ACCEPTANCE',
'NatSystemRouteSupport': 'boolean'}}}
Creates an Amazon Web Services Direct Connect gateway attachment
See also: AWS API Documentation
Request Syntax
client.create_direct_connect_gateway_attachment(
CoreNetworkId='string',
DirectConnectGatewayArn='string',
RoutingPolicyLabel='string',
EdgeLocations=[
'string',
],
NatGatewaySupport='ENABLE'|'DISABLE',
NatSystemRouteSupport=True|False,
NatGatewayRules=[
{
'RuleNumber': 123,
'MatchSourceCidr': 'string',
'NatCidr': 'string'
},
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientToken='string'
)
string
[REQUIRED]
The ID of the Cloud WAN core network that the Direct Connect gateway attachment should be attached to.
string
[REQUIRED]
The ARN of the Direct Connect gateway attachment.
string
The routing policy label to apply to the Direct Connect Gateway attachment for traffic routing decisions.
list
[REQUIRED]
One or more core network edge locations that the Direct Connect gateway attachment is associated with.
(string) --
string
Specifies whether to enable NAT gateway support on the Direct Connect gateway attachment. To enable NAT gateway support, you must also specify at least one NAT rule. If you don't specify a value, NAT gateway support is disabled. Only the core network owner can configure NAT on an attachment.
boolean
Specifies whether the core network installs system routes for the NAT CIDR blocks of the attachment's NAT rules. System routes have a route type of SYSTEM. NAT is applied to traffic whether or not this option is enabled. The default is true.
list
The NAT rules for the Direct Connect gateway attachment, up to 50 rules.
(dict) --
Describes a NAT rule to configure on an attachment. Source addresses in the source CIDR block of traffic from the attachment are translated to the same host addresses in the NAT CIDR block. Traffic to an address in the NAT CIDR block is translated back to the matching address in the source CIDR block.
RuleNumber (integer) -- [REQUIRED]
The rule number, from 1 to 32766. Each rule number must be unique for the attachment.
MatchSourceCidr (string) -- [REQUIRED]
The IPv4 CIDR block to match against the source address of traffic from the attachment. The CIDR block can't overlap with the multicast range (224.0.0.0/4).
NatCidr (string) -- [REQUIRED]
The IPv4 CIDR block to translate matching source addresses to. The prefix length must be the same as the prefix length of MatchSourceCidr. The CIDR block must be within a private (RFC 1918) or shared address space (RFC 6598) range. The CIDR blocks of the NAT rules of an attachment can't overlap with each other.
list
The key value tags to apply to the Direct Connect gateway attachment during creation.
(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
client token
This field is autopopulated if not provided.
dict
Response Syntax
{
'DirectConnectGatewayAttachment': {
'Attachment': {
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'AttachmentId': 'string',
'OwnerAccountId': 'string',
'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'DIRECT_CONNECT_GATEWAY'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'EdgeLocations': [
'string',
],
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'NatGatewaySupport': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'|'PENDING_ATTACHMENT_ACCEPTANCE',
'NatSystemRouteSupport': True|False,
'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'|'SECURITY_GROUP_REFERENCING_UNSUPPORTED_AVAILABILITY_ZONE'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED'|'DIRECT_CONNECT_GATEWAY_NOT_FOUND'|'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS'|'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF'|'VPN_EXISTING_ASSOCIATIONS'|'VPN_STATIC_ROUTES_NAT_UNSUPPORTED'|'VPC_UNSUPPORTED_FEATURES'|'DIRECT_CONNECT_GATEWAY_TOPOLOGY_RESTRICTIONS'|'CREATION_FAILED'|'UPDATE_FAILED'|'DELETION_FAILED',
'Message': 'string',
'ResourceArn': 'string',
'RequestId': 'string'
},
]
},
'DirectConnectGatewayArn': 'string'
}
}
Response Structure
(dict) --
DirectConnectGatewayAttachment (dict) --
Describes the details of a CreateDirectConnectGatewayAttachment 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. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.
EdgeLocations (list) --
The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.
(string) --
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.
NatGatewaySupport (string) --
The state of NAT gateway support on the attachment. This is returned only to the core network owner for attachment types that support NAT.
NatSystemRouteSupport (boolean) --
Indicates whether the core network installs system routes for the NAT CIDR blocks of the attachment's NAT rules. This is returned only to the core network owner for attachment types that support NAT.
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.
DirectConnectGatewayArn (string) --
The Direct Connect gateway attachment ARN.
{'NatGatewayRules': [{'MatchSourceCidr': 'string',
'NatCidr': 'string',
'RuleNumber': 'integer'}],
'NatGatewaySupport': 'ENABLE | DISABLE',
'NatSystemRouteSupport': 'boolean'}
Response {'SiteToSiteVpnAttachment': {'Attachment': {'LastModificationErrors': {'Code': {'CREATION_FAILED',
'DELETION_FAILED',
'DIRECT_CONNECT_GATEWAY_TOPOLOGY_RESTRICTIONS',
'SECURITY_GROUP_REFERENCING_UNSUPPORTED_AVAILABILITY_ZONE',
'UPDATE_FAILED',
'VPN_STATIC_ROUTES_NAT_UNSUPPORTED'}},
'NatGatewaySupport': 'ENABLED | '
'ENABLING | '
'DISABLED | '
'DISABLING | '
'PENDING_ATTACHMENT_ACCEPTANCE',
'NatSystemRouteSupport': 'boolean'}}}
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',
RoutingPolicyLabel='string',
NatGatewaySupport='ENABLE'|'DISABLE',
NatSystemRouteSupport=True|False,
NatGatewayRules=[
{
'RuleNumber': 123,
'MatchSourceCidr': 'string',
'NatCidr': '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.
string
The routing policy label to apply to the Site-to-Site VPN attachment for traffic routing decisions.
string
Specifies whether to enable NAT gateway support on the Site-to-Site VPN attachment. To enable NAT gateway support, you must also specify at least one NAT rule. If you don't specify a value, NAT gateway support is disabled. Only the core network owner can configure NAT on an attachment.
boolean
Specifies whether the core network installs system routes for the NAT CIDR blocks of the attachment's NAT rules. System routes have a route type of SYSTEM. NAT is applied to traffic whether or not this option is enabled. The default is true for VPN connections that use BGP and false for VPN connections that use static routing. If the VPN connection uses static routing, you must specify false or omit this parameter.
list
The NAT rules for the Site-to-Site VPN attachment, up to 50 rules.
(dict) --
Describes a NAT rule to configure on an attachment. Source addresses in the source CIDR block of traffic from the attachment are translated to the same host addresses in the NAT CIDR block. Traffic to an address in the NAT CIDR block is translated back to the matching address in the source CIDR block.
RuleNumber (integer) -- [REQUIRED]
The rule number, from 1 to 32766. Each rule number must be unique for the attachment.
MatchSourceCidr (string) -- [REQUIRED]
The IPv4 CIDR block to match against the source address of traffic from the attachment. The CIDR block can't overlap with the multicast range (224.0.0.0/4).
NatCidr (string) -- [REQUIRED]
The IPv4 CIDR block to translate matching source addresses to. The prefix length must be the same as the prefix length of MatchSourceCidr. The CIDR block must be within a private (RFC 1918) or shared address space (RFC 6598) range. The CIDR blocks of the NAT rules of an attachment can't overlap with each other.
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'|'DIRECT_CONNECT_GATEWAY'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'EdgeLocations': [
'string',
],
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'NatGatewaySupport': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'|'PENDING_ATTACHMENT_ACCEPTANCE',
'NatSystemRouteSupport': True|False,
'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'|'SECURITY_GROUP_REFERENCING_UNSUPPORTED_AVAILABILITY_ZONE'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED'|'DIRECT_CONNECT_GATEWAY_NOT_FOUND'|'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS'|'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF'|'VPN_EXISTING_ASSOCIATIONS'|'VPN_STATIC_ROUTES_NAT_UNSUPPORTED'|'VPC_UNSUPPORTED_FEATURES'|'DIRECT_CONNECT_GATEWAY_TOPOLOGY_RESTRICTIONS'|'CREATION_FAILED'|'UPDATE_FAILED'|'DELETION_FAILED',
'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. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.
EdgeLocations (list) --
The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.
(string) --
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.
NatGatewaySupport (string) --
The state of NAT gateway support on the attachment. This is returned only to the core network owner for attachment types that support NAT.
NatSystemRouteSupport (boolean) --
Indicates whether the core network installs system routes for the NAT CIDR blocks of the attachment's NAT rules. This is returned only to the core network owner for attachment types that support NAT.
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': {'CREATION_FAILED',
'DELETION_FAILED',
'TRANSIT_GATEWAY_ENCRYPTION_NOT_SUPPORTED'}}}}}
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'|'TRANSIT_GATEWAY_ENCRYPTION_NOT_SUPPORTED'|'CREATION_FAILED'|'DELETION_FAILED',
'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 peering 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': {'CREATION_FAILED',
'DELETION_FAILED',
'DIRECT_CONNECT_GATEWAY_TOPOLOGY_RESTRICTIONS',
'SECURITY_GROUP_REFERENCING_UNSUPPORTED_AVAILABILITY_ZONE',
'UPDATE_FAILED',
'VPN_STATIC_ROUTES_NAT_UNSUPPORTED'}},
'NatGatewaySupport': 'ENABLED '
'| '
'ENABLING '
'| '
'DISABLED '
'| '
'DISABLING '
'| '
'PENDING_ATTACHMENT_ACCEPTANCE',
'NatSystemRouteSupport': 'boolean'}}}
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',
RoutingPolicyLabel='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".
string
The routing policy label to apply to the Transit Gateway route table attachment for traffic routing decisions.
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'|'DIRECT_CONNECT_GATEWAY'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'EdgeLocations': [
'string',
],
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'NatGatewaySupport': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'|'PENDING_ATTACHMENT_ACCEPTANCE',
'NatSystemRouteSupport': True|False,
'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'|'SECURITY_GROUP_REFERENCING_UNSUPPORTED_AVAILABILITY_ZONE'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED'|'DIRECT_CONNECT_GATEWAY_NOT_FOUND'|'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS'|'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF'|'VPN_EXISTING_ASSOCIATIONS'|'VPN_STATIC_ROUTES_NAT_UNSUPPORTED'|'VPC_UNSUPPORTED_FEATURES'|'DIRECT_CONNECT_GATEWAY_TOPOLOGY_RESTRICTIONS'|'CREATION_FAILED'|'UPDATE_FAILED'|'DELETION_FAILED',
'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. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.
EdgeLocations (list) --
The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.
(string) --
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.
NatGatewaySupport (string) --
The state of NAT gateway support on the attachment. This is returned only to the core network owner for attachment types that support NAT.
NatSystemRouteSupport (boolean) --
Indicates whether the core network installs system routes for the NAT CIDR blocks of the attachment's NAT rules. This is returned only to the core network owner for attachment types that support NAT.
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".
{'NatGatewayRules': [{'MatchSourceCidr': 'string',
'NatCidr': 'string',
'RuleNumber': 'integer'}],
'NatGatewaySupport': 'ENABLE | DISABLE'}
Response {'VpcAttachment': {'Attachment': {'LastModificationErrors': {'Code': {'CREATION_FAILED',
'DELETION_FAILED',
'DIRECT_CONNECT_GATEWAY_TOPOLOGY_RESTRICTIONS',
'SECURITY_GROUP_REFERENCING_UNSUPPORTED_AVAILABILITY_ZONE',
'UPDATE_FAILED',
'VPN_STATIC_ROUTES_NAT_UNSUPPORTED'}},
'NatGatewaySupport': 'ENABLED | ENABLING | '
'DISABLED | DISABLING | '
'PENDING_ATTACHMENT_ACCEPTANCE',
'NatSystemRouteSupport': 'boolean'}}}
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,
'DnsSupport': True|False,
'SecurityGroupReferencingSupport': True|False
},
RoutingPolicyLabel='string',
NatGatewaySupport='ENABLE'|'DISABLE',
NatGatewayRules=[
{
'RuleNumber': 123,
'MatchSourceCidr': 'string',
'NatCidr': 'string'
},
],
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.
DnsSupport (boolean) --
Indicates whether DNS is supported.
SecurityGroupReferencingSupport (boolean) --
Indicates whether security group referencing is enabled for this VPC attachment. The default is true. However, at the core network policy-level the default is set to false.
string
The routing policy label to apply to the VPC attachment for traffic routing decisions.
string
Specifies whether to enable NAT gateway support on the VPC attachment. To enable NAT gateway support, you must also specify at least one NAT rule. If you don't specify a value, NAT gateway support is disabled. Only the core network owner can configure NAT on an attachment.
list
The NAT rules for the VPC attachment, up to 50 rules.
(dict) --
Describes a NAT rule to configure on an attachment. Source addresses in the source CIDR block of traffic from the attachment are translated to the same host addresses in the NAT CIDR block. Traffic to an address in the NAT CIDR block is translated back to the matching address in the source CIDR block.
RuleNumber (integer) -- [REQUIRED]
The rule number, from 1 to 32766. Each rule number must be unique for the attachment.
MatchSourceCidr (string) -- [REQUIRED]
The IPv4 CIDR block to match against the source address of traffic from the attachment. The CIDR block can't overlap with the multicast range (224.0.0.0/4).
NatCidr (string) -- [REQUIRED]
The IPv4 CIDR block to translate matching source addresses to. The prefix length must be the same as the prefix length of MatchSourceCidr. The CIDR block must be within a private (RFC 1918) or shared address space (RFC 6598) range. The CIDR blocks of the NAT rules of an attachment can't overlap with each other.
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'|'DIRECT_CONNECT_GATEWAY'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'EdgeLocations': [
'string',
],
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'NatGatewaySupport': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'|'PENDING_ATTACHMENT_ACCEPTANCE',
'NatSystemRouteSupport': True|False,
'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'|'SECURITY_GROUP_REFERENCING_UNSUPPORTED_AVAILABILITY_ZONE'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED'|'DIRECT_CONNECT_GATEWAY_NOT_FOUND'|'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS'|'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF'|'VPN_EXISTING_ASSOCIATIONS'|'VPN_STATIC_ROUTES_NAT_UNSUPPORTED'|'VPC_UNSUPPORTED_FEATURES'|'DIRECT_CONNECT_GATEWAY_TOPOLOGY_RESTRICTIONS'|'CREATION_FAILED'|'UPDATE_FAILED'|'DELETION_FAILED',
'Message': 'string',
'ResourceArn': 'string',
'RequestId': 'string'
},
]
},
'SubnetArns': [
'string',
],
'Options': {
'Ipv6Support': True|False,
'ApplianceModeSupport': True|False,
'DnsSupport': True|False,
'SecurityGroupReferencingSupport': 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. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.
EdgeLocations (list) --
The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.
(string) --
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.
NatGatewaySupport (string) --
The state of NAT gateway support on the attachment. This is returned only to the core network owner for attachment types that support NAT.
NatSystemRouteSupport (boolean) --
Indicates whether the core network installs system routes for the NAT CIDR blocks of the attachment's NAT rules. This is returned only to the core network owner for attachment types that support NAT.
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.
DnsSupport (boolean) --
Indicates whether DNS is supported.
SecurityGroupReferencingSupport (boolean) --
Indicates whether security group referencing is enabled for this VPC attachment. The default is true. However, at the core network policy-level the default is set to false.
{'Attachment': {'LastModificationErrors': {'Code': {'CREATION_FAILED',
'DELETION_FAILED',
'DIRECT_CONNECT_GATEWAY_TOPOLOGY_RESTRICTIONS',
'SECURITY_GROUP_REFERENCING_UNSUPPORTED_AVAILABILITY_ZONE',
'UPDATE_FAILED',
'VPN_STATIC_ROUTES_NAT_UNSUPPORTED'}},
'NatGatewaySupport': 'ENABLED | ENABLING | DISABLED | '
'DISABLING | '
'PENDING_ATTACHMENT_ACCEPTANCE',
'NatSystemRouteSupport': 'boolean'}}
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'|'DIRECT_CONNECT_GATEWAY'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'EdgeLocations': [
'string',
],
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'NatGatewaySupport': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'|'PENDING_ATTACHMENT_ACCEPTANCE',
'NatSystemRouteSupport': True|False,
'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'|'SECURITY_GROUP_REFERENCING_UNSUPPORTED_AVAILABILITY_ZONE'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED'|'DIRECT_CONNECT_GATEWAY_NOT_FOUND'|'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS'|'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF'|'VPN_EXISTING_ASSOCIATIONS'|'VPN_STATIC_ROUTES_NAT_UNSUPPORTED'|'VPC_UNSUPPORTED_FEATURES'|'DIRECT_CONNECT_GATEWAY_TOPOLOGY_RESTRICTIONS'|'CREATION_FAILED'|'UPDATE_FAILED'|'DELETION_FAILED',
'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. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.
EdgeLocations (list) --
The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.
(string) --
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.
NatGatewaySupport (string) --
The state of NAT gateway support on the attachment. This is returned only to the core network owner for attachment types that support NAT.
NatSystemRouteSupport (boolean) --
Indicates whether the core network installs system routes for the NAT CIDR blocks of the attachment's NAT rules. This is returned only to the core network owner for attachment types that support NAT.
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': {'CREATION_FAILED',
'DELETION_FAILED'}}}}
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'|'CREATION_FAILED'|'DELETION_FAILED',
'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': {'CREATION_FAILED',
'DELETION_FAILED',
'TRANSIT_GATEWAY_ENCRYPTION_NOT_SUPPORTED'}}}}
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'|'TRANSIT_GATEWAY_ENCRYPTION_NOT_SUPPORTED'|'CREATION_FAILED'|'DELETION_FAILED',
'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 peering 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': {'CREATION_FAILED',
'DELETION_FAILED',
'DIRECT_CONNECT_GATEWAY_TOPOLOGY_RESTRICTIONS',
'SECURITY_GROUP_REFERENCING_UNSUPPORTED_AVAILABILITY_ZONE',
'UPDATE_FAILED',
'VPN_STATIC_ROUTES_NAT_UNSUPPORTED'}},
'NatGatewaySupport': 'ENABLED | ENABLING '
'| DISABLED | '
'DISABLING | '
'PENDING_ATTACHMENT_ACCEPTANCE',
'NatSystemRouteSupport': 'boolean'}}}
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'|'DIRECT_CONNECT_GATEWAY'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'EdgeLocations': [
'string',
],
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'NatGatewaySupport': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'|'PENDING_ATTACHMENT_ACCEPTANCE',
'NatSystemRouteSupport': True|False,
'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'|'SECURITY_GROUP_REFERENCING_UNSUPPORTED_AVAILABILITY_ZONE'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED'|'DIRECT_CONNECT_GATEWAY_NOT_FOUND'|'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS'|'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF'|'VPN_EXISTING_ASSOCIATIONS'|'VPN_STATIC_ROUTES_NAT_UNSUPPORTED'|'VPC_UNSUPPORTED_FEATURES'|'DIRECT_CONNECT_GATEWAY_TOPOLOGY_RESTRICTIONS'|'CREATION_FAILED'|'UPDATE_FAILED'|'DELETION_FAILED',
'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. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.
EdgeLocations (list) --
The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.
(string) --
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.
NatGatewaySupport (string) --
The state of NAT gateway support on the attachment. This is returned only to the core network owner for attachment types that support NAT.
NatSystemRouteSupport (boolean) --
Indicates whether the core network installs system routes for the NAT CIDR blocks of the attachment's NAT rules. This is returned only to the core network owner for attachment types that support NAT.
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': {'CREATION_FAILED',
'DELETION_FAILED'}}}}
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'|'CREATION_FAILED'|'DELETION_FAILED',
'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.
{'DirectConnectGatewayAttachment': {'Attachment': {'LastModificationErrors': {'Code': {'CREATION_FAILED',
'DELETION_FAILED',
'DIRECT_CONNECT_GATEWAY_TOPOLOGY_RESTRICTIONS',
'SECURITY_GROUP_REFERENCING_UNSUPPORTED_AVAILABILITY_ZONE',
'UPDATE_FAILED',
'VPN_STATIC_ROUTES_NAT_UNSUPPORTED'}},
'NatGatewaySupport': 'ENABLED '
'| '
'ENABLING '
'| '
'DISABLED '
'| '
'DISABLING '
'| '
'PENDING_ATTACHMENT_ACCEPTANCE',
'NatSystemRouteSupport': 'boolean'}}}
Returns information about a specific Amazon Web Services Direct Connect gateway attachment.
See also: AWS API Documentation
Request Syntax
client.get_direct_connect_gateway_attachment(
AttachmentId='string'
)
string
[REQUIRED]
The ID of the Direct Connect gateway attachment that you want to see details about.
dict
Response Syntax
{
'DirectConnectGatewayAttachment': {
'Attachment': {
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'AttachmentId': 'string',
'OwnerAccountId': 'string',
'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'DIRECT_CONNECT_GATEWAY'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'EdgeLocations': [
'string',
],
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'NatGatewaySupport': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'|'PENDING_ATTACHMENT_ACCEPTANCE',
'NatSystemRouteSupport': True|False,
'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'|'SECURITY_GROUP_REFERENCING_UNSUPPORTED_AVAILABILITY_ZONE'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED'|'DIRECT_CONNECT_GATEWAY_NOT_FOUND'|'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS'|'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF'|'VPN_EXISTING_ASSOCIATIONS'|'VPN_STATIC_ROUTES_NAT_UNSUPPORTED'|'VPC_UNSUPPORTED_FEATURES'|'DIRECT_CONNECT_GATEWAY_TOPOLOGY_RESTRICTIONS'|'CREATION_FAILED'|'UPDATE_FAILED'|'DELETION_FAILED',
'Message': 'string',
'ResourceArn': 'string',
'RequestId': 'string'
},
]
},
'DirectConnectGatewayArn': 'string'
}
}
Response Structure
(dict) --
DirectConnectGatewayAttachment (dict) --
Shows details about the Direct Connect gateway 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. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.
EdgeLocations (list) --
The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.
(string) --
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.
NatGatewaySupport (string) --
The state of NAT gateway support on the attachment. This is returned only to the core network owner for attachment types that support NAT.
NatSystemRouteSupport (boolean) --
Indicates whether the core network installs system routes for the NAT CIDR blocks of the attachment's NAT rules. This is returned only to the core network owner for attachment types that support NAT.
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.
DirectConnectGatewayArn (string) --
The Direct Connect gateway attachment ARN.
{'MaxResults': 'integer', 'NextToken': 'string', 'Types': {'SYSTEM'}}
Response {'CoreNetworkNetworkFunctionGroup': {'CoreNetworkId': 'string',
'EdgeLocation': 'string',
'NetworkFunctionGroupName': 'string'},
'NetworkRoutes': {'Type': {'SYSTEM'}},
'NextToken': 'string'}
Gets the network routes of the specified global network.
See also: AWS API Documentation
Request Syntax
client.get_network_routes(
GlobalNetworkId='string',
RouteTableIdentifier={
'TransitGatewayRouteTableArn': 'string',
'CoreNetworkSegmentEdge': {
'CoreNetworkId': 'string',
'SegmentName': 'string',
'EdgeLocation': 'string'
},
'CoreNetworkNetworkFunctionGroup': {
'CoreNetworkId': 'string',
'NetworkFunctionGroupName': 'string',
'EdgeLocation': 'string'
}
},
ExactCidrMatches=[
'string',
],
LongestPrefixMatches=[
'string',
],
SubnetOfMatches=[
'string',
],
SupernetOfMatches=[
'string',
],
PrefixListIds=[
'string',
],
States=[
'ACTIVE'|'BLACKHOLE',
],
Types=[
'PROPAGATED'|'STATIC'|'SYSTEM',
],
DestinationFilters={
'string': [
'string',
]
},
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ID of the global network.
dict
[REQUIRED]
The ID of the route table.
TransitGatewayRouteTableArn (string) --
The ARN of the transit gateway route table for the attachment request. For example, "TransitGatewayRouteTableArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway-route-table/tgw-rtb-9876543210123456".
CoreNetworkSegmentEdge (dict) --
The segment edge in a core network.
CoreNetworkId (string) --
The ID of a core network.
SegmentName (string) --
The name of the segment edge.
EdgeLocation (string) --
The Region where the segment edge is located.
CoreNetworkNetworkFunctionGroup (dict) --
The route table identifier associated with the network function group.
CoreNetworkId (string) --
The ID of the core network.
NetworkFunctionGroupName (string) --
The network function group name.
EdgeLocation (string) --
The location for the core network edge.
list
An exact CIDR block.
(string) --
list
The most specific route that matches the traffic (longest prefix match).
(string) --
list
The routes with a subnet that match the specified CIDR filter.
(string) --
list
The routes with a CIDR that encompasses the CIDR filter. Example: If you specify 10.0.1.0/30, then the result returns 10.0.1.0/29.
(string) --
list
The IDs of the prefix lists.
(string) --
list
The route states.
(string) --
list
The route types.
(string) --
dict
Filter by route table destination. Possible Values: TRANSIT_GATEWAY_ATTACHMENT_ID, RESOURCE_ID, or RESOURCE_TYPE.
(string) --
(list) --
(string) --
integer
The maximum number of results to return.
string
The token for the next page of results.
dict
Response Syntax
{
'RouteTableArn': 'string',
'CoreNetworkSegmentEdge': {
'CoreNetworkId': 'string',
'SegmentName': 'string',
'EdgeLocation': 'string'
},
'CoreNetworkNetworkFunctionGroup': {
'CoreNetworkId': 'string',
'NetworkFunctionGroupName': 'string',
'EdgeLocation': 'string'
},
'RouteTableType': 'TRANSIT_GATEWAY_ROUTE_TABLE'|'CORE_NETWORK_SEGMENT'|'NETWORK_FUNCTION_GROUP',
'RouteTableTimestamp': datetime(2015, 1, 1),
'NetworkRoutes': [
{
'DestinationCidrBlock': 'string',
'Destinations': [
{
'CoreNetworkAttachmentId': 'string',
'TransitGatewayAttachmentId': 'string',
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'EdgeLocation': 'string',
'ResourceType': 'string',
'ResourceId': 'string'
},
],
'PrefixListId': 'string',
'State': 'ACTIVE'|'BLACKHOLE',
'Type': 'PROPAGATED'|'STATIC'|'SYSTEM'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
RouteTableArn (string) --
The ARN of the route table.
CoreNetworkSegmentEdge (dict) --
Describes a core network segment edge.
CoreNetworkId (string) --
The ID of a core network.
SegmentName (string) --
The name of the segment edge.
EdgeLocation (string) --
The Region where the segment edge is located.
CoreNetworkNetworkFunctionGroup (dict) --
Describes the network function group route table that the routes are from. This field is present only when you specify CoreNetworkNetworkFunctionGroup in RouteTableIdentifier.
CoreNetworkId (string) --
The ID of the core network.
NetworkFunctionGroupName (string) --
The network function group name.
EdgeLocation (string) --
The location for the core network edge.
RouteTableType (string) --
The route table type.
RouteTableTimestamp (datetime) --
The route table creation time.
NetworkRoutes (list) --
The network routes.
(dict) --
Describes a network route.
DestinationCidrBlock (string) --
A unique identifier for the route, such as a CIDR block.
Destinations (list) --
The destinations.
(dict) --
Describes the destination of a network route.
CoreNetworkAttachmentId (string) --
The ID of a core network attachment.
TransitGatewayAttachmentId (string) --
The ID of the transit gateway attachment.
SegmentName (string) --
The name of the segment.
NetworkFunctionGroupName (string) --
The network function group name associated with the destination.
EdgeLocation (string) --
The edge location for the network destination.
ResourceType (string) --
The resource type.
ResourceId (string) --
The ID of the resource.
PrefixListId (string) --
The ID of the prefix list.
State (string) --
The route state. The possible values are active and blackhole.
Type (string) --
The route type. The possible values are PROPAGATED, STATIC, and SYSTEM. A SYSTEM route is installed by the core network for the NAT CIDR block of an attachment's NAT rule.
NextToken (string) --
The token for the next page of results.
{'SiteToSiteVpnAttachment': {'Attachment': {'LastModificationErrors': {'Code': {'CREATION_FAILED',
'DELETION_FAILED',
'DIRECT_CONNECT_GATEWAY_TOPOLOGY_RESTRICTIONS',
'SECURITY_GROUP_REFERENCING_UNSUPPORTED_AVAILABILITY_ZONE',
'UPDATE_FAILED',
'VPN_STATIC_ROUTES_NAT_UNSUPPORTED'}},
'NatGatewaySupport': 'ENABLED | '
'ENABLING | '
'DISABLED | '
'DISABLING | '
'PENDING_ATTACHMENT_ACCEPTANCE',
'NatSystemRouteSupport': 'boolean'}}}
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'|'DIRECT_CONNECT_GATEWAY'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'EdgeLocations': [
'string',
],
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'NatGatewaySupport': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'|'PENDING_ATTACHMENT_ACCEPTANCE',
'NatSystemRouteSupport': True|False,
'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'|'SECURITY_GROUP_REFERENCING_UNSUPPORTED_AVAILABILITY_ZONE'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED'|'DIRECT_CONNECT_GATEWAY_NOT_FOUND'|'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS'|'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF'|'VPN_EXISTING_ASSOCIATIONS'|'VPN_STATIC_ROUTES_NAT_UNSUPPORTED'|'VPC_UNSUPPORTED_FEATURES'|'DIRECT_CONNECT_GATEWAY_TOPOLOGY_RESTRICTIONS'|'CREATION_FAILED'|'UPDATE_FAILED'|'DELETION_FAILED',
'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. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.
EdgeLocations (list) --
The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.
(string) --
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.
NatGatewaySupport (string) --
The state of NAT gateway support on the attachment. This is returned only to the core network owner for attachment types that support NAT.
NatSystemRouteSupport (boolean) --
Indicates whether the core network installs system routes for the NAT CIDR blocks of the attachment's NAT rules. This is returned only to the core network owner for attachment types that support NAT.
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': {'CREATION_FAILED',
'DELETION_FAILED',
'TRANSIT_GATEWAY_ENCRYPTION_NOT_SUPPORTED'}}}}}
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'|'TRANSIT_GATEWAY_ENCRYPTION_NOT_SUPPORTED'|'CREATION_FAILED'|'DELETION_FAILED',
'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 peering 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': {'CREATION_FAILED',
'DELETION_FAILED',
'DIRECT_CONNECT_GATEWAY_TOPOLOGY_RESTRICTIONS',
'SECURITY_GROUP_REFERENCING_UNSUPPORTED_AVAILABILITY_ZONE',
'UPDATE_FAILED',
'VPN_STATIC_ROUTES_NAT_UNSUPPORTED'}},
'NatGatewaySupport': 'ENABLED '
'| '
'ENABLING '
'| '
'DISABLED '
'| '
'DISABLING '
'| '
'PENDING_ATTACHMENT_ACCEPTANCE',
'NatSystemRouteSupport': 'boolean'}}}
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'|'DIRECT_CONNECT_GATEWAY'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'EdgeLocations': [
'string',
],
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'NatGatewaySupport': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'|'PENDING_ATTACHMENT_ACCEPTANCE',
'NatSystemRouteSupport': True|False,
'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'|'SECURITY_GROUP_REFERENCING_UNSUPPORTED_AVAILABILITY_ZONE'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED'|'DIRECT_CONNECT_GATEWAY_NOT_FOUND'|'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS'|'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF'|'VPN_EXISTING_ASSOCIATIONS'|'VPN_STATIC_ROUTES_NAT_UNSUPPORTED'|'VPC_UNSUPPORTED_FEATURES'|'DIRECT_CONNECT_GATEWAY_TOPOLOGY_RESTRICTIONS'|'CREATION_FAILED'|'UPDATE_FAILED'|'DELETION_FAILED',
'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. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.
EdgeLocations (list) --
The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.
(string) --
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.
NatGatewaySupport (string) --
The state of NAT gateway support on the attachment. This is returned only to the core network owner for attachment types that support NAT.
NatSystemRouteSupport (boolean) --
Indicates whether the core network installs system routes for the NAT CIDR blocks of the attachment's NAT rules. This is returned only to the core network owner for attachment types that support NAT.
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': {'CREATION_FAILED',
'DELETION_FAILED',
'DIRECT_CONNECT_GATEWAY_TOPOLOGY_RESTRICTIONS',
'SECURITY_GROUP_REFERENCING_UNSUPPORTED_AVAILABILITY_ZONE',
'UPDATE_FAILED',
'VPN_STATIC_ROUTES_NAT_UNSUPPORTED'}},
'NatGatewaySupport': 'ENABLED | ENABLING | '
'DISABLED | DISABLING | '
'PENDING_ATTACHMENT_ACCEPTANCE',
'NatSystemRouteSupport': 'boolean'}}}
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'|'DIRECT_CONNECT_GATEWAY'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'EdgeLocations': [
'string',
],
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'NatGatewaySupport': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'|'PENDING_ATTACHMENT_ACCEPTANCE',
'NatSystemRouteSupport': True|False,
'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'|'SECURITY_GROUP_REFERENCING_UNSUPPORTED_AVAILABILITY_ZONE'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED'|'DIRECT_CONNECT_GATEWAY_NOT_FOUND'|'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS'|'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF'|'VPN_EXISTING_ASSOCIATIONS'|'VPN_STATIC_ROUTES_NAT_UNSUPPORTED'|'VPC_UNSUPPORTED_FEATURES'|'DIRECT_CONNECT_GATEWAY_TOPOLOGY_RESTRICTIONS'|'CREATION_FAILED'|'UPDATE_FAILED'|'DELETION_FAILED',
'Message': 'string',
'ResourceArn': 'string',
'RequestId': 'string'
},
]
},
'SubnetArns': [
'string',
],
'Options': {
'Ipv6Support': True|False,
'ApplianceModeSupport': True|False,
'DnsSupport': True|False,
'SecurityGroupReferencingSupport': 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. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.
EdgeLocations (list) --
The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.
(string) --
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.
NatGatewaySupport (string) --
The state of NAT gateway support on the attachment. This is returned only to the core network owner for attachment types that support NAT.
NatSystemRouteSupport (boolean) --
Indicates whether the core network installs system routes for the NAT CIDR blocks of the attachment's NAT rules. This is returned only to the core network owner for attachment types that support NAT.
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.
DnsSupport (boolean) --
Indicates whether DNS is supported.
SecurityGroupReferencingSupport (boolean) --
Indicates whether security group referencing is enabled for this VPC attachment. The default is true. However, at the core network policy-level the default is set to false.
{'Attachments': {'LastModificationErrors': {'Code': {'CREATION_FAILED',
'DELETION_FAILED',
'DIRECT_CONNECT_GATEWAY_TOPOLOGY_RESTRICTIONS',
'SECURITY_GROUP_REFERENCING_UNSUPPORTED_AVAILABILITY_ZONE',
'UPDATE_FAILED',
'VPN_STATIC_ROUTES_NAT_UNSUPPORTED'}},
'NatGatewaySupport': 'ENABLED | ENABLING | DISABLED | '
'DISABLING | '
'PENDING_ATTACHMENT_ACCEPTANCE',
'NatSystemRouteSupport': 'boolean'}}
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'|'DIRECT_CONNECT_GATEWAY'|'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'|'DIRECT_CONNECT_GATEWAY'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'EdgeLocations': [
'string',
],
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'NatGatewaySupport': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'|'PENDING_ATTACHMENT_ACCEPTANCE',
'NatSystemRouteSupport': True|False,
'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'|'SECURITY_GROUP_REFERENCING_UNSUPPORTED_AVAILABILITY_ZONE'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED'|'DIRECT_CONNECT_GATEWAY_NOT_FOUND'|'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS'|'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF'|'VPN_EXISTING_ASSOCIATIONS'|'VPN_STATIC_ROUTES_NAT_UNSUPPORTED'|'VPC_UNSUPPORTED_FEATURES'|'DIRECT_CONNECT_GATEWAY_TOPOLOGY_RESTRICTIONS'|'CREATION_FAILED'|'UPDATE_FAILED'|'DELETION_FAILED',
'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. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.
EdgeLocations (list) --
The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.
(string) --
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.
NatGatewaySupport (string) --
The state of NAT gateway support on the attachment. This is returned only to the core network owner for attachment types that support NAT.
NatSystemRouteSupport (boolean) --
Indicates whether the core network installs system routes for the NAT CIDR blocks of the attachment's NAT rules. This is returned only to the core network owner for attachment types that support NAT.
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.
{'ExactPrefixMatches': ['string'],
'LongestPrefixMatches': ['string'],
'SubnetOfMatches': ['string'],
'SupernetOfMatches': ['string']}
Lists routing information for a core network, including routes and their attributes.
See also: AWS API Documentation
Request Syntax
client.list_core_network_routing_information(
CoreNetworkId='string',
SegmentName='string',
EdgeLocation='string',
NextHopFilters={
'string': [
'string',
]
},
ExactPrefixMatches=[
'string',
],
LongestPrefixMatches=[
'string',
],
SubnetOfMatches=[
'string',
],
SupernetOfMatches=[
'string',
],
LocalPreferenceMatches=[
'string',
],
ExactAsPathMatches=[
'string',
],
MedMatches=[
'string',
],
CommunityMatches=[
'string',
],
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ID of the core network to retrieve routing information for.
string
[REQUIRED]
The name of the segment to filter routing information by.
string
[REQUIRED]
The edge location to filter routing information by.
dict
Filters to apply based on next hop information. Each filter value must exactly match the corresponding next hop value. Values for the same filter are joined with OR, and different filters are joined with AND. The following filters are supported:
core-network-attachment-id: The ID of the core network attachment for the next hop, for example attachment-0123456789abcdef0.
segment-name: The name of the segment for the next hop.
edge-location: The edge location for the next hop, for example us-east-1.
resource-id: The ID of the resource for the next hop.
resource-type: The type of resource for the next hop. The possible values are vpc, vpn, connect-peer, direct-connect-gateway, transit-gateway-route-table, attachment, and blackhole.
ip-address: The IP address of the next hop. For a Site-to-Site VPN next hop, this is the outside IP address of the AWS side of the VPN tunnel. For a Connect peer next hop, this is the core network BGP address of the Connect peer. The value must be a single IPv4 or IPv6 address.
You can specify up to 10 filter values in total across NextHopFilters and the other match parameters in the request. Each filter value can be up to 256 characters.
(string) --
(list) --
(string) --
list
Exact prefix values to match when filtering routing information.
(string) --
list
Filters routing information based on the longest prefix that matches each provided IP address.
(string) --
list
Prefix values to filter routing information whose prefix is a subnet of the prefixes provided.
(string) --
list
Prefix values to filter routing information whose prefix is a supernet of the prefixes provided.
(string) --
list
Local preference values to match when filtering routing information.
(string) --
list
Exact AS path values to match when filtering routing information.
(string) --
list
Multi-Exit Discriminator (MED) values to match when filtering routing information.
(string) --
list
BGP community values to match when filtering routing information.
(string) --
integer
The maximum number of routing information entries to return in a single page.
string
The token for the next page of results.
dict
Response Syntax
{
'CoreNetworkRoutingInformation': [
{
'Prefix': 'string',
'NextHop': {
'IpAddress': 'string',
'CoreNetworkAttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'string',
'SegmentName': 'string',
'EdgeLocation': 'string'
},
'LocalPreference': 'string',
'Med': 'string',
'AsPath': [
'string',
],
'Communities': [
'string',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
CoreNetworkRoutingInformation (list) --
The list of routing information for the core network.
(dict) --
Routing information for a core network, including route details and BGP attributes.
Prefix (string) --
The IP prefix for the route.
NextHop (dict) --
The next hop information for the route.
IpAddress (string) --
The IP address of the next hop.
CoreNetworkAttachmentId (string) --
The ID of the core network attachment for the next hop.
ResourceId (string) --
The ID of the resource for the next hop.
ResourceType (string) --
The type of resource for the next hop.
SegmentName (string) --
The name of the segment for the next hop.
EdgeLocation (string) --
The edge location for the next hop.
LocalPreference (string) --
The BGP local preference value for the route.
Med (string) --
The BGP Multi-Exit Discriminator (MED) value for the route.
AsPath (list) --
The BGP AS path for the route.
(string) --
Communities (list) --
The BGP community values for the route.
(string) --
NextToken (string) --
The token for the next page of results.
{'Peerings': {'LastModificationErrors': {'Code': {'CREATION_FAILED',
'DELETION_FAILED',
'TRANSIT_GATEWAY_ENCRYPTION_NOT_SUPPORTED'}}}}
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'|'TRANSIT_GATEWAY_ENCRYPTION_NOT_SUPPORTED'|'CREATION_FAILED'|'DELETION_FAILED',
'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 peering 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': {'CREATION_FAILED',
'DELETION_FAILED',
'DIRECT_CONNECT_GATEWAY_TOPOLOGY_RESTRICTIONS',
'SECURITY_GROUP_REFERENCING_UNSUPPORTED_AVAILABILITY_ZONE',
'UPDATE_FAILED',
'VPN_STATIC_ROUTES_NAT_UNSUPPORTED'}},
'NatGatewaySupport': 'ENABLED | ENABLING | DISABLED | '
'DISABLING | '
'PENDING_ATTACHMENT_ACCEPTANCE',
'NatSystemRouteSupport': 'boolean'}}
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'|'DIRECT_CONNECT_GATEWAY'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'EdgeLocations': [
'string',
],
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'NatGatewaySupport': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'|'PENDING_ATTACHMENT_ACCEPTANCE',
'NatSystemRouteSupport': True|False,
'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'|'SECURITY_GROUP_REFERENCING_UNSUPPORTED_AVAILABILITY_ZONE'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED'|'DIRECT_CONNECT_GATEWAY_NOT_FOUND'|'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS'|'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF'|'VPN_EXISTING_ASSOCIATIONS'|'VPN_STATIC_ROUTES_NAT_UNSUPPORTED'|'VPC_UNSUPPORTED_FEATURES'|'DIRECT_CONNECT_GATEWAY_TOPOLOGY_RESTRICTIONS'|'CREATION_FAILED'|'UPDATE_FAILED'|'DELETION_FAILED',
'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. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.
EdgeLocations (list) --
The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.
(string) --
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.
NatGatewaySupport (string) --
The state of NAT gateway support on the attachment. This is returned only to the core network owner for attachment types that support NAT.
NatSystemRouteSupport (boolean) --
Indicates whether the core network installs system routes for the NAT CIDR blocks of the attachment's NAT rules. This is returned only to the core network owner for attachment types that support NAT.
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.
{'DirectConnectGatewayAttachment': {'Attachment': {'LastModificationErrors': {'Code': {'CREATION_FAILED',
'DELETION_FAILED',
'DIRECT_CONNECT_GATEWAY_TOPOLOGY_RESTRICTIONS',
'SECURITY_GROUP_REFERENCING_UNSUPPORTED_AVAILABILITY_ZONE',
'UPDATE_FAILED',
'VPN_STATIC_ROUTES_NAT_UNSUPPORTED'}},
'NatGatewaySupport': 'ENABLED '
'| '
'ENABLING '
'| '
'DISABLED '
'| '
'DISABLING '
'| '
'PENDING_ATTACHMENT_ACCEPTANCE',
'NatSystemRouteSupport': 'boolean'}}}
Updates the edge locations associated with an Amazon Web Services Direct Connect gateway attachment.
See also: AWS API Documentation
Request Syntax
client.update_direct_connect_gateway_attachment(
AttachmentId='string',
EdgeLocations=[
'string',
]
)
string
[REQUIRED]
The ID of the Direct Connect gateway attachment for the updated edge locations.
list
One or more edge locations to update for the Direct Connect gateway attachment. The updated array of edge locations overwrites the previous array of locations. EdgeLocations is only used for Direct Connect gateway attachments.
(string) --
dict
Response Syntax
{
'DirectConnectGatewayAttachment': {
'Attachment': {
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'AttachmentId': 'string',
'OwnerAccountId': 'string',
'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'DIRECT_CONNECT_GATEWAY'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'EdgeLocations': [
'string',
],
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'NatGatewaySupport': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'|'PENDING_ATTACHMENT_ACCEPTANCE',
'NatSystemRouteSupport': True|False,
'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'|'SECURITY_GROUP_REFERENCING_UNSUPPORTED_AVAILABILITY_ZONE'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED'|'DIRECT_CONNECT_GATEWAY_NOT_FOUND'|'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS'|'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF'|'VPN_EXISTING_ASSOCIATIONS'|'VPN_STATIC_ROUTES_NAT_UNSUPPORTED'|'VPC_UNSUPPORTED_FEATURES'|'DIRECT_CONNECT_GATEWAY_TOPOLOGY_RESTRICTIONS'|'CREATION_FAILED'|'UPDATE_FAILED'|'DELETION_FAILED',
'Message': 'string',
'ResourceArn': 'string',
'RequestId': 'string'
},
]
},
'DirectConnectGatewayArn': 'string'
}
}
Response Structure
(dict) --
DirectConnectGatewayAttachment (dict) --
Returns details of the Direct Connect gateway attachment with the updated edge locations.
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. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.
EdgeLocations (list) --
The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.
(string) --
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.
NatGatewaySupport (string) --
The state of NAT gateway support on the attachment. This is returned only to the core network owner for attachment types that support NAT.
NatSystemRouteSupport (boolean) --
Indicates whether the core network installs system routes for the NAT CIDR blocks of the attachment's NAT rules. This is returned only to the core network owner for attachment types that support NAT.
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.
DirectConnectGatewayArn (string) --
The Direct Connect gateway attachment ARN.
{'VpcAttachment': {'Attachment': {'LastModificationErrors': {'Code': {'CREATION_FAILED',
'DELETION_FAILED',
'DIRECT_CONNECT_GATEWAY_TOPOLOGY_RESTRICTIONS',
'SECURITY_GROUP_REFERENCING_UNSUPPORTED_AVAILABILITY_ZONE',
'UPDATE_FAILED',
'VPN_STATIC_ROUTES_NAT_UNSUPPORTED'}},
'NatGatewaySupport': 'ENABLED | ENABLING | '
'DISABLED | DISABLING | '
'PENDING_ATTACHMENT_ACCEPTANCE',
'NatSystemRouteSupport': 'boolean'}}}
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,
'DnsSupport': True|False,
'SecurityGroupReferencingSupport': 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.
DnsSupport (boolean) --
Indicates whether DNS is supported.
SecurityGroupReferencingSupport (boolean) --
Indicates whether security group referencing is enabled for this VPC attachment. The default is true. However, at the core network policy-level the default is set to false.
dict
Response Syntax
{
'VpcAttachment': {
'Attachment': {
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'AttachmentId': 'string',
'OwnerAccountId': 'string',
'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'DIRECT_CONNECT_GATEWAY'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'EdgeLocations': [
'string',
],
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'NatGatewaySupport': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'|'PENDING_ATTACHMENT_ACCEPTANCE',
'NatSystemRouteSupport': True|False,
'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'|'SECURITY_GROUP_REFERENCING_UNSUPPORTED_AVAILABILITY_ZONE'|'VPN_CONNECTION_NOT_FOUND'|'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED'|'DIRECT_CONNECT_GATEWAY_NOT_FOUND'|'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS'|'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF'|'VPN_EXISTING_ASSOCIATIONS'|'VPN_STATIC_ROUTES_NAT_UNSUPPORTED'|'VPC_UNSUPPORTED_FEATURES'|'DIRECT_CONNECT_GATEWAY_TOPOLOGY_RESTRICTIONS'|'CREATION_FAILED'|'UPDATE_FAILED'|'DELETION_FAILED',
'Message': 'string',
'ResourceArn': 'string',
'RequestId': 'string'
},
]
},
'SubnetArns': [
'string',
],
'Options': {
'Ipv6Support': True|False,
'ApplianceModeSupport': True|False,
'DnsSupport': True|False,
'SecurityGroupReferencingSupport': 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. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.
EdgeLocations (list) --
The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.
(string) --
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.
NatGatewaySupport (string) --
The state of NAT gateway support on the attachment. This is returned only to the core network owner for attachment types that support NAT.
NatSystemRouteSupport (boolean) --
Indicates whether the core network installs system routes for the NAT CIDR blocks of the attachment's NAT rules. This is returned only to the core network owner for attachment types that support NAT.
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.
DnsSupport (boolean) --
Indicates whether DNS is supported.
SecurityGroupReferencingSupport (boolean) --
Indicates whether security group referencing is enabled for this VPC attachment. The default is true. However, at the core network policy-level the default is set to false.