2024/06/11 - AWS Network Manager - 20 updated api methods
Changes This is model changes & documentation update for Service Insertion feature for AWS Cloud WAN. This feature allows insertion of AWS/3rd party security services on Cloud WAN. This allows to steer inter/intra segment traffic via security appliances and provide visibility to the route updates.
{'Attachment': {'NetworkFunctionGroupName': 'string',
'ProposedNetworkFunctionGroupChange': {'AttachmentPolicyRuleNumber': 'integer',
'NetworkFunctionGroupName': 'string',
'Tags': [{'Key': 'string',
'Value': 'string'}]}}}
Accepts a core network attachment request.
Once the attachment request is accepted by a core network owner, the attachment is created and connected to a core network.
See also: AWS API Documentation
Request Syntax
client.accept_attachment(
AttachmentId='string'
)
string
[REQUIRED]
The ID of the attachment.
dict
Response Syntax
{
'Attachment': {
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'AttachmentId': 'string',
'OwnerAccountId': 'string',
'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'ProposedNetworkFunctionGroupChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'NetworkFunctionGroupName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Attachment (dict) --
The response to the attachment request.
CoreNetworkId (string) --
The ID of a core network.
CoreNetworkArn (string) --
The ARN of a core network.
AttachmentId (string) --
The ID of the attachment.
OwnerAccountId (string) --
The ID of the attachment account owner.
AttachmentType (string) --
The type of attachment.
State (string) --
The state of the attachment.
EdgeLocation (string) --
The Region where the edge is located.
ResourceArn (string) --
The attachment resource ARN.
AttachmentPolicyRuleNumber (integer) --
The policy rule number associated with the attachment.
SegmentName (string) --
The name of the segment attachment.
NetworkFunctionGroupName (string) --
The name of the network function group.
Tags (list) --
The tags associated with the attachment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
ProposedSegmentChange (dict) --
The attachment to move from one segment to another.
Tags (list) --
The list of key-value tags that changed for the segment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
AttachmentPolicyRuleNumber (integer) --
The rule number in the policy document that applies to this change.
SegmentName (string) --
The name of the segment to change.
ProposedNetworkFunctionGroupChange (dict) --
Describes a proposed change to a network function group associated with the attachment.
Tags (list) --
The list of proposed changes to the key-value tags associated with the network function group.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
AttachmentPolicyRuleNumber (integer) --
The proposed new attachment policy rule number for the network function group.
NetworkFunctionGroupName (string) --
The proposed name change for the network function group name.
CreatedAt (datetime) --
The timestamp when the attachment was created.
UpdatedAt (datetime) --
The timestamp when the attachment was last updated.
{'ConnectAttachment': {'Attachment': {'NetworkFunctionGroupName': 'string',
'ProposedNetworkFunctionGroupChange': {'AttachmentPolicyRuleNumber': 'integer',
'NetworkFunctionGroupName': 'string',
'Tags': [{'Key': 'string',
'Value': 'string'}]}}}}
Creates a core network Connect attachment from a specified core network attachment.
A core network Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a core network and an appliance. A core network Connect attachment uses an existing VPC attachment as the underlying transport mechanism.
See also: AWS API Documentation
Request Syntax
client.create_connect_attachment(
CoreNetworkId='string',
EdgeLocation='string',
TransportAttachmentId='string',
Options={
'Protocol': 'GRE'|'NO_ENCAP'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientToken='string'
)
string
[REQUIRED]
The ID of a core network where you want to create the attachment.
string
[REQUIRED]
The Region where the edge is located.
string
[REQUIRED]
The ID of the attachment between the two connections.
dict
[REQUIRED]
Options for creating an attachment.
Protocol (string) --
The protocol used for the attachment connection.
list
The list of key-value tags associated with the request.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
string
The client token associated with the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ConnectAttachment': {
'Attachment': {
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'AttachmentId': 'string',
'OwnerAccountId': 'string',
'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'ProposedNetworkFunctionGroupChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'NetworkFunctionGroupName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
},
'TransportAttachmentId': 'string',
'Options': {
'Protocol': 'GRE'|'NO_ENCAP'
}
}
}
Response Structure
(dict) --
ConnectAttachment (dict) --
The response to a Connect attachment request.
Attachment (dict) --
The attachment details.
CoreNetworkId (string) --
The ID of a core network.
CoreNetworkArn (string) --
The ARN of a core network.
AttachmentId (string) --
The ID of the attachment.
OwnerAccountId (string) --
The ID of the attachment account owner.
AttachmentType (string) --
The type of attachment.
State (string) --
The state of the attachment.
EdgeLocation (string) --
The Region where the edge is located.
ResourceArn (string) --
The attachment resource ARN.
AttachmentPolicyRuleNumber (integer) --
The policy rule number associated with the attachment.
SegmentName (string) --
The name of the segment attachment.
NetworkFunctionGroupName (string) --
The name of the network function group.
Tags (list) --
The tags associated with the attachment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
ProposedSegmentChange (dict) --
The attachment to move from one segment to another.
Tags (list) --
The list of key-value tags that changed for the segment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
AttachmentPolicyRuleNumber (integer) --
The rule number in the policy document that applies to this change.
SegmentName (string) --
The name of the segment to change.
ProposedNetworkFunctionGroupChange (dict) --
Describes a proposed change to a network function group associated with the attachment.
Tags (list) --
The list of proposed changes to the key-value tags associated with the network function group.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
AttachmentPolicyRuleNumber (integer) --
The proposed new attachment policy rule number for the network function group.
NetworkFunctionGroupName (string) --
The proposed name change for the network function group name.
CreatedAt (datetime) --
The timestamp when the attachment was created.
UpdatedAt (datetime) --
The timestamp when the attachment was last updated.
TransportAttachmentId (string) --
The ID of the transport attachment.
Options (dict) --
Options for connecting an attachment.
Protocol (string) --
The protocol used for the attachment connection.
{'CoreNetwork': {'NetworkFunctionGroups': [{'EdgeLocations': ['string'],
'Name': 'string',
'Segments': {'SendTo': ['string'],
'SendVia': ['string']}}]}}
Creates a core network as part of your global network, and optionally, with a core network policy.
See also: AWS API Documentation
Request Syntax
client.create_core_network(
GlobalNetworkId='string',
Description='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
PolicyDocument='string',
ClientToken='string'
)
string
[REQUIRED]
The ID of the global network that a core network will be a part of.
string
The description of a core network.
list
Key-value tags associated with a core network request.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
string
The policy document for creating a core network.
string
The client token associated with a core network request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'CoreNetwork': {
'GlobalNetworkId': 'string',
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'CREATING'|'UPDATING'|'AVAILABLE'|'DELETING',
'Segments': [
{
'Name': 'string',
'EdgeLocations': [
'string',
],
'SharedSegments': [
'string',
]
},
],
'NetworkFunctionGroups': [
{
'Name': 'string',
'EdgeLocations': [
'string',
],
'Segments': {
'SendVia': [
'string',
],
'SendTo': [
'string',
]
}
},
],
'Edges': [
{
'EdgeLocation': 'string',
'Asn': 123,
'InsideCidrBlocks': [
'string',
]
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
CoreNetwork (dict) --
Returns details about a core network.
GlobalNetworkId (string) --
The ID of the global network that your core network is a part of.
CoreNetworkId (string) --
The ID of a core network.
CoreNetworkArn (string) --
The ARN of a core network.
Description (string) --
The description of a core network.
CreatedAt (datetime) --
The timestamp when a core network was created.
State (string) --
The current state of a core network.
Segments (list) --
The segments within a core network.
(dict) --
Describes a core network segment, which are dedicated routes. Only attachments within this segment can communicate with each other.
Name (string) --
The name of a core network segment.
EdgeLocations (list) --
The Regions where the edges are located.
(string) --
SharedSegments (list) --
The shared segments of a core network.
(string) --
NetworkFunctionGroups (list) --
The network function groups associated with a core network.
(dict) --
Describes a network function group.
Name (string) --
The name of the network function group.
EdgeLocations (list) --
The core network edge locations.
(string) --
Segments (dict) --
The segments associated with the network function group.
SendVia (list) --
The list of segments associated with the send-via action.
(string) --
SendTo (list) --
The list of segments associated with the send-to action.
(string) --
Edges (list) --
The edges within a core network.
(dict) --
Describes a core network edge.
EdgeLocation (string) --
The Region where a core network edge is located.
Asn (integer) --
The ASN of a core network edge.
InsideCidrBlocks (list) --
The inside IP addresses used for core network edges.
(string) --
Tags (list) --
The list of key-value tags associated with a core network.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
{'SiteToSiteVpnAttachment': {'Attachment': {'NetworkFunctionGroupName': 'string',
'ProposedNetworkFunctionGroupChange': {'AttachmentPolicyRuleNumber': 'integer',
'NetworkFunctionGroupName': 'string',
'Tags': [{'Key': 'string',
'Value': 'string'}]}}}}
Creates an Amazon Web Services site-to-site VPN attachment on an edge location of a core network.
See also: AWS API Documentation
Request Syntax
client.create_site_to_site_vpn_attachment(
CoreNetworkId='string',
VpnConnectionArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientToken='string'
)
string
[REQUIRED]
The ID of a core network where you're creating a site-to-site VPN attachment.
string
[REQUIRED]
The ARN identifying the VPN attachment.
list
The tags associated with the request.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
string
The client token associated with the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'SiteToSiteVpnAttachment': {
'Attachment': {
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'AttachmentId': 'string',
'OwnerAccountId': 'string',
'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'ProposedNetworkFunctionGroupChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'NetworkFunctionGroupName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
},
'VpnConnectionArn': 'string'
}
}
Response Structure
(dict) --
SiteToSiteVpnAttachment (dict) --
Details about a site-to-site VPN attachment.
Attachment (dict) --
Provides details about a site-to-site VPN attachment.
CoreNetworkId (string) --
The ID of a core network.
CoreNetworkArn (string) --
The ARN of a core network.
AttachmentId (string) --
The ID of the attachment.
OwnerAccountId (string) --
The ID of the attachment account owner.
AttachmentType (string) --
The type of attachment.
State (string) --
The state of the attachment.
EdgeLocation (string) --
The Region where the edge is located.
ResourceArn (string) --
The attachment resource ARN.
AttachmentPolicyRuleNumber (integer) --
The policy rule number associated with the attachment.
SegmentName (string) --
The name of the segment attachment.
NetworkFunctionGroupName (string) --
The name of the network function group.
Tags (list) --
The tags associated with the attachment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
ProposedSegmentChange (dict) --
The attachment to move from one segment to another.
Tags (list) --
The list of key-value tags that changed for the segment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
AttachmentPolicyRuleNumber (integer) --
The rule number in the policy document that applies to this change.
SegmentName (string) --
The name of the segment to change.
ProposedNetworkFunctionGroupChange (dict) --
Describes a proposed change to a network function group associated with the attachment.
Tags (list) --
The list of proposed changes to the key-value tags associated with the network function group.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
AttachmentPolicyRuleNumber (integer) --
The proposed new attachment policy rule number for the network function group.
NetworkFunctionGroupName (string) --
The proposed name change for the network function group name.
CreatedAt (datetime) --
The timestamp when the attachment was created.
UpdatedAt (datetime) --
The timestamp when the attachment was last updated.
VpnConnectionArn (string) --
The ARN of the site-to-site VPN attachment.
{'TransitGatewayRouteTableAttachment': {'Attachment': {'NetworkFunctionGroupName': 'string',
'ProposedNetworkFunctionGroupChange': {'AttachmentPolicyRuleNumber': 'integer',
'NetworkFunctionGroupName': 'string',
'Tags': [{'Key': 'string',
'Value': 'string'}]}}}}
Creates a transit gateway route table attachment.
See also: AWS API Documentation
Request Syntax
client.create_transit_gateway_route_table_attachment(
PeeringId='string',
TransitGatewayRouteTableArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientToken='string'
)
string
[REQUIRED]
The ID of the peer for the
string
[REQUIRED]
The ARN of the transit gateway route table for the attachment request. For example, "TransitGatewayRouteTableArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway-route-table/tgw-rtb-9876543210123456" .
list
The list of key-value tags associated with the request.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
string
The client token associated with the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'TransitGatewayRouteTableAttachment': {
'Attachment': {
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'AttachmentId': 'string',
'OwnerAccountId': 'string',
'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'ProposedNetworkFunctionGroupChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'NetworkFunctionGroupName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
},
'PeeringId': 'string',
'TransitGatewayRouteTableArn': 'string'
}
}
Response Structure
(dict) --
TransitGatewayRouteTableAttachment (dict) --
The route table associated with the create transit gateway route table attachment request.
Attachment (dict) --
Describes a core network attachment.
CoreNetworkId (string) --
The ID of a core network.
CoreNetworkArn (string) --
The ARN of a core network.
AttachmentId (string) --
The ID of the attachment.
OwnerAccountId (string) --
The ID of the attachment account owner.
AttachmentType (string) --
The type of attachment.
State (string) --
The state of the attachment.
EdgeLocation (string) --
The Region where the edge is located.
ResourceArn (string) --
The attachment resource ARN.
AttachmentPolicyRuleNumber (integer) --
The policy rule number associated with the attachment.
SegmentName (string) --
The name of the segment attachment.
NetworkFunctionGroupName (string) --
The name of the network function group.
Tags (list) --
The tags associated with the attachment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
ProposedSegmentChange (dict) --
The attachment to move from one segment to another.
Tags (list) --
The list of key-value tags that changed for the segment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
AttachmentPolicyRuleNumber (integer) --
The rule number in the policy document that applies to this change.
SegmentName (string) --
The name of the segment to change.
ProposedNetworkFunctionGroupChange (dict) --
Describes a proposed change to a network function group associated with the attachment.
Tags (list) --
The list of proposed changes to the key-value tags associated with the network function group.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
AttachmentPolicyRuleNumber (integer) --
The proposed new attachment policy rule number for the network function group.
NetworkFunctionGroupName (string) --
The proposed name change for the network function group name.
CreatedAt (datetime) --
The timestamp when the attachment was created.
UpdatedAt (datetime) --
The timestamp when the attachment was last updated.
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': {'NetworkFunctionGroupName': 'string',
'ProposedNetworkFunctionGroupChange': {'AttachmentPolicyRuleNumber': 'integer',
'NetworkFunctionGroupName': 'string',
'Tags': [{'Key': 'string',
'Value': 'string'}]}}}}
Creates a VPC attachment on an edge location of a core network.
See also: AWS API Documentation
Request Syntax
client.create_vpc_attachment(
CoreNetworkId='string',
VpcArn='string',
SubnetArns=[
'string',
],
Options={
'Ipv6Support': True|False,
'ApplianceModeSupport': True|False
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientToken='string'
)
string
[REQUIRED]
The ID of a core network for the VPC attachment.
string
[REQUIRED]
The ARN of the VPC.
list
[REQUIRED]
The subnet ARN of the VPC attachment.
(string) --
dict
Options for the VPC attachment.
Ipv6Support (boolean) --
Indicates whether IPv6 is supported.
ApplianceModeSupport (boolean) --
Indicates whether appliance mode is supported. If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow. The default value is false .
list
The key-value tags associated with the request.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
string
The client token associated with the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'VpcAttachment': {
'Attachment': {
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'AttachmentId': 'string',
'OwnerAccountId': 'string',
'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'ProposedNetworkFunctionGroupChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'NetworkFunctionGroupName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
},
'SubnetArns': [
'string',
],
'Options': {
'Ipv6Support': True|False,
'ApplianceModeSupport': True|False
}
}
}
Response Structure
(dict) --
VpcAttachment (dict) --
Provides details about the VPC attachment.
Attachment (dict) --
Provides details about the VPC attachment.
CoreNetworkId (string) --
The ID of a core network.
CoreNetworkArn (string) --
The ARN of a core network.
AttachmentId (string) --
The ID of the attachment.
OwnerAccountId (string) --
The ID of the attachment account owner.
AttachmentType (string) --
The type of attachment.
State (string) --
The state of the attachment.
EdgeLocation (string) --
The Region where the edge is located.
ResourceArn (string) --
The attachment resource ARN.
AttachmentPolicyRuleNumber (integer) --
The policy rule number associated with the attachment.
SegmentName (string) --
The name of the segment attachment.
NetworkFunctionGroupName (string) --
The name of the network function group.
Tags (list) --
The tags associated with the attachment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
ProposedSegmentChange (dict) --
The attachment to move from one segment to another.
Tags (list) --
The list of key-value tags that changed for the segment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
AttachmentPolicyRuleNumber (integer) --
The rule number in the policy document that applies to this change.
SegmentName (string) --
The name of the segment to change.
ProposedNetworkFunctionGroupChange (dict) --
Describes a proposed change to a network function group associated with the attachment.
Tags (list) --
The list of proposed changes to the key-value tags associated with the network function group.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
AttachmentPolicyRuleNumber (integer) --
The proposed new attachment policy rule number for the network function group.
NetworkFunctionGroupName (string) --
The proposed name change for the network function group name.
CreatedAt (datetime) --
The timestamp when the attachment was created.
UpdatedAt (datetime) --
The timestamp when the attachment was last updated.
SubnetArns (list) --
The subnet ARNs.
(string) --
Options (dict) --
Provides details about the VPC attachment.
Ipv6Support (boolean) --
Indicates whether IPv6 is supported.
ApplianceModeSupport (boolean) --
Indicates whether appliance mode is supported. If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow. The default value is false .
{'Attachment': {'NetworkFunctionGroupName': 'string',
'ProposedNetworkFunctionGroupChange': {'AttachmentPolicyRuleNumber': 'integer',
'NetworkFunctionGroupName': 'string',
'Tags': [{'Key': 'string',
'Value': 'string'}]}}}
Deletes an attachment. Supports all attachment types.
See also: AWS API Documentation
Request Syntax
client.delete_attachment(
AttachmentId='string'
)
string
[REQUIRED]
The ID of the attachment to delete.
dict
Response Syntax
{
'Attachment': {
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'AttachmentId': 'string',
'OwnerAccountId': 'string',
'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'ProposedNetworkFunctionGroupChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'NetworkFunctionGroupName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Attachment (dict) --
Information about the deleted attachment.
CoreNetworkId (string) --
The ID of a core network.
CoreNetworkArn (string) --
The ARN of a core network.
AttachmentId (string) --
The ID of the attachment.
OwnerAccountId (string) --
The ID of the attachment account owner.
AttachmentType (string) --
The type of attachment.
State (string) --
The state of the attachment.
EdgeLocation (string) --
The Region where the edge is located.
ResourceArn (string) --
The attachment resource ARN.
AttachmentPolicyRuleNumber (integer) --
The policy rule number associated with the attachment.
SegmentName (string) --
The name of the segment attachment.
NetworkFunctionGroupName (string) --
The name of the network function group.
Tags (list) --
The tags associated with the attachment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
ProposedSegmentChange (dict) --
The attachment to move from one segment to another.
Tags (list) --
The list of key-value tags that changed for the segment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
AttachmentPolicyRuleNumber (integer) --
The rule number in the policy document that applies to this change.
SegmentName (string) --
The name of the segment to change.
ProposedNetworkFunctionGroupChange (dict) --
Describes a proposed change to a network function group associated with the attachment.
Tags (list) --
The list of proposed changes to the key-value tags associated with the network function group.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
AttachmentPolicyRuleNumber (integer) --
The proposed new attachment policy rule number for the network function group.
NetworkFunctionGroupName (string) --
The proposed name change for the network function group name.
CreatedAt (datetime) --
The timestamp when the attachment was created.
UpdatedAt (datetime) --
The timestamp when the attachment was last updated.
{'CoreNetwork': {'NetworkFunctionGroups': [{'EdgeLocations': ['string'],
'Name': 'string',
'Segments': {'SendTo': ['string'],
'SendVia': ['string']}}]}}
Deletes a core network along with all core network policies. This can only be done if there are no attachments on a core network.
See also: AWS API Documentation
Request Syntax
client.delete_core_network(
CoreNetworkId='string'
)
string
[REQUIRED]
The network ID of the deleted core network.
dict
Response Syntax
{
'CoreNetwork': {
'GlobalNetworkId': 'string',
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'CREATING'|'UPDATING'|'AVAILABLE'|'DELETING',
'Segments': [
{
'Name': 'string',
'EdgeLocations': [
'string',
],
'SharedSegments': [
'string',
]
},
],
'NetworkFunctionGroups': [
{
'Name': 'string',
'EdgeLocations': [
'string',
],
'Segments': {
'SendVia': [
'string',
],
'SendTo': [
'string',
]
}
},
],
'Edges': [
{
'EdgeLocation': 'string',
'Asn': 123,
'InsideCidrBlocks': [
'string',
]
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
CoreNetwork (dict) --
Information about the deleted core network.
GlobalNetworkId (string) --
The ID of the global network that your core network is a part of.
CoreNetworkId (string) --
The ID of a core network.
CoreNetworkArn (string) --
The ARN of a core network.
Description (string) --
The description of a core network.
CreatedAt (datetime) --
The timestamp when a core network was created.
State (string) --
The current state of a core network.
Segments (list) --
The segments within a core network.
(dict) --
Describes a core network segment, which are dedicated routes. Only attachments within this segment can communicate with each other.
Name (string) --
The name of a core network segment.
EdgeLocations (list) --
The Regions where the edges are located.
(string) --
SharedSegments (list) --
The shared segments of a core network.
(string) --
NetworkFunctionGroups (list) --
The network function groups associated with a core network.
(dict) --
Describes a network function group.
Name (string) --
The name of the network function group.
EdgeLocations (list) --
The core network edge locations.
(string) --
Segments (dict) --
The segments associated with the network function group.
SendVia (list) --
The list of segments associated with the send-via action.
(string) --
SendTo (list) --
The list of segments associated with the send-to action.
(string) --
Edges (list) --
The edges within a core network.
(dict) --
Describes a core network edge.
EdgeLocation (string) --
The Region where a core network edge is located.
Asn (integer) --
The ASN of a core network edge.
InsideCidrBlocks (list) --
The inside IP addresses used for core network edges.
(string) --
Tags (list) --
The list of key-value tags associated with a core network.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
{'ConnectAttachment': {'Attachment': {'NetworkFunctionGroupName': 'string',
'ProposedNetworkFunctionGroupChange': {'AttachmentPolicyRuleNumber': 'integer',
'NetworkFunctionGroupName': 'string',
'Tags': [{'Key': 'string',
'Value': 'string'}]}}}}
Returns information about a core network Connect attachment.
See also: AWS API Documentation
Request Syntax
client.get_connect_attachment(
AttachmentId='string'
)
string
[REQUIRED]
The ID of the attachment.
dict
Response Syntax
{
'ConnectAttachment': {
'Attachment': {
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'AttachmentId': 'string',
'OwnerAccountId': 'string',
'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'ProposedNetworkFunctionGroupChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'NetworkFunctionGroupName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
},
'TransportAttachmentId': 'string',
'Options': {
'Protocol': 'GRE'|'NO_ENCAP'
}
}
}
Response Structure
(dict) --
ConnectAttachment (dict) --
Details about the Connect attachment.
Attachment (dict) --
The attachment details.
CoreNetworkId (string) --
The ID of a core network.
CoreNetworkArn (string) --
The ARN of a core network.
AttachmentId (string) --
The ID of the attachment.
OwnerAccountId (string) --
The ID of the attachment account owner.
AttachmentType (string) --
The type of attachment.
State (string) --
The state of the attachment.
EdgeLocation (string) --
The Region where the edge is located.
ResourceArn (string) --
The attachment resource ARN.
AttachmentPolicyRuleNumber (integer) --
The policy rule number associated with the attachment.
SegmentName (string) --
The name of the segment attachment.
NetworkFunctionGroupName (string) --
The name of the network function group.
Tags (list) --
The tags associated with the attachment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
ProposedSegmentChange (dict) --
The attachment to move from one segment to another.
Tags (list) --
The list of key-value tags that changed for the segment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
AttachmentPolicyRuleNumber (integer) --
The rule number in the policy document that applies to this change.
SegmentName (string) --
The name of the segment to change.
ProposedNetworkFunctionGroupChange (dict) --
Describes a proposed change to a network function group associated with the attachment.
Tags (list) --
The list of proposed changes to the key-value tags associated with the network function group.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
AttachmentPolicyRuleNumber (integer) --
The proposed new attachment policy rule number for the network function group.
NetworkFunctionGroupName (string) --
The proposed name change for the network function group name.
CreatedAt (datetime) --
The timestamp when the attachment was created.
UpdatedAt (datetime) --
The timestamp when the attachment was last updated.
TransportAttachmentId (string) --
The ID of the transport attachment.
Options (dict) --
Options for connecting an attachment.
Protocol (string) --
The protocol used for the attachment connection.
{'CoreNetwork': {'NetworkFunctionGroups': [{'EdgeLocations': ['string'],
'Name': 'string',
'Segments': {'SendTo': ['string'],
'SendVia': ['string']}}]}}
Returns information about the LIVE policy for a core network.
See also: AWS API Documentation
Request Syntax
client.get_core_network(
CoreNetworkId='string'
)
string
[REQUIRED]
The ID of a core network.
dict
Response Syntax
{
'CoreNetwork': {
'GlobalNetworkId': 'string',
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'CREATING'|'UPDATING'|'AVAILABLE'|'DELETING',
'Segments': [
{
'Name': 'string',
'EdgeLocations': [
'string',
],
'SharedSegments': [
'string',
]
},
],
'NetworkFunctionGroups': [
{
'Name': 'string',
'EdgeLocations': [
'string',
],
'Segments': {
'SendVia': [
'string',
],
'SendTo': [
'string',
]
}
},
],
'Edges': [
{
'EdgeLocation': 'string',
'Asn': 123,
'InsideCidrBlocks': [
'string',
]
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
CoreNetwork (dict) --
Details about a core network.
GlobalNetworkId (string) --
The ID of the global network that your core network is a part of.
CoreNetworkId (string) --
The ID of a core network.
CoreNetworkArn (string) --
The ARN of a core network.
Description (string) --
The description of a core network.
CreatedAt (datetime) --
The timestamp when a core network was created.
State (string) --
The current state of a core network.
Segments (list) --
The segments within a core network.
(dict) --
Describes a core network segment, which are dedicated routes. Only attachments within this segment can communicate with each other.
Name (string) --
The name of a core network segment.
EdgeLocations (list) --
The Regions where the edges are located.
(string) --
SharedSegments (list) --
The shared segments of a core network.
(string) --
NetworkFunctionGroups (list) --
The network function groups associated with a core network.
(dict) --
Describes a network function group.
Name (string) --
The name of the network function group.
EdgeLocations (list) --
The core network edge locations.
(string) --
Segments (dict) --
The segments associated with the network function group.
SendVia (list) --
The list of segments associated with the send-via action.
(string) --
SendTo (list) --
The list of segments associated with the send-to action.
(string) --
Edges (list) --
The edges within a core network.
(dict) --
Describes a core network edge.
EdgeLocation (string) --
The Region where a core network edge is located.
Asn (integer) --
The ASN of a core network edge.
InsideCidrBlocks (list) --
The inside IP addresses used for core network edges.
(string) --
Tags (list) --
The list of key-value tags associated with a core network.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
{'CoreNetworkChangeEvents': {'Type': {'NETWORK_FUNCTION_GROUP'},
'Values': {'NetworkFunctionGroupName': 'string'}}}
Returns information about a core network change event.
See also: AWS API Documentation
Request Syntax
client.get_core_network_change_events(
CoreNetworkId='string',
PolicyVersionId=123,
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ID of a core network.
integer
[REQUIRED]
The ID of the policy version.
integer
The maximum number of results to return.
string
The token for the next page of results.
dict
Response Syntax
{
'CoreNetworkChangeEvents': [
{
'Type': 'CORE_NETWORK_SEGMENT'|'NETWORK_FUNCTION_GROUP'|'CORE_NETWORK_EDGE'|'ATTACHMENT_MAPPING'|'ATTACHMENT_ROUTE_PROPAGATION'|'ATTACHMENT_ROUTE_STATIC'|'CORE_NETWORK_CONFIGURATION'|'SEGMENTS_CONFIGURATION'|'SEGMENT_ACTIONS_CONFIGURATION'|'ATTACHMENT_POLICIES_CONFIGURATION',
'Action': 'ADD'|'MODIFY'|'REMOVE',
'IdentifierPath': 'string',
'EventTime': datetime(2015, 1, 1),
'Status': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETE'|'FAILED',
'Values': {
'EdgeLocation': 'string',
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'AttachmentId': 'string',
'Cidr': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
CoreNetworkChangeEvents (list) --
The response to GetCoreNetworkChangeEventsRequest .
(dict) --
Describes a core network change event. This can be a change to a segment, attachment, route, etc.
Type (string) --
Describes the type of change event.
Action (string) --
The action taken for the change event.
IdentifierPath (string) --
Uniquely identifies the path for a change within the changeset. For example, the IdentifierPath for a core network segment change might be "CORE_NETWORK_SEGMENT/us-east-1/devsegment" .
EventTime (datetime) --
The timestamp for an event change in status.
Status (string) --
The status of the core network change event.
Values (dict) --
Details of the change event.
EdgeLocation (string) --
The edge location for the core network change event.
SegmentName (string) --
The segment name if the change event is associated with a segment.
NetworkFunctionGroupName (string) --
The changed network function group name.
AttachmentId (string) --
The ID of the attachment if the change event is associated with an attachment.
Cidr (string) --
For a STATIC_ROUTE event, this is the IP address.
NextToken (string) --
The token for the next page of results.
{'CoreNetworkChanges': {'NewValues': {'NetworkFunctionGroupName': 'string',
'ServiceInsertionActions': [{'Action': 'send-via '
'| '
'send-to',
'Mode': 'dual-hop '
'| '
'single-hop',
'Via': {'NetworkFunctionGroups': [{'Name': 'string'}],
'WithEdgeOverrides': [{'EdgeSets': [['string']],
'UseEdge': 'string'}]},
'WhenSentTo': {'WhenSentToSegmentsList': ['string']}}]},
'PreviousValues': {'NetworkFunctionGroupName': 'string',
'ServiceInsertionActions': [{'Action': 'send-via '
'| '
'send-to',
'Mode': 'dual-hop '
'| '
'single-hop',
'Via': {'NetworkFunctionGroups': [{'Name': 'string'}],
'WithEdgeOverrides': [{'EdgeSets': [['string']],
'UseEdge': 'string'}]},
'WhenSentTo': {'WhenSentToSegmentsList': ['string']}}]},
'Type': {'NETWORK_FUNCTION_GROUP'}}}
Returns a change set between the LIVE core network policy and a submitted policy.
See also: AWS API Documentation
Request Syntax
client.get_core_network_change_set(
CoreNetworkId='string',
PolicyVersionId=123,
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ID of a core network.
integer
[REQUIRED]
The ID of the policy version.
integer
The maximum number of results to return.
string
The token for the next page of results.
dict
Response Syntax
{
'CoreNetworkChanges': [
{
'Type': 'CORE_NETWORK_SEGMENT'|'NETWORK_FUNCTION_GROUP'|'CORE_NETWORK_EDGE'|'ATTACHMENT_MAPPING'|'ATTACHMENT_ROUTE_PROPAGATION'|'ATTACHMENT_ROUTE_STATIC'|'CORE_NETWORK_CONFIGURATION'|'SEGMENTS_CONFIGURATION'|'SEGMENT_ACTIONS_CONFIGURATION'|'ATTACHMENT_POLICIES_CONFIGURATION',
'Action': 'ADD'|'MODIFY'|'REMOVE',
'Identifier': 'string',
'PreviousValues': {
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'EdgeLocations': [
'string',
],
'Asn': 123,
'Cidr': 'string',
'DestinationIdentifier': 'string',
'InsideCidrBlocks': [
'string',
],
'SharedSegments': [
'string',
],
'ServiceInsertionActions': [
{
'Action': 'send-via'|'send-to',
'Mode': 'dual-hop'|'single-hop',
'WhenSentTo': {
'WhenSentToSegmentsList': [
'string',
]
},
'Via': {
'NetworkFunctionGroups': [
{
'Name': 'string'
},
],
'WithEdgeOverrides': [
{
'EdgeSets': [
[
'string',
],
],
'UseEdge': 'string'
},
]
}
},
]
},
'NewValues': {
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'EdgeLocations': [
'string',
],
'Asn': 123,
'Cidr': 'string',
'DestinationIdentifier': 'string',
'InsideCidrBlocks': [
'string',
],
'SharedSegments': [
'string',
],
'ServiceInsertionActions': [
{
'Action': 'send-via'|'send-to',
'Mode': 'dual-hop'|'single-hop',
'WhenSentTo': {
'WhenSentToSegmentsList': [
'string',
]
},
'Via': {
'NetworkFunctionGroups': [
{
'Name': 'string'
},
],
'WithEdgeOverrides': [
{
'EdgeSets': [
[
'string',
],
],
'UseEdge': 'string'
},
]
}
},
]
},
'IdentifierPath': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
CoreNetworkChanges (list) --
Describes a core network changes.
(dict) --
Details describing a core network change.
Type (string) --
The type of change.
Action (string) --
The action to take for a core network.
Identifier (string) --
The resource identifier.
PreviousValues (dict) --
The previous values for a core network.
SegmentName (string) --
The names of the segments in a core network.
NetworkFunctionGroupName (string) --
The network function group name if the change event is associated with a network function group.
EdgeLocations (list) --
The Regions where edges are located in a core network.
(string) --
Asn (integer) --
The ASN of a core network.
Cidr (string) --
The IP addresses used for a core network.
DestinationIdentifier (string) --
The ID of the destination.
InsideCidrBlocks (list) --
The inside IP addresses used for core network change values.
(string) --
SharedSegments (list) --
The shared segments for a core network change value.
(string) --
ServiceInsertionActions (list) --
Describes the service insertion action.
(dict) --
Describes the action that the service insertion will take for any segments associated with it.
Action (string) --
The action the service insertion takes for traffic. send-via sends east-west traffic between attachments. send-to sends north-south traffic to the security appliance, and then from that to either the Internet or to an on-premesis location.
Mode (string) --
Describes the mode packets take for the send-via action. This is not used when the action is send-to . dual-hop packets traverse attachments in both the source to the destination core network edges. This mode requires that an inspection attachment must be present in all Regions of the service insertion-enabled segments. For single-hop , packets traverse a single intermediate inserted attachment. You can use EdgeOverride to specify a specific edge to use.
WhenSentTo (dict) --
The list of destination segments if the service insertion action is send-via .
WhenSentToSegmentsList (list) --
The list of destination segments when the service insertion action is send-to .
(string) --
Via (dict) --
The list of network function groups and any edge overrides for the chosen service insertion action. Used for both send-to or send-via .
NetworkFunctionGroups (list) --
The list of network function groups associated with the service insertion action.
(dict) --
Describes a network function group for service insertion.
Name (string) --
The name of the network function group.
WithEdgeOverrides (list) --
Describes any edge overrides. An edge override is a specific edge to be used for traffic.
(dict) --
Describes the edge that's used for the override.
EdgeSets (list) --
The list of edge locations.
(list) --
(string) --
UseEdge (string) --
The edge that should be used when overriding the current edge order.
NewValues (dict) --
The new value for a core network
SegmentName (string) --
The names of the segments in a core network.
NetworkFunctionGroupName (string) --
The network function group name if the change event is associated with a network function group.
EdgeLocations (list) --
The Regions where edges are located in a core network.
(string) --
Asn (integer) --
The ASN of a core network.
Cidr (string) --
The IP addresses used for a core network.
DestinationIdentifier (string) --
The ID of the destination.
InsideCidrBlocks (list) --
The inside IP addresses used for core network change values.
(string) --
SharedSegments (list) --
The shared segments for a core network change value.
(string) --
ServiceInsertionActions (list) --
Describes the service insertion action.
(dict) --
Describes the action that the service insertion will take for any segments associated with it.
Action (string) --
The action the service insertion takes for traffic. send-via sends east-west traffic between attachments. send-to sends north-south traffic to the security appliance, and then from that to either the Internet or to an on-premesis location.
Mode (string) --
Describes the mode packets take for the send-via action. This is not used when the action is send-to . dual-hop packets traverse attachments in both the source to the destination core network edges. This mode requires that an inspection attachment must be present in all Regions of the service insertion-enabled segments. For single-hop , packets traverse a single intermediate inserted attachment. You can use EdgeOverride to specify a specific edge to use.
WhenSentTo (dict) --
The list of destination segments if the service insertion action is send-via .
WhenSentToSegmentsList (list) --
The list of destination segments when the service insertion action is send-to .
(string) --
Via (dict) --
The list of network function groups and any edge overrides for the chosen service insertion action. Used for both send-to or send-via .
NetworkFunctionGroups (list) --
The list of network function groups associated with the service insertion action.
(dict) --
Describes a network function group for service insertion.
Name (string) --
The name of the network function group.
WithEdgeOverrides (list) --
Describes any edge overrides. An edge override is a specific edge to be used for traffic.
(dict) --
Describes the edge that's used for the override.
EdgeSets (list) --
The list of edge locations.
(list) --
(string) --
UseEdge (string) --
The edge that should be used when overriding the current edge order.
IdentifierPath (string) --
Uniquely identifies the path for a change within the changeset. For example, the IdentifierPath for a core network segment change might be "CORE_NETWORK_SEGMENT/us-east-1/devsegment" .
NextToken (string) --
The token for the next page of results.
{'RouteTableIdentifier': {'CoreNetworkNetworkFunctionGroup': {'CoreNetworkId': 'string',
'EdgeLocation': 'string',
'NetworkFunctionGroupName': 'string'}}}
Response {'NetworkRoutes': {'Destinations': {'NetworkFunctionGroupName': 'string'}},
'RouteTableType': {'NETWORK_FUNCTION_GROUP'}}
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',
],
DestinationFilters={
'string': [
'string',
]
}
)
string
[REQUIRED]
The ID of the global network.
dict
[REQUIRED]
The ID of the route table.
TransitGatewayRouteTableArn (string) --
The ARN of the transit gateway route table 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) --
dict
Response Syntax
{
'RouteTableArn': 'string',
'CoreNetworkSegmentEdge': {
'CoreNetworkId': 'string',
'SegmentName': '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'
},
]
}
Response Structure
(dict) --
RouteTableArn (string) --
The ARN of the route table.
CoreNetworkSegmentEdge (dict) --
Describes a core network segment edge.
CoreNetworkId (string) --
The ID of a core network.
SegmentName (string) --
The name of the segment edge.
EdgeLocation (string) --
The Region where the segment edge is located.
RouteTableType (string) --
The route table type.
RouteTableTimestamp (datetime) --
The route table creation time.
NetworkRoutes (list) --
The network routes.
(dict) --
Describes a network route.
DestinationCidrBlock (string) --
A unique identifier for the route, such as a CIDR block.
Destinations (list) --
The destinations.
(dict) --
Describes the destination of a network route.
CoreNetworkAttachmentId (string) --
The ID of a core network attachment.
TransitGatewayAttachmentId (string) --
The ID of the transit gateway attachment.
SegmentName (string) --
The name of the segment.
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 and static .
{'SiteToSiteVpnAttachment': {'Attachment': {'NetworkFunctionGroupName': 'string',
'ProposedNetworkFunctionGroupChange': {'AttachmentPolicyRuleNumber': 'integer',
'NetworkFunctionGroupName': 'string',
'Tags': [{'Key': 'string',
'Value': 'string'}]}}}}
Returns information about a site-to-site VPN attachment.
See also: AWS API Documentation
Request Syntax
client.get_site_to_site_vpn_attachment(
AttachmentId='string'
)
string
[REQUIRED]
The ID of the attachment.
dict
Response Syntax
{
'SiteToSiteVpnAttachment': {
'Attachment': {
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'AttachmentId': 'string',
'OwnerAccountId': 'string',
'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'ProposedNetworkFunctionGroupChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'NetworkFunctionGroupName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
},
'VpnConnectionArn': 'string'
}
}
Response Structure
(dict) --
SiteToSiteVpnAttachment (dict) --
Describes the site-to-site attachment.
Attachment (dict) --
Provides details about a site-to-site VPN attachment.
CoreNetworkId (string) --
The ID of a core network.
CoreNetworkArn (string) --
The ARN of a core network.
AttachmentId (string) --
The ID of the attachment.
OwnerAccountId (string) --
The ID of the attachment account owner.
AttachmentType (string) --
The type of attachment.
State (string) --
The state of the attachment.
EdgeLocation (string) --
The Region where the edge is located.
ResourceArn (string) --
The attachment resource ARN.
AttachmentPolicyRuleNumber (integer) --
The policy rule number associated with the attachment.
SegmentName (string) --
The name of the segment attachment.
NetworkFunctionGroupName (string) --
The name of the network function group.
Tags (list) --
The tags associated with the attachment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
ProposedSegmentChange (dict) --
The attachment to move from one segment to another.
Tags (list) --
The list of key-value tags that changed for the segment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
AttachmentPolicyRuleNumber (integer) --
The rule number in the policy document that applies to this change.
SegmentName (string) --
The name of the segment to change.
ProposedNetworkFunctionGroupChange (dict) --
Describes a proposed change to a network function group associated with the attachment.
Tags (list) --
The list of proposed changes to the key-value tags associated with the network function group.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
AttachmentPolicyRuleNumber (integer) --
The proposed new attachment policy rule number for the network function group.
NetworkFunctionGroupName (string) --
The proposed name change for the network function group name.
CreatedAt (datetime) --
The timestamp when the attachment was created.
UpdatedAt (datetime) --
The timestamp when the attachment was last updated.
VpnConnectionArn (string) --
The ARN of the site-to-site VPN attachment.
{'TransitGatewayRouteTableAttachment': {'Attachment': {'NetworkFunctionGroupName': 'string',
'ProposedNetworkFunctionGroupChange': {'AttachmentPolicyRuleNumber': 'integer',
'NetworkFunctionGroupName': 'string',
'Tags': [{'Key': 'string',
'Value': 'string'}]}}}}
Returns information about a transit gateway route table attachment.
See also: AWS API Documentation
Request Syntax
client.get_transit_gateway_route_table_attachment(
AttachmentId='string'
)
string
[REQUIRED]
The ID of the transit gateway route table attachment.
dict
Response Syntax
{
'TransitGatewayRouteTableAttachment': {
'Attachment': {
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'AttachmentId': 'string',
'OwnerAccountId': 'string',
'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'ProposedNetworkFunctionGroupChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'NetworkFunctionGroupName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
},
'PeeringId': 'string',
'TransitGatewayRouteTableArn': 'string'
}
}
Response Structure
(dict) --
TransitGatewayRouteTableAttachment (dict) --
Returns information about the transit gateway route table attachment.
Attachment (dict) --
Describes a core network attachment.
CoreNetworkId (string) --
The ID of a core network.
CoreNetworkArn (string) --
The ARN of a core network.
AttachmentId (string) --
The ID of the attachment.
OwnerAccountId (string) --
The ID of the attachment account owner.
AttachmentType (string) --
The type of attachment.
State (string) --
The state of the attachment.
EdgeLocation (string) --
The Region where the edge is located.
ResourceArn (string) --
The attachment resource ARN.
AttachmentPolicyRuleNumber (integer) --
The policy rule number associated with the attachment.
SegmentName (string) --
The name of the segment attachment.
NetworkFunctionGroupName (string) --
The name of the network function group.
Tags (list) --
The tags associated with the attachment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
ProposedSegmentChange (dict) --
The attachment to move from one segment to another.
Tags (list) --
The list of key-value tags that changed for the segment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
AttachmentPolicyRuleNumber (integer) --
The rule number in the policy document that applies to this change.
SegmentName (string) --
The name of the segment to change.
ProposedNetworkFunctionGroupChange (dict) --
Describes a proposed change to a network function group associated with the attachment.
Tags (list) --
The list of proposed changes to the key-value tags associated with the network function group.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
AttachmentPolicyRuleNumber (integer) --
The proposed new attachment policy rule number for the network function group.
NetworkFunctionGroupName (string) --
The proposed name change for the network function group name.
CreatedAt (datetime) --
The timestamp when the attachment was created.
UpdatedAt (datetime) --
The timestamp when the attachment was last updated.
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': {'NetworkFunctionGroupName': 'string',
'ProposedNetworkFunctionGroupChange': {'AttachmentPolicyRuleNumber': 'integer',
'NetworkFunctionGroupName': 'string',
'Tags': [{'Key': 'string',
'Value': 'string'}]}}}}
Returns information about a VPC attachment.
See also: AWS API Documentation
Request Syntax
client.get_vpc_attachment(
AttachmentId='string'
)
string
[REQUIRED]
The ID of the attachment.
dict
Response Syntax
{
'VpcAttachment': {
'Attachment': {
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'AttachmentId': 'string',
'OwnerAccountId': 'string',
'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'ProposedNetworkFunctionGroupChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'NetworkFunctionGroupName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
},
'SubnetArns': [
'string',
],
'Options': {
'Ipv6Support': True|False,
'ApplianceModeSupport': True|False
}
}
}
Response Structure
(dict) --
VpcAttachment (dict) --
Returns details about a VPC attachment.
Attachment (dict) --
Provides details about the VPC attachment.
CoreNetworkId (string) --
The ID of a core network.
CoreNetworkArn (string) --
The ARN of a core network.
AttachmentId (string) --
The ID of the attachment.
OwnerAccountId (string) --
The ID of the attachment account owner.
AttachmentType (string) --
The type of attachment.
State (string) --
The state of the attachment.
EdgeLocation (string) --
The Region where the edge is located.
ResourceArn (string) --
The attachment resource ARN.
AttachmentPolicyRuleNumber (integer) --
The policy rule number associated with the attachment.
SegmentName (string) --
The name of the segment attachment.
NetworkFunctionGroupName (string) --
The name of the network function group.
Tags (list) --
The tags associated with the attachment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
ProposedSegmentChange (dict) --
The attachment to move from one segment to another.
Tags (list) --
The list of key-value tags that changed for the segment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
AttachmentPolicyRuleNumber (integer) --
The rule number in the policy document that applies to this change.
SegmentName (string) --
The name of the segment to change.
ProposedNetworkFunctionGroupChange (dict) --
Describes a proposed change to a network function group associated with the attachment.
Tags (list) --
The list of proposed changes to the key-value tags associated with the network function group.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
AttachmentPolicyRuleNumber (integer) --
The proposed new attachment policy rule number for the network function group.
NetworkFunctionGroupName (string) --
The proposed name change for the network function group name.
CreatedAt (datetime) --
The timestamp when the attachment was created.
UpdatedAt (datetime) --
The timestamp when the attachment was last updated.
SubnetArns (list) --
The subnet ARNs.
(string) --
Options (dict) --
Provides details about the VPC attachment.
Ipv6Support (boolean) --
Indicates whether IPv6 is supported.
ApplianceModeSupport (boolean) --
Indicates whether appliance mode is supported. If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow. The default value is false .
{'Attachments': {'NetworkFunctionGroupName': 'string',
'ProposedNetworkFunctionGroupChange': {'AttachmentPolicyRuleNumber': 'integer',
'NetworkFunctionGroupName': 'string',
'Tags': [{'Key': 'string',
'Value': 'string'}]}}}
Returns a list of core network attachments.
See also: AWS API Documentation
Request Syntax
client.list_attachments(
CoreNetworkId='string',
AttachmentType='CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'TRANSIT_GATEWAY_ROUTE_TABLE',
EdgeLocation='string',
State='REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
MaxResults=123,
NextToken='string'
)
string
The ID of a core network.
string
The type of attachment.
string
The Region where the edge is located.
string
The state of the attachment.
integer
The maximum number of results to return.
string
The token for the next page of results.
dict
Response Syntax
{
'Attachments': [
{
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'AttachmentId': 'string',
'OwnerAccountId': 'string',
'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'ProposedNetworkFunctionGroupChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'NetworkFunctionGroupName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Attachments (list) --
Describes the list of attachments.
(dict) --
Describes a core network attachment.
CoreNetworkId (string) --
The ID of a core network.
CoreNetworkArn (string) --
The ARN of a core network.
AttachmentId (string) --
The ID of the attachment.
OwnerAccountId (string) --
The ID of the attachment account owner.
AttachmentType (string) --
The type of attachment.
State (string) --
The state of the attachment.
EdgeLocation (string) --
The Region where the edge is located.
ResourceArn (string) --
The attachment resource ARN.
AttachmentPolicyRuleNumber (integer) --
The policy rule number associated with the attachment.
SegmentName (string) --
The name of the segment attachment.
NetworkFunctionGroupName (string) --
The name of the network function group.
Tags (list) --
The tags associated with the attachment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
ProposedSegmentChange (dict) --
The attachment to move from one segment to another.
Tags (list) --
The list of key-value tags that changed for the segment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
AttachmentPolicyRuleNumber (integer) --
The rule number in the policy document that applies to this change.
SegmentName (string) --
The name of the segment to change.
ProposedNetworkFunctionGroupChange (dict) --
Describes a proposed change to a network function group associated with the attachment.
Tags (list) --
The list of proposed changes to the key-value tags associated with the network function group.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
AttachmentPolicyRuleNumber (integer) --
The proposed new attachment policy rule number for the network function group.
NetworkFunctionGroupName (string) --
The proposed name change for the network function group name.
CreatedAt (datetime) --
The timestamp when the attachment was created.
UpdatedAt (datetime) --
The timestamp when the attachment was last updated.
NextToken (string) --
The token for the next page of results.
{'Attachment': {'NetworkFunctionGroupName': 'string',
'ProposedNetworkFunctionGroupChange': {'AttachmentPolicyRuleNumber': 'integer',
'NetworkFunctionGroupName': 'string',
'Tags': [{'Key': 'string',
'Value': 'string'}]}}}
Rejects a core network attachment request.
See also: AWS API Documentation
Request Syntax
client.reject_attachment(
AttachmentId='string'
)
string
[REQUIRED]
The ID of the attachment.
dict
Response Syntax
{
'Attachment': {
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'AttachmentId': 'string',
'OwnerAccountId': 'string',
'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'ProposedNetworkFunctionGroupChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'NetworkFunctionGroupName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Attachment (dict) --
Describes the rejected attachment request.
CoreNetworkId (string) --
The ID of a core network.
CoreNetworkArn (string) --
The ARN of a core network.
AttachmentId (string) --
The ID of the attachment.
OwnerAccountId (string) --
The ID of the attachment account owner.
AttachmentType (string) --
The type of attachment.
State (string) --
The state of the attachment.
EdgeLocation (string) --
The Region where the edge is located.
ResourceArn (string) --
The attachment resource ARN.
AttachmentPolicyRuleNumber (integer) --
The policy rule number associated with the attachment.
SegmentName (string) --
The name of the segment attachment.
NetworkFunctionGroupName (string) --
The name of the network function group.
Tags (list) --
The tags associated with the attachment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
ProposedSegmentChange (dict) --
The attachment to move from one segment to another.
Tags (list) --
The list of key-value tags that changed for the segment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
AttachmentPolicyRuleNumber (integer) --
The rule number in the policy document that applies to this change.
SegmentName (string) --
The name of the segment to change.
ProposedNetworkFunctionGroupChange (dict) --
Describes a proposed change to a network function group associated with the attachment.
Tags (list) --
The list of proposed changes to the key-value tags associated with the network function group.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
AttachmentPolicyRuleNumber (integer) --
The proposed new attachment policy rule number for the network function group.
NetworkFunctionGroupName (string) --
The proposed name change for the network function group name.
CreatedAt (datetime) --
The timestamp when the attachment was created.
UpdatedAt (datetime) --
The timestamp when the attachment was last updated.
{'CoreNetwork': {'NetworkFunctionGroups': [{'EdgeLocations': ['string'],
'Name': 'string',
'Segments': {'SendTo': ['string'],
'SendVia': ['string']}}]}}
Updates the description of a core network.
See also: AWS API Documentation
Request Syntax
client.update_core_network(
CoreNetworkId='string',
Description='string'
)
string
[REQUIRED]
The ID of a core network.
string
The description of the update.
dict
Response Syntax
{
'CoreNetwork': {
'GlobalNetworkId': 'string',
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'CREATING'|'UPDATING'|'AVAILABLE'|'DELETING',
'Segments': [
{
'Name': 'string',
'EdgeLocations': [
'string',
],
'SharedSegments': [
'string',
]
},
],
'NetworkFunctionGroups': [
{
'Name': 'string',
'EdgeLocations': [
'string',
],
'Segments': {
'SendVia': [
'string',
],
'SendTo': [
'string',
]
}
},
],
'Edges': [
{
'EdgeLocation': 'string',
'Asn': 123,
'InsideCidrBlocks': [
'string',
]
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
CoreNetwork (dict) --
Returns information about a core network update.
GlobalNetworkId (string) --
The ID of the global network that your core network is a part of.
CoreNetworkId (string) --
The ID of a core network.
CoreNetworkArn (string) --
The ARN of a core network.
Description (string) --
The description of a core network.
CreatedAt (datetime) --
The timestamp when a core network was created.
State (string) --
The current state of a core network.
Segments (list) --
The segments within a core network.
(dict) --
Describes a core network segment, which are dedicated routes. Only attachments within this segment can communicate with each other.
Name (string) --
The name of a core network segment.
EdgeLocations (list) --
The Regions where the edges are located.
(string) --
SharedSegments (list) --
The shared segments of a core network.
(string) --
NetworkFunctionGroups (list) --
The network function groups associated with a core network.
(dict) --
Describes a network function group.
Name (string) --
The name of the network function group.
EdgeLocations (list) --
The core network edge locations.
(string) --
Segments (dict) --
The segments associated with the network function group.
SendVia (list) --
The list of segments associated with the send-via action.
(string) --
SendTo (list) --
The list of segments associated with the send-to action.
(string) --
Edges (list) --
The edges within a core network.
(dict) --
Describes a core network edge.
EdgeLocation (string) --
The Region where a core network edge is located.
Asn (integer) --
The ASN of a core network edge.
InsideCidrBlocks (list) --
The inside IP addresses used for core network edges.
(string) --
Tags (list) --
The list of key-value tags associated with a core network.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
{'VpcAttachment': {'Attachment': {'NetworkFunctionGroupName': 'string',
'ProposedNetworkFunctionGroupChange': {'AttachmentPolicyRuleNumber': 'integer',
'NetworkFunctionGroupName': 'string',
'Tags': [{'Key': 'string',
'Value': 'string'}]}}}}
Updates a VPC attachment.
See also: AWS API Documentation
Request Syntax
client.update_vpc_attachment(
AttachmentId='string',
AddSubnetArns=[
'string',
],
RemoveSubnetArns=[
'string',
],
Options={
'Ipv6Support': True|False,
'ApplianceModeSupport': True|False
}
)
string
[REQUIRED]
The ID of the attachment.
list
Adds a subnet ARN to the VPC attachment.
(string) --
list
Removes a subnet ARN from the attachment.
(string) --
dict
Additional options for updating the VPC attachment.
Ipv6Support (boolean) --
Indicates whether IPv6 is supported.
ApplianceModeSupport (boolean) --
Indicates whether appliance mode is supported. If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow. The default value is false .
dict
Response Syntax
{
'VpcAttachment': {
'Attachment': {
'CoreNetworkId': 'string',
'CoreNetworkArn': 'string',
'AttachmentId': 'string',
'OwnerAccountId': 'string',
'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'TRANSIT_GATEWAY_ROUTE_TABLE',
'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
'EdgeLocation': 'string',
'ResourceArn': 'string',
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string',
'NetworkFunctionGroupName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProposedSegmentChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'SegmentName': 'string'
},
'ProposedNetworkFunctionGroupChange': {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AttachmentPolicyRuleNumber': 123,
'NetworkFunctionGroupName': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
},
'SubnetArns': [
'string',
],
'Options': {
'Ipv6Support': True|False,
'ApplianceModeSupport': True|False
}
}
}
Response Structure
(dict) --
VpcAttachment (dict) --
Describes the updated VPC attachment.
Attachment (dict) --
Provides details about the VPC attachment.
CoreNetworkId (string) --
The ID of a core network.
CoreNetworkArn (string) --
The ARN of a core network.
AttachmentId (string) --
The ID of the attachment.
OwnerAccountId (string) --
The ID of the attachment account owner.
AttachmentType (string) --
The type of attachment.
State (string) --
The state of the attachment.
EdgeLocation (string) --
The Region where the edge is located.
ResourceArn (string) --
The attachment resource ARN.
AttachmentPolicyRuleNumber (integer) --
The policy rule number associated with the attachment.
SegmentName (string) --
The name of the segment attachment.
NetworkFunctionGroupName (string) --
The name of the network function group.
Tags (list) --
The tags associated with the attachment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
ProposedSegmentChange (dict) --
The attachment to move from one segment to another.
Tags (list) --
The list of key-value tags that changed for the segment.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
AttachmentPolicyRuleNumber (integer) --
The rule number in the policy document that applies to this change.
SegmentName (string) --
The name of the segment to change.
ProposedNetworkFunctionGroupChange (dict) --
Describes a proposed change to a network function group associated with the attachment.
Tags (list) --
The list of proposed changes to the key-value tags associated with the network function group.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
AttachmentPolicyRuleNumber (integer) --
The proposed new attachment policy rule number for the network function group.
NetworkFunctionGroupName (string) --
The proposed name change for the network function group name.
CreatedAt (datetime) --
The timestamp when the attachment was created.
UpdatedAt (datetime) --
The timestamp when the attachment was last updated.
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 .