2026/11/17 - Amazon Elastic Compute Cloud - 1 new 18 updated api methods
Changes Adds multipath resilience for inter-Region VPC peering connections and Transit Gateway peering attachments. Adds support for quantum-resistant key exchanges to Site-to-Site VPN. Allows querying multiple instance types in a single DescribeCapacityBlockOfferings request.
Modifies the options for a transit gateway peering attachment. The peering attachment must be in the available state.
You can allow multipath resilience for your side of an inter-Region transit gateway peering attachment between supported Regions. Multipath resilience isn't supported for transit gateway peering attachments in the same Region. It takes effect only when both the requester and the accepter allow it. To modify the requester side, send the request in the Region of the requester transit gateway. To modify the accepter side, send the request in the Region of the accepter transit gateway. To check whether multipath resilience is in effect, use DescribeTransitGatewayPeeringAttachments and check multipathResilienceStatus.
See also: AWS API Documentation
Request Syntax
client.modify_transit_gateway_peering_attachment(
TransitGatewayAttachmentId='string',
Options={
'AllowMultipathResilience': True|False,
'MultipathResilienceMode': 'always-on'
},
DryRun=True|False
)
string
[REQUIRED]
The ID of the transit gateway peering attachment.
dict
The options to modify for the transit gateway peering attachment.
AllowMultipathResilience (boolean) --
Specifies whether you allow multipath resilience for your side of the transit gateway peering attachment. Multipath resilience is supported only for inter-Region transit gateway peering attachments between supported Regions. It takes effect only when both the requester and the accepter allow it. If you don't specify this parameter, the current setting doesn't change.
MultipathResilienceMode (string) --
The multipath resilience mode. You can specify this parameter only if AllowMultipathResilience is true.
The following value is valid:
always-on – Replicates traffic across multiple network paths while multipath resilience is in effect.
If AllowMultipathResilience is true and you don't specify a mode, the default is always-on.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'TransitGatewayPeeringAttachment': {
'TransitGatewayAttachmentId': 'string',
'AccepterTransitGatewayAttachmentId': 'string',
'RequesterTgwInfo': {
'TransitGatewayId': 'string',
'CoreNetworkId': 'string',
'OwnerId': 'string',
'Region': 'string'
},
'AccepterTgwInfo': {
'TransitGatewayId': 'string',
'CoreNetworkId': 'string',
'OwnerId': 'string',
'Region': 'string'
},
'Options': {
'DynamicRouting': 'enable'|'disable',
'RequesterAllowMultipathResilience': True|False,
'RequesterMultipathResilienceMode': 'always-on',
'AccepterAllowMultipathResilience': True|False,
'AccepterMultipathResilienceMode': 'always-on',
'MultipathResilienceStatus': 'pending'|'enabled'|'disabled'
},
'Status': {
'Code': 'string',
'Message': 'string'
},
'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
'CreationTime': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
TransitGatewayPeeringAttachment (dict) --
Information about the transit gateway peering attachment.
TransitGatewayAttachmentId (string) --
The ID of the transit gateway peering attachment.
AccepterTransitGatewayAttachmentId (string) --
The ID of the accepter transit gateway attachment.
RequesterTgwInfo (dict) --
Information about the requester transit gateway.
TransitGatewayId (string) --
The ID of the transit gateway.
CoreNetworkId (string) --
The ID of the core network where the transit gateway peer is located.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the transit gateway.
Region (string) --
The Region of the transit gateway.
AccepterTgwInfo (dict) --
Information about the accepter transit gateway.
TransitGatewayId (string) --
The ID of the transit gateway.
CoreNetworkId (string) --
The ID of the core network where the transit gateway peer is located.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the transit gateway.
Region (string) --
The Region of the transit gateway.
Options (dict) --
Details about the transit gateway peering attachment.
DynamicRouting (string) --
Describes whether dynamic routing is enabled or disabled for the transit gateway peering attachment.
RequesterAllowMultipathResilience (boolean) --
Indicates whether the requester allows multipath resilience for the transit gateway peering attachment.
RequesterMultipathResilienceMode (string) --
The multipath resilience mode for the requester. This value is present only when the requester allows multipath resilience.
AccepterAllowMultipathResilience (boolean) --
Indicates whether the accepter allows multipath resilience for the transit gateway peering attachment.
AccepterMultipathResilienceMode (string) --
The multipath resilience mode for the accepter. This value is present only when the accepter allows multipath resilience.
MultipathResilienceStatus (string) --
The multipath resilience status of the transit gateway peering attachment. The possible values are:
enabled – Both the requester and the accepter allow multipath resilience.
pending – Either the requester or the accepter allows multipath resilience, but not both.
disabled – Neither the requester nor the accepter allows multipath resilience.
Status (dict) --
The status of the transit gateway peering attachment.
Code (string) --
The status code.
Message (string) --
The status message, if applicable.
State (string) --
The state of the transit gateway peering attachment. Note that the initiating state has been deprecated.
CreationTime (datetime) --
The time the transit gateway peering attachment was created.
Tags (list) --
The tags for the transit gateway peering attachment.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
{'TransitGatewayPeeringAttachment': {'Options': {'AccepterAllowMultipathResilience': 'boolean',
'AccepterMultipathResilienceMode': 'always-on',
'MultipathResilienceStatus': 'pending '
'| '
'enabled '
'| '
'disabled',
'RequesterAllowMultipathResilience': 'boolean',
'RequesterMultipathResilienceMode': 'always-on'}}}
Accepts a transit gateway peering attachment request. The peering attachment must be in the pendingAcceptance state.
See also: AWS API Documentation
Request Syntax
client.accept_transit_gateway_peering_attachment(
TransitGatewayAttachmentId='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the transit gateway attachment.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'TransitGatewayPeeringAttachment': {
'TransitGatewayAttachmentId': 'string',
'AccepterTransitGatewayAttachmentId': 'string',
'RequesterTgwInfo': {
'TransitGatewayId': 'string',
'CoreNetworkId': 'string',
'OwnerId': 'string',
'Region': 'string'
},
'AccepterTgwInfo': {
'TransitGatewayId': 'string',
'CoreNetworkId': 'string',
'OwnerId': 'string',
'Region': 'string'
},
'Options': {
'DynamicRouting': 'enable'|'disable',
'RequesterAllowMultipathResilience': True|False,
'RequesterMultipathResilienceMode': 'always-on',
'AccepterAllowMultipathResilience': True|False,
'AccepterMultipathResilienceMode': 'always-on',
'MultipathResilienceStatus': 'pending'|'enabled'|'disabled'
},
'Status': {
'Code': 'string',
'Message': 'string'
},
'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
'CreationTime': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
TransitGatewayPeeringAttachment (dict) --
The transit gateway peering attachment.
TransitGatewayAttachmentId (string) --
The ID of the transit gateway peering attachment.
AccepterTransitGatewayAttachmentId (string) --
The ID of the accepter transit gateway attachment.
RequesterTgwInfo (dict) --
Information about the requester transit gateway.
TransitGatewayId (string) --
The ID of the transit gateway.
CoreNetworkId (string) --
The ID of the core network where the transit gateway peer is located.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the transit gateway.
Region (string) --
The Region of the transit gateway.
AccepterTgwInfo (dict) --
Information about the accepter transit gateway.
TransitGatewayId (string) --
The ID of the transit gateway.
CoreNetworkId (string) --
The ID of the core network where the transit gateway peer is located.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the transit gateway.
Region (string) --
The Region of the transit gateway.
Options (dict) --
Details about the transit gateway peering attachment.
DynamicRouting (string) --
Describes whether dynamic routing is enabled or disabled for the transit gateway peering attachment.
RequesterAllowMultipathResilience (boolean) --
Indicates whether the requester allows multipath resilience for the transit gateway peering attachment.
RequesterMultipathResilienceMode (string) --
The multipath resilience mode for the requester. This value is present only when the requester allows multipath resilience.
AccepterAllowMultipathResilience (boolean) --
Indicates whether the accepter allows multipath resilience for the transit gateway peering attachment.
AccepterMultipathResilienceMode (string) --
The multipath resilience mode for the accepter. This value is present only when the accepter allows multipath resilience.
MultipathResilienceStatus (string) --
The multipath resilience status of the transit gateway peering attachment. The possible values are:
enabled – Both the requester and the accepter allow multipath resilience.
pending – Either the requester or the accepter allows multipath resilience, but not both.
disabled – Neither the requester nor the accepter allows multipath resilience.
Status (dict) --
The status of the transit gateway peering attachment.
Code (string) --
The status code.
Message (string) --
The status message, if applicable.
State (string) --
The state of the transit gateway peering attachment. Note that the initiating state has been deprecated.
CreationTime (datetime) --
The time the transit gateway peering attachment was created.
Tags (list) --
The tags for the transit gateway peering attachment.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
{'VpcPeeringConnection': {'AccepterVpcInfo': {'PeeringOptions': {'AllowMultipathResilience': 'boolean',
'MultipathResilienceMode': 'always-on'}},
'MultipathResilienceStatus': 'pending | enabled | '
'disabled',
'RequesterVpcInfo': {'PeeringOptions': {'AllowMultipathResilience': 'boolean',
'MultipathResilienceMode': 'always-on'}}}}
Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use DescribeVpcPeeringConnections to view your outstanding VPC peering connection requests.
For an inter-Region VPC peering connection request, you must accept the VPC peering connection in the Region of the accepter VPC.
If the requester allows multipath resilience, accepting the request also allows multipath resilience for the accepter VPC, and the multipathResilienceStatus of the VPC peering connection becomes enabled. Additional charges apply. For more information, see Amazon VPC pricing. To stop allowing multipath resilience for the accepter VPC, use ModifyVpcPeeringConnectionOptions and set AllowMultipathResilience to false.
See also: AWS API Documentation
Request Syntax
client.accept_vpc_peering_connection(
DryRun=True|False,
VpcPeeringConnectionId='string'
)
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
string
[REQUIRED]
The ID of the VPC peering connection. You must specify this parameter in the request.
dict
Response Syntax
{
'VpcPeeringConnection': {
'AccepterVpcInfo': {
'CidrBlock': 'string',
'Ipv6CidrBlockSet': [
{
'Ipv6CidrBlock': 'string'
},
],
'CidrBlockSet': [
{
'CidrBlock': 'string'
},
],
'OwnerId': 'string',
'PeeringOptions': {
'AllowDnsResolutionFromRemoteVpc': True|False,
'AllowEgressFromLocalClassicLinkToRemoteVpc': True|False,
'AllowEgressFromLocalVpcToRemoteClassicLink': True|False,
'AllowMultipathResilience': True|False,
'MultipathResilienceMode': 'always-on'
},
'VpcId': 'string',
'Region': 'string'
},
'ExpirationTime': datetime(2015, 1, 1),
'RequesterVpcInfo': {
'CidrBlock': 'string',
'Ipv6CidrBlockSet': [
{
'Ipv6CidrBlock': 'string'
},
],
'CidrBlockSet': [
{
'CidrBlock': 'string'
},
],
'OwnerId': 'string',
'PeeringOptions': {
'AllowDnsResolutionFromRemoteVpc': True|False,
'AllowEgressFromLocalClassicLinkToRemoteVpc': True|False,
'AllowEgressFromLocalVpcToRemoteClassicLink': True|False,
'AllowMultipathResilience': True|False,
'MultipathResilienceMode': 'always-on'
},
'VpcId': 'string',
'Region': 'string'
},
'Status': {
'Code': 'initiating-request'|'pending-acceptance'|'active'|'deleted'|'rejected'|'failed'|'expired'|'provisioning'|'deleting',
'Message': 'string'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VpcPeeringConnectionId': 'string',
'MultipathResilienceStatus': 'pending'|'enabled'|'disabled'
}
}
Response Structure
(dict) --
VpcPeeringConnection (dict) --
Information about the VPC peering connection.
AccepterVpcInfo (dict) --
Information about the accepter VPC. CIDR block information is only returned when describing an active VPC peering connection.
CidrBlock (string) --
The IPv4 CIDR block for the VPC.
Ipv6CidrBlockSet (list) --
The IPv6 CIDR block for the VPC.
(dict) --
Describes an IPv6 CIDR block.
Ipv6CidrBlock (string) --
The IPv6 CIDR block.
CidrBlockSet (list) --
Information about the IPv4 CIDR blocks for the VPC.
(dict) --
Describes an IPv4 CIDR block.
CidrBlock (string) --
The IPv4 CIDR block.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the VPC.
PeeringOptions (dict) --
Information about the VPC peering connection options for the accepter or requester VPC.
AllowDnsResolutionFromRemoteVpc (boolean) --
Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.
AllowEgressFromLocalClassicLinkToRemoteVpc (boolean) --
Deprecated.
AllowEgressFromLocalVpcToRemoteClassicLink (boolean) --
Deprecated.
AllowMultipathResilience (boolean) --
Indicates whether this side of the VPC peering connection allows multipath resilience.
MultipathResilienceMode (string) --
The multipath resilience mode for this side of the VPC peering connection. This value is present only when this side allows multipath resilience.
VpcId (string) --
The ID of the VPC.
Region (string) --
The Region in which the VPC is located.
ExpirationTime (datetime) --
The time that an unaccepted VPC peering connection will expire.
RequesterVpcInfo (dict) --
Information about the requester VPC. CIDR block information is only returned when describing an active VPC peering connection.
CidrBlock (string) --
The IPv4 CIDR block for the VPC.
Ipv6CidrBlockSet (list) --
The IPv6 CIDR block for the VPC.
(dict) --
Describes an IPv6 CIDR block.
Ipv6CidrBlock (string) --
The IPv6 CIDR block.
CidrBlockSet (list) --
Information about the IPv4 CIDR blocks for the VPC.
(dict) --
Describes an IPv4 CIDR block.
CidrBlock (string) --
The IPv4 CIDR block.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the VPC.
PeeringOptions (dict) --
Information about the VPC peering connection options for the accepter or requester VPC.
AllowDnsResolutionFromRemoteVpc (boolean) --
Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.
AllowEgressFromLocalClassicLinkToRemoteVpc (boolean) --
Deprecated.
AllowEgressFromLocalVpcToRemoteClassicLink (boolean) --
Deprecated.
AllowMultipathResilience (boolean) --
Indicates whether this side of the VPC peering connection allows multipath resilience.
MultipathResilienceMode (string) --
The multipath resilience mode for this side of the VPC peering connection. This value is present only when this side allows multipath resilience.
VpcId (string) --
The ID of the VPC.
Region (string) --
The Region in which the VPC is located.
Status (dict) --
The status of the VPC peering connection.
Code (string) --
The status of the VPC peering connection.
Message (string) --
A message that provides more information about the status, if applicable.
Tags (list) --
Any tags assigned to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
VpcPeeringConnectionId (string) --
The ID of the VPC peering connection.
MultipathResilienceStatus (string) --
The multipath resilience status of the VPC peering connection. The possible values are:
enabled – Both the requester and the accepter allow multipath resilience.
pending – Either the requester or the accepter allows multipath resilience, but not both.
disabled – Neither the requester nor the accepter allows multipath resilience.
{'Options': {'AllowMultipathResilience': 'boolean',
'MultipathResilienceMode': 'always-on'}}
Response {'TransitGatewayPeeringAttachment': {'Options': {'AccepterAllowMultipathResilience': 'boolean',
'AccepterMultipathResilienceMode': 'always-on',
'MultipathResilienceStatus': 'pending '
'| '
'enabled '
'| '
'disabled',
'RequesterAllowMultipathResilience': 'boolean',
'RequesterMultipathResilienceMode': 'always-on'}}}
Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter). The peer transit gateway can be in your account or a different Amazon Web Services account.
After you create the peering attachment, the owner of the accepter transit gateway must accept the attachment request.
See also: AWS API Documentation
Request Syntax
client.create_transit_gateway_peering_attachment(
TransitGatewayId='string',
PeerTransitGatewayId='string',
PeerAccountId='string',
PeerRegion='string',
Options={
'DynamicRouting': 'enable'|'disable',
'AllowMultipathResilience': True|False,
'MultipathResilienceMode': 'always-on'
},
TagSpecifications=[
{
'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fca-policy'|'fleet'|'fpga-image'|'host-reservation'|'image'|'image-usage-report'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-metering-policy'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'vpc-encryption-control'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task'|'ipam-prefix-list-resolver'|'ipam-policy'|'ipam-prefix-list-resolver-target'|'ipam-internet-registry-association'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator'|'ipam-pool-allocation'|'capacity-reservation-cancellation-quote'|'application-status-check'|'capacity-reservation-modification-quote'|'metric-category',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False
)
string
[REQUIRED]
The ID of the transit gateway.
string
[REQUIRED]
The ID of the peer transit gateway with which to create the peering attachment.
string
[REQUIRED]
The ID of the Amazon Web Services account that owns the peer transit gateway.
string
[REQUIRED]
The Region where the peer transit gateway is located.
dict
Requests a transit gateway peering attachment.
DynamicRouting (string) --
Indicates whether dynamic routing is enabled or disabled.
AllowMultipathResilience (boolean) --
Specifies whether you allow multipath resilience for the requester side of the transit gateway peering attachment. Multipath resilience is supported only for inter-Region transit gateway peering attachments between supported Regions. It takes effect only when both the requester and the accepter allow it. If you don't specify this parameter, the default is false.
MultipathResilienceMode (string) --
The multipath resilience mode. You can specify this parameter only if AllowMultipathResilience is true.
The following value is valid:
always-on – Replicates traffic across multiple network paths while multipath resilience is in effect.
If AllowMultipathResilience is true and you don't specify a mode, the default is always-on.
list
The tags to apply to the transit gateway peering attachment.
(dict) --
The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
ResourceType (string) --
The type of resource to tag on creation.
Tags (list) --
The tags to apply to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'TransitGatewayPeeringAttachment': {
'TransitGatewayAttachmentId': 'string',
'AccepterTransitGatewayAttachmentId': 'string',
'RequesterTgwInfo': {
'TransitGatewayId': 'string',
'CoreNetworkId': 'string',
'OwnerId': 'string',
'Region': 'string'
},
'AccepterTgwInfo': {
'TransitGatewayId': 'string',
'CoreNetworkId': 'string',
'OwnerId': 'string',
'Region': 'string'
},
'Options': {
'DynamicRouting': 'enable'|'disable',
'RequesterAllowMultipathResilience': True|False,
'RequesterMultipathResilienceMode': 'always-on',
'AccepterAllowMultipathResilience': True|False,
'AccepterMultipathResilienceMode': 'always-on',
'MultipathResilienceStatus': 'pending'|'enabled'|'disabled'
},
'Status': {
'Code': 'string',
'Message': 'string'
},
'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
'CreationTime': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
TransitGatewayPeeringAttachment (dict) --
The transit gateway peering attachment.
TransitGatewayAttachmentId (string) --
The ID of the transit gateway peering attachment.
AccepterTransitGatewayAttachmentId (string) --
The ID of the accepter transit gateway attachment.
RequesterTgwInfo (dict) --
Information about the requester transit gateway.
TransitGatewayId (string) --
The ID of the transit gateway.
CoreNetworkId (string) --
The ID of the core network where the transit gateway peer is located.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the transit gateway.
Region (string) --
The Region of the transit gateway.
AccepterTgwInfo (dict) --
Information about the accepter transit gateway.
TransitGatewayId (string) --
The ID of the transit gateway.
CoreNetworkId (string) --
The ID of the core network where the transit gateway peer is located.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the transit gateway.
Region (string) --
The Region of the transit gateway.
Options (dict) --
Details about the transit gateway peering attachment.
DynamicRouting (string) --
Describes whether dynamic routing is enabled or disabled for the transit gateway peering attachment.
RequesterAllowMultipathResilience (boolean) --
Indicates whether the requester allows multipath resilience for the transit gateway peering attachment.
RequesterMultipathResilienceMode (string) --
The multipath resilience mode for the requester. This value is present only when the requester allows multipath resilience.
AccepterAllowMultipathResilience (boolean) --
Indicates whether the accepter allows multipath resilience for the transit gateway peering attachment.
AccepterMultipathResilienceMode (string) --
The multipath resilience mode for the accepter. This value is present only when the accepter allows multipath resilience.
MultipathResilienceStatus (string) --
The multipath resilience status of the transit gateway peering attachment. The possible values are:
enabled – Both the requester and the accepter allow multipath resilience.
pending – Either the requester or the accepter allows multipath resilience, but not both.
disabled – Neither the requester nor the accepter allows multipath resilience.
Status (dict) --
The status of the transit gateway peering attachment.
Code (string) --
The status code.
Message (string) --
The status message, if applicable.
State (string) --
The state of the transit gateway peering attachment. Note that the initiating state has been deprecated.
CreationTime (datetime) --
The time the transit gateway peering attachment was created.
Tags (list) --
The tags for the transit gateway peering attachment.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
{'RequesterPeeringConnectionOptions': {'AllowMultipathResilience': 'boolean',
'MultipathResilienceMode': 'always-on'}}
Response {'VpcPeeringConnection': {'AccepterVpcInfo': {'PeeringOptions': {'AllowMultipathResilience': 'boolean',
'MultipathResilienceMode': 'always-on'}},
'MultipathResilienceStatus': 'pending | enabled | '
'disabled',
'RequesterVpcInfo': {'PeeringOptions': {'AllowMultipathResilience': 'boolean',
'MultipathResilienceMode': 'always-on'}}}}
Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection. The accepter VPC can belong to another Amazon Web Services account and can be in a different Region to the requester VPC. The requester VPC and accepter VPC cannot have overlapping CIDR blocks.
The owner of the accepter VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.
Multipath resilience replicates the traffic of an inter-Region VPC peering connection across multiple network paths.
If you create a VPC peering connection request between VPCs with overlapping CIDR blocks, the VPC peering connection has a status of failed.
See also: AWS API Documentation
Request Syntax
client.create_vpc_peering_connection(
PeerRegion='string',
TagSpecifications=[
{
'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fca-policy'|'fleet'|'fpga-image'|'host-reservation'|'image'|'image-usage-report'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-metering-policy'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'vpc-encryption-control'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task'|'ipam-prefix-list-resolver'|'ipam-policy'|'ipam-prefix-list-resolver-target'|'ipam-internet-registry-association'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator'|'ipam-pool-allocation'|'capacity-reservation-cancellation-quote'|'application-status-check'|'capacity-reservation-modification-quote'|'metric-category',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
RequesterPeeringConnectionOptions={
'AllowMultipathResilience': True|False,
'MultipathResilienceMode': 'always-on'
},
DryRun=True|False,
VpcId='string',
PeerVpcId='string',
PeerOwnerId='string'
)
string
The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.
Default: The Region in which you make the request.
list
The tags to assign to the peering connection.
(dict) --
The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
ResourceType (string) --
The type of resource to tag on creation.
Tags (list) --
The tags to apply to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
dict
The VPC peering connection options to apply to the requester VPC.
AllowMultipathResilience (boolean) --
Specifies whether you allow multipath resilience for the requester VPC. Multipath resilience is supported only for inter-Region VPC peering connections between supported Regions. It takes effect only when both the requester and the accepter allow it. Accepting the VPC peering connection request also allows multipath resilience for the accepter VPC. If you don't specify this parameter, the default is false.
MultipathResilienceMode (string) --
The multipath resilience mode. You can specify this parameter only if AllowMultipathResilience is true.
The following value is valid:
always-on – Replicates traffic across multiple network paths while multipath resilience is in effect.
If AllowMultipathResilience is true and you don't specify a mode, the default is always-on.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
string
[REQUIRED]
The ID of the requester VPC. You must specify this parameter in the request.
string
The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request.
string
The Amazon Web Services account ID of the owner of the accepter VPC.
Default: Your Amazon Web Services account ID
dict
Response Syntax
{
'VpcPeeringConnection': {
'AccepterVpcInfo': {
'CidrBlock': 'string',
'Ipv6CidrBlockSet': [
{
'Ipv6CidrBlock': 'string'
},
],
'CidrBlockSet': [
{
'CidrBlock': 'string'
},
],
'OwnerId': 'string',
'PeeringOptions': {
'AllowDnsResolutionFromRemoteVpc': True|False,
'AllowEgressFromLocalClassicLinkToRemoteVpc': True|False,
'AllowEgressFromLocalVpcToRemoteClassicLink': True|False,
'AllowMultipathResilience': True|False,
'MultipathResilienceMode': 'always-on'
},
'VpcId': 'string',
'Region': 'string'
},
'ExpirationTime': datetime(2015, 1, 1),
'RequesterVpcInfo': {
'CidrBlock': 'string',
'Ipv6CidrBlockSet': [
{
'Ipv6CidrBlock': 'string'
},
],
'CidrBlockSet': [
{
'CidrBlock': 'string'
},
],
'OwnerId': 'string',
'PeeringOptions': {
'AllowDnsResolutionFromRemoteVpc': True|False,
'AllowEgressFromLocalClassicLinkToRemoteVpc': True|False,
'AllowEgressFromLocalVpcToRemoteClassicLink': True|False,
'AllowMultipathResilience': True|False,
'MultipathResilienceMode': 'always-on'
},
'VpcId': 'string',
'Region': 'string'
},
'Status': {
'Code': 'initiating-request'|'pending-acceptance'|'active'|'deleted'|'rejected'|'failed'|'expired'|'provisioning'|'deleting',
'Message': 'string'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VpcPeeringConnectionId': 'string',
'MultipathResilienceStatus': 'pending'|'enabled'|'disabled'
}
}
Response Structure
(dict) --
VpcPeeringConnection (dict) --
Information about the VPC peering connection.
AccepterVpcInfo (dict) --
Information about the accepter VPC. CIDR block information is only returned when describing an active VPC peering connection.
CidrBlock (string) --
The IPv4 CIDR block for the VPC.
Ipv6CidrBlockSet (list) --
The IPv6 CIDR block for the VPC.
(dict) --
Describes an IPv6 CIDR block.
Ipv6CidrBlock (string) --
The IPv6 CIDR block.
CidrBlockSet (list) --
Information about the IPv4 CIDR blocks for the VPC.
(dict) --
Describes an IPv4 CIDR block.
CidrBlock (string) --
The IPv4 CIDR block.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the VPC.
PeeringOptions (dict) --
Information about the VPC peering connection options for the accepter or requester VPC.
AllowDnsResolutionFromRemoteVpc (boolean) --
Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.
AllowEgressFromLocalClassicLinkToRemoteVpc (boolean) --
Deprecated.
AllowEgressFromLocalVpcToRemoteClassicLink (boolean) --
Deprecated.
AllowMultipathResilience (boolean) --
Indicates whether this side of the VPC peering connection allows multipath resilience.
MultipathResilienceMode (string) --
The multipath resilience mode for this side of the VPC peering connection. This value is present only when this side allows multipath resilience.
VpcId (string) --
The ID of the VPC.
Region (string) --
The Region in which the VPC is located.
ExpirationTime (datetime) --
The time that an unaccepted VPC peering connection will expire.
RequesterVpcInfo (dict) --
Information about the requester VPC. CIDR block information is only returned when describing an active VPC peering connection.
CidrBlock (string) --
The IPv4 CIDR block for the VPC.
Ipv6CidrBlockSet (list) --
The IPv6 CIDR block for the VPC.
(dict) --
Describes an IPv6 CIDR block.
Ipv6CidrBlock (string) --
The IPv6 CIDR block.
CidrBlockSet (list) --
Information about the IPv4 CIDR blocks for the VPC.
(dict) --
Describes an IPv4 CIDR block.
CidrBlock (string) --
The IPv4 CIDR block.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the VPC.
PeeringOptions (dict) --
Information about the VPC peering connection options for the accepter or requester VPC.
AllowDnsResolutionFromRemoteVpc (boolean) --
Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.
AllowEgressFromLocalClassicLinkToRemoteVpc (boolean) --
Deprecated.
AllowEgressFromLocalVpcToRemoteClassicLink (boolean) --
Deprecated.
AllowMultipathResilience (boolean) --
Indicates whether this side of the VPC peering connection allows multipath resilience.
MultipathResilienceMode (string) --
The multipath resilience mode for this side of the VPC peering connection. This value is present only when this side allows multipath resilience.
VpcId (string) --
The ID of the VPC.
Region (string) --
The Region in which the VPC is located.
Status (dict) --
The status of the VPC peering connection.
Code (string) --
The status of the VPC peering connection.
Message (string) --
A message that provides more information about the status, if applicable.
Tags (list) --
Any tags assigned to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
VpcPeeringConnectionId (string) --
The ID of the VPC peering connection.
MultipathResilienceStatus (string) --
The multipath resilience status of the VPC peering connection. The possible values are:
enabled – Both the requester and the accepter allow multipath resilience.
pending – Either the requester or the accepter allows multipath resilience, but not both.
disabled – Neither the requester nor the accepter allows multipath resilience.
{'Options': {'TunnelOptions': {'Phase1AdditionalKeyExchanges': [{'AdditionalKeyExchangeRound': 'integer',
'KeyExchangeMethods': [{'Value': 'integer'}],
'Requirement': 'required '
'| '
'optional'}],
'Phase2AdditionalKeyExchanges': [{'AdditionalKeyExchangeRound': 'integer',
'KeyExchangeMethods': [{'Value': 'integer'}],
'Requirement': 'required '
'| '
'optional'}]}}}
Response {'VpnConnection': {'Options': {'TunnelOptions': {'Phase1AdditionalKeyExchanges': [{'AdditionalKeyExchangeRound': 'integer',
'KeyExchangeMethods': [{'Value': 'integer'}],
'Requirement': 'required '
'| '
'optional'}],
'Phase2AdditionalKeyExchanges': [{'AdditionalKeyExchangeRound': 'integer',
'KeyExchangeMethods': [{'Value': 'integer'}],
'Requirement': 'required '
'| '
'optional'}]}}}}
Creates a VPN connection between an existing virtual private gateway or transit gateway and a customer gateway. The supported connection type is ipsec.1.
The response includes information that you need to give to your network administrator to configure your customer gateway.
If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
See also: AWS API Documentation
Request Syntax
client.create_vpn_connection(
CustomerGatewayId='string',
Type='string',
VpnGatewayId='string',
TransitGatewayId='string',
VpnConcentratorId='string',
TagSpecifications=[
{
'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fca-policy'|'fleet'|'fpga-image'|'host-reservation'|'image'|'image-usage-report'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-metering-policy'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'vpc-encryption-control'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task'|'ipam-prefix-list-resolver'|'ipam-policy'|'ipam-prefix-list-resolver-target'|'ipam-internet-registry-association'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator'|'ipam-pool-allocation'|'capacity-reservation-cancellation-quote'|'application-status-check'|'capacity-reservation-modification-quote'|'metric-category',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
PreSharedKeyStorage='string',
DryRun=True|False,
Options={
'EnableAcceleration': True|False,
'TunnelInsideIpVersion': 'ipv4'|'ipv6',
'TunnelOptions': [
{
'TunnelInsideCidr': 'string',
'TunnelInsideIpv6Cidr': 'string',
'PreSharedKey': 'string',
'Phase1LifetimeSeconds': 123,
'Phase2LifetimeSeconds': 123,
'RekeyMarginTimeSeconds': 123,
'RekeyFuzzPercentage': 123,
'ReplayWindowSize': 123,
'DPDTimeoutSeconds': 123,
'DPDTimeoutAction': 'string',
'Phase1EncryptionAlgorithms': [
{
'Value': 'string'
},
],
'Phase2EncryptionAlgorithms': [
{
'Value': 'string'
},
],
'Phase1IntegrityAlgorithms': [
{
'Value': 'string'
},
],
'Phase2IntegrityAlgorithms': [
{
'Value': 'string'
},
],
'Phase1DHGroupNumbers': [
{
'Value': 123
},
],
'Phase2DHGroupNumbers': [
{
'Value': 123
},
],
'IKEVersions': [
{
'Value': 'string'
},
],
'StartupAction': 'string',
'LogOptions': {
'CloudWatchLogOptions': {
'LogEnabled': True|False,
'LogGroupArn': 'string',
'LogOutputFormat': 'string',
'BgpLogEnabled': True|False,
'BgpLogGroupArn': 'string',
'BgpLogOutputFormat': 'string'
}
},
'EnableTunnelLifecycleControl': True|False,
'Phase1AdditionalKeyExchanges': [
{
'AdditionalKeyExchangeRound': 123,
'KeyExchangeMethods': [
{
'Value': 123
},
],
'Requirement': 'required'|'optional'
},
],
'Phase2AdditionalKeyExchanges': [
{
'AdditionalKeyExchangeRound': 123,
'KeyExchangeMethods': [
{
'Value': 123
},
],
'Requirement': 'required'|'optional'
},
]
},
],
'LocalIpv4NetworkCidr': 'string',
'RemoteIpv4NetworkCidr': 'string',
'LocalIpv6NetworkCidr': 'string',
'RemoteIpv6NetworkCidr': 'string',
'OutsideIpAddressType': 'string',
'TransportTransitGatewayAttachmentId': 'string',
'TunnelBandwidth': 'standard'|'large',
'StaticRoutesOnly': True|False
}
)
string
[REQUIRED]
The ID of the customer gateway.
string
[REQUIRED]
The type of VPN connection ( ipsec.1).
string
The ID of the virtual private gateway. If you specify a virtual private gateway, you cannot specify a transit gateway.
string
The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private gateway.
string
The ID of the VPN concentrator to associate with the VPN connection.
list
The tags to apply to the VPN connection.
(dict) --
The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
ResourceType (string) --
The type of resource to tag on creation.
Tags (list) --
The tags to apply to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
string
Specifies the storage mode for the pre-shared key (PSK). Valid values are Standard" (stored in the Site-to-Site VPN service) or SecretsManager (stored in Amazon Web Services Secrets Manager).
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
The options for the VPN connection.
EnableAcceleration (boolean) --
Indicate whether to enable acceleration for the VPN connection.
Default: false
TunnelInsideIpVersion (string) --
Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.
Default: ipv4
TunnelOptions (list) --
The tunnel options for the VPN connection.
(dict) --
The tunnel options for a single VPN tunnel.
TunnelInsideCidr (string) --
The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway.
Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The following CIDR blocks are reserved and cannot be used:
169.254.0.0/30
169.254.1.0/30
169.254.2.0/30
169.254.3.0/30
169.254.4.0/30
169.254.5.0/30
169.254.169.252/30
TunnelInsideIpv6Cidr (string) --
The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same transit gateway.
Constraints: A size /126 CIDR block from the local fd00::/8 range.
PreSharedKey (string) --
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and customer gateway.
Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (_). Must be between 8 and 64 characters in length and cannot start with zero (0).
Phase1LifetimeSeconds (integer) --
The lifetime for phase 1 of the IKE negotiation, in seconds.
Constraints: A value between 900 and 28,800.
Default: 28800
Phase2LifetimeSeconds (integer) --
The lifetime for phase 2 of the IKE negotiation, in seconds.
Constraints: A value between 900 and 3,600. The value must be less than the value for Phase1LifetimeSeconds.
Default: 3600
RekeyMarginTimeSeconds (integer) --
The margin time, in seconds, before the phase 2 lifetime expires, during which the Amazon Web Services side of the VPN connection performs an IKE rekey. The exact time of the rekey is randomly selected based on the value for RekeyFuzzPercentage.
Constraints: A value between 60 and half of Phase2LifetimeSeconds.
Default: 270
RekeyFuzzPercentage (integer) --
The percentage of the rekey window (determined by RekeyMarginTimeSeconds) during which the rekey time is randomly selected.
Constraints: A value between 0 and 100.
Default: 100
ReplayWindowSize (integer) --
The number of packets in an IKE replay window.
Constraints: A value between 64 and 2048.
Default: 1024
DPDTimeoutSeconds (integer) --
The number of seconds after which a DPD timeout occurs.
Constraints: A value greater than or equal to 30.
Default: 30
DPDTimeoutAction (string) --
The action to take after DPD timeout occurs. Specify restart to restart the IKE initiation. Specify clear to end the IKE session.
Valid Values: clear | none | restart
Default: clear
Phase1EncryptionAlgorithms (list) --
One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
(dict) --
Specifies the encryption algorithm for the VPN tunnel for phase 1 IKE negotiations.
Value (string) --
The value for the encryption algorithm.
Phase2EncryptionAlgorithms (list) --
One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
(dict) --
Specifies the encryption algorithm for the VPN tunnel for phase 2 IKE negotiations.
Value (string) --
The encryption algorithm.
Phase1IntegrityAlgorithms (list) --
One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
(dict) --
Specifies the integrity algorithm for the VPN tunnel for phase 1 IKE negotiations.
Value (string) --
The value for the integrity algorithm.
Phase2IntegrityAlgorithms (list) --
One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
(dict) --
Specifies the integrity algorithm for the VPN tunnel for phase 2 IKE negotiations.
Value (string) --
The integrity algorithm.
Phase1DHGroupNumbers (list) --
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 35
(dict) --
Specifies a Diffie-Hellman group number for the VPN tunnel for phase 1 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
Phase2DHGroupNumbers (list) --
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 35 | 36 | 37
(dict) --
Specifies a Diffie-Hellman group number for the VPN tunnel for phase 2 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
IKEVersions (list) --
The IKE versions that are permitted for the VPN tunnel.
Valid values: ikev1 | ikev2
(dict) --
The IKE version that is permitted for the VPN tunnel.
Value (string) --
The IKE version.
StartupAction (string) --
The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify start for Amazon Web Services to initiate the IKE negotiation.
Valid Values: add | start
Default: add
LogOptions (dict) --
Options for logging VPN tunnel activity.
CloudWatchLogOptions (dict) --
Options for sending VPN tunnel logs to CloudWatch.
LogEnabled (boolean) --
Enable or disable VPN tunnel logging feature. Default value is False.
Valid values: True | False
LogGroupArn (string) --
The Amazon Resource Name (ARN) of the CloudWatch log group to send logs to.
LogOutputFormat (string) --
Set log format. Default format is json.
Valid values: json | text
BgpLogEnabled (boolean) --
Specifies whether to enable BGP logging for the VPN connection. Default value is False.
Valid values: True | False
BgpLogGroupArn (string) --
The Amazon Resource Name (ARN) of the CloudWatch log group where BGP logs will be sent.
BgpLogOutputFormat (string) --
The desired output format for BGP logs to be sent to CloudWatch. Default format is json.
Valid values: json | text
EnableTunnelLifecycleControl (boolean) --
Turn on or off tunnel endpoint lifecycle control feature.
Phase1AdditionalKeyExchanges (list) --
One or more additional key exchange rounds that are permitted for the VPN tunnel for phase 1 IKE negotiations. Additional key exchanges occur after the initial Diffie-Hellman exchange. Each round must have a unique round number.
Additional key exchanges are supported only with IKEv2. You can't specify a required round if IKEVersions contains only ikev1.
(dict) --
Specifies an additional key exchange round for the VPN tunnel, as defined in RFC 9370.
AdditionalKeyExchangeRound (integer) -- [REQUIRED]
The additional key exchange round number.
Valid range: Minimum value of 1. Maximum value of 7.
KeyExchangeMethods (list) --
The key exchange method numbers that are permitted for this round. The method numbers are the IANA IKEv2 key exchange method transform IDs.
A required round must specify at least one method. An optional round can omit this parameter or specify an empty list. If omitted or empty for an optional round, the round is disabled.
IKEv2 requires that the initial Diffie-Hellman exchange and each required round use a different key exchange method. The permitted methods must allow a distinct method to be selected for each of them.
Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 35 | 36 | 37
(dict) --
Specifies a key exchange method number that is permitted for an additional key exchange round.
Value (integer) --
The key exchange method number.
Requirement (string) --
Indicates whether this round is mandatory. If required, the tunnel isn't established unless the customer gateway device negotiates this round. If optional, the round is negotiated only if the customer gateway device supports it.
Valid values: required | optional
Default: required
Phase2AdditionalKeyExchanges (list) --
One or more additional key exchange rounds that are permitted for the VPN tunnel for phase 2 IKE negotiations. Additional key exchanges occur after the initial Diffie-Hellman exchange. Each round must have a unique round number.
Additional key exchanges are supported only with IKEv2. You can't specify a required round if IKEVersions contains only ikev1.
(dict) --
Specifies an additional key exchange round for the VPN tunnel, as defined in RFC 9370.
AdditionalKeyExchangeRound (integer) -- [REQUIRED]
The additional key exchange round number.
Valid range: Minimum value of 1. Maximum value of 7.
KeyExchangeMethods (list) --
The key exchange method numbers that are permitted for this round. The method numbers are the IANA IKEv2 key exchange method transform IDs.
A required round must specify at least one method. An optional round can omit this parameter or specify an empty list. If omitted or empty for an optional round, the round is disabled.
IKEv2 requires that the initial Diffie-Hellman exchange and each required round use a different key exchange method. The permitted methods must allow a distinct method to be selected for each of them.
Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 35 | 36 | 37
(dict) --
Specifies a key exchange method number that is permitted for an additional key exchange round.
Value (integer) --
The key exchange method number.
Requirement (string) --
Indicates whether this round is mandatory. If required, the tunnel isn't established unless the customer gateway device negotiates this round. If optional, the round is negotiated only if the customer gateway device supports it.
Valid values: required | optional
Default: required
LocalIpv4NetworkCidr (string) --
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: 0.0.0.0/0
RemoteIpv4NetworkCidr (string) --
The IPv4 CIDR on the Amazon Web Services side of the VPN connection.
Default: 0.0.0.0/0
LocalIpv6NetworkCidr (string) --
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: ::/0
RemoteIpv6NetworkCidr (string) --
The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
Default: ::/0
OutsideIpAddressType (string) --
The type of IP address assigned to the outside interface of the customer gateway device.
Valid values: PrivateIpv4 | PublicIpv4 | Ipv6
Default: PublicIpv4
TransportTransitGatewayAttachmentId (string) --
The transit gateway attachment ID to use for the VPN tunnel.
Required if OutsideIpAddressType is set to PrivateIpv4.
TunnelBandwidth (string) --
The desired bandwidth specification for the VPN tunnel, used when creating or modifying VPN connection options to set the tunnel's throughput capacity. standard supports up to 1.25 Gbps per tunnel, while large supports up to 5 Gbps per tunnel. The default value is standard. Existing VPN connections without a bandwidth setting will automatically default to standard.
StaticRoutesOnly (boolean) --
Indicate whether the VPN connection uses static routes only. If you are creating a VPN connection for a device that does not support BGP, you must specify true. Use CreateVpnConnectionRoute to create a static route.
Default: false
dict
Response Syntax
{
'VpnConnection': {
'Category': 'string',
'TransitGatewayId': 'string',
'VpnConcentratorId': 'string',
'CoreNetworkArn': 'string',
'CoreNetworkAttachmentArn': 'string',
'GatewayAssociationState': 'associated'|'not-associated'|'associating'|'disassociating',
'Options': {
'EnableAcceleration': True|False,
'StaticRoutesOnly': True|False,
'LocalIpv4NetworkCidr': 'string',
'RemoteIpv4NetworkCidr': 'string',
'LocalIpv6NetworkCidr': 'string',
'RemoteIpv6NetworkCidr': 'string',
'OutsideIpAddressType': 'string',
'TransportTransitGatewayAttachmentId': 'string',
'TunnelInsideIpVersion': 'ipv4'|'ipv6',
'TunnelOptions': [
{
'OutsideIpAddress': 'string',
'TunnelInsideCidr': 'string',
'TunnelInsideIpv6Cidr': 'string',
'PreSharedKey': 'string',
'Phase1LifetimeSeconds': 123,
'Phase2LifetimeSeconds': 123,
'RekeyMarginTimeSeconds': 123,
'RekeyFuzzPercentage': 123,
'ReplayWindowSize': 123,
'DpdTimeoutSeconds': 123,
'DpdTimeoutAction': 'string',
'Phase1EncryptionAlgorithms': [
{
'Value': 'string'
},
],
'Phase2EncryptionAlgorithms': [
{
'Value': 'string'
},
],
'Phase1IntegrityAlgorithms': [
{
'Value': 'string'
},
],
'Phase2IntegrityAlgorithms': [
{
'Value': 'string'
},
],
'Phase1DHGroupNumbers': [
{
'Value': 123
},
],
'Phase2DHGroupNumbers': [
{
'Value': 123
},
],
'IkeVersions': [
{
'Value': 'string'
},
],
'StartupAction': 'string',
'LogOptions': {
'CloudWatchLogOptions': {
'LogEnabled': True|False,
'LogGroupArn': 'string',
'LogOutputFormat': 'string',
'BgpLogEnabled': True|False,
'BgpLogGroupArn': 'string',
'BgpLogOutputFormat': 'string'
}
},
'EnableTunnelLifecycleControl': True|False,
'Phase1AdditionalKeyExchanges': [
{
'AdditionalKeyExchangeRound': 123,
'KeyExchangeMethods': [
{
'Value': 123
},
],
'Requirement': 'required'|'optional'
},
],
'Phase2AdditionalKeyExchanges': [
{
'AdditionalKeyExchangeRound': 123,
'KeyExchangeMethods': [
{
'Value': 123
},
],
'Requirement': 'required'|'optional'
},
]
},
],
'TunnelBandwidth': 'standard'|'large'
},
'Routes': [
{
'DestinationCidrBlock': 'string',
'Source': 'Static',
'State': 'pending'|'available'|'deleting'|'deleted'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VgwTelemetry': [
{
'AcceptedRouteCount': 123,
'LastStatusChange': datetime(2015, 1, 1),
'OutsideIpAddress': 'string',
'Status': 'UP'|'DOWN',
'StatusMessage': 'string',
'CertificateArn': 'string'
},
],
'PreSharedKeyArn': 'string',
'VpnConnectionId': 'string',
'State': 'pending'|'available'|'deleting'|'deleted',
'CustomerGatewayConfiguration': 'string',
'Type': 'ipsec.1',
'CustomerGatewayId': 'string',
'VpnGatewayId': 'string'
}
}
Response Structure
(dict) --
Contains the output of CreateVpnConnection.
VpnConnection (dict) --
Information about the VPN connection.
Category (string) --
The category of the VPN connection. A value of VPN indicates an Amazon Web Services VPN connection. A value of VPN-Classic indicates an Amazon Web Services Classic VPN connection.
TransitGatewayId (string) --
The ID of the transit gateway associated with the VPN connection.
VpnConcentratorId (string) --
The ID of the VPN concentrator associated with the VPN connection.
CoreNetworkArn (string) --
The ARN of the core network.
CoreNetworkAttachmentArn (string) --
The ARN of the core network attachment.
GatewayAssociationState (string) --
The current state of the gateway association.
Options (dict) --
The VPN connection options.
EnableAcceleration (boolean) --
Indicates whether acceleration is enabled for the VPN connection.
StaticRoutesOnly (boolean) --
Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
LocalIpv4NetworkCidr (string) --
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv4NetworkCidr (string) --
The IPv4 CIDR on the Amazon Web Services side of the VPN connection.
LocalIpv6NetworkCidr (string) --
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv6NetworkCidr (string) --
The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
OutsideIpAddressType (string) --
The type of IPv4 address assigned to the outside interface of the customer gateway.
Valid values: PrivateIpv4 | PublicIpv4 | Ipv6
Default: PublicIpv4
TransportTransitGatewayAttachmentId (string) --
The transit gateway attachment ID in use for the VPN tunnel.
TunnelInsideIpVersion (string) --
Indicates whether the VPN tunnels process IPv4 or IPv6 traffic.
TunnelOptions (list) --
Indicates the VPN tunnel options.
(dict) --
The VPN tunnel options.
OutsideIpAddress (string) --
The external IP address of the VPN tunnel.
TunnelInsideCidr (string) --
The range of inside IPv4 addresses for the tunnel.
TunnelInsideIpv6Cidr (string) --
The range of inside IPv6 addresses for the tunnel.
PreSharedKey (string) --
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.
Phase1LifetimeSeconds (integer) --
The lifetime for phase 1 of the IKE negotiation, in seconds.
Phase2LifetimeSeconds (integer) --
The lifetime for phase 2 of the IKE negotiation, in seconds.
RekeyMarginTimeSeconds (integer) --
The margin time, in seconds, before the phase 2 lifetime expires, during which the Amazon Web Services side of the VPN connection performs an IKE rekey.
RekeyFuzzPercentage (integer) --
The percentage of the rekey window determined by RekeyMarginTimeSeconds during which the rekey time is randomly selected.
ReplayWindowSize (integer) --
The number of packets in an IKE replay window.
DpdTimeoutSeconds (integer) --
The number of seconds after which a DPD timeout occurs.
DpdTimeoutAction (string) --
The action to take after a DPD timeout occurs.
Phase1EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The encryption algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the encryption algorithm.
Phase2EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The encryption algorithm for phase 2 IKE negotiations.
Value (string) --
The encryption algorithm.
Phase1IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The integrity algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the integrity algorithm.
Phase2IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The integrity algorithm for phase 2 IKE negotiations.
Value (string) --
The integrity algorithm.
Phase1DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 1 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
Phase2DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 2 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
IkeVersions (list) --
The IKE versions that are permitted for the VPN tunnel.
(dict) --
The internet key exchange (IKE) version permitted for the VPN tunnel.
Value (string) --
The IKE version.
StartupAction (string) --
The action to take when the establishing the VPN tunnels for a VPN connection.
LogOptions (dict) --
Options for logging VPN tunnel activity.
CloudWatchLogOptions (dict) --
Options for sending VPN tunnel logs to CloudWatch.
LogEnabled (boolean) --
Status of VPN tunnel logging feature. Default value is False.
Valid values: True | False
LogGroupArn (string) --
The Amazon Resource Name (ARN) of the CloudWatch log group to send logs to.
LogOutputFormat (string) --
Configured log format. Default format is json.
Valid values: json | text
BgpLogEnabled (boolean) --
Indicates whether Border Gateway Protocol (BGP) logging is enabled for the VPN connection. Default value is False.
Valid values: True | False
BgpLogGroupArn (string) --
The Amazon Resource Name (ARN) of the CloudWatch log group for BGP logs.
BgpLogOutputFormat (string) --
The output format for BGP logs sent to CloudWatch. Default format is json.
Valid values: json | text
EnableTunnelLifecycleControl (boolean) --
Status of tunnel endpoint lifecycle control feature.
Phase1AdditionalKeyExchanges (list) --
The permitted additional key exchange rounds for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
Describes an additional key exchange round that is permitted for the VPN tunnel.
AdditionalKeyExchangeRound (integer) --
The additional key exchange round number.
KeyExchangeMethods (list) --
The key exchange method numbers permitted for this round.
(dict) --
The key exchange method number that is permitted for an additional key exchange round.
Value (integer) --
The key exchange method number.
Requirement (string) --
Indicates whether this round is mandatory.
Phase2AdditionalKeyExchanges (list) --
The permitted additional key exchange rounds for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
Describes an additional key exchange round that is permitted for the VPN tunnel.
AdditionalKeyExchangeRound (integer) --
The additional key exchange round number.
KeyExchangeMethods (list) --
The key exchange method numbers permitted for this round.
(dict) --
The key exchange method number that is permitted for an additional key exchange round.
Value (integer) --
The key exchange method number.
Requirement (string) --
Indicates whether this round is mandatory.
TunnelBandwidth (string) --
The configured bandwidth for the VPN tunnel. Represents the current throughput capacity setting for the tunnel connection. standard tunnel bandwidth supports up to 1.25 Gbps per tunnel while large supports up to 5 Gbps per tunnel. If no tunnel bandwidth was specified for the connection, standard is used as the default value.
Routes (list) --
The static routes associated with the VPN connection.
(dict) --
Describes a static route for a VPN connection.
DestinationCidrBlock (string) --
The CIDR block associated with the local subnet of the customer data center.
Source (string) --
Indicates how the routes were provided.
State (string) --
The current state of the static route.
Tags (list) --
Any tags assigned to the VPN connection.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
VgwTelemetry (list) --
Information about the VPN tunnel.
(dict) --
Describes telemetry for a VPN tunnel.
AcceptedRouteCount (integer) --
The number of accepted routes.
LastStatusChange (datetime) --
The date and time of the last change in status. This field is updated when changes in IKE (Phase 1), IPSec (Phase 2), or BGP status are detected.
OutsideIpAddress (string) --
The Internet-routable IP address of the virtual private gateway's outside interface.
Status (string) --
The status of the VPN tunnel.
StatusMessage (string) --
If an error occurs, a description of the error.
CertificateArn (string) --
The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.
PreSharedKeyArn (string) --
The Amazon Resource Name (ARN) of the Secrets Manager secret storing the pre-shared key(s) for the VPN connection.
VpnConnectionId (string) --
The ID of the VPN connection.
State (string) --
The current state of the VPN connection.
CustomerGatewayConfiguration (string) --
The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.
Type (string) --
The type of VPN connection.
CustomerGatewayId (string) --
The ID of the customer gateway at your end of the VPN connection.
VpnGatewayId (string) --
The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection.
{'TransitGatewayPeeringAttachment': {'Options': {'AccepterAllowMultipathResilience': 'boolean',
'AccepterMultipathResilienceMode': 'always-on',
'MultipathResilienceStatus': 'pending '
'| '
'enabled '
'| '
'disabled',
'RequesterAllowMultipathResilience': 'boolean',
'RequesterMultipathResilienceMode': 'always-on'}}}
Deletes a transit gateway peering attachment.
See also: AWS API Documentation
Request Syntax
client.delete_transit_gateway_peering_attachment(
TransitGatewayAttachmentId='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the transit gateway peering attachment.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'TransitGatewayPeeringAttachment': {
'TransitGatewayAttachmentId': 'string',
'AccepterTransitGatewayAttachmentId': 'string',
'RequesterTgwInfo': {
'TransitGatewayId': 'string',
'CoreNetworkId': 'string',
'OwnerId': 'string',
'Region': 'string'
},
'AccepterTgwInfo': {
'TransitGatewayId': 'string',
'CoreNetworkId': 'string',
'OwnerId': 'string',
'Region': 'string'
},
'Options': {
'DynamicRouting': 'enable'|'disable',
'RequesterAllowMultipathResilience': True|False,
'RequesterMultipathResilienceMode': 'always-on',
'AccepterAllowMultipathResilience': True|False,
'AccepterMultipathResilienceMode': 'always-on',
'MultipathResilienceStatus': 'pending'|'enabled'|'disabled'
},
'Status': {
'Code': 'string',
'Message': 'string'
},
'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
'CreationTime': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
TransitGatewayPeeringAttachment (dict) --
The transit gateway peering attachment.
TransitGatewayAttachmentId (string) --
The ID of the transit gateway peering attachment.
AccepterTransitGatewayAttachmentId (string) --
The ID of the accepter transit gateway attachment.
RequesterTgwInfo (dict) --
Information about the requester transit gateway.
TransitGatewayId (string) --
The ID of the transit gateway.
CoreNetworkId (string) --
The ID of the core network where the transit gateway peer is located.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the transit gateway.
Region (string) --
The Region of the transit gateway.
AccepterTgwInfo (dict) --
Information about the accepter transit gateway.
TransitGatewayId (string) --
The ID of the transit gateway.
CoreNetworkId (string) --
The ID of the core network where the transit gateway peer is located.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the transit gateway.
Region (string) --
The Region of the transit gateway.
Options (dict) --
Details about the transit gateway peering attachment.
DynamicRouting (string) --
Describes whether dynamic routing is enabled or disabled for the transit gateway peering attachment.
RequesterAllowMultipathResilience (boolean) --
Indicates whether the requester allows multipath resilience for the transit gateway peering attachment.
RequesterMultipathResilienceMode (string) --
The multipath resilience mode for the requester. This value is present only when the requester allows multipath resilience.
AccepterAllowMultipathResilience (boolean) --
Indicates whether the accepter allows multipath resilience for the transit gateway peering attachment.
AccepterMultipathResilienceMode (string) --
The multipath resilience mode for the accepter. This value is present only when the accepter allows multipath resilience.
MultipathResilienceStatus (string) --
The multipath resilience status of the transit gateway peering attachment. The possible values are:
enabled – Both the requester and the accepter allow multipath resilience.
pending – Either the requester or the accepter allows multipath resilience, but not both.
disabled – Neither the requester nor the accepter allows multipath resilience.
Status (dict) --
The status of the transit gateway peering attachment.
Code (string) --
The status code.
Message (string) --
The status message, if applicable.
State (string) --
The state of the transit gateway peering attachment. Note that the initiating state has been deprecated.
CreationTime (datetime) --
The time the transit gateway peering attachment was created.
Tags (list) --
The tags for the transit gateway peering attachment.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
{'InstanceTypePreferences': [{'InstanceType': 'string'}]}
Response {'CapacityBlockOfferings': {'CapacityBlockOfferingSegments': [{'AvailabilityZone': 'string',
'AvailabilityZoneId': 'string',
'CapacityBlockDurationHours': 'integer',
'CapacityBlockDurationMinutes': 'integer',
'CurrencyCode': 'string',
'EndDate': 'timestamp',
'InstanceCount': 'integer',
'InstanceType': 'string',
'StartDate': 'timestamp',
'UpfrontFee': 'string',
'ZoneType': 'string'}]}}
Describes Capacity Block offerings available for purchase in the Amazon Web Services Region that you're currently using. With Capacity Blocks, you can purchase a specific GPU instance type or EC2 UltraServer for a period of time.
To search for an available Capacity Block offering, you specify a reservation duration and instance count.
See also: AWS API Documentation
Request Syntax
client.describe_capacity_block_offerings(
DryRun=True|False,
InstanceType='string',
InstanceCount=123,
StartDateRange=datetime(2015, 1, 1),
EndDateRange=datetime(2015, 1, 1),
CapacityDurationHours=123,
NextToken='string',
MaxResults=123,
UltraserverType='string',
UltraserverCount=123,
AllAvailabilityZones=True|False,
InstanceTypePreferences=[
{
'InstanceType': 'string'
},
]
)
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
string
The type of instance for which the Capacity Block offering reserves capacity.
integer
The number of instances for which to reserve capacity. Each Capacity Block can have up to 64 instances, and you can have up to 256 instances across Capacity Blocks.
datetime
The earliest start date for the Capacity Block offering.
datetime
The latest end date for the Capacity Block offering.
integer
[REQUIRED]
The reservation duration for the Capacity Block, in hours. You must specify the duration in 1-day increments up 14 days, and in 7-day increments up to 182 days.
string
The token to use to retrieve the next page of results.
integer
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
string
The EC2 UltraServer type of the Capacity Block offerings.
integer
The number of EC2 UltraServers in the offerings.
boolean
Include all Availability Zones and Local Zones, regardless of your opt-in status. If you do not use this parameter, the results include available offerings from all Availability Zones in the Amazon Web Services Region and Local Zones you are opted into.
list
List of instance type preferences for the Capacity Block offering search. Accepts one or more instance type names. Either this or the legacy InstanceType parameter is required.
(dict) --
Instance type preference for a Capacity Block search. Specifies one or more instance types to evaluate when searching for available Capacity Blocks.
InstanceType (string) --
The instance type to consider in the Capacity Block search.
dict
Response Syntax
{
'CapacityBlockOfferings': [
{
'CapacityBlockOfferingId': 'string',
'InstanceType': 'string',
'AvailabilityZone': 'string',
'InstanceCount': 123,
'StartDate': datetime(2015, 1, 1),
'EndDate': datetime(2015, 1, 1),
'CapacityBlockDurationHours': 123,
'UpfrontFee': 'string',
'CurrencyCode': 'string',
'Tenancy': 'default'|'dedicated',
'UltraserverType': 'string',
'UltraserverCount': 123,
'CapacityBlockDurationMinutes': 123,
'ZoneType': 'string',
'CapacityBlockOfferingSegments': [
{
'InstanceType': 'string',
'AvailabilityZone': 'string',
'AvailabilityZoneId': 'string',
'InstanceCount': 123,
'StartDate': datetime(2015, 1, 1),
'EndDate': datetime(2015, 1, 1),
'CapacityBlockDurationHours': 123,
'CapacityBlockDurationMinutes': 123,
'UpfrontFee': 'string',
'CurrencyCode': 'string',
'ZoneType': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
CapacityBlockOfferings (list) --
The recommended Capacity Block offering for the dates specified.
(dict) --
The recommended Capacity Block that fits your search requirements.
CapacityBlockOfferingId (string) --
The ID of the Capacity Block offering.
InstanceType (string) --
The instance type of the Capacity Block offering.
AvailabilityZone (string) --
The Availability Zone of the Capacity Block offering.
InstanceCount (integer) --
The number of instances in the Capacity Block offering.
StartDate (datetime) --
The start date of the Capacity Block offering.
EndDate (datetime) --
The end date of the Capacity Block offering.
CapacityBlockDurationHours (integer) --
The number of hours (in addition to capacityBlockDurationMinutes) for the duration of the Capacity Block reservation. For example, if a Capacity Block starts at 04:55 and ends at 11:30, the hours field would be 6.
UpfrontFee (string) --
The total price to be paid up front.
CurrencyCode (string) --
The currency of the payment for the Capacity Block.
Tenancy (string) --
The tenancy of the Capacity Block.
UltraserverType (string) --
The EC2 UltraServer type of the Capacity Block offering.
UltraserverCount (integer) --
The number of EC2 UltraServers in the offering.
CapacityBlockDurationMinutes (integer) --
The number of minutes (in addition to capacityBlockDurationHours) for the duration of the Capacity Block reservation. For example, if a Capacity Block starts at 08:55 and ends at 11:30, the minutes field would be 35.
ZoneType (string) --
The type of zone where the Capacity Block offering is available.
CapacityBlockOfferingSegments (list) --
The individual segments that compose the Capacity Block offering. Each segment describes a distinct block of capacity with its own Availability Zone, instance type, schedule, and pricing.
(dict) --
Describes an individual segment within a Capacity Block offering. Each segment represents a distinct block of capacity with its own Availability Zone, instance type, duration, pricing, and schedule.
InstanceType (string) --
The instance type of the Capacity Block offering segment.
AvailabilityZone (string) --
The Availability Zone of the Capacity Block offering segment.
AvailabilityZoneId (string) --
The ID of the Availability Zone for the Capacity Block offering segment.
InstanceCount (integer) --
The number of instances in the Capacity Block offering segment.
StartDate (datetime) --
The start date of the Capacity Block offering segment.
EndDate (datetime) --
The end date of the Capacity Block offering segment.
CapacityBlockDurationHours (integer) --
The number of hours for the duration of the Capacity Block offering segment.
CapacityBlockDurationMinutes (integer) --
The number of minutes for the duration of the Capacity Block offering segment.
UpfrontFee (string) --
The total price to be paid up front for the Capacity Block offering segment.
CurrencyCode (string) --
The currency of the payment for the Capacity Block offering segment.
ZoneType (string) --
The type of zone where the Capacity Block offering segment is available.
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
{'TransitGatewayPeeringAttachments': {'Options': {'AccepterAllowMultipathResilience': 'boolean',
'AccepterMultipathResilienceMode': 'always-on',
'MultipathResilienceStatus': 'pending '
'| '
'enabled '
'| '
'disabled',
'RequesterAllowMultipathResilience': 'boolean',
'RequesterMultipathResilienceMode': 'always-on'}}}
Describes your transit gateway peering attachments.
See also: AWS API Documentation
Request Syntax
client.describe_transit_gateway_peering_attachments(
TransitGatewayAttachmentIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
list
One or more IDs of the transit gateway peering attachments.
(string) --
list
One or more filters. The possible values are:
transit-gateway-attachment-id - The ID of the transit gateway attachment.
local-owner-id - The ID of your Amazon Web Services account.
remote-owner-id - The ID of the Amazon Web Services account in the remote Region that owns the transit gateway.
state - The state of the peering attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
transit-gateway-id - The ID of the transit gateway.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
integer
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
string
The token for the next page of results.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'TransitGatewayPeeringAttachments': [
{
'TransitGatewayAttachmentId': 'string',
'AccepterTransitGatewayAttachmentId': 'string',
'RequesterTgwInfo': {
'TransitGatewayId': 'string',
'CoreNetworkId': 'string',
'OwnerId': 'string',
'Region': 'string'
},
'AccepterTgwInfo': {
'TransitGatewayId': 'string',
'CoreNetworkId': 'string',
'OwnerId': 'string',
'Region': 'string'
},
'Options': {
'DynamicRouting': 'enable'|'disable',
'RequesterAllowMultipathResilience': True|False,
'RequesterMultipathResilienceMode': 'always-on',
'AccepterAllowMultipathResilience': True|False,
'AccepterMultipathResilienceMode': 'always-on',
'MultipathResilienceStatus': 'pending'|'enabled'|'disabled'
},
'Status': {
'Code': 'string',
'Message': 'string'
},
'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
'CreationTime': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TransitGatewayPeeringAttachments (list) --
The transit gateway peering attachments.
(dict) --
Describes the transit gateway peering attachment.
TransitGatewayAttachmentId (string) --
The ID of the transit gateway peering attachment.
AccepterTransitGatewayAttachmentId (string) --
The ID of the accepter transit gateway attachment.
RequesterTgwInfo (dict) --
Information about the requester transit gateway.
TransitGatewayId (string) --
The ID of the transit gateway.
CoreNetworkId (string) --
The ID of the core network where the transit gateway peer is located.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the transit gateway.
Region (string) --
The Region of the transit gateway.
AccepterTgwInfo (dict) --
Information about the accepter transit gateway.
TransitGatewayId (string) --
The ID of the transit gateway.
CoreNetworkId (string) --
The ID of the core network where the transit gateway peer is located.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the transit gateway.
Region (string) --
The Region of the transit gateway.
Options (dict) --
Details about the transit gateway peering attachment.
DynamicRouting (string) --
Describes whether dynamic routing is enabled or disabled for the transit gateway peering attachment.
RequesterAllowMultipathResilience (boolean) --
Indicates whether the requester allows multipath resilience for the transit gateway peering attachment.
RequesterMultipathResilienceMode (string) --
The multipath resilience mode for the requester. This value is present only when the requester allows multipath resilience.
AccepterAllowMultipathResilience (boolean) --
Indicates whether the accepter allows multipath resilience for the transit gateway peering attachment.
AccepterMultipathResilienceMode (string) --
The multipath resilience mode for the accepter. This value is present only when the accepter allows multipath resilience.
MultipathResilienceStatus (string) --
The multipath resilience status of the transit gateway peering attachment. The possible values are:
enabled – Both the requester and the accepter allow multipath resilience.
pending – Either the requester or the accepter allows multipath resilience, but not both.
disabled – Neither the requester nor the accepter allows multipath resilience.
Status (dict) --
The status of the transit gateway peering attachment.
Code (string) --
The status code.
Message (string) --
The status message, if applicable.
State (string) --
The state of the transit gateway peering attachment. Note that the initiating state has been deprecated.
CreationTime (datetime) --
The time the transit gateway peering attachment was created.
Tags (list) --
The tags for the transit gateway peering attachment.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
{'VpcPeeringConnections': {'AccepterVpcInfo': {'PeeringOptions': {'AllowMultipathResilience': 'boolean',
'MultipathResilienceMode': 'always-on'}},
'MultipathResilienceStatus': 'pending | enabled | '
'disabled',
'RequesterVpcInfo': {'PeeringOptions': {'AllowMultipathResilience': 'boolean',
'MultipathResilienceMode': 'always-on'}}}}
Describes your VPC peering connections. The default is to describe all your VPC peering connections. Alternatively, you can specify specific VPC peering connection IDs or filter the results to include only the VPC peering connections that match specific criteria.
See also: AWS API Documentation
Request Syntax
client.describe_vpc_peering_connections(
NextToken='string',
MaxResults=123,
DryRun=True|False,
VpcPeeringConnectionIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
]
)
string
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
integer
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
list
The IDs of the VPC peering connections.
Default: Describes all your VPC peering connections.
(string) --
list
The filters.
accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter VPC.
accepter-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the accepter VPC.
accepter-vpc-info.vpc-id - The ID of the accepter VPC.
expiration-time - The expiration date and time for the VPC peering connection.
requester-vpc-info.cidr-block - The IPv4 CIDR block of the requester's VPC.
requester-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the requester VPC.
requester-vpc-info.vpc-id - The ID of the requester VPC.
status-code - The status of the VPC peering connection ( pending-acceptance | failed | expired | provisioning | active | deleting | deleted | rejected).
status-message - A message that provides more information about the status of the VPC peering connection, if applicable.
tag - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-peering-connection-id - The ID of the VPC peering connection.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
dict
Response Syntax
{
'VpcPeeringConnections': [
{
'AccepterVpcInfo': {
'CidrBlock': 'string',
'Ipv6CidrBlockSet': [
{
'Ipv6CidrBlock': 'string'
},
],
'CidrBlockSet': [
{
'CidrBlock': 'string'
},
],
'OwnerId': 'string',
'PeeringOptions': {
'AllowDnsResolutionFromRemoteVpc': True|False,
'AllowEgressFromLocalClassicLinkToRemoteVpc': True|False,
'AllowEgressFromLocalVpcToRemoteClassicLink': True|False,
'AllowMultipathResilience': True|False,
'MultipathResilienceMode': 'always-on'
},
'VpcId': 'string',
'Region': 'string'
},
'ExpirationTime': datetime(2015, 1, 1),
'RequesterVpcInfo': {
'CidrBlock': 'string',
'Ipv6CidrBlockSet': [
{
'Ipv6CidrBlock': 'string'
},
],
'CidrBlockSet': [
{
'CidrBlock': 'string'
},
],
'OwnerId': 'string',
'PeeringOptions': {
'AllowDnsResolutionFromRemoteVpc': True|False,
'AllowEgressFromLocalClassicLinkToRemoteVpc': True|False,
'AllowEgressFromLocalVpcToRemoteClassicLink': True|False,
'AllowMultipathResilience': True|False,
'MultipathResilienceMode': 'always-on'
},
'VpcId': 'string',
'Region': 'string'
},
'Status': {
'Code': 'initiating-request'|'pending-acceptance'|'active'|'deleted'|'rejected'|'failed'|'expired'|'provisioning'|'deleting',
'Message': 'string'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VpcPeeringConnectionId': 'string',
'MultipathResilienceStatus': 'pending'|'enabled'|'disabled'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
VpcPeeringConnections (list) --
Information about the VPC peering connections.
(dict) --
Describes a VPC peering connection.
AccepterVpcInfo (dict) --
Information about the accepter VPC. CIDR block information is only returned when describing an active VPC peering connection.
CidrBlock (string) --
The IPv4 CIDR block for the VPC.
Ipv6CidrBlockSet (list) --
The IPv6 CIDR block for the VPC.
(dict) --
Describes an IPv6 CIDR block.
Ipv6CidrBlock (string) --
The IPv6 CIDR block.
CidrBlockSet (list) --
Information about the IPv4 CIDR blocks for the VPC.
(dict) --
Describes an IPv4 CIDR block.
CidrBlock (string) --
The IPv4 CIDR block.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the VPC.
PeeringOptions (dict) --
Information about the VPC peering connection options for the accepter or requester VPC.
AllowDnsResolutionFromRemoteVpc (boolean) --
Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.
AllowEgressFromLocalClassicLinkToRemoteVpc (boolean) --
Deprecated.
AllowEgressFromLocalVpcToRemoteClassicLink (boolean) --
Deprecated.
AllowMultipathResilience (boolean) --
Indicates whether this side of the VPC peering connection allows multipath resilience.
MultipathResilienceMode (string) --
The multipath resilience mode for this side of the VPC peering connection. This value is present only when this side allows multipath resilience.
VpcId (string) --
The ID of the VPC.
Region (string) --
The Region in which the VPC is located.
ExpirationTime (datetime) --
The time that an unaccepted VPC peering connection will expire.
RequesterVpcInfo (dict) --
Information about the requester VPC. CIDR block information is only returned when describing an active VPC peering connection.
CidrBlock (string) --
The IPv4 CIDR block for the VPC.
Ipv6CidrBlockSet (list) --
The IPv6 CIDR block for the VPC.
(dict) --
Describes an IPv6 CIDR block.
Ipv6CidrBlock (string) --
The IPv6 CIDR block.
CidrBlockSet (list) --
Information about the IPv4 CIDR blocks for the VPC.
(dict) --
Describes an IPv4 CIDR block.
CidrBlock (string) --
The IPv4 CIDR block.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the VPC.
PeeringOptions (dict) --
Information about the VPC peering connection options for the accepter or requester VPC.
AllowDnsResolutionFromRemoteVpc (boolean) --
Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.
AllowEgressFromLocalClassicLinkToRemoteVpc (boolean) --
Deprecated.
AllowEgressFromLocalVpcToRemoteClassicLink (boolean) --
Deprecated.
AllowMultipathResilience (boolean) --
Indicates whether this side of the VPC peering connection allows multipath resilience.
MultipathResilienceMode (string) --
The multipath resilience mode for this side of the VPC peering connection. This value is present only when this side allows multipath resilience.
VpcId (string) --
The ID of the VPC.
Region (string) --
The Region in which the VPC is located.
Status (dict) --
The status of the VPC peering connection.
Code (string) --
The status of the VPC peering connection.
Message (string) --
A message that provides more information about the status, if applicable.
Tags (list) --
Any tags assigned to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
VpcPeeringConnectionId (string) --
The ID of the VPC peering connection.
MultipathResilienceStatus (string) --
The multipath resilience status of the VPC peering connection. The possible values are:
enabled – Both the requester and the accepter allow multipath resilience.
pending – Either the requester or the accepter allows multipath resilience, but not both.
disabled – Neither the requester nor the accepter allows multipath resilience.
NextToken (string) --
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
{'VpnConnections': {'Options': {'TunnelOptions': {'Phase1AdditionalKeyExchanges': [{'AdditionalKeyExchangeRound': 'integer',
'KeyExchangeMethods': [{'Value': 'integer'}],
'Requirement': 'required '
'| '
'optional'}],
'Phase2AdditionalKeyExchanges': [{'AdditionalKeyExchangeRound': 'integer',
'KeyExchangeMethods': [{'Value': 'integer'}],
'Requirement': 'required '
'| '
'optional'}]}}}}
Describes one or more of your VPN connections.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
See also: AWS API Documentation
Request Syntax
client.describe_vpn_connections(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
VpnConnectionIds=[
'string',
],
DryRun=True|False
)
list
One or more filters.
customer-gateway-configuration - The configuration information for the customer gateway.
customer-gateway-id - The ID of a customer gateway associated with the VPN connection.
state - The state of the VPN connection ( pending | available | deleting | deleted).
option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).
route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.
bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
type - The type of VPN connection. Currently the only supported type is ipsec.1.
vpn-connection-id - The ID of the VPN connection.
vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.
transit-gateway-id - The ID of a transit gateway associated with the VPN connection.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
list
One or more VPN connection IDs.
Default: Describes your VPN connections.
(string) --
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'VpnConnections': [
{
'Category': 'string',
'TransitGatewayId': 'string',
'VpnConcentratorId': 'string',
'CoreNetworkArn': 'string',
'CoreNetworkAttachmentArn': 'string',
'GatewayAssociationState': 'associated'|'not-associated'|'associating'|'disassociating',
'Options': {
'EnableAcceleration': True|False,
'StaticRoutesOnly': True|False,
'LocalIpv4NetworkCidr': 'string',
'RemoteIpv4NetworkCidr': 'string',
'LocalIpv6NetworkCidr': 'string',
'RemoteIpv6NetworkCidr': 'string',
'OutsideIpAddressType': 'string',
'TransportTransitGatewayAttachmentId': 'string',
'TunnelInsideIpVersion': 'ipv4'|'ipv6',
'TunnelOptions': [
{
'OutsideIpAddress': 'string',
'TunnelInsideCidr': 'string',
'TunnelInsideIpv6Cidr': 'string',
'PreSharedKey': 'string',
'Phase1LifetimeSeconds': 123,
'Phase2LifetimeSeconds': 123,
'RekeyMarginTimeSeconds': 123,
'RekeyFuzzPercentage': 123,
'ReplayWindowSize': 123,
'DpdTimeoutSeconds': 123,
'DpdTimeoutAction': 'string',
'Phase1EncryptionAlgorithms': [
{
'Value': 'string'
},
],
'Phase2EncryptionAlgorithms': [
{
'Value': 'string'
},
],
'Phase1IntegrityAlgorithms': [
{
'Value': 'string'
},
],
'Phase2IntegrityAlgorithms': [
{
'Value': 'string'
},
],
'Phase1DHGroupNumbers': [
{
'Value': 123
},
],
'Phase2DHGroupNumbers': [
{
'Value': 123
},
],
'IkeVersions': [
{
'Value': 'string'
},
],
'StartupAction': 'string',
'LogOptions': {
'CloudWatchLogOptions': {
'LogEnabled': True|False,
'LogGroupArn': 'string',
'LogOutputFormat': 'string',
'BgpLogEnabled': True|False,
'BgpLogGroupArn': 'string',
'BgpLogOutputFormat': 'string'
}
},
'EnableTunnelLifecycleControl': True|False,
'Phase1AdditionalKeyExchanges': [
{
'AdditionalKeyExchangeRound': 123,
'KeyExchangeMethods': [
{
'Value': 123
},
],
'Requirement': 'required'|'optional'
},
],
'Phase2AdditionalKeyExchanges': [
{
'AdditionalKeyExchangeRound': 123,
'KeyExchangeMethods': [
{
'Value': 123
},
],
'Requirement': 'required'|'optional'
},
]
},
],
'TunnelBandwidth': 'standard'|'large'
},
'Routes': [
{
'DestinationCidrBlock': 'string',
'Source': 'Static',
'State': 'pending'|'available'|'deleting'|'deleted'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VgwTelemetry': [
{
'AcceptedRouteCount': 123,
'LastStatusChange': datetime(2015, 1, 1),
'OutsideIpAddress': 'string',
'Status': 'UP'|'DOWN',
'StatusMessage': 'string',
'CertificateArn': 'string'
},
],
'PreSharedKeyArn': 'string',
'VpnConnectionId': 'string',
'State': 'pending'|'available'|'deleting'|'deleted',
'CustomerGatewayConfiguration': 'string',
'Type': 'ipsec.1',
'CustomerGatewayId': 'string',
'VpnGatewayId': 'string'
},
]
}
Response Structure
(dict) --
Contains the output of DescribeVpnConnections.
VpnConnections (list) --
Information about one or more VPN connections.
(dict) --
Describes a VPN connection.
Category (string) --
The category of the VPN connection. A value of VPN indicates an Amazon Web Services VPN connection. A value of VPN-Classic indicates an Amazon Web Services Classic VPN connection.
TransitGatewayId (string) --
The ID of the transit gateway associated with the VPN connection.
VpnConcentratorId (string) --
The ID of the VPN concentrator associated with the VPN connection.
CoreNetworkArn (string) --
The ARN of the core network.
CoreNetworkAttachmentArn (string) --
The ARN of the core network attachment.
GatewayAssociationState (string) --
The current state of the gateway association.
Options (dict) --
The VPN connection options.
EnableAcceleration (boolean) --
Indicates whether acceleration is enabled for the VPN connection.
StaticRoutesOnly (boolean) --
Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
LocalIpv4NetworkCidr (string) --
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv4NetworkCidr (string) --
The IPv4 CIDR on the Amazon Web Services side of the VPN connection.
LocalIpv6NetworkCidr (string) --
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv6NetworkCidr (string) --
The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
OutsideIpAddressType (string) --
The type of IPv4 address assigned to the outside interface of the customer gateway.
Valid values: PrivateIpv4 | PublicIpv4 | Ipv6
Default: PublicIpv4
TransportTransitGatewayAttachmentId (string) --
The transit gateway attachment ID in use for the VPN tunnel.
TunnelInsideIpVersion (string) --
Indicates whether the VPN tunnels process IPv4 or IPv6 traffic.
TunnelOptions (list) --
Indicates the VPN tunnel options.
(dict) --
The VPN tunnel options.
OutsideIpAddress (string) --
The external IP address of the VPN tunnel.
TunnelInsideCidr (string) --
The range of inside IPv4 addresses for the tunnel.
TunnelInsideIpv6Cidr (string) --
The range of inside IPv6 addresses for the tunnel.
PreSharedKey (string) --
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.
Phase1LifetimeSeconds (integer) --
The lifetime for phase 1 of the IKE negotiation, in seconds.
Phase2LifetimeSeconds (integer) --
The lifetime for phase 2 of the IKE negotiation, in seconds.
RekeyMarginTimeSeconds (integer) --
The margin time, in seconds, before the phase 2 lifetime expires, during which the Amazon Web Services side of the VPN connection performs an IKE rekey.
RekeyFuzzPercentage (integer) --
The percentage of the rekey window determined by RekeyMarginTimeSeconds during which the rekey time is randomly selected.
ReplayWindowSize (integer) --
The number of packets in an IKE replay window.
DpdTimeoutSeconds (integer) --
The number of seconds after which a DPD timeout occurs.
DpdTimeoutAction (string) --
The action to take after a DPD timeout occurs.
Phase1EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The encryption algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the encryption algorithm.
Phase2EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The encryption algorithm for phase 2 IKE negotiations.
Value (string) --
The encryption algorithm.
Phase1IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The integrity algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the integrity algorithm.
Phase2IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The integrity algorithm for phase 2 IKE negotiations.
Value (string) --
The integrity algorithm.
Phase1DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 1 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
Phase2DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 2 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
IkeVersions (list) --
The IKE versions that are permitted for the VPN tunnel.
(dict) --
The internet key exchange (IKE) version permitted for the VPN tunnel.
Value (string) --
The IKE version.
StartupAction (string) --
The action to take when the establishing the VPN tunnels for a VPN connection.
LogOptions (dict) --
Options for logging VPN tunnel activity.
CloudWatchLogOptions (dict) --
Options for sending VPN tunnel logs to CloudWatch.
LogEnabled (boolean) --
Status of VPN tunnel logging feature. Default value is False.
Valid values: True | False
LogGroupArn (string) --
The Amazon Resource Name (ARN) of the CloudWatch log group to send logs to.
LogOutputFormat (string) --
Configured log format. Default format is json.
Valid values: json | text
BgpLogEnabled (boolean) --
Indicates whether Border Gateway Protocol (BGP) logging is enabled for the VPN connection. Default value is False.
Valid values: True | False
BgpLogGroupArn (string) --
The Amazon Resource Name (ARN) of the CloudWatch log group for BGP logs.
BgpLogOutputFormat (string) --
The output format for BGP logs sent to CloudWatch. Default format is json.
Valid values: json | text
EnableTunnelLifecycleControl (boolean) --
Status of tunnel endpoint lifecycle control feature.
Phase1AdditionalKeyExchanges (list) --
The permitted additional key exchange rounds for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
Describes an additional key exchange round that is permitted for the VPN tunnel.
AdditionalKeyExchangeRound (integer) --
The additional key exchange round number.
KeyExchangeMethods (list) --
The key exchange method numbers permitted for this round.
(dict) --
The key exchange method number that is permitted for an additional key exchange round.
Value (integer) --
The key exchange method number.
Requirement (string) --
Indicates whether this round is mandatory.
Phase2AdditionalKeyExchanges (list) --
The permitted additional key exchange rounds for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
Describes an additional key exchange round that is permitted for the VPN tunnel.
AdditionalKeyExchangeRound (integer) --
The additional key exchange round number.
KeyExchangeMethods (list) --
The key exchange method numbers permitted for this round.
(dict) --
The key exchange method number that is permitted for an additional key exchange round.
Value (integer) --
The key exchange method number.
Requirement (string) --
Indicates whether this round is mandatory.
TunnelBandwidth (string) --
The configured bandwidth for the VPN tunnel. Represents the current throughput capacity setting for the tunnel connection. standard tunnel bandwidth supports up to 1.25 Gbps per tunnel while large supports up to 5 Gbps per tunnel. If no tunnel bandwidth was specified for the connection, standard is used as the default value.
Routes (list) --
The static routes associated with the VPN connection.
(dict) --
Describes a static route for a VPN connection.
DestinationCidrBlock (string) --
The CIDR block associated with the local subnet of the customer data center.
Source (string) --
Indicates how the routes were provided.
State (string) --
The current state of the static route.
Tags (list) --
Any tags assigned to the VPN connection.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
VgwTelemetry (list) --
Information about the VPN tunnel.
(dict) --
Describes telemetry for a VPN tunnel.
AcceptedRouteCount (integer) --
The number of accepted routes.
LastStatusChange (datetime) --
The date and time of the last change in status. This field is updated when changes in IKE (Phase 1), IPSec (Phase 2), or BGP status are detected.
OutsideIpAddress (string) --
The Internet-routable IP address of the virtual private gateway's outside interface.
Status (string) --
The status of the VPN tunnel.
StatusMessage (string) --
If an error occurs, a description of the error.
CertificateArn (string) --
The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.
PreSharedKeyArn (string) --
The Amazon Resource Name (ARN) of the Secrets Manager secret storing the pre-shared key(s) for the VPN connection.
VpnConnectionId (string) --
The ID of the VPN connection.
State (string) --
The current state of the VPN connection.
CustomerGatewayConfiguration (string) --
The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.
Type (string) --
The type of VPN connection.
CustomerGatewayId (string) --
The ID of the customer gateway at your end of the VPN connection.
VpnGatewayId (string) --
The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection.
{'ActiveVpnTunnelStatus': {'Phase1AdditionalKeyExchanges': [{'AdditionalKeyExchangeRound': 'integer',
'KeyExchangeMethod': 'integer'}],
'Phase2AdditionalKeyExchanges': [{'AdditionalKeyExchangeRound': 'integer',
'KeyExchangeMethod': 'integer'}]}}
Returns the currently negotiated security parameters for an active VPN tunnel, including IKE version, DH groups, encryption algorithms, and integrity algorithms.
See also: AWS API Documentation
Request Syntax
client.get_active_vpn_tunnel_status(
VpnConnectionId='string',
VpnTunnelOutsideIpAddress='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the VPN connection for which to retrieve the active tunnel status.
string
[REQUIRED]
The external IP address of the VPN tunnel for which to retrieve the active status.
boolean
Checks whether you have the required permissions for the action, without actually making the request.
dict
Response Syntax
{
'ActiveVpnTunnelStatus': {
'Phase1EncryptionAlgorithm': 'string',
'Phase2EncryptionAlgorithm': 'string',
'Phase1IntegrityAlgorithm': 'string',
'Phase2IntegrityAlgorithm': 'string',
'Phase1DHGroup': 123,
'Phase2DHGroup': 123,
'IkeVersion': 'string',
'ProvisioningStatus': 'available'|'pending'|'failed',
'ProvisioningStatusReason': 'string',
'Phase1AdditionalKeyExchanges': [
{
'AdditionalKeyExchangeRound': 123,
'KeyExchangeMethod': 123
},
],
'Phase2AdditionalKeyExchanges': [
{
'AdditionalKeyExchangeRound': 123,
'KeyExchangeMethod': 123
},
]
}
}
Response Structure
(dict) --
ActiveVpnTunnelStatus (dict) --
Information about the current security configuration of the VPN tunnel.
Phase1EncryptionAlgorithm (string) --
The encryption algorithm negotiated in Phase 1 IKE negotiations.
Phase2EncryptionAlgorithm (string) --
The encryption algorithm negotiated in Phase 2 IKE negotiations.
Phase1IntegrityAlgorithm (string) --
The integrity algorithm negotiated in Phase 1 IKE negotiations.
Phase2IntegrityAlgorithm (string) --
The integrity algorithm negotiated in Phase 2 IKE negotiations.
Phase1DHGroup (integer) --
The Diffie-Hellman group number being used in Phase 1 IKE negotiations.
Phase2DHGroup (integer) --
The Diffie-Hellman group number being used in Phase 2 IKE negotiations.
IkeVersion (string) --
The version of the Internet Key Exchange (IKE) protocol being used.
ProvisioningStatus (string) --
The current provisioning status of the VPN tunnel.
ProvisioningStatusReason (string) --
The reason for the current provisioning status.
Phase1AdditionalKeyExchanges (list) --
The additional key exchanges negotiated in Phase 1 IKE negotiations.
(dict) --
Describes an additional key exchange round negotiated for an active VPN tunnel.
AdditionalKeyExchangeRound (integer) --
The additional key exchange round number.
KeyExchangeMethod (integer) --
The key exchange method number negotiated for this round.
Phase2AdditionalKeyExchanges (list) --
The additional key exchanges negotiated in Phase 2 IKE negotiations.
(dict) --
Describes an additional key exchange round negotiated for an active VPN tunnel.
AdditionalKeyExchangeRound (integer) --
The additional key exchange round number.
KeyExchangeMethod (integer) --
The key exchange method number negotiated for this round.
{'AccepterPeeringConnectionOptions': {'AllowMultipathResilience': 'boolean',
'MultipathResilienceMode': 'always-on'},
'RequesterPeeringConnectionOptions': {'AllowMultipathResilience': 'boolean',
'MultipathResilienceMode': 'always-on'}}
Modifies the VPC peering connection options on one side of a VPC peering connection.
If the peered VPCs are in the same Amazon Web Services account, you can enable DNS resolution for queries from the local VPC. This ensures that queries from the local VPC resolve to private IP addresses in the peer VPC. This option is not available if the peered VPCs are in different Amazon Web Services accounts or different Regions. For peered VPCs in different Amazon Web Services accounts, each Amazon Web Services account owner must initiate a separate request to modify the peering connection options. For inter-region peering connections, you must use the Region for the requester VPC to modify the requester VPC peering options and the Region for the accepter VPC to modify the accepter VPC peering options. To verify which VPCs are the accepter and the requester for a VPC peering connection, use the DescribeVpcPeeringConnections command.
Multipath resilience replicates the traffic of an inter-Region VPC peering connection across multiple network paths. You can allow multipath resilience for your side of the connection if both of its Regions are supported. It takes effect only when both the requester and the accepter allow it. Additional charges apply when multipath resilience is in effect. For more information, see Amazon VPC pricing. To check whether multipath resilience is in effect, use DescribeVpcPeeringConnections and check multipathResilienceStatus.
See also: AWS API Documentation
Request Syntax
client.modify_vpc_peering_connection_options(
AccepterPeeringConnectionOptions={
'AllowDnsResolutionFromRemoteVpc': True|False,
'AllowEgressFromLocalClassicLinkToRemoteVpc': True|False,
'AllowEgressFromLocalVpcToRemoteClassicLink': True|False,
'AllowMultipathResilience': True|False,
'MultipathResilienceMode': 'always-on'
},
DryRun=True|False,
RequesterPeeringConnectionOptions={
'AllowDnsResolutionFromRemoteVpc': True|False,
'AllowEgressFromLocalClassicLinkToRemoteVpc': True|False,
'AllowEgressFromLocalVpcToRemoteClassicLink': True|False,
'AllowMultipathResilience': True|False,
'MultipathResilienceMode': 'always-on'
},
VpcPeeringConnectionId='string'
)
dict
The VPC peering connection options for the accepter VPC.
AllowDnsResolutionFromRemoteVpc (boolean) --
If true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.
AllowEgressFromLocalClassicLinkToRemoteVpc (boolean) --
Deprecated.
AllowEgressFromLocalVpcToRemoteClassicLink (boolean) --
Deprecated.
AllowMultipathResilience (boolean) --
Specifies whether you allow multipath resilience for this side of the VPC peering connection. Multipath resilience is supported only for inter-Region VPC peering connections between supported Regions. It takes effect only when both the requester and the accepter allow it. If you don't specify this parameter, the current setting doesn't change.
MultipathResilienceMode (string) --
The multipath resilience mode. You can specify this parameter only if AllowMultipathResilience is true.
The following value is valid:
always-on – Replicates traffic across multiple network paths while multipath resilience is in effect.
If AllowMultipathResilience is true and you don't specify a mode, the default is always-on.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
The VPC peering connection options for the requester VPC.
AllowDnsResolutionFromRemoteVpc (boolean) --
If true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.
AllowEgressFromLocalClassicLinkToRemoteVpc (boolean) --
Deprecated.
AllowEgressFromLocalVpcToRemoteClassicLink (boolean) --
Deprecated.
AllowMultipathResilience (boolean) --
Specifies whether you allow multipath resilience for this side of the VPC peering connection. Multipath resilience is supported only for inter-Region VPC peering connections between supported Regions. It takes effect only when both the requester and the accepter allow it. If you don't specify this parameter, the current setting doesn't change.
MultipathResilienceMode (string) --
The multipath resilience mode. You can specify this parameter only if AllowMultipathResilience is true.
The following value is valid:
always-on – Replicates traffic across multiple network paths while multipath resilience is in effect.
If AllowMultipathResilience is true and you don't specify a mode, the default is always-on.
string
[REQUIRED]
The ID of the VPC peering connection.
dict
Response Syntax
{
'AccepterPeeringConnectionOptions': {
'AllowDnsResolutionFromRemoteVpc': True|False,
'AllowEgressFromLocalClassicLinkToRemoteVpc': True|False,
'AllowEgressFromLocalVpcToRemoteClassicLink': True|False,
'AllowMultipathResilience': True|False,
'MultipathResilienceMode': 'always-on'
},
'RequesterPeeringConnectionOptions': {
'AllowDnsResolutionFromRemoteVpc': True|False,
'AllowEgressFromLocalClassicLinkToRemoteVpc': True|False,
'AllowEgressFromLocalVpcToRemoteClassicLink': True|False,
'AllowMultipathResilience': True|False,
'MultipathResilienceMode': 'always-on'
}
}
Response Structure
(dict) --
AccepterPeeringConnectionOptions (dict) --
Information about the VPC peering connection options for the accepter VPC.
AllowDnsResolutionFromRemoteVpc (boolean) --
If true, the public DNS hostnames of instances in the specified VPC resolve to private IP addresses when queried from instances in the peer VPC.
AllowEgressFromLocalClassicLinkToRemoteVpc (boolean) --
Deprecated.
AllowEgressFromLocalVpcToRemoteClassicLink (boolean) --
Deprecated.
AllowMultipathResilience (boolean) --
Indicates whether this side of the VPC peering connection allows multipath resilience.
MultipathResilienceMode (string) --
The multipath resilience mode for this side of the VPC peering connection. This value is present only when this side allows multipath resilience.
RequesterPeeringConnectionOptions (dict) --
Information about the VPC peering connection options for the requester VPC.
AllowDnsResolutionFromRemoteVpc (boolean) --
If true, the public DNS hostnames of instances in the specified VPC resolve to private IP addresses when queried from instances in the peer VPC.
AllowEgressFromLocalClassicLinkToRemoteVpc (boolean) --
Deprecated.
AllowEgressFromLocalVpcToRemoteClassicLink (boolean) --
Deprecated.
AllowMultipathResilience (boolean) --
Indicates whether this side of the VPC peering connection allows multipath resilience.
MultipathResilienceMode (string) --
The multipath resilience mode for this side of the VPC peering connection. This value is present only when this side allows multipath resilience.
{'VpnConnection': {'Options': {'TunnelOptions': {'Phase1AdditionalKeyExchanges': [{'AdditionalKeyExchangeRound': 'integer',
'KeyExchangeMethods': [{'Value': 'integer'}],
'Requirement': 'required '
'| '
'optional'}],
'Phase2AdditionalKeyExchanges': [{'AdditionalKeyExchangeRound': 'integer',
'KeyExchangeMethods': [{'Value': 'integer'}],
'Requirement': 'required '
'| '
'optional'}]}}}}
Modifies the customer gateway or the target gateway of an Amazon Web Services Site-to-Site VPN connection. To modify the target gateway, the following migration options are available:
An existing virtual private gateway to a new virtual private gateway
An existing virtual private gateway to a transit gateway
An existing transit gateway to a new transit gateway
An existing transit gateway to a virtual private gateway
Before you perform the migration to the new gateway, you must configure the new gateway. Use CreateVpnGateway to create a virtual private gateway, or CreateTransitGateway to create a transit gateway.
This step is required when you migrate from a virtual private gateway with static routes to a transit gateway.
You must delete the static routes before you migrate to the new gateway.
Keep a copy of the static route before you delete it. You will need to add back these routes to the transit gateway after the VPN connection migration is complete.
After you migrate to the new gateway, you might need to modify your VPC route table. Use CreateRoute and DeleteRoute to make the changes described in Update VPC route tables in the Amazon Web Services Site-to-Site VPN User Guide.
When the new gateway is a transit gateway, modify the transit gateway route table to allow traffic between the VPC and the Amazon Web Services Site-to-Site VPN connection. Use CreateTransitGatewayRoute to add the routes.
If you deleted VPN static routes, you must add the static routes to the transit gateway route table.
After you perform this operation, the VPN endpoint's IP addresses on the Amazon Web Services side and the tunnel options remain intact. Your Amazon Web Services Site-to-Site VPN connection will be temporarily unavailable for a brief period while we provision the new endpoints.
See also: AWS API Documentation
Request Syntax
client.modify_vpn_connection(
VpnConnectionId='string',
TransitGatewayId='string',
CustomerGatewayId='string',
VpnGatewayId='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the VPN connection.
string
The ID of the transit gateway.
string
The ID of the customer gateway at your end of the VPN connection.
string
The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'VpnConnection': {
'Category': 'string',
'TransitGatewayId': 'string',
'VpnConcentratorId': 'string',
'CoreNetworkArn': 'string',
'CoreNetworkAttachmentArn': 'string',
'GatewayAssociationState': 'associated'|'not-associated'|'associating'|'disassociating',
'Options': {
'EnableAcceleration': True|False,
'StaticRoutesOnly': True|False,
'LocalIpv4NetworkCidr': 'string',
'RemoteIpv4NetworkCidr': 'string',
'LocalIpv6NetworkCidr': 'string',
'RemoteIpv6NetworkCidr': 'string',
'OutsideIpAddressType': 'string',
'TransportTransitGatewayAttachmentId': 'string',
'TunnelInsideIpVersion': 'ipv4'|'ipv6',
'TunnelOptions': [
{
'OutsideIpAddress': 'string',
'TunnelInsideCidr': 'string',
'TunnelInsideIpv6Cidr': 'string',
'PreSharedKey': 'string',
'Phase1LifetimeSeconds': 123,
'Phase2LifetimeSeconds': 123,
'RekeyMarginTimeSeconds': 123,
'RekeyFuzzPercentage': 123,
'ReplayWindowSize': 123,
'DpdTimeoutSeconds': 123,
'DpdTimeoutAction': 'string',
'Phase1EncryptionAlgorithms': [
{
'Value': 'string'
},
],
'Phase2EncryptionAlgorithms': [
{
'Value': 'string'
},
],
'Phase1IntegrityAlgorithms': [
{
'Value': 'string'
},
],
'Phase2IntegrityAlgorithms': [
{
'Value': 'string'
},
],
'Phase1DHGroupNumbers': [
{
'Value': 123
},
],
'Phase2DHGroupNumbers': [
{
'Value': 123
},
],
'IkeVersions': [
{
'Value': 'string'
},
],
'StartupAction': 'string',
'LogOptions': {
'CloudWatchLogOptions': {
'LogEnabled': True|False,
'LogGroupArn': 'string',
'LogOutputFormat': 'string',
'BgpLogEnabled': True|False,
'BgpLogGroupArn': 'string',
'BgpLogOutputFormat': 'string'
}
},
'EnableTunnelLifecycleControl': True|False,
'Phase1AdditionalKeyExchanges': [
{
'AdditionalKeyExchangeRound': 123,
'KeyExchangeMethods': [
{
'Value': 123
},
],
'Requirement': 'required'|'optional'
},
],
'Phase2AdditionalKeyExchanges': [
{
'AdditionalKeyExchangeRound': 123,
'KeyExchangeMethods': [
{
'Value': 123
},
],
'Requirement': 'required'|'optional'
},
]
},
],
'TunnelBandwidth': 'standard'|'large'
},
'Routes': [
{
'DestinationCidrBlock': 'string',
'Source': 'Static',
'State': 'pending'|'available'|'deleting'|'deleted'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VgwTelemetry': [
{
'AcceptedRouteCount': 123,
'LastStatusChange': datetime(2015, 1, 1),
'OutsideIpAddress': 'string',
'Status': 'UP'|'DOWN',
'StatusMessage': 'string',
'CertificateArn': 'string'
},
],
'PreSharedKeyArn': 'string',
'VpnConnectionId': 'string',
'State': 'pending'|'available'|'deleting'|'deleted',
'CustomerGatewayConfiguration': 'string',
'Type': 'ipsec.1',
'CustomerGatewayId': 'string',
'VpnGatewayId': 'string'
}
}
Response Structure
(dict) --
VpnConnection (dict) --
Information about the VPN connection.
Category (string) --
The category of the VPN connection. A value of VPN indicates an Amazon Web Services VPN connection. A value of VPN-Classic indicates an Amazon Web Services Classic VPN connection.
TransitGatewayId (string) --
The ID of the transit gateway associated with the VPN connection.
VpnConcentratorId (string) --
The ID of the VPN concentrator associated with the VPN connection.
CoreNetworkArn (string) --
The ARN of the core network.
CoreNetworkAttachmentArn (string) --
The ARN of the core network attachment.
GatewayAssociationState (string) --
The current state of the gateway association.
Options (dict) --
The VPN connection options.
EnableAcceleration (boolean) --
Indicates whether acceleration is enabled for the VPN connection.
StaticRoutesOnly (boolean) --
Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
LocalIpv4NetworkCidr (string) --
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv4NetworkCidr (string) --
The IPv4 CIDR on the Amazon Web Services side of the VPN connection.
LocalIpv6NetworkCidr (string) --
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv6NetworkCidr (string) --
The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
OutsideIpAddressType (string) --
The type of IPv4 address assigned to the outside interface of the customer gateway.
Valid values: PrivateIpv4 | PublicIpv4 | Ipv6
Default: PublicIpv4
TransportTransitGatewayAttachmentId (string) --
The transit gateway attachment ID in use for the VPN tunnel.
TunnelInsideIpVersion (string) --
Indicates whether the VPN tunnels process IPv4 or IPv6 traffic.
TunnelOptions (list) --
Indicates the VPN tunnel options.
(dict) --
The VPN tunnel options.
OutsideIpAddress (string) --
The external IP address of the VPN tunnel.
TunnelInsideCidr (string) --
The range of inside IPv4 addresses for the tunnel.
TunnelInsideIpv6Cidr (string) --
The range of inside IPv6 addresses for the tunnel.
PreSharedKey (string) --
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.
Phase1LifetimeSeconds (integer) --
The lifetime for phase 1 of the IKE negotiation, in seconds.
Phase2LifetimeSeconds (integer) --
The lifetime for phase 2 of the IKE negotiation, in seconds.
RekeyMarginTimeSeconds (integer) --
The margin time, in seconds, before the phase 2 lifetime expires, during which the Amazon Web Services side of the VPN connection performs an IKE rekey.
RekeyFuzzPercentage (integer) --
The percentage of the rekey window determined by RekeyMarginTimeSeconds during which the rekey time is randomly selected.
ReplayWindowSize (integer) --
The number of packets in an IKE replay window.
DpdTimeoutSeconds (integer) --
The number of seconds after which a DPD timeout occurs.
DpdTimeoutAction (string) --
The action to take after a DPD timeout occurs.
Phase1EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The encryption algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the encryption algorithm.
Phase2EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The encryption algorithm for phase 2 IKE negotiations.
Value (string) --
The encryption algorithm.
Phase1IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The integrity algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the integrity algorithm.
Phase2IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The integrity algorithm for phase 2 IKE negotiations.
Value (string) --
The integrity algorithm.
Phase1DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 1 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
Phase2DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 2 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
IkeVersions (list) --
The IKE versions that are permitted for the VPN tunnel.
(dict) --
The internet key exchange (IKE) version permitted for the VPN tunnel.
Value (string) --
The IKE version.
StartupAction (string) --
The action to take when the establishing the VPN tunnels for a VPN connection.
LogOptions (dict) --
Options for logging VPN tunnel activity.
CloudWatchLogOptions (dict) --
Options for sending VPN tunnel logs to CloudWatch.
LogEnabled (boolean) --
Status of VPN tunnel logging feature. Default value is False.
Valid values: True | False
LogGroupArn (string) --
The Amazon Resource Name (ARN) of the CloudWatch log group to send logs to.
LogOutputFormat (string) --
Configured log format. Default format is json.
Valid values: json | text
BgpLogEnabled (boolean) --
Indicates whether Border Gateway Protocol (BGP) logging is enabled for the VPN connection. Default value is False.
Valid values: True | False
BgpLogGroupArn (string) --
The Amazon Resource Name (ARN) of the CloudWatch log group for BGP logs.
BgpLogOutputFormat (string) --
The output format for BGP logs sent to CloudWatch. Default format is json.
Valid values: json | text
EnableTunnelLifecycleControl (boolean) --
Status of tunnel endpoint lifecycle control feature.
Phase1AdditionalKeyExchanges (list) --
The permitted additional key exchange rounds for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
Describes an additional key exchange round that is permitted for the VPN tunnel.
AdditionalKeyExchangeRound (integer) --
The additional key exchange round number.
KeyExchangeMethods (list) --
The key exchange method numbers permitted for this round.
(dict) --
The key exchange method number that is permitted for an additional key exchange round.
Value (integer) --
The key exchange method number.
Requirement (string) --
Indicates whether this round is mandatory.
Phase2AdditionalKeyExchanges (list) --
The permitted additional key exchange rounds for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
Describes an additional key exchange round that is permitted for the VPN tunnel.
AdditionalKeyExchangeRound (integer) --
The additional key exchange round number.
KeyExchangeMethods (list) --
The key exchange method numbers permitted for this round.
(dict) --
The key exchange method number that is permitted for an additional key exchange round.
Value (integer) --
The key exchange method number.
Requirement (string) --
Indicates whether this round is mandatory.
TunnelBandwidth (string) --
The configured bandwidth for the VPN tunnel. Represents the current throughput capacity setting for the tunnel connection. standard tunnel bandwidth supports up to 1.25 Gbps per tunnel while large supports up to 5 Gbps per tunnel. If no tunnel bandwidth was specified for the connection, standard is used as the default value.
Routes (list) --
The static routes associated with the VPN connection.
(dict) --
Describes a static route for a VPN connection.
DestinationCidrBlock (string) --
The CIDR block associated with the local subnet of the customer data center.
Source (string) --
Indicates how the routes were provided.
State (string) --
The current state of the static route.
Tags (list) --
Any tags assigned to the VPN connection.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
VgwTelemetry (list) --
Information about the VPN tunnel.
(dict) --
Describes telemetry for a VPN tunnel.
AcceptedRouteCount (integer) --
The number of accepted routes.
LastStatusChange (datetime) --
The date and time of the last change in status. This field is updated when changes in IKE (Phase 1), IPSec (Phase 2), or BGP status are detected.
OutsideIpAddress (string) --
The Internet-routable IP address of the virtual private gateway's outside interface.
Status (string) --
The status of the VPN tunnel.
StatusMessage (string) --
If an error occurs, a description of the error.
CertificateArn (string) --
The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.
PreSharedKeyArn (string) --
The Amazon Resource Name (ARN) of the Secrets Manager secret storing the pre-shared key(s) for the VPN connection.
VpnConnectionId (string) --
The ID of the VPN connection.
State (string) --
The current state of the VPN connection.
CustomerGatewayConfiguration (string) --
The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.
Type (string) --
The type of VPN connection.
CustomerGatewayId (string) --
The ID of the customer gateway at your end of the VPN connection.
VpnGatewayId (string) --
The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection.
{'VpnConnection': {'Options': {'TunnelOptions': {'Phase1AdditionalKeyExchanges': [{'AdditionalKeyExchangeRound': 'integer',
'KeyExchangeMethods': [{'Value': 'integer'}],
'Requirement': 'required '
'| '
'optional'}],
'Phase2AdditionalKeyExchanges': [{'AdditionalKeyExchangeRound': 'integer',
'KeyExchangeMethods': [{'Value': 'integer'}],
'Requirement': 'required '
'| '
'optional'}]}}}}
Modifies the connection options for your Site-to-Site VPN connection.
When you modify the VPN connection options, the VPN endpoint IP addresses on the Amazon Web Services side do not change, and the tunnel options do not change. Your VPN connection will be temporarily unavailable for a brief period while the VPN connection is updated.
See also: AWS API Documentation
Request Syntax
client.modify_vpn_connection_options(
VpnConnectionId='string',
LocalIpv4NetworkCidr='string',
RemoteIpv4NetworkCidr='string',
LocalIpv6NetworkCidr='string',
RemoteIpv6NetworkCidr='string',
TunnelBandwidth='standard'|'large',
DryRun=True|False
)
string
[REQUIRED]
The ID of the Site-to-Site VPN connection.
string
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: 0.0.0.0/0
string
The IPv4 CIDR on the Amazon Web Services side of the VPN connection.
Default: 0.0.0.0/0
string
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: ::/0
string
The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
Default: ::/0
string
The desired bandwidth specification for the VPN connection. standard supports up to 1.25 Gbps per tunnel, while large supports up to 5 Gbps per tunnel. Large bandwidth is only available for VPN connections attached to a transit gateway or to Cloud WAN. The default value is standard.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'VpnConnection': {
'Category': 'string',
'TransitGatewayId': 'string',
'VpnConcentratorId': 'string',
'CoreNetworkArn': 'string',
'CoreNetworkAttachmentArn': 'string',
'GatewayAssociationState': 'associated'|'not-associated'|'associating'|'disassociating',
'Options': {
'EnableAcceleration': True|False,
'StaticRoutesOnly': True|False,
'LocalIpv4NetworkCidr': 'string',
'RemoteIpv4NetworkCidr': 'string',
'LocalIpv6NetworkCidr': 'string',
'RemoteIpv6NetworkCidr': 'string',
'OutsideIpAddressType': 'string',
'TransportTransitGatewayAttachmentId': 'string',
'TunnelInsideIpVersion': 'ipv4'|'ipv6',
'TunnelOptions': [
{
'OutsideIpAddress': 'string',
'TunnelInsideCidr': 'string',
'TunnelInsideIpv6Cidr': 'string',
'PreSharedKey': 'string',
'Phase1LifetimeSeconds': 123,
'Phase2LifetimeSeconds': 123,
'RekeyMarginTimeSeconds': 123,
'RekeyFuzzPercentage': 123,
'ReplayWindowSize': 123,
'DpdTimeoutSeconds': 123,
'DpdTimeoutAction': 'string',
'Phase1EncryptionAlgorithms': [
{
'Value': 'string'
},
],
'Phase2EncryptionAlgorithms': [
{
'Value': 'string'
},
],
'Phase1IntegrityAlgorithms': [
{
'Value': 'string'
},
],
'Phase2IntegrityAlgorithms': [
{
'Value': 'string'
},
],
'Phase1DHGroupNumbers': [
{
'Value': 123
},
],
'Phase2DHGroupNumbers': [
{
'Value': 123
},
],
'IkeVersions': [
{
'Value': 'string'
},
],
'StartupAction': 'string',
'LogOptions': {
'CloudWatchLogOptions': {
'LogEnabled': True|False,
'LogGroupArn': 'string',
'LogOutputFormat': 'string',
'BgpLogEnabled': True|False,
'BgpLogGroupArn': 'string',
'BgpLogOutputFormat': 'string'
}
},
'EnableTunnelLifecycleControl': True|False,
'Phase1AdditionalKeyExchanges': [
{
'AdditionalKeyExchangeRound': 123,
'KeyExchangeMethods': [
{
'Value': 123
},
],
'Requirement': 'required'|'optional'
},
],
'Phase2AdditionalKeyExchanges': [
{
'AdditionalKeyExchangeRound': 123,
'KeyExchangeMethods': [
{
'Value': 123
},
],
'Requirement': 'required'|'optional'
},
]
},
],
'TunnelBandwidth': 'standard'|'large'
},
'Routes': [
{
'DestinationCidrBlock': 'string',
'Source': 'Static',
'State': 'pending'|'available'|'deleting'|'deleted'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VgwTelemetry': [
{
'AcceptedRouteCount': 123,
'LastStatusChange': datetime(2015, 1, 1),
'OutsideIpAddress': 'string',
'Status': 'UP'|'DOWN',
'StatusMessage': 'string',
'CertificateArn': 'string'
},
],
'PreSharedKeyArn': 'string',
'VpnConnectionId': 'string',
'State': 'pending'|'available'|'deleting'|'deleted',
'CustomerGatewayConfiguration': 'string',
'Type': 'ipsec.1',
'CustomerGatewayId': 'string',
'VpnGatewayId': 'string'
}
}
Response Structure
(dict) --
VpnConnection (dict) --
Information about the VPN connection.
Category (string) --
The category of the VPN connection. A value of VPN indicates an Amazon Web Services VPN connection. A value of VPN-Classic indicates an Amazon Web Services Classic VPN connection.
TransitGatewayId (string) --
The ID of the transit gateway associated with the VPN connection.
VpnConcentratorId (string) --
The ID of the VPN concentrator associated with the VPN connection.
CoreNetworkArn (string) --
The ARN of the core network.
CoreNetworkAttachmentArn (string) --
The ARN of the core network attachment.
GatewayAssociationState (string) --
The current state of the gateway association.
Options (dict) --
The VPN connection options.
EnableAcceleration (boolean) --
Indicates whether acceleration is enabled for the VPN connection.
StaticRoutesOnly (boolean) --
Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
LocalIpv4NetworkCidr (string) --
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv4NetworkCidr (string) --
The IPv4 CIDR on the Amazon Web Services side of the VPN connection.
LocalIpv6NetworkCidr (string) --
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv6NetworkCidr (string) --
The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
OutsideIpAddressType (string) --
The type of IPv4 address assigned to the outside interface of the customer gateway.
Valid values: PrivateIpv4 | PublicIpv4 | Ipv6
Default: PublicIpv4
TransportTransitGatewayAttachmentId (string) --
The transit gateway attachment ID in use for the VPN tunnel.
TunnelInsideIpVersion (string) --
Indicates whether the VPN tunnels process IPv4 or IPv6 traffic.
TunnelOptions (list) --
Indicates the VPN tunnel options.
(dict) --
The VPN tunnel options.
OutsideIpAddress (string) --
The external IP address of the VPN tunnel.
TunnelInsideCidr (string) --
The range of inside IPv4 addresses for the tunnel.
TunnelInsideIpv6Cidr (string) --
The range of inside IPv6 addresses for the tunnel.
PreSharedKey (string) --
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.
Phase1LifetimeSeconds (integer) --
The lifetime for phase 1 of the IKE negotiation, in seconds.
Phase2LifetimeSeconds (integer) --
The lifetime for phase 2 of the IKE negotiation, in seconds.
RekeyMarginTimeSeconds (integer) --
The margin time, in seconds, before the phase 2 lifetime expires, during which the Amazon Web Services side of the VPN connection performs an IKE rekey.
RekeyFuzzPercentage (integer) --
The percentage of the rekey window determined by RekeyMarginTimeSeconds during which the rekey time is randomly selected.
ReplayWindowSize (integer) --
The number of packets in an IKE replay window.
DpdTimeoutSeconds (integer) --
The number of seconds after which a DPD timeout occurs.
DpdTimeoutAction (string) --
The action to take after a DPD timeout occurs.
Phase1EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The encryption algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the encryption algorithm.
Phase2EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The encryption algorithm for phase 2 IKE negotiations.
Value (string) --
The encryption algorithm.
Phase1IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The integrity algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the integrity algorithm.
Phase2IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The integrity algorithm for phase 2 IKE negotiations.
Value (string) --
The integrity algorithm.
Phase1DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 1 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
Phase2DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 2 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
IkeVersions (list) --
The IKE versions that are permitted for the VPN tunnel.
(dict) --
The internet key exchange (IKE) version permitted for the VPN tunnel.
Value (string) --
The IKE version.
StartupAction (string) --
The action to take when the establishing the VPN tunnels for a VPN connection.
LogOptions (dict) --
Options for logging VPN tunnel activity.
CloudWatchLogOptions (dict) --
Options for sending VPN tunnel logs to CloudWatch.
LogEnabled (boolean) --
Status of VPN tunnel logging feature. Default value is False.
Valid values: True | False
LogGroupArn (string) --
The Amazon Resource Name (ARN) of the CloudWatch log group to send logs to.
LogOutputFormat (string) --
Configured log format. Default format is json.
Valid values: json | text
BgpLogEnabled (boolean) --
Indicates whether Border Gateway Protocol (BGP) logging is enabled for the VPN connection. Default value is False.
Valid values: True | False
BgpLogGroupArn (string) --
The Amazon Resource Name (ARN) of the CloudWatch log group for BGP logs.
BgpLogOutputFormat (string) --
The output format for BGP logs sent to CloudWatch. Default format is json.
Valid values: json | text
EnableTunnelLifecycleControl (boolean) --
Status of tunnel endpoint lifecycle control feature.
Phase1AdditionalKeyExchanges (list) --
The permitted additional key exchange rounds for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
Describes an additional key exchange round that is permitted for the VPN tunnel.
AdditionalKeyExchangeRound (integer) --
The additional key exchange round number.
KeyExchangeMethods (list) --
The key exchange method numbers permitted for this round.
(dict) --
The key exchange method number that is permitted for an additional key exchange round.
Value (integer) --
The key exchange method number.
Requirement (string) --
Indicates whether this round is mandatory.
Phase2AdditionalKeyExchanges (list) --
The permitted additional key exchange rounds for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
Describes an additional key exchange round that is permitted for the VPN tunnel.
AdditionalKeyExchangeRound (integer) --
The additional key exchange round number.
KeyExchangeMethods (list) --
The key exchange method numbers permitted for this round.
(dict) --
The key exchange method number that is permitted for an additional key exchange round.
Value (integer) --
The key exchange method number.
Requirement (string) --
Indicates whether this round is mandatory.
TunnelBandwidth (string) --
The configured bandwidth for the VPN tunnel. Represents the current throughput capacity setting for the tunnel connection. standard tunnel bandwidth supports up to 1.25 Gbps per tunnel while large supports up to 5 Gbps per tunnel. If no tunnel bandwidth was specified for the connection, standard is used as the default value.
Routes (list) --
The static routes associated with the VPN connection.
(dict) --
Describes a static route for a VPN connection.
DestinationCidrBlock (string) --
The CIDR block associated with the local subnet of the customer data center.
Source (string) --
Indicates how the routes were provided.
State (string) --
The current state of the static route.
Tags (list) --
Any tags assigned to the VPN connection.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
VgwTelemetry (list) --
Information about the VPN tunnel.
(dict) --
Describes telemetry for a VPN tunnel.
AcceptedRouteCount (integer) --
The number of accepted routes.
LastStatusChange (datetime) --
The date and time of the last change in status. This field is updated when changes in IKE (Phase 1), IPSec (Phase 2), or BGP status are detected.
OutsideIpAddress (string) --
The Internet-routable IP address of the virtual private gateway's outside interface.
Status (string) --
The status of the VPN tunnel.
StatusMessage (string) --
If an error occurs, a description of the error.
CertificateArn (string) --
The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.
PreSharedKeyArn (string) --
The Amazon Resource Name (ARN) of the Secrets Manager secret storing the pre-shared key(s) for the VPN connection.
VpnConnectionId (string) --
The ID of the VPN connection.
State (string) --
The current state of the VPN connection.
CustomerGatewayConfiguration (string) --
The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.
Type (string) --
The type of VPN connection.
CustomerGatewayId (string) --
The ID of the customer gateway at your end of the VPN connection.
VpnGatewayId (string) --
The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection.
{'VpnConnection': {'Options': {'TunnelOptions': {'Phase1AdditionalKeyExchanges': [{'AdditionalKeyExchangeRound': 'integer',
'KeyExchangeMethods': [{'Value': 'integer'}],
'Requirement': 'required '
'| '
'optional'}],
'Phase2AdditionalKeyExchanges': [{'AdditionalKeyExchangeRound': 'integer',
'KeyExchangeMethods': [{'Value': 'integer'}],
'Requirement': 'required '
'| '
'optional'}]}}}}
Modifies the VPN tunnel endpoint certificate.
See also: AWS API Documentation
Request Syntax
client.modify_vpn_tunnel_certificate(
VpnConnectionId='string',
VpnTunnelOutsideIpAddress='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the Amazon Web Services Site-to-Site VPN connection.
string
[REQUIRED]
The external IP address of the VPN tunnel.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'VpnConnection': {
'Category': 'string',
'TransitGatewayId': 'string',
'VpnConcentratorId': 'string',
'CoreNetworkArn': 'string',
'CoreNetworkAttachmentArn': 'string',
'GatewayAssociationState': 'associated'|'not-associated'|'associating'|'disassociating',
'Options': {
'EnableAcceleration': True|False,
'StaticRoutesOnly': True|False,
'LocalIpv4NetworkCidr': 'string',
'RemoteIpv4NetworkCidr': 'string',
'LocalIpv6NetworkCidr': 'string',
'RemoteIpv6NetworkCidr': 'string',
'OutsideIpAddressType': 'string',
'TransportTransitGatewayAttachmentId': 'string',
'TunnelInsideIpVersion': 'ipv4'|'ipv6',
'TunnelOptions': [
{
'OutsideIpAddress': 'string',
'TunnelInsideCidr': 'string',
'TunnelInsideIpv6Cidr': 'string',
'PreSharedKey': 'string',
'Phase1LifetimeSeconds': 123,
'Phase2LifetimeSeconds': 123,
'RekeyMarginTimeSeconds': 123,
'RekeyFuzzPercentage': 123,
'ReplayWindowSize': 123,
'DpdTimeoutSeconds': 123,
'DpdTimeoutAction': 'string',
'Phase1EncryptionAlgorithms': [
{
'Value': 'string'
},
],
'Phase2EncryptionAlgorithms': [
{
'Value': 'string'
},
],
'Phase1IntegrityAlgorithms': [
{
'Value': 'string'
},
],
'Phase2IntegrityAlgorithms': [
{
'Value': 'string'
},
],
'Phase1DHGroupNumbers': [
{
'Value': 123
},
],
'Phase2DHGroupNumbers': [
{
'Value': 123
},
],
'IkeVersions': [
{
'Value': 'string'
},
],
'StartupAction': 'string',
'LogOptions': {
'CloudWatchLogOptions': {
'LogEnabled': True|False,
'LogGroupArn': 'string',
'LogOutputFormat': 'string',
'BgpLogEnabled': True|False,
'BgpLogGroupArn': 'string',
'BgpLogOutputFormat': 'string'
}
},
'EnableTunnelLifecycleControl': True|False,
'Phase1AdditionalKeyExchanges': [
{
'AdditionalKeyExchangeRound': 123,
'KeyExchangeMethods': [
{
'Value': 123
},
],
'Requirement': 'required'|'optional'
},
],
'Phase2AdditionalKeyExchanges': [
{
'AdditionalKeyExchangeRound': 123,
'KeyExchangeMethods': [
{
'Value': 123
},
],
'Requirement': 'required'|'optional'
},
]
},
],
'TunnelBandwidth': 'standard'|'large'
},
'Routes': [
{
'DestinationCidrBlock': 'string',
'Source': 'Static',
'State': 'pending'|'available'|'deleting'|'deleted'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VgwTelemetry': [
{
'AcceptedRouteCount': 123,
'LastStatusChange': datetime(2015, 1, 1),
'OutsideIpAddress': 'string',
'Status': 'UP'|'DOWN',
'StatusMessage': 'string',
'CertificateArn': 'string'
},
],
'PreSharedKeyArn': 'string',
'VpnConnectionId': 'string',
'State': 'pending'|'available'|'deleting'|'deleted',
'CustomerGatewayConfiguration': 'string',
'Type': 'ipsec.1',
'CustomerGatewayId': 'string',
'VpnGatewayId': 'string'
}
}
Response Structure
(dict) --
VpnConnection (dict) --
Information about the VPN connection.
Category (string) --
The category of the VPN connection. A value of VPN indicates an Amazon Web Services VPN connection. A value of VPN-Classic indicates an Amazon Web Services Classic VPN connection.
TransitGatewayId (string) --
The ID of the transit gateway associated with the VPN connection.
VpnConcentratorId (string) --
The ID of the VPN concentrator associated with the VPN connection.
CoreNetworkArn (string) --
The ARN of the core network.
CoreNetworkAttachmentArn (string) --
The ARN of the core network attachment.
GatewayAssociationState (string) --
The current state of the gateway association.
Options (dict) --
The VPN connection options.
EnableAcceleration (boolean) --
Indicates whether acceleration is enabled for the VPN connection.
StaticRoutesOnly (boolean) --
Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
LocalIpv4NetworkCidr (string) --
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv4NetworkCidr (string) --
The IPv4 CIDR on the Amazon Web Services side of the VPN connection.
LocalIpv6NetworkCidr (string) --
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv6NetworkCidr (string) --
The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
OutsideIpAddressType (string) --
The type of IPv4 address assigned to the outside interface of the customer gateway.
Valid values: PrivateIpv4 | PublicIpv4 | Ipv6
Default: PublicIpv4
TransportTransitGatewayAttachmentId (string) --
The transit gateway attachment ID in use for the VPN tunnel.
TunnelInsideIpVersion (string) --
Indicates whether the VPN tunnels process IPv4 or IPv6 traffic.
TunnelOptions (list) --
Indicates the VPN tunnel options.
(dict) --
The VPN tunnel options.
OutsideIpAddress (string) --
The external IP address of the VPN tunnel.
TunnelInsideCidr (string) --
The range of inside IPv4 addresses for the tunnel.
TunnelInsideIpv6Cidr (string) --
The range of inside IPv6 addresses for the tunnel.
PreSharedKey (string) --
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.
Phase1LifetimeSeconds (integer) --
The lifetime for phase 1 of the IKE negotiation, in seconds.
Phase2LifetimeSeconds (integer) --
The lifetime for phase 2 of the IKE negotiation, in seconds.
RekeyMarginTimeSeconds (integer) --
The margin time, in seconds, before the phase 2 lifetime expires, during which the Amazon Web Services side of the VPN connection performs an IKE rekey.
RekeyFuzzPercentage (integer) --
The percentage of the rekey window determined by RekeyMarginTimeSeconds during which the rekey time is randomly selected.
ReplayWindowSize (integer) --
The number of packets in an IKE replay window.
DpdTimeoutSeconds (integer) --
The number of seconds after which a DPD timeout occurs.
DpdTimeoutAction (string) --
The action to take after a DPD timeout occurs.
Phase1EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The encryption algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the encryption algorithm.
Phase2EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The encryption algorithm for phase 2 IKE negotiations.
Value (string) --
The encryption algorithm.
Phase1IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The integrity algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the integrity algorithm.
Phase2IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The integrity algorithm for phase 2 IKE negotiations.
Value (string) --
The integrity algorithm.
Phase1DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 1 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
Phase2DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 2 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
IkeVersions (list) --
The IKE versions that are permitted for the VPN tunnel.
(dict) --
The internet key exchange (IKE) version permitted for the VPN tunnel.
Value (string) --
The IKE version.
StartupAction (string) --
The action to take when the establishing the VPN tunnels for a VPN connection.
LogOptions (dict) --
Options for logging VPN tunnel activity.
CloudWatchLogOptions (dict) --
Options for sending VPN tunnel logs to CloudWatch.
LogEnabled (boolean) --
Status of VPN tunnel logging feature. Default value is False.
Valid values: True | False
LogGroupArn (string) --
The Amazon Resource Name (ARN) of the CloudWatch log group to send logs to.
LogOutputFormat (string) --
Configured log format. Default format is json.
Valid values: json | text
BgpLogEnabled (boolean) --
Indicates whether Border Gateway Protocol (BGP) logging is enabled for the VPN connection. Default value is False.
Valid values: True | False
BgpLogGroupArn (string) --
The Amazon Resource Name (ARN) of the CloudWatch log group for BGP logs.
BgpLogOutputFormat (string) --
The output format for BGP logs sent to CloudWatch. Default format is json.
Valid values: json | text
EnableTunnelLifecycleControl (boolean) --
Status of tunnel endpoint lifecycle control feature.
Phase1AdditionalKeyExchanges (list) --
The permitted additional key exchange rounds for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
Describes an additional key exchange round that is permitted for the VPN tunnel.
AdditionalKeyExchangeRound (integer) --
The additional key exchange round number.
KeyExchangeMethods (list) --
The key exchange method numbers permitted for this round.
(dict) --
The key exchange method number that is permitted for an additional key exchange round.
Value (integer) --
The key exchange method number.
Requirement (string) --
Indicates whether this round is mandatory.
Phase2AdditionalKeyExchanges (list) --
The permitted additional key exchange rounds for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
Describes an additional key exchange round that is permitted for the VPN tunnel.
AdditionalKeyExchangeRound (integer) --
The additional key exchange round number.
KeyExchangeMethods (list) --
The key exchange method numbers permitted for this round.
(dict) --
The key exchange method number that is permitted for an additional key exchange round.
Value (integer) --
The key exchange method number.
Requirement (string) --
Indicates whether this round is mandatory.
TunnelBandwidth (string) --
The configured bandwidth for the VPN tunnel. Represents the current throughput capacity setting for the tunnel connection. standard tunnel bandwidth supports up to 1.25 Gbps per tunnel while large supports up to 5 Gbps per tunnel. If no tunnel bandwidth was specified for the connection, standard is used as the default value.
Routes (list) --
The static routes associated with the VPN connection.
(dict) --
Describes a static route for a VPN connection.
DestinationCidrBlock (string) --
The CIDR block associated with the local subnet of the customer data center.
Source (string) --
Indicates how the routes were provided.
State (string) --
The current state of the static route.
Tags (list) --
Any tags assigned to the VPN connection.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
VgwTelemetry (list) --
Information about the VPN tunnel.
(dict) --
Describes telemetry for a VPN tunnel.
AcceptedRouteCount (integer) --
The number of accepted routes.
LastStatusChange (datetime) --
The date and time of the last change in status. This field is updated when changes in IKE (Phase 1), IPSec (Phase 2), or BGP status are detected.
OutsideIpAddress (string) --
The Internet-routable IP address of the virtual private gateway's outside interface.
Status (string) --
The status of the VPN tunnel.
StatusMessage (string) --
If an error occurs, a description of the error.
CertificateArn (string) --
The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.
PreSharedKeyArn (string) --
The Amazon Resource Name (ARN) of the Secrets Manager secret storing the pre-shared key(s) for the VPN connection.
VpnConnectionId (string) --
The ID of the VPN connection.
State (string) --
The current state of the VPN connection.
CustomerGatewayConfiguration (string) --
The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.
Type (string) --
The type of VPN connection.
CustomerGatewayId (string) --
The ID of the customer gateway at your end of the VPN connection.
VpnGatewayId (string) --
The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection.
{'TunnelOptions': {'Phase1AdditionalKeyExchanges': [{'AdditionalKeyExchangeRound': 'integer',
'KeyExchangeMethods': [{'Value': 'integer'}],
'Requirement': 'required '
'| '
'optional'}],
'Phase2AdditionalKeyExchanges': [{'AdditionalKeyExchangeRound': 'integer',
'KeyExchangeMethods': [{'Value': 'integer'}],
'Requirement': 'required '
'| '
'optional'}]}}
Response {'VpnConnection': {'Options': {'TunnelOptions': {'Phase1AdditionalKeyExchanges': [{'AdditionalKeyExchangeRound': 'integer',
'KeyExchangeMethods': [{'Value': 'integer'}],
'Requirement': 'required '
'| '
'optional'}],
'Phase2AdditionalKeyExchanges': [{'AdditionalKeyExchangeRound': 'integer',
'KeyExchangeMethods': [{'Value': 'integer'}],
'Requirement': 'required '
'| '
'optional'}]}}}}
Modifies the options for a VPN tunnel in an Amazon Web Services Site-to-Site VPN connection. You can modify multiple options for a tunnel in a single request, but you can only modify one tunnel at a time. For more information, see Site-to-Site VPN tunnel options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.
See also: AWS API Documentation
Request Syntax
client.modify_vpn_tunnel_options(
VpnConnectionId='string',
VpnTunnelOutsideIpAddress='string',
TunnelOptions={
'TunnelInsideCidr': 'string',
'TunnelInsideIpv6Cidr': 'string',
'PreSharedKey': 'string',
'Phase1LifetimeSeconds': 123,
'Phase2LifetimeSeconds': 123,
'RekeyMarginTimeSeconds': 123,
'RekeyFuzzPercentage': 123,
'ReplayWindowSize': 123,
'DPDTimeoutSeconds': 123,
'DPDTimeoutAction': 'string',
'Phase1EncryptionAlgorithms': [
{
'Value': 'string'
},
],
'Phase2EncryptionAlgorithms': [
{
'Value': 'string'
},
],
'Phase1IntegrityAlgorithms': [
{
'Value': 'string'
},
],
'Phase2IntegrityAlgorithms': [
{
'Value': 'string'
},
],
'Phase1DHGroupNumbers': [
{
'Value': 123
},
],
'Phase2DHGroupNumbers': [
{
'Value': 123
},
],
'IKEVersions': [
{
'Value': 'string'
},
],
'StartupAction': 'string',
'LogOptions': {
'CloudWatchLogOptions': {
'LogEnabled': True|False,
'LogGroupArn': 'string',
'LogOutputFormat': 'string',
'BgpLogEnabled': True|False,
'BgpLogGroupArn': 'string',
'BgpLogOutputFormat': 'string'
}
},
'EnableTunnelLifecycleControl': True|False,
'Phase1AdditionalKeyExchanges': [
{
'AdditionalKeyExchangeRound': 123,
'KeyExchangeMethods': [
{
'Value': 123
},
],
'Requirement': 'required'|'optional'
},
],
'Phase2AdditionalKeyExchanges': [
{
'AdditionalKeyExchangeRound': 123,
'KeyExchangeMethods': [
{
'Value': 123
},
],
'Requirement': 'required'|'optional'
},
]
},
DryRun=True|False,
SkipTunnelReplacement=True|False,
PreSharedKeyStorage='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services Site-to-Site VPN connection.
string
[REQUIRED]
The external IP address of the VPN tunnel.
dict
[REQUIRED]
The tunnel options to modify.
TunnelInsideCidr (string) --
The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway.
Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The following CIDR blocks are reserved and cannot be used:
169.254.0.0/30
169.254.1.0/30
169.254.2.0/30
169.254.3.0/30
169.254.4.0/30
169.254.5.0/30
169.254.169.252/30
TunnelInsideIpv6Cidr (string) --
The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same transit gateway.
Constraints: A size /126 CIDR block from the local fd00::/8 range.
PreSharedKey (string) --
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.
Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (_). Must be between 8 and 64 characters in length and cannot start with zero (0).
Phase1LifetimeSeconds (integer) --
The lifetime for phase 1 of the IKE negotiation, in seconds.
Constraints: A value between 900 and 28,800.
Default: 28800
Phase2LifetimeSeconds (integer) --
The lifetime for phase 2 of the IKE negotiation, in seconds.
Constraints: A value between 900 and 3,600. The value must be less than the value for Phase1LifetimeSeconds.
Default: 3600
RekeyMarginTimeSeconds (integer) --
The margin time, in seconds, before the phase 2 lifetime expires, during which the Amazon Web Services side of the VPN connection performs an IKE rekey. The exact time of the rekey is randomly selected based on the value for RekeyFuzzPercentage.
Constraints: A value between 60 and half of Phase2LifetimeSeconds.
Default: 270
RekeyFuzzPercentage (integer) --
The percentage of the rekey window (determined by RekeyMarginTimeSeconds) during which the rekey time is randomly selected.
Constraints: A value between 0 and 100.
Default: 100
ReplayWindowSize (integer) --
The number of packets in an IKE replay window.
Constraints: A value between 64 and 2048.
Default: 1024
DPDTimeoutSeconds (integer) --
The number of seconds after which a DPD timeout occurs. A DPD timeout of 40 seconds means that the VPN endpoint will consider the peer dead 30 seconds after the first failed keep-alive.
Constraints: A value greater than or equal to 30.
Default: 40
DPDTimeoutAction (string) --
The action to take after DPD timeout occurs. Specify restart to restart the IKE initiation. Specify clear to end the IKE session.
Valid Values: clear | none | restart
Default: clear
Phase1EncryptionAlgorithms (list) --
One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
(dict) --
Specifies the encryption algorithm for the VPN tunnel for phase 1 IKE negotiations.
Value (string) --
The value for the encryption algorithm.
Phase2EncryptionAlgorithms (list) --
One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
(dict) --
Specifies the encryption algorithm for the VPN tunnel for phase 2 IKE negotiations.
Value (string) --
The encryption algorithm.
Phase1IntegrityAlgorithms (list) --
One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
(dict) --
Specifies the integrity algorithm for the VPN tunnel for phase 1 IKE negotiations.
Value (string) --
The value for the integrity algorithm.
Phase2IntegrityAlgorithms (list) --
One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
(dict) --
Specifies the integrity algorithm for the VPN tunnel for phase 2 IKE negotiations.
Value (string) --
The integrity algorithm.
Phase1DHGroupNumbers (list) --
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 35
(dict) --
Specifies a Diffie-Hellman group number for the VPN tunnel for phase 1 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
Phase2DHGroupNumbers (list) --
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 35 | 36 | 37
(dict) --
Specifies a Diffie-Hellman group number for the VPN tunnel for phase 2 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
IKEVersions (list) --
The IKE versions that are permitted for the VPN tunnel.
Valid values: ikev1 | ikev2
(dict) --
The IKE version that is permitted for the VPN tunnel.
Value (string) --
The IKE version.
StartupAction (string) --
The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify start for Amazon Web Services to initiate the IKE negotiation.
Valid Values: add | start
Default: add
LogOptions (dict) --
Options for logging VPN tunnel activity.
CloudWatchLogOptions (dict) --
Options for sending VPN tunnel logs to CloudWatch.
LogEnabled (boolean) --
Enable or disable VPN tunnel logging feature. Default value is False.
Valid values: True | False
LogGroupArn (string) --
The Amazon Resource Name (ARN) of the CloudWatch log group to send logs to.
LogOutputFormat (string) --
Set log format. Default format is json.
Valid values: json | text
BgpLogEnabled (boolean) --
Specifies whether to enable BGP logging for the VPN connection. Default value is False.
Valid values: True | False
BgpLogGroupArn (string) --
The Amazon Resource Name (ARN) of the CloudWatch log group where BGP logs will be sent.
BgpLogOutputFormat (string) --
The desired output format for BGP logs to be sent to CloudWatch. Default format is json.
Valid values: json | text
EnableTunnelLifecycleControl (boolean) --
Turn on or off tunnel endpoint lifecycle control feature.
Phase1AdditionalKeyExchanges (list) --
One or more additional key exchange rounds that are permitted for the VPN tunnel for phase 1 IKE negotiations. Additional key exchanges occur after the initial Diffie-Hellman exchange. Each round must have a unique round number.
Additional key exchanges are supported only with IKEv2. You can't specify a required round if IKEVersions contains only ikev1.
(dict) --
Specifies an additional key exchange round for the VPN tunnel, as defined in RFC 9370.
AdditionalKeyExchangeRound (integer) -- [REQUIRED]
The additional key exchange round number.
Valid range: Minimum value of 1. Maximum value of 7.
KeyExchangeMethods (list) --
The key exchange method numbers that are permitted for this round. The method numbers are the IANA IKEv2 key exchange method transform IDs.
A required round must specify at least one method. An optional round can omit this parameter or specify an empty list. If omitted or empty for an optional round, the round is disabled.
IKEv2 requires that the initial Diffie-Hellman exchange and each required round use a different key exchange method. The permitted methods must allow a distinct method to be selected for each of them.
Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 35 | 36 | 37
(dict) --
Specifies a key exchange method number that is permitted for an additional key exchange round.
Value (integer) --
The key exchange method number.
Requirement (string) --
Indicates whether this round is mandatory. If required, the tunnel isn't established unless the customer gateway device negotiates this round. If optional, the round is negotiated only if the customer gateway device supports it.
Valid values: required | optional
Default: required
Phase2AdditionalKeyExchanges (list) --
One or more additional key exchange rounds that are permitted for the VPN tunnel for phase 2 IKE negotiations. Additional key exchanges occur after the initial Diffie-Hellman exchange. Each round must have a unique round number.
Additional key exchanges are supported only with IKEv2. You can't specify a required round if IKEVersions contains only ikev1.
(dict) --
Specifies an additional key exchange round for the VPN tunnel, as defined in RFC 9370.
AdditionalKeyExchangeRound (integer) -- [REQUIRED]
The additional key exchange round number.
Valid range: Minimum value of 1. Maximum value of 7.
KeyExchangeMethods (list) --
The key exchange method numbers that are permitted for this round. The method numbers are the IANA IKEv2 key exchange method transform IDs.
A required round must specify at least one method. An optional round can omit this parameter or specify an empty list. If omitted or empty for an optional round, the round is disabled.
IKEv2 requires that the initial Diffie-Hellman exchange and each required round use a different key exchange method. The permitted methods must allow a distinct method to be selected for each of them.
Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 35 | 36 | 37
(dict) --
Specifies a key exchange method number that is permitted for an additional key exchange round.
Value (integer) --
The key exchange method number.
Requirement (string) --
Indicates whether this round is mandatory. If required, the tunnel isn't established unless the customer gateway device negotiates this round. If optional, the round is negotiated only if the customer gateway device supports it.
Valid values: required | optional
Default: required
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
boolean
Choose whether or not to trigger immediate tunnel replacement. This is only applicable when turning on or off EnableTunnelLifecycleControl.
Valid values: True | False
string
Specifies the storage mode for the pre-shared key (PSK). Valid values are Standard (stored in Site-to-Site VPN service) or SecretsManager (stored in Amazon Web Services Secrets Manager).
dict
Response Syntax
{
'VpnConnection': {
'Category': 'string',
'TransitGatewayId': 'string',
'VpnConcentratorId': 'string',
'CoreNetworkArn': 'string',
'CoreNetworkAttachmentArn': 'string',
'GatewayAssociationState': 'associated'|'not-associated'|'associating'|'disassociating',
'Options': {
'EnableAcceleration': True|False,
'StaticRoutesOnly': True|False,
'LocalIpv4NetworkCidr': 'string',
'RemoteIpv4NetworkCidr': 'string',
'LocalIpv6NetworkCidr': 'string',
'RemoteIpv6NetworkCidr': 'string',
'OutsideIpAddressType': 'string',
'TransportTransitGatewayAttachmentId': 'string',
'TunnelInsideIpVersion': 'ipv4'|'ipv6',
'TunnelOptions': [
{
'OutsideIpAddress': 'string',
'TunnelInsideCidr': 'string',
'TunnelInsideIpv6Cidr': 'string',
'PreSharedKey': 'string',
'Phase1LifetimeSeconds': 123,
'Phase2LifetimeSeconds': 123,
'RekeyMarginTimeSeconds': 123,
'RekeyFuzzPercentage': 123,
'ReplayWindowSize': 123,
'DpdTimeoutSeconds': 123,
'DpdTimeoutAction': 'string',
'Phase1EncryptionAlgorithms': [
{
'Value': 'string'
},
],
'Phase2EncryptionAlgorithms': [
{
'Value': 'string'
},
],
'Phase1IntegrityAlgorithms': [
{
'Value': 'string'
},
],
'Phase2IntegrityAlgorithms': [
{
'Value': 'string'
},
],
'Phase1DHGroupNumbers': [
{
'Value': 123
},
],
'Phase2DHGroupNumbers': [
{
'Value': 123
},
],
'IkeVersions': [
{
'Value': 'string'
},
],
'StartupAction': 'string',
'LogOptions': {
'CloudWatchLogOptions': {
'LogEnabled': True|False,
'LogGroupArn': 'string',
'LogOutputFormat': 'string',
'BgpLogEnabled': True|False,
'BgpLogGroupArn': 'string',
'BgpLogOutputFormat': 'string'
}
},
'EnableTunnelLifecycleControl': True|False,
'Phase1AdditionalKeyExchanges': [
{
'AdditionalKeyExchangeRound': 123,
'KeyExchangeMethods': [
{
'Value': 123
},
],
'Requirement': 'required'|'optional'
},
],
'Phase2AdditionalKeyExchanges': [
{
'AdditionalKeyExchangeRound': 123,
'KeyExchangeMethods': [
{
'Value': 123
},
],
'Requirement': 'required'|'optional'
},
]
},
],
'TunnelBandwidth': 'standard'|'large'
},
'Routes': [
{
'DestinationCidrBlock': 'string',
'Source': 'Static',
'State': 'pending'|'available'|'deleting'|'deleted'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VgwTelemetry': [
{
'AcceptedRouteCount': 123,
'LastStatusChange': datetime(2015, 1, 1),
'OutsideIpAddress': 'string',
'Status': 'UP'|'DOWN',
'StatusMessage': 'string',
'CertificateArn': 'string'
},
],
'PreSharedKeyArn': 'string',
'VpnConnectionId': 'string',
'State': 'pending'|'available'|'deleting'|'deleted',
'CustomerGatewayConfiguration': 'string',
'Type': 'ipsec.1',
'CustomerGatewayId': 'string',
'VpnGatewayId': 'string'
}
}
Response Structure
(dict) --
VpnConnection (dict) --
Information about the VPN connection.
Category (string) --
The category of the VPN connection. A value of VPN indicates an Amazon Web Services VPN connection. A value of VPN-Classic indicates an Amazon Web Services Classic VPN connection.
TransitGatewayId (string) --
The ID of the transit gateway associated with the VPN connection.
VpnConcentratorId (string) --
The ID of the VPN concentrator associated with the VPN connection.
CoreNetworkArn (string) --
The ARN of the core network.
CoreNetworkAttachmentArn (string) --
The ARN of the core network attachment.
GatewayAssociationState (string) --
The current state of the gateway association.
Options (dict) --
The VPN connection options.
EnableAcceleration (boolean) --
Indicates whether acceleration is enabled for the VPN connection.
StaticRoutesOnly (boolean) --
Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
LocalIpv4NetworkCidr (string) --
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv4NetworkCidr (string) --
The IPv4 CIDR on the Amazon Web Services side of the VPN connection.
LocalIpv6NetworkCidr (string) --
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv6NetworkCidr (string) --
The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
OutsideIpAddressType (string) --
The type of IPv4 address assigned to the outside interface of the customer gateway.
Valid values: PrivateIpv4 | PublicIpv4 | Ipv6
Default: PublicIpv4
TransportTransitGatewayAttachmentId (string) --
The transit gateway attachment ID in use for the VPN tunnel.
TunnelInsideIpVersion (string) --
Indicates whether the VPN tunnels process IPv4 or IPv6 traffic.
TunnelOptions (list) --
Indicates the VPN tunnel options.
(dict) --
The VPN tunnel options.
OutsideIpAddress (string) --
The external IP address of the VPN tunnel.
TunnelInsideCidr (string) --
The range of inside IPv4 addresses for the tunnel.
TunnelInsideIpv6Cidr (string) --
The range of inside IPv6 addresses for the tunnel.
PreSharedKey (string) --
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.
Phase1LifetimeSeconds (integer) --
The lifetime for phase 1 of the IKE negotiation, in seconds.
Phase2LifetimeSeconds (integer) --
The lifetime for phase 2 of the IKE negotiation, in seconds.
RekeyMarginTimeSeconds (integer) --
The margin time, in seconds, before the phase 2 lifetime expires, during which the Amazon Web Services side of the VPN connection performs an IKE rekey.
RekeyFuzzPercentage (integer) --
The percentage of the rekey window determined by RekeyMarginTimeSeconds during which the rekey time is randomly selected.
ReplayWindowSize (integer) --
The number of packets in an IKE replay window.
DpdTimeoutSeconds (integer) --
The number of seconds after which a DPD timeout occurs.
DpdTimeoutAction (string) --
The action to take after a DPD timeout occurs.
Phase1EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The encryption algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the encryption algorithm.
Phase2EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The encryption algorithm for phase 2 IKE negotiations.
Value (string) --
The encryption algorithm.
Phase1IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The integrity algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the integrity algorithm.
Phase2IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The integrity algorithm for phase 2 IKE negotiations.
Value (string) --
The integrity algorithm.
Phase1DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 1 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
Phase2DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 2 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
IkeVersions (list) --
The IKE versions that are permitted for the VPN tunnel.
(dict) --
The internet key exchange (IKE) version permitted for the VPN tunnel.
Value (string) --
The IKE version.
StartupAction (string) --
The action to take when the establishing the VPN tunnels for a VPN connection.
LogOptions (dict) --
Options for logging VPN tunnel activity.
CloudWatchLogOptions (dict) --
Options for sending VPN tunnel logs to CloudWatch.
LogEnabled (boolean) --
Status of VPN tunnel logging feature. Default value is False.
Valid values: True | False
LogGroupArn (string) --
The Amazon Resource Name (ARN) of the CloudWatch log group to send logs to.
LogOutputFormat (string) --
Configured log format. Default format is json.
Valid values: json | text
BgpLogEnabled (boolean) --
Indicates whether Border Gateway Protocol (BGP) logging is enabled for the VPN connection. Default value is False.
Valid values: True | False
BgpLogGroupArn (string) --
The Amazon Resource Name (ARN) of the CloudWatch log group for BGP logs.
BgpLogOutputFormat (string) --
The output format for BGP logs sent to CloudWatch. Default format is json.
Valid values: json | text
EnableTunnelLifecycleControl (boolean) --
Status of tunnel endpoint lifecycle control feature.
Phase1AdditionalKeyExchanges (list) --
The permitted additional key exchange rounds for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
Describes an additional key exchange round that is permitted for the VPN tunnel.
AdditionalKeyExchangeRound (integer) --
The additional key exchange round number.
KeyExchangeMethods (list) --
The key exchange method numbers permitted for this round.
(dict) --
The key exchange method number that is permitted for an additional key exchange round.
Value (integer) --
The key exchange method number.
Requirement (string) --
Indicates whether this round is mandatory.
Phase2AdditionalKeyExchanges (list) --
The permitted additional key exchange rounds for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
Describes an additional key exchange round that is permitted for the VPN tunnel.
AdditionalKeyExchangeRound (integer) --
The additional key exchange round number.
KeyExchangeMethods (list) --
The key exchange method numbers permitted for this round.
(dict) --
The key exchange method number that is permitted for an additional key exchange round.
Value (integer) --
The key exchange method number.
Requirement (string) --
Indicates whether this round is mandatory.
TunnelBandwidth (string) --
The configured bandwidth for the VPN tunnel. Represents the current throughput capacity setting for the tunnel connection. standard tunnel bandwidth supports up to 1.25 Gbps per tunnel while large supports up to 5 Gbps per tunnel. If no tunnel bandwidth was specified for the connection, standard is used as the default value.
Routes (list) --
The static routes associated with the VPN connection.
(dict) --
Describes a static route for a VPN connection.
DestinationCidrBlock (string) --
The CIDR block associated with the local subnet of the customer data center.
Source (string) --
Indicates how the routes were provided.
State (string) --
The current state of the static route.
Tags (list) --
Any tags assigned to the VPN connection.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
VgwTelemetry (list) --
Information about the VPN tunnel.
(dict) --
Describes telemetry for a VPN tunnel.
AcceptedRouteCount (integer) --
The number of accepted routes.
LastStatusChange (datetime) --
The date and time of the last change in status. This field is updated when changes in IKE (Phase 1), IPSec (Phase 2), or BGP status are detected.
OutsideIpAddress (string) --
The Internet-routable IP address of the virtual private gateway's outside interface.
Status (string) --
The status of the VPN tunnel.
StatusMessage (string) --
If an error occurs, a description of the error.
CertificateArn (string) --
The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.
PreSharedKeyArn (string) --
The Amazon Resource Name (ARN) of the Secrets Manager secret storing the pre-shared key(s) for the VPN connection.
VpnConnectionId (string) --
The ID of the VPN connection.
State (string) --
The current state of the VPN connection.
CustomerGatewayConfiguration (string) --
The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.
Type (string) --
The type of VPN connection.
CustomerGatewayId (string) --
The ID of the customer gateway at your end of the VPN connection.
VpnGatewayId (string) --
The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection.
{'CapacityReservations': [{'AdjustmentDetails': {'CommitmentDuration': 'long',
'CommitmentEndDate': 'timestamp',
'EndDate': 'timestamp',
'EndDateType': 'string',
'StartDate': 'timestamp'},
'AdjustmentStatus': 'requested | applied | rejected',
'AvailabilityZone': 'string',
'AvailabilityZoneId': 'string',
'AvailableInstanceCount': 'integer',
'CapacityAllocations': [{'AllocationMetadata': [{'Key': 'string',
'Value': 'string'}],
'AllocationType': 'used | '
'future '
'| '
'cancelling',
'Count': 'integer'}],
'CapacityBlockId': 'string',
'CapacityReservationArn': 'string',
'CapacityReservationFleetId': 'string',
'CapacityReservationId': 'string',
'CommitmentInfo': {'CommitmentDuration': 'long',
'CommitmentEndDate': 'timestamp',
'CommittedInstanceCount': 'integer'},
'CreateDate': 'timestamp',
'DeliveryPreference': 'fixed | incremental',
'EbsOptimized': 'boolean',
'EndDate': 'timestamp',
'EndDateType': 'unlimited | limited',
'EphemeralStorage': 'boolean',
'InstanceMatchCriteria': 'open | targeted',
'InstancePlatform': 'Linux/UNIX | Red Hat '
'Enterprise Linux | SUSE Linux '
'| Windows | Windows with SQL '
'Server | Windows with SQL '
'Server Enterprise | Windows '
'with SQL Server Standard | '
'Windows with SQL Server Web | '
'Linux with SQL Server Standard '
'| Linux with SQL Server Web | '
'Linux with SQL Server '
'Enterprise | RHEL with SQL '
'Server Standard | RHEL with '
'SQL Server Enterprise | RHEL '
'with SQL Server Web | RHEL '
'with HA | RHEL with HA and SQL '
'Server Standard | RHEL with HA '
'and SQL Server Enterprise | '
'Ubuntu Pro',
'InstanceType': 'string',
'Interruptible': 'boolean',
'InterruptibleCapacityAllocation': {'InstanceCount': 'integer',
'InterruptibleCapacityReservationId': 'string',
'InterruptionType': 'adhoc',
'Status': 'pending '
'| '
'active '
'| '
'updating '
'| '
'canceling '
'| '
'canceled '
'| '
'failed',
'TargetInstanceCount': 'integer',
'ZeroSizePreference': 'retain '
'| '
'default'},
'InterruptionInfo': {'InterruptionType': 'adhoc',
'SourceCapacityReservationId': 'string'},
'LaunchStatus': 'launchable | unlaunchable',
'OriginalStartDate': 'timestamp',
'OutpostArn': 'string',
'OwnerId': 'string',
'PlacementGroupArn': 'string',
'ReservationType': 'default | capacity-block',
'StartDate': 'timestamp',
'State': 'active | expired | cancelled | pending | '
'failed | scheduled | payment-pending | '
'payment-failed | assessing | delayed | '
'unsupported | cancelling | unavailable',
'Tags': [{'Key': 'string', 'Value': 'string'}],
'Tenancy': 'default | dedicated',
'TotalInstanceCount': 'integer',
'UnusedReservationBillingOwnerId': 'string',
'ZeroSizePreference': 'retain | default'}]}
Purchase the Capacity Block for use with your account. With Capacity Blocks you ensure GPU capacity is available for machine learning (ML) workloads. You must specify the ID of the Capacity Block offering you are purchasing.
See also: AWS API Documentation
Request Syntax
client.purchase_capacity_block(
DryRun=True|False,
TagSpecifications=[
{
'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fca-policy'|'fleet'|'fpga-image'|'host-reservation'|'image'|'image-usage-report'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-metering-policy'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'vpc-encryption-control'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task'|'ipam-prefix-list-resolver'|'ipam-policy'|'ipam-prefix-list-resolver-target'|'ipam-internet-registry-association'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator'|'ipam-pool-allocation'|'capacity-reservation-cancellation-quote'|'application-status-check'|'capacity-reservation-modification-quote'|'metric-category',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
CapacityBlockOfferingId='string',
InstancePlatform='Linux/UNIX'|'Red Hat Enterprise Linux'|'SUSE Linux'|'Windows'|'Windows with SQL Server'|'Windows with SQL Server Enterprise'|'Windows with SQL Server Standard'|'Windows with SQL Server Web'|'Linux with SQL Server Standard'|'Linux with SQL Server Web'|'Linux with SQL Server Enterprise'|'RHEL with SQL Server Standard'|'RHEL with SQL Server Enterprise'|'RHEL with SQL Server Web'|'RHEL with HA'|'RHEL with HA and SQL Server Standard'|'RHEL with HA and SQL Server Enterprise'|'Ubuntu Pro'
)
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
list
The tags to apply to the Capacity Block during launch.
(dict) --
The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
ResourceType (string) --
The type of resource to tag on creation.
Tags (list) --
The tags to apply to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
string
[REQUIRED]
The ID of the Capacity Block offering.
string
[REQUIRED]
The type of operating system for which to reserve capacity.
dict
Response Syntax
{
'CapacityReservation': {
'CapacityReservationId': 'string',
'OwnerId': 'string',
'CapacityReservationArn': 'string',
'AvailabilityZoneId': 'string',
'InstanceType': 'string',
'InstancePlatform': 'Linux/UNIX'|'Red Hat Enterprise Linux'|'SUSE Linux'|'Windows'|'Windows with SQL Server'|'Windows with SQL Server Enterprise'|'Windows with SQL Server Standard'|'Windows with SQL Server Web'|'Linux with SQL Server Standard'|'Linux with SQL Server Web'|'Linux with SQL Server Enterprise'|'RHEL with SQL Server Standard'|'RHEL with SQL Server Enterprise'|'RHEL with SQL Server Web'|'RHEL with HA'|'RHEL with HA and SQL Server Standard'|'RHEL with HA and SQL Server Enterprise'|'Ubuntu Pro',
'AvailabilityZone': 'string',
'Tenancy': 'default'|'dedicated',
'TotalInstanceCount': 123,
'AvailableInstanceCount': 123,
'EbsOptimized': True|False,
'EphemeralStorage': True|False,
'State': 'active'|'expired'|'cancelled'|'pending'|'failed'|'scheduled'|'payment-pending'|'payment-failed'|'assessing'|'delayed'|'unsupported'|'cancelling'|'unavailable',
'StartDate': datetime(2015, 1, 1),
'EndDate': datetime(2015, 1, 1),
'EndDateType': 'unlimited'|'limited',
'InstanceMatchCriteria': 'open'|'targeted',
'CreateDate': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'OutpostArn': 'string',
'CapacityReservationFleetId': 'string',
'PlacementGroupArn': 'string',
'CapacityAllocations': [
{
'AllocationType': 'used'|'future'|'cancelling',
'Count': 123,
'AllocationMetadata': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'ReservationType': 'default'|'capacity-block',
'UnusedReservationBillingOwnerId': 'string',
'CommitmentInfo': {
'CommittedInstanceCount': 123,
'CommitmentEndDate': datetime(2015, 1, 1),
'CommitmentDuration': 123
},
'DeliveryPreference': 'fixed'|'incremental',
'CapacityBlockId': 'string',
'Interruptible': True|False,
'InterruptibleCapacityAllocation': {
'InstanceCount': 123,
'TargetInstanceCount': 123,
'Status': 'pending'|'active'|'updating'|'canceling'|'canceled'|'failed',
'InterruptibleCapacityReservationId': 'string',
'InterruptionType': 'adhoc',
'ZeroSizePreference': 'retain'|'default'
},
'InterruptionInfo': {
'SourceCapacityReservationId': 'string',
'InterruptionType': 'adhoc'
},
'AdjustmentStatus': 'requested'|'applied'|'rejected',
'AdjustmentDetails': {
'StartDate': datetime(2015, 1, 1),
'EndDate': datetime(2015, 1, 1),
'CommitmentEndDate': datetime(2015, 1, 1),
'EndDateType': 'string',
'CommitmentDuration': 123
},
'OriginalStartDate': datetime(2015, 1, 1),
'ZeroSizePreference': 'retain'|'default',
'LaunchStatus': 'launchable'|'unlaunchable'
},
'CapacityBlocks': [
{
'CapacityBlockId': 'string',
'UltraserverType': 'string',
'AvailabilityZone': 'string',
'AvailabilityZoneId': 'string',
'CapacityReservationIds': [
'string',
],
'StartDate': datetime(2015, 1, 1),
'EndDate': datetime(2015, 1, 1),
'CreateDate': datetime(2015, 1, 1),
'State': 'active'|'expired'|'unavailable'|'cancelled'|'failed'|'scheduled'|'payment-pending'|'payment-failed',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'CapacityReservations': [
{
'CapacityReservationId': 'string',
'OwnerId': 'string',
'CapacityReservationArn': 'string',
'AvailabilityZoneId': 'string',
'InstanceType': 'string',
'InstancePlatform': 'Linux/UNIX'|'Red Hat Enterprise Linux'|'SUSE Linux'|'Windows'|'Windows with SQL Server'|'Windows with SQL Server Enterprise'|'Windows with SQL Server Standard'|'Windows with SQL Server Web'|'Linux with SQL Server Standard'|'Linux with SQL Server Web'|'Linux with SQL Server Enterprise'|'RHEL with SQL Server Standard'|'RHEL with SQL Server Enterprise'|'RHEL with SQL Server Web'|'RHEL with HA'|'RHEL with HA and SQL Server Standard'|'RHEL with HA and SQL Server Enterprise'|'Ubuntu Pro',
'AvailabilityZone': 'string',
'Tenancy': 'default'|'dedicated',
'TotalInstanceCount': 123,
'AvailableInstanceCount': 123,
'EbsOptimized': True|False,
'EphemeralStorage': True|False,
'State': 'active'|'expired'|'cancelled'|'pending'|'failed'|'scheduled'|'payment-pending'|'payment-failed'|'assessing'|'delayed'|'unsupported'|'cancelling'|'unavailable',
'StartDate': datetime(2015, 1, 1),
'EndDate': datetime(2015, 1, 1),
'EndDateType': 'unlimited'|'limited',
'InstanceMatchCriteria': 'open'|'targeted',
'CreateDate': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'OutpostArn': 'string',
'CapacityReservationFleetId': 'string',
'PlacementGroupArn': 'string',
'CapacityAllocations': [
{
'AllocationType': 'used'|'future'|'cancelling',
'Count': 123,
'AllocationMetadata': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'ReservationType': 'default'|'capacity-block',
'UnusedReservationBillingOwnerId': 'string',
'CommitmentInfo': {
'CommittedInstanceCount': 123,
'CommitmentEndDate': datetime(2015, 1, 1),
'CommitmentDuration': 123
},
'DeliveryPreference': 'fixed'|'incremental',
'CapacityBlockId': 'string',
'Interruptible': True|False,
'InterruptibleCapacityAllocation': {
'InstanceCount': 123,
'TargetInstanceCount': 123,
'Status': 'pending'|'active'|'updating'|'canceling'|'canceled'|'failed',
'InterruptibleCapacityReservationId': 'string',
'InterruptionType': 'adhoc',
'ZeroSizePreference': 'retain'|'default'
},
'InterruptionInfo': {
'SourceCapacityReservationId': 'string',
'InterruptionType': 'adhoc'
},
'AdjustmentStatus': 'requested'|'applied'|'rejected',
'AdjustmentDetails': {
'StartDate': datetime(2015, 1, 1),
'EndDate': datetime(2015, 1, 1),
'CommitmentEndDate': datetime(2015, 1, 1),
'EndDateType': 'string',
'CommitmentDuration': 123
},
'OriginalStartDate': datetime(2015, 1, 1),
'ZeroSizePreference': 'retain'|'default',
'LaunchStatus': 'launchable'|'unlaunchable'
},
]
}
Response Structure
(dict) --
CapacityReservation (dict) --
The Capacity Reservation.
CapacityReservationId (string) --
The ID of the Capacity Reservation.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the Capacity Reservation.
CapacityReservationArn (string) --
The Amazon Resource Name (ARN) of the Capacity Reservation.
AvailabilityZoneId (string) --
The ID of the Availability Zone in which the capacity is reserved.
InstanceType (string) --
The type of instance for which the Capacity Reservation reserves capacity.
InstancePlatform (string) --
The type of operating system for which the Capacity Reservation reserves capacity.
AvailabilityZone (string) --
The Availability Zone in which the capacity is reserved.
Tenancy (string) --
Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.
dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
TotalInstanceCount (integer) --
The total number of instances for which the Capacity Reservation reserves capacity.
AvailableInstanceCount (integer) --
The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.
EbsOptimized (boolean) --
Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.
EphemeralStorage (boolean) --
Deprecated.
State (string) --
The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
active - The capacity is available for use.
expired - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use.
cancelled - The Capacity Reservation was canceled. The reserved capacity is no longer available for your use.
pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
failed - The Capacity Reservation request has failed. A request can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes.
scheduled - (Future-dated Capacity Reservations) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.
payment-pending - (Capacity Blocks) The upfront payment has not been processed yet.
payment-failed - (Capacity Blocks) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released.
assessing - (Future-dated Capacity Reservations) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.
delayed - (Future-dated Capacity Reservations) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time.
unsupported - (Future-dated Capacity Reservations) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered.
cancelling - (Future-dated Capacity Reservations) The Capacity Reservation is being cancelled. Capacity has been released but charges continue for the commitment wind-down period. The reservation transitions to cancelled when the wind-down completes.
StartDate (datetime) --
The date and time the Capacity Reservation was started.
EndDate (datetime) --
The date and time the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.
EndDateType (string) --
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
unlimited - The Capacity Reservation remains active until you explicitly cancel it.
limited - The Capacity Reservation expires automatically at a specified date and time.
InstanceMatchCriteria (string) --
Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.
targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.
CreateDate (datetime) --
The date and time the Capacity Reservation was created.
Tags (list) --
Any tags assigned to the Capacity Reservation.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.
CapacityReservationFleetId (string) --
The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs. Only valid for Capacity Reservations that were created by a Capacity Reservation Fleet.
PlacementGroupArn (string) --
The Amazon Resource Name (ARN) of the cluster placement group in which the Capacity Reservation was created. For more information, see Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide.
CapacityAllocations (list) --
Information about instance capacity usage.
(dict) --
Information about instance capacity usage for a Capacity Reservation.
AllocationType (string) --
The usage type. used indicates that the instance capacity is in use by instances that are running in the Capacity Reservation.
Count (integer) --
The amount of instance capacity associated with the usage. For example a value of 4 indicates that instance capacity for 4 instances is currently in use.
AllocationMetadata (list) --
Additional metadata associated with the capacity allocation. Each entry contains a key-value pair providing context about the allocation.
(dict) --
A key-value pair that provides additional metadata about a capacity allocation.
Key (string) --
The key of the metadata entry.
Value (string) --
The value of the metadata entry.
ReservationType (string) --
The type of Capacity Reservation.
UnusedReservationBillingOwnerId (string) --
The ID of the Amazon Web Services account to which billing of the unused capacity of the Capacity Reservation is assigned.
CommitmentInfo (dict) --
Information about your commitment for a future-dated Capacity Reservation.
CommittedInstanceCount (integer) --
The instance capacity that you committed to when you requested the future-dated Capacity Reservation.
CommitmentEndDate (datetime) --
The date and time at which the commitment duration expires, in the ISO8601 format in the UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ). You can't decrease the instance count or cancel the Capacity Reservation before this date and time.
CommitmentDuration (integer) --
The commitment duration, in seconds, for the future-dated Capacity Reservation. This is the minimum duration for which you commit to having the Capacity Reservation in the active state in your account after it has been delivered.
DeliveryPreference (string) --
The delivery method for a future-dated Capacity Reservation. incremental indicates that the requested capacity is delivered in addition to any running instances and reserved capacity that you have in your account at the requested date and time.
CapacityBlockId (string) --
The ID of the Capacity Block.
Interruptible (boolean) --
Indicates whether this Capacity Reservation is interruptible, meaning instances may be terminated when the owner reclaims capacity.
InterruptibleCapacityAllocation (dict) --
Contains allocation details for interruptible reservations, including current allocated instances and target instance counts within the interruptibleCapacityAllocation object.
InstanceCount (integer) --
The current number of instances allocated to the interruptible reservation.
TargetInstanceCount (integer) --
After your modify request, the requested number of instances allocated to interruptible reservation.
Status (string) --
The current status of the allocation (updating during reclamation, active when complete).
InterruptibleCapacityReservationId (string) --
The ID of the interruptible Capacity Reservation created from the allocation.
InterruptionType (string) --
The type of interruption policy applied to the interruptible reservation.
ZeroSizePreference (string) --
Specifies how Amazon EC2 handles the interruptible Capacity Reservation when you reduce its allocation to zero instances. A value of retain keeps the interruptible Capacity Reservation active at zero capacity so that you can allocate instances to it again later. A value of default cancels the interruptible Capacity Reservation and returns the capacity to your source Capacity Reservation.
InterruptionInfo (dict) --
Information about the interruption configuration and association with the source reservation for interruptible Capacity Reservations.
SourceCapacityReservationId (string) --
The ID of the source Capacity Reservation from which the interruptible reservation was created.
InterruptionType (string) --
The interruption type that determines how instances are terminated when capacity is reclaimed.
AdjustmentStatus (string) --
The status of the most recent modification to the Capacity Reservation. A Capacity Reservation can have one of the following adjustment statuses:
requested - The modification was requested and is being processed.
applied - The modification was applied to the Capacity Reservation.
rejected - The modification was not applied and the Capacity Reservation keeps its existing configuration.
This field is not returned if the Capacity Reservation has never been modified.
AdjustmentDetails (dict) --
The configuration that the Capacity Reservation will have after the requested adjustment is applied.
StartDate (datetime) --
The start date that the Capacity Reservation will have after the adjustment.
EndDate (datetime) --
The end date that the Capacity Reservation will have after the adjustment.
CommitmentEndDate (datetime) --
The date and time at which the commitment duration will expire after the adjustment.
EndDateType (string) --
Indicates the way in which the Capacity Reservation will end after the adjustment. Possible values are:
unlimited - The Capacity Reservation remains active until you explicitly cancel it.
limited - The Capacity Reservation expires automatically at the date and time given by endDate.
CommitmentDuration (integer) --
The commitment duration, in seconds, that the Capacity Reservation will have after the adjustment.
OriginalStartDate (datetime) --
The start date that you originally requested for the Capacity Reservation, in the ISO8601 format in the UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ). This value doesn't change when you push out the start date.
ZeroSizePreference (string) --
The zero-size preference configured for the interruptible Capacity Reservation. A value of retain keeps the interruptible Capacity Reservation active at zero capacity when you reduce its allocation to zero. A value of default cancels the interruptible Capacity Reservation when you reduce its allocation to zero.
LaunchStatus (string) --
Indicates whether you can launch instances into the Capacity Reservation. A Capacity Reservation can have the following launch statuses:
launchable - You can launch instances into the Capacity Reservation.
unlaunchable - You can't launch instances into the Capacity Reservation. For example, the Capacity Reservation is not active.
CapacityBlocks (list) --
The Capacity Block.
(dict) --
Reserve powerful GPU instances on a future date to support your short duration machine learning (ML) workloads. Instances that run inside a Capacity Block are automatically placed close together inside Amazon EC2 UltraClusters, for low-latency, petabit-scale, non-blocking networking.
You can also reserve Amazon EC2 UltraServers. UltraServers connect multiple EC2 instances using a low-latency, high-bandwidth accelerator interconnect (NeuronLink). They are built to tackle very large-scale AI/ML workloads that require significant processing power. For more information, see Amazon EC2 UltraServers.
CapacityBlockId (string) --
The ID of the Capacity Block.
UltraserverType (string) --
The EC2 UltraServer type of the Capacity Block.
AvailabilityZone (string) --
The Availability Zone of the Capacity Block.
AvailabilityZoneId (string) --
The Availability Zone ID of the Capacity Block.
CapacityReservationIds (list) --
The ID of the Capacity Reservation.
(string) --
StartDate (datetime) --
The date and time at which the Capacity Block was started.
EndDate (datetime) --
The date and time at which the Capacity Block expires. When a Capacity Block expires, all instances in the Capacity Block are terminated.
CreateDate (datetime) --
The date and time at which the Capacity Block was created.
State (string) --
The state of the Capacity Block.
Tags (list) --
The tags assigned to the Capacity Block.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
CapacityReservations (list) --
The Capacity Reservations created as a result of the Capacity Block purchase. When a Capacity Block offering contains multiple segments, a separate Capacity Reservation is created for each segment.
(dict) --
Describes a Capacity Reservation.
CapacityReservationId (string) --
The ID of the Capacity Reservation.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the Capacity Reservation.
CapacityReservationArn (string) --
The Amazon Resource Name (ARN) of the Capacity Reservation.
AvailabilityZoneId (string) --
The ID of the Availability Zone in which the capacity is reserved.
InstanceType (string) --
The type of instance for which the Capacity Reservation reserves capacity.
InstancePlatform (string) --
The type of operating system for which the Capacity Reservation reserves capacity.
AvailabilityZone (string) --
The Availability Zone in which the capacity is reserved.
Tenancy (string) --
Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.
dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
TotalInstanceCount (integer) --
The total number of instances for which the Capacity Reservation reserves capacity.
AvailableInstanceCount (integer) --
The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.
EbsOptimized (boolean) --
Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.
EphemeralStorage (boolean) --
Deprecated.
State (string) --
The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
active - The capacity is available for use.
expired - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use.
cancelled - The Capacity Reservation was canceled. The reserved capacity is no longer available for your use.
pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
failed - The Capacity Reservation request has failed. A request can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes.
scheduled - (Future-dated Capacity Reservations) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.
payment-pending - (Capacity Blocks) The upfront payment has not been processed yet.
payment-failed - (Capacity Blocks) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released.
assessing - (Future-dated Capacity Reservations) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.
delayed - (Future-dated Capacity Reservations) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time.
unsupported - (Future-dated Capacity Reservations) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered.
cancelling - (Future-dated Capacity Reservations) The Capacity Reservation is being cancelled. Capacity has been released but charges continue for the commitment wind-down period. The reservation transitions to cancelled when the wind-down completes.
StartDate (datetime) --
The date and time the Capacity Reservation was started.
EndDate (datetime) --
The date and time the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.
EndDateType (string) --
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
unlimited - The Capacity Reservation remains active until you explicitly cancel it.
limited - The Capacity Reservation expires automatically at a specified date and time.
InstanceMatchCriteria (string) --
Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.
targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.
CreateDate (datetime) --
The date and time the Capacity Reservation was created.
Tags (list) --
Any tags assigned to the Capacity Reservation.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.
CapacityReservationFleetId (string) --
The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs. Only valid for Capacity Reservations that were created by a Capacity Reservation Fleet.
PlacementGroupArn (string) --
The Amazon Resource Name (ARN) of the cluster placement group in which the Capacity Reservation was created. For more information, see Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide.
CapacityAllocations (list) --
Information about instance capacity usage.
(dict) --
Information about instance capacity usage for a Capacity Reservation.
AllocationType (string) --
The usage type. used indicates that the instance capacity is in use by instances that are running in the Capacity Reservation.
Count (integer) --
The amount of instance capacity associated with the usage. For example a value of 4 indicates that instance capacity for 4 instances is currently in use.
AllocationMetadata (list) --
Additional metadata associated with the capacity allocation. Each entry contains a key-value pair providing context about the allocation.
(dict) --
A key-value pair that provides additional metadata about a capacity allocation.
Key (string) --
The key of the metadata entry.
Value (string) --
The value of the metadata entry.
ReservationType (string) --
The type of Capacity Reservation.
UnusedReservationBillingOwnerId (string) --
The ID of the Amazon Web Services account to which billing of the unused capacity of the Capacity Reservation is assigned.
CommitmentInfo (dict) --
Information about your commitment for a future-dated Capacity Reservation.
CommittedInstanceCount (integer) --
The instance capacity that you committed to when you requested the future-dated Capacity Reservation.
CommitmentEndDate (datetime) --
The date and time at which the commitment duration expires, in the ISO8601 format in the UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ). You can't decrease the instance count or cancel the Capacity Reservation before this date and time.
CommitmentDuration (integer) --
The commitment duration, in seconds, for the future-dated Capacity Reservation. This is the minimum duration for which you commit to having the Capacity Reservation in the active state in your account after it has been delivered.
DeliveryPreference (string) --
The delivery method for a future-dated Capacity Reservation. incremental indicates that the requested capacity is delivered in addition to any running instances and reserved capacity that you have in your account at the requested date and time.
CapacityBlockId (string) --
The ID of the Capacity Block.
Interruptible (boolean) --
Indicates whether this Capacity Reservation is interruptible, meaning instances may be terminated when the owner reclaims capacity.
InterruptibleCapacityAllocation (dict) --
Contains allocation details for interruptible reservations, including current allocated instances and target instance counts within the interruptibleCapacityAllocation object.
InstanceCount (integer) --
The current number of instances allocated to the interruptible reservation.
TargetInstanceCount (integer) --
After your modify request, the requested number of instances allocated to interruptible reservation.
Status (string) --
The current status of the allocation (updating during reclamation, active when complete).
InterruptibleCapacityReservationId (string) --
The ID of the interruptible Capacity Reservation created from the allocation.
InterruptionType (string) --
The type of interruption policy applied to the interruptible reservation.
ZeroSizePreference (string) --
Specifies how Amazon EC2 handles the interruptible Capacity Reservation when you reduce its allocation to zero instances. A value of retain keeps the interruptible Capacity Reservation active at zero capacity so that you can allocate instances to it again later. A value of default cancels the interruptible Capacity Reservation and returns the capacity to your source Capacity Reservation.
InterruptionInfo (dict) --
Information about the interruption configuration and association with the source reservation for interruptible Capacity Reservations.
SourceCapacityReservationId (string) --
The ID of the source Capacity Reservation from which the interruptible reservation was created.
InterruptionType (string) --
The interruption type that determines how instances are terminated when capacity is reclaimed.
AdjustmentStatus (string) --
The status of the most recent modification to the Capacity Reservation. A Capacity Reservation can have one of the following adjustment statuses:
requested - The modification was requested and is being processed.
applied - The modification was applied to the Capacity Reservation.
rejected - The modification was not applied and the Capacity Reservation keeps its existing configuration.
This field is not returned if the Capacity Reservation has never been modified.
AdjustmentDetails (dict) --
The configuration that the Capacity Reservation will have after the requested adjustment is applied.
StartDate (datetime) --
The start date that the Capacity Reservation will have after the adjustment.
EndDate (datetime) --
The end date that the Capacity Reservation will have after the adjustment.
CommitmentEndDate (datetime) --
The date and time at which the commitment duration will expire after the adjustment.
EndDateType (string) --
Indicates the way in which the Capacity Reservation will end after the adjustment. Possible values are:
unlimited - The Capacity Reservation remains active until you explicitly cancel it.
limited - The Capacity Reservation expires automatically at the date and time given by endDate.
CommitmentDuration (integer) --
The commitment duration, in seconds, that the Capacity Reservation will have after the adjustment.
OriginalStartDate (datetime) --
The start date that you originally requested for the Capacity Reservation, in the ISO8601 format in the UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ). This value doesn't change when you push out the start date.
ZeroSizePreference (string) --
The zero-size preference configured for the interruptible Capacity Reservation. A value of retain keeps the interruptible Capacity Reservation active at zero capacity when you reduce its allocation to zero. A value of default cancels the interruptible Capacity Reservation when you reduce its allocation to zero.
LaunchStatus (string) --
Indicates whether you can launch instances into the Capacity Reservation. A Capacity Reservation can have the following launch statuses:
launchable - You can launch instances into the Capacity Reservation.
unlaunchable - You can't launch instances into the Capacity Reservation. For example, the Capacity Reservation is not active.
{'TransitGatewayPeeringAttachment': {'Options': {'AccepterAllowMultipathResilience': 'boolean',
'AccepterMultipathResilienceMode': 'always-on',
'MultipathResilienceStatus': 'pending '
'| '
'enabled '
'| '
'disabled',
'RequesterAllowMultipathResilience': 'boolean',
'RequesterMultipathResilienceMode': 'always-on'}}}
Rejects a transit gateway peering attachment request.
See also: AWS API Documentation
Request Syntax
client.reject_transit_gateway_peering_attachment(
TransitGatewayAttachmentId='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the transit gateway peering attachment.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'TransitGatewayPeeringAttachment': {
'TransitGatewayAttachmentId': 'string',
'AccepterTransitGatewayAttachmentId': 'string',
'RequesterTgwInfo': {
'TransitGatewayId': 'string',
'CoreNetworkId': 'string',
'OwnerId': 'string',
'Region': 'string'
},
'AccepterTgwInfo': {
'TransitGatewayId': 'string',
'CoreNetworkId': 'string',
'OwnerId': 'string',
'Region': 'string'
},
'Options': {
'DynamicRouting': 'enable'|'disable',
'RequesterAllowMultipathResilience': True|False,
'RequesterMultipathResilienceMode': 'always-on',
'AccepterAllowMultipathResilience': True|False,
'AccepterMultipathResilienceMode': 'always-on',
'MultipathResilienceStatus': 'pending'|'enabled'|'disabled'
},
'Status': {
'Code': 'string',
'Message': 'string'
},
'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
'CreationTime': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
TransitGatewayPeeringAttachment (dict) --
The transit gateway peering attachment.
TransitGatewayAttachmentId (string) --
The ID of the transit gateway peering attachment.
AccepterTransitGatewayAttachmentId (string) --
The ID of the accepter transit gateway attachment.
RequesterTgwInfo (dict) --
Information about the requester transit gateway.
TransitGatewayId (string) --
The ID of the transit gateway.
CoreNetworkId (string) --
The ID of the core network where the transit gateway peer is located.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the transit gateway.
Region (string) --
The Region of the transit gateway.
AccepterTgwInfo (dict) --
Information about the accepter transit gateway.
TransitGatewayId (string) --
The ID of the transit gateway.
CoreNetworkId (string) --
The ID of the core network where the transit gateway peer is located.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the transit gateway.
Region (string) --
The Region of the transit gateway.
Options (dict) --
Details about the transit gateway peering attachment.
DynamicRouting (string) --
Describes whether dynamic routing is enabled or disabled for the transit gateway peering attachment.
RequesterAllowMultipathResilience (boolean) --
Indicates whether the requester allows multipath resilience for the transit gateway peering attachment.
RequesterMultipathResilienceMode (string) --
The multipath resilience mode for the requester. This value is present only when the requester allows multipath resilience.
AccepterAllowMultipathResilience (boolean) --
Indicates whether the accepter allows multipath resilience for the transit gateway peering attachment.
AccepterMultipathResilienceMode (string) --
The multipath resilience mode for the accepter. This value is present only when the accepter allows multipath resilience.
MultipathResilienceStatus (string) --
The multipath resilience status of the transit gateway peering attachment. The possible values are:
enabled – Both the requester and the accepter allow multipath resilience.
pending – Either the requester or the accepter allows multipath resilience, but not both.
disabled – Neither the requester nor the accepter allows multipath resilience.
Status (dict) --
The status of the transit gateway peering attachment.
Code (string) --
The status code.
Message (string) --
The status message, if applicable.
State (string) --
The state of the transit gateway peering attachment. Note that the initiating state has been deprecated.
CreationTime (datetime) --
The time the transit gateway peering attachment was created.
Tags (list) --
The tags for the transit gateway peering attachment.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.