2026/04/20 - Amazon Elastic Compute Cloud - 3 new34 updated api methods
Changes Added Transit Gateway Integration into AWS Client VPN.
Deletes a Transit Gateway attachment for a Client VPN endpoint. The Transit Gateway owner can delete the attachment to remove the association between the Client VPN endpoint and the Transit Gateway.
See also: AWS API Documentation
Request Syntax
client.delete_transit_gateway_client_vpn_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
{
'TransitGatewayClientVpnAttachment': {
'TransitGatewayAttachmentId': 'string',
'TransitGatewayId': 'string',
'ClientVpnEndpointId': 'string',
'ClientVpnOwnerId': 'string',
'State': 'pending-acceptance'|'pending'|'rejected'|'available'|'deleting'|'deleted',
'CreationTime': 'string'
}
}
Response Structure
(dict) --
TransitGatewayClientVpnAttachment (dict) --
Information about the Transit Gateway Client VPN attachment.
TransitGatewayAttachmentId (string) --
The ID of the Transit Gateway attachment.
TransitGatewayId (string) --
The ID of the Transit Gateway.
ClientVpnEndpointId (string) --
The ID of the Client VPN endpoint.
ClientVpnOwnerId (string) --
The ID of the Amazon Web Services account that owns the Client VPN endpoint.
State (string) --
The state of the Transit Gateway attachment.
CreationTime (string) --
The date and time the Transit Gateway attachment was created.
Rejects a Transit Gateway attachment request for a Client VPN endpoint. The Transit Gateway owner can reject the attachment request to prevent the Client VPN endpoint from routing traffic through the Transit Gateway.
See also: AWS API Documentation
Request Syntax
client.reject_transit_gateway_client_vpn_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
{
'TransitGatewayClientVpnAttachment': {
'TransitGatewayAttachmentId': 'string',
'TransitGatewayId': 'string',
'ClientVpnEndpointId': 'string',
'ClientVpnOwnerId': 'string',
'State': 'pending-acceptance'|'pending'|'rejected'|'available'|'deleting'|'deleted',
'CreationTime': 'string'
}
}
Response Structure
(dict) --
TransitGatewayClientVpnAttachment (dict) --
Information about the Transit Gateway Client VPN attachment.
TransitGatewayAttachmentId (string) --
The ID of the Transit Gateway attachment.
TransitGatewayId (string) --
The ID of the Transit Gateway.
ClientVpnEndpointId (string) --
The ID of the Client VPN endpoint.
ClientVpnOwnerId (string) --
The ID of the Amazon Web Services account that owns the Client VPN endpoint.
State (string) --
The state of the Transit Gateway attachment.
CreationTime (string) --
The date and time the Transit Gateway attachment was created.
Accepts a Transit Gateway attachment request for a Client VPN endpoint. The Transit Gateway owner must accept the attachment request before the Client VPN endpoint can route traffic through the Transit Gateway.
See also: AWS API Documentation
Request Syntax
client.accept_transit_gateway_client_vpn_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
{
'TransitGatewayClientVpnAttachment': {
'TransitGatewayAttachmentId': 'string',
'TransitGatewayId': 'string',
'ClientVpnEndpointId': 'string',
'ClientVpnOwnerId': 'string',
'State': 'pending-acceptance'|'pending'|'rejected'|'available'|'deleting'|'deleted',
'CreationTime': 'string'
}
}
Response Structure
(dict) --
TransitGatewayClientVpnAttachment (dict) --
Information about the Transit Gateway Client VPN attachment.
TransitGatewayAttachmentId (string) --
The ID of the Transit Gateway attachment.
TransitGatewayId (string) --
The ID of the Transit Gateway.
ClientVpnEndpointId (string) --
The ID of the Client VPN endpoint.
ClientVpnOwnerId (string) --
The ID of the Amazon Web Services account that owns the Client VPN endpoint.
State (string) --
The state of the Transit Gateway attachment.
CreationTime (string) --
The date and time the Transit Gateway attachment was created.
{'Associations': {'ResourceType': {'client-vpn'}}}
Accepts a request to associate subnets with a transit gateway multicast domain.
See also: AWS API Documentation
Request Syntax
client.accept_transit_gateway_multicast_domain_associations(
TransitGatewayMulticastDomainId='string',
TransitGatewayAttachmentId='string',
SubnetIds=[
'string',
],
DryRun=True|False
)
string
The ID of the transit gateway multicast domain.
string
The ID of the transit gateway attachment.
list
The IDs of the subnets to associate with the transit gateway multicast domain.
(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
{
'Associations': {
'TransitGatewayMulticastDomainId': 'string',
'TransitGatewayAttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function'|'client-vpn',
'ResourceOwnerId': 'string',
'Subnets': [
{
'SubnetId': 'string',
'State': 'pendingAcceptance'|'associating'|'associated'|'disassociating'|'disassociated'|'rejected'|'failed'
},
]
}
}
Response Structure
(dict) --
Associations (dict) --
Information about the multicast domain associations.
TransitGatewayMulticastDomainId (string) --
The ID of the transit gateway multicast domain.
TransitGatewayAttachmentId (string) --
The ID of the transit gateway attachment.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The type of resource, for example a VPC attachment.
ResourceOwnerId (string) --
The ID of the Amazon Web Services account that owns the resource.
Subnets (list) --
The subnets associated with the multicast domain.
(dict) --
Describes the subnet association with the transit gateway multicast domain.
SubnetId (string) --
The ID of the subnet.
State (string) --
The state of the subnet association.
{'AvailabilityZone': 'string', 'AvailabilityZoneId': 'string'}
Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy.
If you specified a VPC when you created the Client VPN endpoint or if you have previous subnet associations, the specified subnet must be in the same VPC. To specify a subnet that's in a different VPC, you must first modify the Client VPN endpoint ( ModifyClientVpnEndpoint) and change the VPC that's associated with it.
See also: AWS API Documentation
Request Syntax
client.associate_client_vpn_target_network(
ClientVpnEndpointId='string',
SubnetId='string',
ClientToken='string',
DryRun=True|False,
AvailabilityZone='string',
AvailabilityZoneId='string'
)
string
[REQUIRED]
The ID of the Client VPN endpoint.
string
The ID of the subnet to associate with the Client VPN endpoint. Required for VPC-based endpoints. For Transit Gateway-based endpoints, use AvailabilityZone or AvailabilityZoneId instead.
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
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 Availability Zone name for the Transit Gateway association. Required if when associating an Availability Zone with a Client VPN endpoint that uses a Transit Gateway. You cannot specify both SubnetId and AvailabilityZone.
string
The Availability Zone ID for the Transit Gateway association. Required if when associating an Availability Zone with a Client VPN endpoint that uses a Transit Gateway. You cannot specify both AvailabilityZone and AvailabilityZoneId.
dict
Response Syntax
{
'AssociationId': 'string',
'Status': {
'Code': 'associating'|'associated'|'association-failed'|'disassociating'|'disassociated',
'Message': 'string'
}
}
Response Structure
(dict) --
AssociationId (string) --
The unique ID of the target network association.
Status (dict) --
The current state of the target network association.
Code (string) --
The state of the target network association.
Message (string) --
A message about the status of the target network association, if applicable.
{'Associations': {'ResourceType': {'client-vpn'}}}
Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.
The transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments to see the state of the attachment.
See also: AWS API Documentation
Request Syntax
client.associate_transit_gateway_multicast_domain(
TransitGatewayMulticastDomainId='string',
TransitGatewayAttachmentId='string',
SubnetIds=[
'string',
],
DryRun=True|False
)
string
[REQUIRED]
The ID of the transit gateway multicast domain.
string
[REQUIRED]
The ID of the transit gateway attachment to associate with the transit gateway multicast domain.
list
[REQUIRED]
The IDs of the subnets to associate with the transit gateway multicast domain.
(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
{
'Associations': {
'TransitGatewayMulticastDomainId': 'string',
'TransitGatewayAttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function'|'client-vpn',
'ResourceOwnerId': 'string',
'Subnets': [
{
'SubnetId': 'string',
'State': 'pendingAcceptance'|'associating'|'associated'|'disassociating'|'disassociated'|'rejected'|'failed'
},
]
}
}
Response Structure
(dict) --
Associations (dict) --
Information about the transit gateway multicast domain associations.
TransitGatewayMulticastDomainId (string) --
The ID of the transit gateway multicast domain.
TransitGatewayAttachmentId (string) --
The ID of the transit gateway attachment.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The type of resource, for example a VPC attachment.
ResourceOwnerId (string) --
The ID of the Amazon Web Services account that owns the resource.
Subnets (list) --
The subnets associated with the multicast domain.
(dict) --
Describes the subnet association with the transit gateway multicast domain.
SubnetId (string) --
The ID of the subnet.
State (string) --
The state of the subnet association.
{'Association': {'ResourceType': {'client-vpn'}}}
Associates the specified transit gateway attachment with a transit gateway policy table.
See also: AWS API Documentation
Request Syntax
client.associate_transit_gateway_policy_table(
TransitGatewayPolicyTableId='string',
TransitGatewayAttachmentId='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the transit gateway policy table to associate with the transit gateway attachment.
string
[REQUIRED]
The ID of the transit gateway attachment to associate with the policy table.
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
{
'Association': {
'TransitGatewayPolicyTableId': 'string',
'TransitGatewayAttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function'|'client-vpn',
'State': 'associating'|'associated'|'disassociating'|'disassociated'
}
}
Response Structure
(dict) --
Association (dict) --
Describes the association of a transit gateway and a transit gateway policy table.
TransitGatewayPolicyTableId (string) --
The ID of the transit gateway policy table.
TransitGatewayAttachmentId (string) --
The ID of the transit gateway attachment.
ResourceId (string) --
The resource ID of the transit gateway attachment.
ResourceType (string) --
The resource type for the transit gateway policy table association.
State (string) --
The state of the transit gateway policy table association.
{'Association': {'ResourceType': {'client-vpn'}}}
Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.
See also: AWS API Documentation
Request Syntax
client.associate_transit_gateway_route_table(
TransitGatewayRouteTableId='string',
TransitGatewayAttachmentId='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the transit gateway route table.
string
[REQUIRED]
The ID of the 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
{
'Association': {
'TransitGatewayRouteTableId': 'string',
'TransitGatewayAttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function'|'client-vpn',
'State': 'associating'|'associated'|'disassociating'|'disassociated'
}
}
Response Structure
(dict) --
Association (dict) --
The ID of the association.
TransitGatewayRouteTableId (string) --
The ID of the transit gateway route table.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The resource type. Note that the tgw-peering resource type has been deprecated.
State (string) --
The state of the association.
{'TransitGatewayConfiguration': {'AvailabilityZoneIds': ['string'],
'AvailabilityZones': ['string'],
'TransitGatewayId': 'string'}}
Response {'Status': {'Code': {'pending'}}}
Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated.
See also: AWS API Documentation
Request Syntax
client.create_client_vpn_endpoint(
ClientCidrBlock='string',
ServerCertificateArn='string',
AuthenticationOptions=[
{
'Type': 'certificate-authentication'|'directory-service-authentication'|'federated-authentication',
'ActiveDirectory': {
'DirectoryId': 'string'
},
'MutualAuthentication': {
'ClientRootCertificateChainArn': 'string'
},
'FederatedAuthentication': {
'SAMLProviderArn': 'string',
'SelfServiceSAMLProviderArn': 'string'
}
},
],
ConnectionLogOptions={
'Enabled': True|False,
'CloudwatchLogGroup': 'string',
'CloudwatchLogStream': 'string'
},
DnsServers=[
'string',
],
TransportProtocol='tcp'|'udp',
VpnPort=123,
Description='string',
SplitTunnel=True|False,
DryRun=True|False,
ClientToken='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'|'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'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
SecurityGroupIds=[
'string',
],
VpcId='string',
SelfServicePortal='enabled'|'disabled',
ClientConnectOptions={
'Enabled': True|False,
'LambdaFunctionArn': 'string'
},
SessionTimeoutHours=123,
ClientLoginBannerOptions={
'Enabled': True|False,
'BannerText': 'string'
},
ClientRouteEnforcementOptions={
'Enforced': True|False
},
DisconnectOnSessionTimeout=True|False,
EndpointIpAddressType='ipv4'|'ipv6'|'dual-stack',
TrafficIpAddressType='ipv4'|'ipv6'|'dual-stack',
TransitGatewayConfiguration={
'TransitGatewayId': 'string',
'AvailabilityZones': [
'string',
],
'AvailabilityZoneIds': [
'string',
]
}
)
string
The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. Client CIDR range must have a size of at least /22 and must not be greater than /12.
string
[REQUIRED]
The ARN of the server certificate. For more information, see the Certificate Manager User Guide.
list
[REQUIRED]
Information about the authentication method to be used to authenticate clients.
(dict) --
Describes the authentication method to be used by a Client VPN endpoint. For more information, see Authentication in the Client VPN Administrator Guide.
Type (string) --
The type of client authentication to be used.
ActiveDirectory (dict) --
Information about the Active Directory to be used, if applicable. You must provide this information if Type is directory-service-authentication.
DirectoryId (string) --
The ID of the Active Directory to be used for authentication.
MutualAuthentication (dict) --
Information about the authentication certificates to be used, if applicable. You must provide this information if Type is certificate-authentication.
ClientRootCertificateChainArn (string) --
The ARN of the client certificate. The certificate must be signed by a certificate authority (CA) and it must be provisioned in Certificate Manager (ACM).
FederatedAuthentication (dict) --
Information about the IAM SAML identity provider to be used, if applicable. You must provide this information if Type is federated-authentication.
SAMLProviderArn (string) --
The Amazon Resource Name (ARN) of the IAM SAML identity provider.
SelfServiceSAMLProviderArn (string) --
The Amazon Resource Name (ARN) of the IAM SAML identity provider for the self-service portal.
dict
[REQUIRED]
Information about the client connection logging options.
If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:
Client connection requests
Client connection results (successful and unsuccessful)
Reasons for unsuccessful client connection requests
Client connection termination time
Enabled (boolean) --
Indicates whether connection logging is enabled.
CloudwatchLogGroup (string) --
The name of the CloudWatch Logs log group. Required if connection logging is enabled.
CloudwatchLogStream (string) --
The name of the CloudWatch Logs log stream to which the connection data is published.
list
Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address configured on the device is used for the DNS server.
(string) --
string
The transport protocol to be used by the VPN session.
Default value: udp
integer
The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
Valid Values: 443 | 1194
Default Value: 443
string
A brief description of the Client VPN endpoint.
boolean
Indicates whether split-tunnel is enabled on the Client VPN endpoint.
By default, split-tunnel on a VPN endpoint is disabled.
For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the Client VPN Administrator Guide.
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
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
list
The tags to apply to the Client VPN endpoint during creation.
(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.
list
The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups.
(string) --
string
The ID of the VPC to associate with the Client VPN endpoint. If no security group IDs are specified in the request, the default security group for the VPC is applied.
string
Specify whether to enable the self-service portal for the Client VPN endpoint.
Default Value: enabled
dict
The options for managing connection authorization for new client connections.
Enabled (boolean) --
Indicates whether client connect options are enabled. The default is false (not enabled).
LambdaFunctionArn (string) --
The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.
integer
The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
dict
Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
Enabled (boolean) --
Enable or disable a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
Valid values: true | false
Default value: false
BannerText (string) --
Customizable text that will be displayed in a banner on Amazon Web Services provided clients when a VPN session is established. UTF-8 encoded characters only. Maximum of 1400 characters.
dict
Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN. T his feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel.
Client route enforcement works by monitoring the route table of a connected device for routing policy changes to the VPN connection. If the feature detects any VPN routing policy modifications, it will automatically force an update to the route table, reverting it back to the expected route configurations.
Enforced (boolean) --
Enable or disable Client Route Enforcement. The state can either be true (enabled) or false (disabled). The default is false.
Valid values: true | false
Default value: false
boolean
Indicates whether the client VPN session is disconnected after the maximum timeout specified in SessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. The default value is true.
string
The IP address type for the Client VPN endpoint. Valid values are ipv4 (default) for IPv4 addressing only, ipv6 for IPv6 addressing only, or dual-stack for both IPv4 and IPv6 addressing. When set to dual-stack, clients can connect to the endpoint using either IPv4 or IPv6 addresses..
string
The IP address type for traffic within the Client VPN tunnel. Valid values are ipv4 (default) for IPv4 traffic only, ipv6 for IPv6 addressing only, or dual-stack for both IPv4 and IPv6 traffic. When set to dual-stack, clients can access both IPv4 and IPv6 resources through the VPN .
dict
The Transit Gateway configuration for the Client VPN endpoint. Use this parameter to associate the endpoint with a Transit Gateway instead of a VPC. You cannot specify both TransitGatewayConfiguration and VpcId/ SecurityGroupIds.
TransitGatewayId (string) --
The ID of the Transit Gateway to associate with the Client VPN endpoint.
AvailabilityZones (list) --
The Availability Zone names for the Transit Gateway association. You can specify up to the maximum number of Availability Zones supported by the Transit Gateway. You cannot specify both AvailabilityZones and AvailabilityZoneIds.
(string) --
AvailabilityZoneIds (list) --
The Availability Zone IDs for the Transit Gateway association. You can specify up to the maximum number of Availability Zones supported by the Transit Gateway. You cannot specify both AvailabilityZones and AvailabilityZoneIds.
(string) --
dict
Response Syntax
{
'ClientVpnEndpointId': 'string',
'Status': {
'Code': 'pending-associate'|'available'|'deleting'|'deleted'|'pending',
'Message': 'string'
},
'DnsName': 'string'
}
Response Structure
(dict) --
ClientVpnEndpointId (string) --
The ID of the Client VPN endpoint.
Status (dict) --
The current state of the Client VPN endpoint.
Code (string) --
The state of the Client VPN endpoint. Possible states include:
pending-associate - The Client VPN endpoint has been created but no target networks have been associated. The Client VPN endpoint cannot accept connections.
available - The Client VPN endpoint has been created and a target network has been associated. The Client VPN endpoint can accept connections.
deleting - The Client VPN endpoint is being deleted. The Client VPN endpoint cannot accept connections.
deleted - The Client VPN endpoint has been deleted. The Client VPN endpoint cannot accept connections.
pending - The Client VPN endpoint has been created with a Transit Gateway configuration and is waiting for the Transit Gateway attachment to be accepted. The Client VPN endpoint cannot accept connections.
Message (string) --
A message about the status of the Client VPN endpoint.
DnsName (string) --
The DNS name to be used by clients when establishing their VPN session.
{'DestinationTransitGatewayAttachmentType': {'client-vpn'},
'SourceTransitGatewayAttachmentType': {'client-vpn'}}
Response {'TransitGatewayMeteringPolicyEntry': {'MeteringPolicyRule': {'DestinationTransitGatewayAttachmentType': {'client-vpn'},
'SourceTransitGatewayAttachmentType': {'client-vpn'}}}}
Creates an entry in a transit gateway metering policy to define traffic measurement rules.
See also: AWS API Documentation
Request Syntax
client.create_transit_gateway_metering_policy_entry(
TransitGatewayMeteringPolicyId='string',
PolicyRuleNumber=123,
SourceTransitGatewayAttachmentId='string',
SourceTransitGatewayAttachmentType='vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function'|'client-vpn',
SourceCidrBlock='string',
SourcePortRange='string',
DestinationTransitGatewayAttachmentId='string',
DestinationTransitGatewayAttachmentType='vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function'|'client-vpn',
DestinationCidrBlock='string',
DestinationPortRange='string',
Protocol='string',
MeteredAccount='source-attachment-owner'|'destination-attachment-owner'|'transit-gateway-owner',
DryRun=True|False
)
string
[REQUIRED]
The ID of the transit gateway metering policy to add the entry to.
integer
[REQUIRED]
The rule number for the metering policy entry. Rules are processed in order from lowest to highest number.
string
The ID of the source transit gateway attachment for traffic matching.
string
The type of the source transit gateway attachment for traffic matching. Note that the tgw-peering resource type has been deprecated. To configure metering policies for Connect, use the transport attachment type.
string
The source CIDR block for traffic matching.
string
The source port range for traffic matching.
string
The ID of the destination transit gateway attachment for traffic matching.
string
The type of the destination transit gateway attachment for traffic matching. Note that the tgw-peering resource type has been deprecated. To configure metering policies for Connect, use the transport attachment type.
string
The destination CIDR block for traffic matching.
string
The destination port range for traffic matching.
string
The protocol for traffic matching (1, 6, 17, etc.).
string
[REQUIRED]
The Amazon Web Services account ID to which the metered traffic should be attributed.
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
{
'TransitGatewayMeteringPolicyEntry': {
'PolicyRuleNumber': 'string',
'MeteredAccount': 'source-attachment-owner'|'destination-attachment-owner'|'transit-gateway-owner',
'State': 'available'|'deleted',
'UpdatedAt': datetime(2015, 1, 1),
'UpdateEffectiveAt': datetime(2015, 1, 1),
'MeteringPolicyRule': {
'SourceTransitGatewayAttachmentId': 'string',
'SourceTransitGatewayAttachmentType': 'vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function'|'client-vpn',
'SourceCidrBlock': 'string',
'SourcePortRange': 'string',
'DestinationTransitGatewayAttachmentId': 'string',
'DestinationTransitGatewayAttachmentType': 'vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function'|'client-vpn',
'DestinationCidrBlock': 'string',
'DestinationPortRange': 'string',
'Protocol': 'string'
}
}
}
Response Structure
(dict) --
TransitGatewayMeteringPolicyEntry (dict) --
Information about the created transit gateway metering policy entry.
PolicyRuleNumber (string) --
The rule number of the metering policy entry.
MeteredAccount (string) --
The Amazon Web Services account ID to which the metered traffic is attributed.
State (string) --
The state of the metering policy entry.
UpdatedAt (datetime) --
The date and time when the metering policy entry was last updated.
UpdateEffectiveAt (datetime) --
The date and time when the metering policy entry update becomes effective.
MeteringPolicyRule (dict) --
The metering policy rule that defines traffic matching criteria.
SourceTransitGatewayAttachmentId (string) --
The ID of the source transit gateway attachment.
SourceTransitGatewayAttachmentType (string) --
The type of the source transit gateway attachment. Note that the tgw-peering resource type has been deprecated. To configure metering policies for Connect, use the transport attachment type.
SourceCidrBlock (string) --
The source CIDR block for the rule.
SourcePortRange (string) --
The source port range for the rule.
DestinationTransitGatewayAttachmentId (string) --
The ID of the destination transit gateway attachment.
DestinationTransitGatewayAttachmentType (string) --
The type of the destination transit gateway attachment. Note that the tgw-peering resource type has been deprecated. To configure metering policies for Connect, use the transport attachment type.
DestinationCidrBlock (string) --
The destination CIDR block for the rule.
DestinationPortRange (string) --
The destination port range for the rule.
Protocol (string) --
The protocol for the rule (1, 6, 17, etc.).
{'TransitGatewayPrefixListReference': {'TransitGatewayAttachment': {'ResourceType': {'client-vpn'}}}}
Creates a reference (route) to a prefix list in a specified transit gateway route table.
See also: AWS API Documentation
Request Syntax
client.create_transit_gateway_prefix_list_reference(
TransitGatewayRouteTableId='string',
PrefixListId='string',
TransitGatewayAttachmentId='string',
Blackhole=True|False,
DryRun=True|False
)
string
[REQUIRED]
The ID of the transit gateway route table.
string
[REQUIRED]
The ID of the prefix list that is used for destination matches.
string
The ID of the attachment to which traffic is routed.
boolean
Indicates whether to drop traffic that matches this route.
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
{
'TransitGatewayPrefixListReference': {
'TransitGatewayRouteTableId': 'string',
'PrefixListId': 'string',
'PrefixListOwnerId': 'string',
'State': 'pending'|'available'|'modifying'|'deleting',
'Blackhole': True|False,
'TransitGatewayAttachment': {
'TransitGatewayAttachmentId': 'string',
'ResourceType': 'vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function'|'client-vpn',
'ResourceId': 'string'
}
}
}
Response Structure
(dict) --
TransitGatewayPrefixListReference (dict) --
Information about the prefix list reference.
TransitGatewayRouteTableId (string) --
The ID of the transit gateway route table.
PrefixListId (string) --
The ID of the prefix list.
PrefixListOwnerId (string) --
The ID of the prefix list owner.
State (string) --
The state of the prefix list reference.
Blackhole (boolean) --
Indicates whether traffic that matches this route is dropped.
TransitGatewayAttachment (dict) --
Information about the transit gateway attachment.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
ResourceType (string) --
The resource type. Note that the tgw-peering resource type has been deprecated.
ResourceId (string) --
The ID of the resource.
{'Route': {'TransitGatewayAttachments': {'ResourceType': {'client-vpn'}}}}
Creates a static route for the specified transit gateway route table.
See also: AWS API Documentation
Request Syntax
client.create_transit_gateway_route(
DestinationCidrBlock='string',
TransitGatewayRouteTableId='string',
TransitGatewayAttachmentId='string',
Blackhole=True|False,
DryRun=True|False
)
string
[REQUIRED]
The CIDR range used for destination matches. Routing decisions are based on the most specific match.
string
[REQUIRED]
The ID of the transit gateway route table.
string
The ID of the attachment.
boolean
Indicates whether to drop traffic that matches this route.
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
{
'Route': {
'DestinationCidrBlock': 'string',
'PrefixListId': 'string',
'TransitGatewayRouteTableAnnouncementId': 'string',
'TransitGatewayAttachments': [
{
'ResourceId': 'string',
'TransitGatewayAttachmentId': 'string',
'ResourceType': 'vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function'|'client-vpn'
},
],
'Type': 'static'|'propagated',
'State': 'pending'|'active'|'blackhole'|'deleting'|'deleted'
}
}
Response Structure
(dict) --
Route (dict) --
Information about the route.
DestinationCidrBlock (string) --
The CIDR block used for destination matches.
PrefixListId (string) --
The ID of the prefix list used for destination matches.
TransitGatewayRouteTableAnnouncementId (string) --
The ID of the transit gateway route table announcement.
TransitGatewayAttachments (list) --
The attachments.
(dict) --
Describes a route attachment.
ResourceId (string) --
The ID of the resource.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
ResourceType (string) --
The resource type. Note that the tgw-peering resource type has been deprecated.
Type (string) --
The route type.
State (string) --
The state of the route.
{'Status': {'Code': {'pending'}}}
Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint.
See also: AWS API Documentation
Request Syntax
client.delete_client_vpn_endpoint(
ClientVpnEndpointId='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the Client VPN to be deleted.
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
{
'Status': {
'Code': 'pending-associate'|'available'|'deleting'|'deleted'|'pending',
'Message': 'string'
}
}
Response Structure
(dict) --
Status (dict) --
The current state of the Client VPN endpoint.
Code (string) --
The state of the Client VPN endpoint. Possible states include:
pending-associate - The Client VPN endpoint has been created but no target networks have been associated. The Client VPN endpoint cannot accept connections.
available - The Client VPN endpoint has been created and a target network has been associated. The Client VPN endpoint can accept connections.
deleting - The Client VPN endpoint is being deleted. The Client VPN endpoint cannot accept connections.
deleted - The Client VPN endpoint has been deleted. The Client VPN endpoint cannot accept connections.
pending - The Client VPN endpoint has been created with a Transit Gateway configuration and is waiting for the Transit Gateway attachment to be accepted. The Client VPN endpoint cannot accept connections.
Message (string) --
A message about the status of the Client VPN endpoint.
{'TransitGatewayMeteringPolicyEntry': {'MeteringPolicyRule': {'DestinationTransitGatewayAttachmentType': {'client-vpn'},
'SourceTransitGatewayAttachmentType': {'client-vpn'}}}}
Deletes an entry from a transit gateway metering policy.
See also: AWS API Documentation
Request Syntax
client.delete_transit_gateway_metering_policy_entry(
TransitGatewayMeteringPolicyId='string',
PolicyRuleNumber=123,
DryRun=True|False
)
string
[REQUIRED]
The ID of the transit gateway metering policy containing the entry to delete.
integer
[REQUIRED]
The rule number of the metering policy entry to delete.
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
{
'TransitGatewayMeteringPolicyEntry': {
'PolicyRuleNumber': 'string',
'MeteredAccount': 'source-attachment-owner'|'destination-attachment-owner'|'transit-gateway-owner',
'State': 'available'|'deleted',
'UpdatedAt': datetime(2015, 1, 1),
'UpdateEffectiveAt': datetime(2015, 1, 1),
'MeteringPolicyRule': {
'SourceTransitGatewayAttachmentId': 'string',
'SourceTransitGatewayAttachmentType': 'vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function'|'client-vpn',
'SourceCidrBlock': 'string',
'SourcePortRange': 'string',
'DestinationTransitGatewayAttachmentId': 'string',
'DestinationTransitGatewayAttachmentType': 'vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function'|'client-vpn',
'DestinationCidrBlock': 'string',
'DestinationPortRange': 'string',
'Protocol': 'string'
}
}
}
Response Structure
(dict) --
TransitGatewayMeteringPolicyEntry (dict) --
Information about the deleted transit gateway metering policy entry.
PolicyRuleNumber (string) --
The rule number of the metering policy entry.
MeteredAccount (string) --
The Amazon Web Services account ID to which the metered traffic is attributed.
State (string) --
The state of the metering policy entry.
UpdatedAt (datetime) --
The date and time when the metering policy entry was last updated.
UpdateEffectiveAt (datetime) --
The date and time when the metering policy entry update becomes effective.
MeteringPolicyRule (dict) --
The metering policy rule that defines traffic matching criteria.
SourceTransitGatewayAttachmentId (string) --
The ID of the source transit gateway attachment.
SourceTransitGatewayAttachmentType (string) --
The type of the source transit gateway attachment. Note that the tgw-peering resource type has been deprecated. To configure metering policies for Connect, use the transport attachment type.
SourceCidrBlock (string) --
The source CIDR block for the rule.
SourcePortRange (string) --
The source port range for the rule.
DestinationTransitGatewayAttachmentId (string) --
The ID of the destination transit gateway attachment.
DestinationTransitGatewayAttachmentType (string) --
The type of the destination transit gateway attachment. Note that the tgw-peering resource type has been deprecated. To configure metering policies for Connect, use the transport attachment type.
DestinationCidrBlock (string) --
The destination CIDR block for the rule.
DestinationPortRange (string) --
The destination port range for the rule.
Protocol (string) --
The protocol for the rule (1, 6, 17, etc.).
{'TransitGatewayPrefixListReference': {'TransitGatewayAttachment': {'ResourceType': {'client-vpn'}}}}
Deletes a reference (route) to a prefix list in a specified transit gateway route table.
See also: AWS API Documentation
Request Syntax
client.delete_transit_gateway_prefix_list_reference(
TransitGatewayRouteTableId='string',
PrefixListId='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the route table.
string
[REQUIRED]
The ID of the prefix list.
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
{
'TransitGatewayPrefixListReference': {
'TransitGatewayRouteTableId': 'string',
'PrefixListId': 'string',
'PrefixListOwnerId': 'string',
'State': 'pending'|'available'|'modifying'|'deleting',
'Blackhole': True|False,
'TransitGatewayAttachment': {
'TransitGatewayAttachmentId': 'string',
'ResourceType': 'vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function'|'client-vpn',
'ResourceId': 'string'
}
}
}
Response Structure
(dict) --
TransitGatewayPrefixListReference (dict) --
Information about the deleted prefix list reference.
TransitGatewayRouteTableId (string) --
The ID of the transit gateway route table.
PrefixListId (string) --
The ID of the prefix list.
PrefixListOwnerId (string) --
The ID of the prefix list owner.
State (string) --
The state of the prefix list reference.
Blackhole (boolean) --
Indicates whether traffic that matches this route is dropped.
TransitGatewayAttachment (dict) --
Information about the transit gateway attachment.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
ResourceType (string) --
The resource type. Note that the tgw-peering resource type has been deprecated.
ResourceId (string) --
The ID of the resource.
{'Route': {'TransitGatewayAttachments': {'ResourceType': {'client-vpn'}}}}
Deletes the specified route from the specified transit gateway route table.
See also: AWS API Documentation
Request Syntax
client.delete_transit_gateway_route(
TransitGatewayRouteTableId='string',
DestinationCidrBlock='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the transit gateway route table.
string
[REQUIRED]
The CIDR range for the route. This must match the CIDR for the route exactly.
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
{
'Route': {
'DestinationCidrBlock': 'string',
'PrefixListId': 'string',
'TransitGatewayRouteTableAnnouncementId': 'string',
'TransitGatewayAttachments': [
{
'ResourceId': 'string',
'TransitGatewayAttachmentId': 'string',
'ResourceType': 'vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function'|'client-vpn'
},
],
'Type': 'static'|'propagated',
'State': 'pending'|'active'|'blackhole'|'deleting'|'deleted'
}
}
Response Structure
(dict) --
Route (dict) --
Information about the route.
DestinationCidrBlock (string) --
The CIDR block used for destination matches.
PrefixListId (string) --
The ID of the prefix list used for destination matches.
TransitGatewayRouteTableAnnouncementId (string) --
The ID of the transit gateway route table announcement.
TransitGatewayAttachments (list) --
The attachments.
(dict) --
Describes a route attachment.
ResourceId (string) --
The ID of the resource.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
ResourceType (string) --
The resource type. Note that the tgw-peering resource type has been deprecated.
Type (string) --
The route type.
State (string) --
The state of the route.
{'ClientVpnEndpoints': {'Status': {'Code': {'pending'}},
'TransitGatewayConfiguration': {'AvailabilityZoneIds': ['string'],
'AvailabilityZones': ['string'],
'TransitGatewayAttachmentId': 'string',
'TransitGatewayId': 'string'}}}
Describes one or more Client VPN endpoints in the account.
See also: AWS API Documentation
Request Syntax
client.describe_client_vpn_endpoints(
ClientVpnEndpointIds=[
'string',
],
MaxResults=123,
NextToken='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False
)
list
The ID of the Client VPN endpoint.
(string) --
integer
The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
string
The token to retrieve the next page of results.
list
One or more filters. Filter names and values are case-sensitive.
endpoint-id - The ID of the Client VPN endpoint.
transport-protocol - The transport protocol ( tcp | udp).
(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) --
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
{
'ClientVpnEndpoints': [
{
'ClientVpnEndpointId': 'string',
'Description': 'string',
'Status': {
'Code': 'pending-associate'|'available'|'deleting'|'deleted'|'pending',
'Message': 'string'
},
'CreationTime': 'string',
'DeletionTime': 'string',
'DnsName': 'string',
'ClientCidrBlock': 'string',
'DnsServers': [
'string',
],
'SplitTunnel': True|False,
'VpnProtocol': 'openvpn',
'TransportProtocol': 'tcp'|'udp',
'VpnPort': 123,
'AssociatedTargetNetworks': [
{
'NetworkId': 'string',
'NetworkType': 'vpc'
},
],
'ServerCertificateArn': 'string',
'AuthenticationOptions': [
{
'Type': 'certificate-authentication'|'directory-service-authentication'|'federated-authentication',
'ActiveDirectory': {
'DirectoryId': 'string'
},
'MutualAuthentication': {
'ClientRootCertificateChain': 'string'
},
'FederatedAuthentication': {
'SamlProviderArn': 'string',
'SelfServiceSamlProviderArn': 'string'
}
},
],
'ConnectionLogOptions': {
'Enabled': True|False,
'CloudwatchLogGroup': 'string',
'CloudwatchLogStream': 'string'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'SecurityGroupIds': [
'string',
],
'VpcId': 'string',
'SelfServicePortalUrl': 'string',
'ClientConnectOptions': {
'Enabled': True|False,
'LambdaFunctionArn': 'string',
'Status': {
'Code': 'applying'|'applied',
'Message': 'string'
}
},
'SessionTimeoutHours': 123,
'ClientLoginBannerOptions': {
'Enabled': True|False,
'BannerText': 'string'
},
'ClientRouteEnforcementOptions': {
'Enforced': True|False
},
'DisconnectOnSessionTimeout': True|False,
'EndpointIpAddressType': 'ipv4'|'ipv6'|'dual-stack',
'TrafficIpAddressType': 'ipv4'|'ipv6'|'dual-stack',
'TransitGatewayConfiguration': {
'TransitGatewayId': 'string',
'TransitGatewayAttachmentId': 'string',
'AvailabilityZones': [
'string',
],
'AvailabilityZoneIds': [
'string',
]
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ClientVpnEndpoints (list) --
Information about the Client VPN endpoints.
(dict) --
Describes a Client VPN endpoint.
ClientVpnEndpointId (string) --
The ID of the Client VPN endpoint.
Description (string) --
A brief description of the endpoint.
Status (dict) --
The current state of the Client VPN endpoint.
Code (string) --
The state of the Client VPN endpoint. Possible states include:
pending-associate - The Client VPN endpoint has been created but no target networks have been associated. The Client VPN endpoint cannot accept connections.
available - The Client VPN endpoint has been created and a target network has been associated. The Client VPN endpoint can accept connections.
deleting - The Client VPN endpoint is being deleted. The Client VPN endpoint cannot accept connections.
deleted - The Client VPN endpoint has been deleted. The Client VPN endpoint cannot accept connections.
pending - The Client VPN endpoint has been created with a Transit Gateway configuration and is waiting for the Transit Gateway attachment to be accepted. The Client VPN endpoint cannot accept connections.
Message (string) --
A message about the status of the Client VPN endpoint.
CreationTime (string) --
The date and time the Client VPN endpoint was created.
DeletionTime (string) --
The date and time the Client VPN endpoint was deleted, if applicable.
DnsName (string) --
The DNS name to be used by clients when connecting to the Client VPN endpoint.
ClientCidrBlock (string) --
The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
DnsServers (list) --
Information about the DNS servers to be used for DNS resolution.
(string) --
SplitTunnel (boolean) --
Indicates whether split-tunnel is enabled in the Client VPN endpoint.
For information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint in the Client VPN Administrator Guide.
VpnProtocol (string) --
The protocol used by the VPN session.
TransportProtocol (string) --
The transport protocol used by the Client VPN endpoint.
VpnPort (integer) --
The port number for the Client VPN endpoint.
AssociatedTargetNetworks (list) --
Information about the associated target networks. A target network is a subnet in a VPC.
(dict) --
Describes a target network that is associated with a Client VPN endpoint. A target network is a subnet in a VPC.
NetworkId (string) --
The ID of the subnet.
NetworkType (string) --
The target network type.
ServerCertificateArn (string) --
The ARN of the server certificate.
AuthenticationOptions (list) --
Information about the authentication method used by the Client VPN endpoint.
(dict) --
Describes the authentication methods used by a Client VPN endpoint. For more information, see Authentication in the Client VPN Administrator Guide.
Type (string) --
The authentication type used.
ActiveDirectory (dict) --
Information about the Active Directory, if applicable.
DirectoryId (string) --
The ID of the Active Directory used for authentication.
MutualAuthentication (dict) --
Information about the authentication certificates, if applicable.
ClientRootCertificateChain (string) --
The ARN of the client certificate.
FederatedAuthentication (dict) --
Information about the IAM SAML identity provider, if applicable.
SamlProviderArn (string) --
The Amazon Resource Name (ARN) of the IAM SAML identity provider.
SelfServiceSamlProviderArn (string) --
The Amazon Resource Name (ARN) of the IAM SAML identity provider for the self-service portal.
ConnectionLogOptions (dict) --
Information about the client connection logging options for the Client VPN endpoint.
Enabled (boolean) --
Indicates whether client connection logging is enabled for the Client VPN endpoint.
CloudwatchLogGroup (string) --
The name of the Amazon CloudWatch Logs log group to which connection logging data is published.
CloudwatchLogStream (string) --
The name of the Amazon CloudWatch Logs log stream to which connection logging data is published.
Tags (list) --
Any tags assigned to the Client VPN endpoint.
(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.
SecurityGroupIds (list) --
The IDs of the security groups for the target network.
(string) --
VpcId (string) --
The ID of the VPC.
SelfServicePortalUrl (string) --
The URL of the self-service portal.
ClientConnectOptions (dict) --
The options for managing connection authorization for new client connections.
Enabled (boolean) --
Indicates whether client connect options are enabled.
LambdaFunctionArn (string) --
The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.
Status (dict) --
The status of any updates to the client connect options.
Code (string) --
The status code.
Message (string) --
The status message.
SessionTimeoutHours (integer) --
The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
ClientLoginBannerOptions (dict) --
Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
Enabled (boolean) --
Current state of text banner feature.
Valid values: true | false
BannerText (string) --
Customizable text that will be displayed in a banner on Amazon Web Services provided clients when a VPN session is established. UTF-8 encoded characters only. Maximum of 1400 characters.
ClientRouteEnforcementOptions (dict) --
Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN. T his feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel.
Client route enforcement works by monitoring the route table of a connected device for routing policy changes to the VPN connection. If the feature detects any VPN routing policy modifications, it will automatically force an update to the route table, reverting it back to the expected route configurations.
Enforced (boolean) --
Status of the client route enforcement feature, indicating whether Client Route Enforcement is true (enabled) or false (disabled).
Valid values: true | false
Default value: false
DisconnectOnSessionTimeout (boolean) --
Indicates whether the client VPN session is disconnected after the maximum sessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. The default value is true.
EndpointIpAddressType (string) --
The IP address type of the Client VPN endpoint. Possible values are ipv4 for IPv4 addressing only, ipv6 for IPv6 addressing only, or ``dual-stack ``for both IPv4 and IPv6 addressing.
TrafficIpAddressType (string) --
The IP address type of the Client VPN endpoint. Possible values are either ipv4 for IPv4 addressing only, ipv6 for IPv6 addressing only, or dual-stack for both IPv4 and IPv6 addressing.
TransitGatewayConfiguration (dict) --
The Transit Gateway configuration for the Client VPN endpoint.
TransitGatewayId (string) --
The ID of the Transit Gateway.
TransitGatewayAttachmentId (string) --
The ID of the Transit Gateway attachment.
AvailabilityZones (list) --
The Availability Zone names for the Transit Gateway association.
(string) --
AvailabilityZoneIds (list) --
The Availability Zone IDs for the Transit Gateway association.
(string) --
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.
{'Routes': {'TransitGatewayAttachmentId': 'string'}}
Describes the routes for the specified Client VPN endpoint.
See also: AWS API Documentation
Request Syntax
client.describe_client_vpn_routes(
ClientVpnEndpointId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the Client VPN endpoint.
list
One or more filters. Filter names and values are case-sensitive.
destination-cidr - The CIDR of the route destination.
origin - How the route was associated with the Client VPN endpoint ( associate | add-route).
target-subnet - The ID of the subnet through which traffic is routed.
(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 for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
string
The token to retrieve 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
{
'Routes': [
{
'ClientVpnEndpointId': 'string',
'DestinationCidr': 'string',
'TargetSubnet': 'string',
'Type': 'string',
'Origin': 'string',
'Status': {
'Code': 'creating'|'active'|'failed'|'deleting',
'Message': 'string'
},
'Description': 'string',
'TransitGatewayAttachmentId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Routes (list) --
Information about the Client VPN endpoint routes.
(dict) --
Information about a Client VPN endpoint route.
ClientVpnEndpointId (string) --
The ID of the Client VPN endpoint with which the route is associated.
DestinationCidr (string) --
The IPv4 address range, in CIDR notation, of the route destination.
TargetSubnet (string) --
The ID of the subnet through which traffic is routed.
Type (string) --
The route type.
Origin (string) --
Indicates how the route was associated with the Client VPN endpoint. associate indicates that the route was automatically added when the target network was associated with the Client VPN endpoint. add-route indicates that the route was manually added using the CreateClientVpnRoute action.
Status (dict) --
The current state of the route.
Code (string) --
The state of the Client VPN endpoint route.
Message (string) --
A message about the status of the Client VPN endpoint route, if applicable.
Description (string) --
A brief description of the route.
TransitGatewayAttachmentId (string) --
The ID of the Transit Gateway attachment, if the route targets a Transit Gateway.
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.
{'ClientVpnTargetNetworks': {'AvailabilityZoneIds': ['string'],
'AvailabilityZones': ['string']}}
Describes the target networks associated with the specified Client VPN endpoint.
See also: AWS API Documentation
Request Syntax
client.describe_client_vpn_target_networks(
ClientVpnEndpointId='string',
AssociationIds=[
'string',
],
MaxResults=123,
NextToken='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False
)
string
[REQUIRED]
The ID of the Client VPN endpoint.
list
The IDs of the target network associations.
(string) --
integer
The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
string
The token to retrieve the next page of results.
list
One or more filters. Filter names and values are case-sensitive.
association-id - The ID of the association.
target-network-id - The ID of the subnet specified as the target network.
vpc-id - The ID of the VPC in which the target network is located.
(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) --
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
{
'ClientVpnTargetNetworks': [
{
'AssociationId': 'string',
'VpcId': 'string',
'TargetNetworkId': 'string',
'ClientVpnEndpointId': 'string',
'Status': {
'Code': 'associating'|'associated'|'association-failed'|'disassociating'|'disassociated',
'Message': 'string'
},
'SecurityGroups': [
'string',
],
'AvailabilityZones': [
'string',
],
'AvailabilityZoneIds': [
'string',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ClientVpnTargetNetworks (list) --
Information about the associated target networks.
(dict) --
Describes a target network associated with a Client VPN endpoint.
AssociationId (string) --
The ID of the association.
VpcId (string) --
The ID of the VPC in which the target network (subnet) is located.
TargetNetworkId (string) --
The ID of the subnet specified as the target network.
ClientVpnEndpointId (string) --
The ID of the Client VPN endpoint with which the target network is associated.
Status (dict) --
The current state of the target network association.
Code (string) --
The state of the target network association.
Message (string) --
A message about the status of the target network association, if applicable.
SecurityGroups (list) --
The IDs of the security groups applied to the target network association.
(string) --
AvailabilityZones (list) --
The Availability Zone names for the target network association, if the Client VPN endpoint uses a Transit Gateway.
(string) --
AvailabilityZoneIds (list) --
The Availability Zone IDs for the target network association, if the Client VPN endpoint uses a Transit Gateway.
(string) --
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.
{'TransitGatewayAttachments': {'ResourceType': {'client-vpn'}}}
Describes one or more attachments between resources and transit gateways. By default, all attachments are described. Alternatively, you can filter the results by attachment ID, attachment state, resource ID, or resource owner.
See also: AWS API Documentation
Request Syntax
client.describe_transit_gateway_attachments(
TransitGatewayAttachmentIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
list
The IDs of the attachments.
(string) --
list
One or more filters. The possible values are:
association.state - The state of the association ( associating | associated | disassociating).
association.transit-gateway-route-table-id - The ID of the route table for the transit gateway.
resource-id - The ID of the resource.
resource-owner-id - The ID of the Amazon Web Services account that owns the resource.
resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting.
transit-gateway-attachment-id - The ID of the attachment.
transit-gateway-id - The ID of the transit gateway.
transit-gateway-owner-id - The ID of the Amazon Web Services account that owns 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
{
'TransitGatewayAttachments': [
{
'TransitGatewayAttachmentId': 'string',
'TransitGatewayId': 'string',
'TransitGatewayOwnerId': 'string',
'ResourceOwnerId': 'string',
'ResourceType': 'vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function'|'client-vpn',
'ResourceId': 'string',
'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
'Association': {
'TransitGatewayRouteTableId': 'string',
'State': 'associating'|'associated'|'disassociating'|'disassociated'
},
'CreationTime': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TransitGatewayAttachments (list) --
Information about the attachments.
(dict) --
Describes an attachment between a resource and a transit gateway.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
TransitGatewayId (string) --
The ID of the transit gateway.
TransitGatewayOwnerId (string) --
The ID of the Amazon Web Services account that owns the transit gateway.
ResourceOwnerId (string) --
The ID of the Amazon Web Services account that owns the resource.
ResourceType (string) --
The resource type. Note that the tgw-peering resource type has been deprecated.
ResourceId (string) --
The ID of the resource.
State (string) --
The attachment state. Note that the initiating state has been deprecated.
Association (dict) --
The association.
TransitGatewayRouteTableId (string) --
The ID of the route table for the transit gateway.
State (string) --
The state of the association.
CreationTime (datetime) --
The creation time.
Tags (list) --
The tags for the 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.
{'Propagation': {'ResourceType': {'client-vpn'}}}
Disables the specified resource attachment from propagating routes to the specified propagation route table.
See also: AWS API Documentation
Request Syntax
client.disable_transit_gateway_route_table_propagation(
TransitGatewayRouteTableId='string',
TransitGatewayAttachmentId='string',
DryRun=True|False,
TransitGatewayRouteTableAnnouncementId='string'
)
string
[REQUIRED]
The ID of the propagation route table.
string
The ID of the 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.
string
The ID of the route table announcement.
dict
Response Syntax
{
'Propagation': {
'TransitGatewayAttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function'|'client-vpn',
'TransitGatewayRouteTableId': 'string',
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'TransitGatewayRouteTableAnnouncementId': 'string'
}
}
Response Structure
(dict) --
Propagation (dict) --
Information about route propagation.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The resource type. Note that the tgw-peering resource type has been deprecated.
TransitGatewayRouteTableId (string) --
The ID of the transit gateway route table.
State (string) --
The state.
TransitGatewayRouteTableAnnouncementId (string) --
The ID of the transit gateway route table announcement.
{'Associations': {'ResourceType': {'client-vpn'}}}
Disassociates the specified subnets from the transit gateway multicast domain.
See also: AWS API Documentation
Request Syntax
client.disassociate_transit_gateway_multicast_domain(
TransitGatewayMulticastDomainId='string',
TransitGatewayAttachmentId='string',
SubnetIds=[
'string',
],
DryRun=True|False
)
string
[REQUIRED]
The ID of the transit gateway multicast domain.
string
[REQUIRED]
The ID of the attachment.
list
[REQUIRED]
The IDs of the subnets;
(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
{
'Associations': {
'TransitGatewayMulticastDomainId': 'string',
'TransitGatewayAttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function'|'client-vpn',
'ResourceOwnerId': 'string',
'Subnets': [
{
'SubnetId': 'string',
'State': 'pendingAcceptance'|'associating'|'associated'|'disassociating'|'disassociated'|'rejected'|'failed'
},
]
}
}
Response Structure
(dict) --
Associations (dict) --
Information about the association.
TransitGatewayMulticastDomainId (string) --
The ID of the transit gateway multicast domain.
TransitGatewayAttachmentId (string) --
The ID of the transit gateway attachment.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The type of resource, for example a VPC attachment.
ResourceOwnerId (string) --
The ID of the Amazon Web Services account that owns the resource.
Subnets (list) --
The subnets associated with the multicast domain.
(dict) --
Describes the subnet association with the transit gateway multicast domain.
SubnetId (string) --
The ID of the subnet.
State (string) --
The state of the subnet association.
{'Association': {'ResourceType': {'client-vpn'}}}
Removes the association between an an attachment and a policy table.
See also: AWS API Documentation
Request Syntax
client.disassociate_transit_gateway_policy_table(
TransitGatewayPolicyTableId='string',
TransitGatewayAttachmentId='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the disassociated policy table.
string
[REQUIRED]
The ID of the transit gateway attachment to disassociate from the policy table.
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
{
'Association': {
'TransitGatewayPolicyTableId': 'string',
'TransitGatewayAttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function'|'client-vpn',
'State': 'associating'|'associated'|'disassociating'|'disassociated'
}
}
Response Structure
(dict) --
Association (dict) --
Returns details about the transit gateway policy table disassociation.
TransitGatewayPolicyTableId (string) --
The ID of the transit gateway policy table.
TransitGatewayAttachmentId (string) --
The ID of the transit gateway attachment.
ResourceId (string) --
The resource ID of the transit gateway attachment.
ResourceType (string) --
The resource type for the transit gateway policy table association.
State (string) --
The state of the transit gateway policy table association.
{'Association': {'ResourceType': {'client-vpn'}}}
Disassociates a resource attachment from a transit gateway route table.
See also: AWS API Documentation
Request Syntax
client.disassociate_transit_gateway_route_table(
TransitGatewayRouteTableId='string',
TransitGatewayAttachmentId='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the transit gateway route table.
string
[REQUIRED]
The ID of the 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
{
'Association': {
'TransitGatewayRouteTableId': 'string',
'TransitGatewayAttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function'|'client-vpn',
'State': 'associating'|'associated'|'disassociating'|'disassociated'
}
}
Response Structure
(dict) --
Association (dict) --
Information about the association.
TransitGatewayRouteTableId (string) --
The ID of the transit gateway route table.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The resource type. Note that the tgw-peering resource type has been deprecated.
State (string) --
The state of the association.
{'Propagation': {'ResourceType': {'client-vpn'}}}
Enables the specified attachment to propagate routes to the specified propagation route table.
See also: AWS API Documentation
Request Syntax
client.enable_transit_gateway_route_table_propagation(
TransitGatewayRouteTableId='string',
TransitGatewayAttachmentId='string',
DryRun=True|False,
TransitGatewayRouteTableAnnouncementId='string'
)
string
[REQUIRED]
The ID of the propagation route table.
string
The ID of the 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.
string
The ID of the transit gateway route table announcement.
dict
Response Syntax
{
'Propagation': {
'TransitGatewayAttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function'|'client-vpn',
'TransitGatewayRouteTableId': 'string',
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'TransitGatewayRouteTableAnnouncementId': 'string'
}
}
Response Structure
(dict) --
Propagation (dict) --
Information about route propagation.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The resource type. Note that the tgw-peering resource type has been deprecated.
TransitGatewayRouteTableId (string) --
The ID of the transit gateway route table.
State (string) --
The state.
TransitGatewayRouteTableAnnouncementId (string) --
The ID of the transit gateway route table announcement.
{'TransitGatewayMeteringPolicyEntries': {'MeteringPolicyRule': {'DestinationTransitGatewayAttachmentType': {'client-vpn'},
'SourceTransitGatewayAttachmentType': {'client-vpn'}}}}
Retrieves the entries for a transit gateway metering policy.
See also: AWS API Documentation
Request Syntax
client.get_transit_gateway_metering_policy_entries(
TransitGatewayMeteringPolicyId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the transit gateway metering policy to retrieve entries for.
list
One or more filters to apply when retrieving metering policy entries.
(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
{
'TransitGatewayMeteringPolicyEntries': [
{
'PolicyRuleNumber': 'string',
'MeteredAccount': 'source-attachment-owner'|'destination-attachment-owner'|'transit-gateway-owner',
'State': 'available'|'deleted',
'UpdatedAt': datetime(2015, 1, 1),
'UpdateEffectiveAt': datetime(2015, 1, 1),
'MeteringPolicyRule': {
'SourceTransitGatewayAttachmentId': 'string',
'SourceTransitGatewayAttachmentType': 'vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function'|'client-vpn',
'SourceCidrBlock': 'string',
'SourcePortRange': 'string',
'DestinationTransitGatewayAttachmentId': 'string',
'DestinationTransitGatewayAttachmentType': 'vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function'|'client-vpn',
'DestinationCidrBlock': 'string',
'DestinationPortRange': 'string',
'Protocol': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TransitGatewayMeteringPolicyEntries (list) --
Information about the transit gateway metering policy entries.
(dict) --
Describes an entry in a transit gateway metering policy.
PolicyRuleNumber (string) --
The rule number of the metering policy entry.
MeteredAccount (string) --
The Amazon Web Services account ID to which the metered traffic is attributed.
State (string) --
The state of the metering policy entry.
UpdatedAt (datetime) --
The date and time when the metering policy entry was last updated.
UpdateEffectiveAt (datetime) --
The date and time when the metering policy entry update becomes effective.
MeteringPolicyRule (dict) --
The metering policy rule that defines traffic matching criteria.
SourceTransitGatewayAttachmentId (string) --
The ID of the source transit gateway attachment.
SourceTransitGatewayAttachmentType (string) --
The type of the source transit gateway attachment. Note that the tgw-peering resource type has been deprecated. To configure metering policies for Connect, use the transport attachment type.
SourceCidrBlock (string) --
The source CIDR block for the rule.
SourcePortRange (string) --
The source port range for the rule.
DestinationTransitGatewayAttachmentId (string) --
The ID of the destination transit gateway attachment.
DestinationTransitGatewayAttachmentType (string) --
The type of the destination transit gateway attachment. Note that the tgw-peering resource type has been deprecated. To configure metering policies for Connect, use the transport attachment type.
DestinationCidrBlock (string) --
The destination CIDR block for the rule.
DestinationPortRange (string) --
The destination port range for the rule.
Protocol (string) --
The protocol for the rule (1, 6, 17, etc.).
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.
{'MulticastDomainAssociations': {'ResourceType': {'client-vpn'}}}
Gets information about the associations for the transit gateway multicast domain.
See also: AWS API Documentation
Request Syntax
client.get_transit_gateway_multicast_domain_associations(
TransitGatewayMulticastDomainId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the transit gateway multicast domain.
list
One or more filters. The possible values are:
resource-id - The ID of the resource.
resource-type - The type of resource. The valid value is: vpc.
state - The state of the subnet association. Valid values are associated | associating | disassociated | disassociating.
subnet-id - The ID of the subnet.
transit-gateway-attachment-id - The id of the transit gateway attachment.
(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
{
'MulticastDomainAssociations': [
{
'TransitGatewayAttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function'|'client-vpn',
'ResourceOwnerId': 'string',
'Subnet': {
'SubnetId': 'string',
'State': 'pendingAcceptance'|'associating'|'associated'|'disassociating'|'disassociated'|'rejected'|'failed'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
MulticastDomainAssociations (list) --
Information about the multicast domain associations.
(dict) --
Describes the resources associated with the transit gateway multicast domain.
TransitGatewayAttachmentId (string) --
The ID of the transit gateway attachment.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The type of resource, for example a VPC attachment.
ResourceOwnerId (string) --
The ID of the Amazon Web Services account that owns the transit gateway multicast domain association resource.
Subnet (dict) --
The subnet associated with the transit gateway multicast domain.
SubnetId (string) --
The ID of the subnet.
State (string) --
The state of the subnet association.
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.
{'Associations': {'ResourceType': {'client-vpn'}}}
Gets a list of the transit gateway policy table associations.
See also: AWS API Documentation
Request Syntax
client.get_transit_gateway_policy_table_associations(
TransitGatewayPolicyTableId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the transit gateway policy table.
list
The filters associated with the transit gateway policy table.
(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
{
'Associations': [
{
'TransitGatewayPolicyTableId': 'string',
'TransitGatewayAttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function'|'client-vpn',
'State': 'associating'|'associated'|'disassociating'|'disassociated'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Associations (list) --
Returns details about the transit gateway policy table association.
(dict) --
Describes a transit gateway policy table association.
TransitGatewayPolicyTableId (string) --
The ID of the transit gateway policy table.
TransitGatewayAttachmentId (string) --
The ID of the transit gateway attachment.
ResourceId (string) --
The resource ID of the transit gateway attachment.
ResourceType (string) --
The resource type for the transit gateway policy table association.
State (string) --
The state of the transit gateway policy table association.
NextToken (string) --
The token for the next page of results.
{'TransitGatewayPrefixListReferences': {'TransitGatewayAttachment': {'ResourceType': {'client-vpn'}}}}
Gets information about the prefix list references in a specified transit gateway route table.
See also: AWS API Documentation
Request Syntax
client.get_transit_gateway_prefix_list_references(
TransitGatewayRouteTableId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the transit gateway route table.
list
One or more filters. The possible values are:
attachment.resource-id - The ID of the resource for the attachment.
attachment.resource-type - The type of resource for the attachment. Valid values are vpc | vpn | direct-connect-gateway | peering.
attachment.transit-gateway-attachment-id - The ID of the attachment.
is-blackhole - Whether traffic matching the route is blocked ( true | false).
prefix-list-id - The ID of the prefix list.
prefix-list-owner-id - The ID of the owner of the prefix list.
state - The state of the prefix list reference ( pending | available | modifying | deleting).
(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
{
'TransitGatewayPrefixListReferences': [
{
'TransitGatewayRouteTableId': 'string',
'PrefixListId': 'string',
'PrefixListOwnerId': 'string',
'State': 'pending'|'available'|'modifying'|'deleting',
'Blackhole': True|False,
'TransitGatewayAttachment': {
'TransitGatewayAttachmentId': 'string',
'ResourceType': 'vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function'|'client-vpn',
'ResourceId': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TransitGatewayPrefixListReferences (list) --
Information about the prefix list references.
(dict) --
Describes a prefix list reference.
TransitGatewayRouteTableId (string) --
The ID of the transit gateway route table.
PrefixListId (string) --
The ID of the prefix list.
PrefixListOwnerId (string) --
The ID of the prefix list owner.
State (string) --
The state of the prefix list reference.
Blackhole (boolean) --
Indicates whether traffic that matches this route is dropped.
TransitGatewayAttachment (dict) --
Information about the transit gateway attachment.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
ResourceType (string) --
The resource type. Note that the tgw-peering resource type has been deprecated.
ResourceId (string) --
The ID of the resource.
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.
{'Associations': {'ResourceType': {'client-vpn'}}}
Gets information about the associations for the specified transit gateway route table.
See also: AWS API Documentation
Request Syntax
client.get_transit_gateway_route_table_associations(
TransitGatewayRouteTableId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the transit gateway route table.
list
One or more filters. The possible values are:
resource-id - The ID of the resource.
resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
transit-gateway-attachment-id - The ID of the attachment.
(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
{
'Associations': [
{
'TransitGatewayAttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function'|'client-vpn',
'State': 'associating'|'associated'|'disassociating'|'disassociated'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Associations (list) --
Information about the associations.
(dict) --
Describes an association between a route table and a resource attachment.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The resource type. Note that the tgw-peering resource type has been deprecated.
State (string) --
The state of the association.
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.
{'TransitGatewayRouteTablePropagations': {'ResourceType': {'client-vpn'}}}
Gets information about the route table propagations for the specified transit gateway route table.
See also: AWS API Documentation
Request Syntax
client.get_transit_gateway_route_table_propagations(
TransitGatewayRouteTableId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the transit gateway route table.
list
One or more filters. The possible values are:
resource-id - The ID of the resource.
resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
transit-gateway-attachment-id - The ID of the attachment.
(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
{
'TransitGatewayRouteTablePropagations': [
{
'TransitGatewayAttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function'|'client-vpn',
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'TransitGatewayRouteTableAnnouncementId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TransitGatewayRouteTablePropagations (list) --
Information about the route table propagations.
(dict) --
Describes a route table propagation.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The type of resource. Note that the tgw-peering resource type has been deprecated.
State (string) --
The state of the resource.
TransitGatewayRouteTableAnnouncementId (string) --
The ID of the transit gateway route table announcement.
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.
{'TransitGatewayConfiguration': {'AvailabilityZoneIds': ['string'],
'AvailabilityZones': ['string'],
'TransitGatewayId': 'string'}}
Modifies the specified Client VPN endpoint. Modifying the DNS server resets existing client connections.
See also: AWS API Documentation
Request Syntax
client.modify_client_vpn_endpoint(
ClientVpnEndpointId='string',
ServerCertificateArn='string',
ConnectionLogOptions={
'Enabled': True|False,
'CloudwatchLogGroup': 'string',
'CloudwatchLogStream': 'string'
},
DnsServers={
'CustomDnsServers': [
'string',
],
'Enabled': True|False
},
VpnPort=123,
Description='string',
SplitTunnel=True|False,
DryRun=True|False,
SecurityGroupIds=[
'string',
],
VpcId='string',
SelfServicePortal='enabled'|'disabled',
ClientConnectOptions={
'Enabled': True|False,
'LambdaFunctionArn': 'string'
},
SessionTimeoutHours=123,
ClientLoginBannerOptions={
'Enabled': True|False,
'BannerText': 'string'
},
ClientRouteEnforcementOptions={
'Enforced': True|False
},
DisconnectOnSessionTimeout=True|False,
TransitGatewayConfiguration={
'TransitGatewayId': 'string',
'AvailabilityZones': [
'string',
],
'AvailabilityZoneIds': [
'string',
]
}
)
string
[REQUIRED]
The ID of the Client VPN endpoint to modify.
string
The ARN of the server certificate to be used. The server certificate must be provisioned in Certificate Manager (ACM).
dict
Information about the client connection logging options.
If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:
Client connection requests
Client connection results (successful and unsuccessful)
Reasons for unsuccessful client connection requests
Client connection termination time
Enabled (boolean) --
Indicates whether connection logging is enabled.
CloudwatchLogGroup (string) --
The name of the CloudWatch Logs log group. Required if connection logging is enabled.
CloudwatchLogStream (string) --
The name of the CloudWatch Logs log stream to which the connection data is published.
dict
Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have up to two DNS servers.
CustomDnsServers (list) --
The IPv4 address range, in CIDR notation, of the DNS servers to be used. You can specify up to two DNS servers. Ensure that the DNS servers can be reached by the clients. The specified values overwrite the existing values.
(string) --
Enabled (boolean) --
Indicates whether DNS servers should be used. Specify False to delete the existing DNS servers.
integer
The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
Valid Values: 443 | 1194
Default Value: 443
string
A brief description of the Client VPN endpoint.
boolean
Indicates whether the VPN is split-tunnel.
For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the Client VPN Administrator Guide.
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 one or more security groups to apply to the target network.
(string) --
string
The ID of the VPC to associate with the Client VPN endpoint.
string
Specify whether to enable the self-service portal for the Client VPN endpoint.
dict
The options for managing connection authorization for new client connections.
Enabled (boolean) --
Indicates whether client connect options are enabled. The default is false (not enabled).
LambdaFunctionArn (string) --
The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.
integer
The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
dict
Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
Enabled (boolean) --
Enable or disable a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
Valid values: true | false
Default value: false
BannerText (string) --
Customizable text that will be displayed in a banner on Amazon Web Services provided clients when a VPN session is established. UTF-8 encoded characters only. Maximum of 1400 characters.
dict
Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN. T his feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel.
Client route enforcement works by monitoring the route table of a connected device for routing policy changes to the VPN connection. If the feature detects any VPN routing policy modifications, it will automatically force an update to the route table, reverting it back to the expected route configurations.
Enforced (boolean) --
Enable or disable Client Route Enforcement. The state can either be true (enabled) or false (disabled). The default is false.
Valid values: true | false
Default value: false
boolean
Indicates whether the client VPN session is disconnected after the maximum timeout specified in sessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. The default value is true.
dict
The Transit Gateway configuration for the Client VPN endpoint. This option is currently not supported.
TransitGatewayId (string) --
The ID of the Transit Gateway to associate with the Client VPN endpoint.
AvailabilityZones (list) --
The Availability Zone names for the Transit Gateway association. You can specify up to the maximum number of Availability Zones supported by the Transit Gateway. You cannot specify both AvailabilityZones and AvailabilityZoneIds.
(string) --
AvailabilityZoneIds (list) --
The Availability Zone IDs for the Transit Gateway association. You can specify up to the maximum number of Availability Zones supported by the Transit Gateway. You cannot specify both AvailabilityZones and AvailabilityZoneIds.
(string) --
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, it returns an error.
{'TransitGatewayPrefixListReference': {'TransitGatewayAttachment': {'ResourceType': {'client-vpn'}}}}
Modifies a reference (route) to a prefix list in a specified transit gateway route table.
See also: AWS API Documentation
Request Syntax
client.modify_transit_gateway_prefix_list_reference(
TransitGatewayRouteTableId='string',
PrefixListId='string',
TransitGatewayAttachmentId='string',
Blackhole=True|False,
DryRun=True|False
)
string
[REQUIRED]
The ID of the transit gateway route table.
string
[REQUIRED]
The ID of the prefix list.
string
The ID of the attachment to which traffic is routed.
boolean
Indicates whether to drop traffic that matches this route.
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
{
'TransitGatewayPrefixListReference': {
'TransitGatewayRouteTableId': 'string',
'PrefixListId': 'string',
'PrefixListOwnerId': 'string',
'State': 'pending'|'available'|'modifying'|'deleting',
'Blackhole': True|False,
'TransitGatewayAttachment': {
'TransitGatewayAttachmentId': 'string',
'ResourceType': 'vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function'|'client-vpn',
'ResourceId': 'string'
}
}
}
Response Structure
(dict) --
TransitGatewayPrefixListReference (dict) --
Information about the prefix list reference.
TransitGatewayRouteTableId (string) --
The ID of the transit gateway route table.
PrefixListId (string) --
The ID of the prefix list.
PrefixListOwnerId (string) --
The ID of the prefix list owner.
State (string) --
The state of the prefix list reference.
Blackhole (boolean) --
Indicates whether traffic that matches this route is dropped.
TransitGatewayAttachment (dict) --
Information about the transit gateway attachment.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
ResourceType (string) --
The resource type. Note that the tgw-peering resource type has been deprecated.
ResourceId (string) --
The ID of the resource.
{'Associations': {'ResourceType': {'client-vpn'}}}
Rejects a request to associate cross-account subnets with a transit gateway multicast domain.
See also: AWS API Documentation
Request Syntax
client.reject_transit_gateway_multicast_domain_associations(
TransitGatewayMulticastDomainId='string',
TransitGatewayAttachmentId='string',
SubnetIds=[
'string',
],
DryRun=True|False
)
string
The ID of the transit gateway multicast domain.
string
The ID of the transit gateway attachment.
list
The IDs of the subnets to associate with the transit gateway multicast domain.
(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
{
'Associations': {
'TransitGatewayMulticastDomainId': 'string',
'TransitGatewayAttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function'|'client-vpn',
'ResourceOwnerId': 'string',
'Subnets': [
{
'SubnetId': 'string',
'State': 'pendingAcceptance'|'associating'|'associated'|'disassociating'|'disassociated'|'rejected'|'failed'
},
]
}
}
Response Structure
(dict) --
Associations (dict) --
Information about the multicast domain associations.
TransitGatewayMulticastDomainId (string) --
The ID of the transit gateway multicast domain.
TransitGatewayAttachmentId (string) --
The ID of the transit gateway attachment.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The type of resource, for example a VPC attachment.
ResourceOwnerId (string) --
The ID of the Amazon Web Services account that owns the resource.
Subnets (list) --
The subnets associated with the multicast domain.
(dict) --
Describes the subnet association with the transit gateway multicast domain.
SubnetId (string) --
The ID of the subnet.
State (string) --
The state of the subnet association.
{'Route': {'TransitGatewayAttachments': {'ResourceType': {'client-vpn'}}}}
Replaces the specified route in the specified transit gateway route table.
See also: AWS API Documentation
Request Syntax
client.replace_transit_gateway_route(
DestinationCidrBlock='string',
TransitGatewayRouteTableId='string',
TransitGatewayAttachmentId='string',
Blackhole=True|False,
DryRun=True|False
)
string
[REQUIRED]
The CIDR range used for the destination match. Routing decisions are based on the most specific match.
string
[REQUIRED]
The ID of the route table.
string
The ID of the attachment.
boolean
Indicates whether traffic matching this route is to be dropped.
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
{
'Route': {
'DestinationCidrBlock': 'string',
'PrefixListId': 'string',
'TransitGatewayRouteTableAnnouncementId': 'string',
'TransitGatewayAttachments': [
{
'ResourceId': 'string',
'TransitGatewayAttachmentId': 'string',
'ResourceType': 'vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function'|'client-vpn'
},
],
'Type': 'static'|'propagated',
'State': 'pending'|'active'|'blackhole'|'deleting'|'deleted'
}
}
Response Structure
(dict) --
Route (dict) --
Information about the modified route.
DestinationCidrBlock (string) --
The CIDR block used for destination matches.
PrefixListId (string) --
The ID of the prefix list used for destination matches.
TransitGatewayRouteTableAnnouncementId (string) --
The ID of the transit gateway route table announcement.
TransitGatewayAttachments (list) --
The attachments.
(dict) --
Describes a route attachment.
ResourceId (string) --
The ID of the resource.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
ResourceType (string) --
The resource type. Note that the tgw-peering resource type has been deprecated.
Type (string) --
The route type.
State (string) --
The state of the route.
{'MulticastGroups': {'ResourceType': {'client-vpn'}}}
Searches one or more transit gateway multicast groups and returns the group membership information.
See also: AWS API Documentation
Request Syntax
client.search_transit_gateway_multicast_groups(
TransitGatewayMulticastDomainId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the transit gateway multicast domain.
list
One or more filters. The possible values are:
group-ip-address - The IP address of the transit gateway multicast group.
is-group-member - The resource is a group member. Valid values are true | false.
is-group-source - The resource is a group source. Valid values are true | false.
member-type - The member type. Valid values are igmp | static.
resource-id - The ID of the resource.
resource-type - The type of resource. Valid values are vpc | vpn | direct-connect-gateway | tgw-peering.
source-type - The source type. Valid values are igmp | static.
subnet-id - The ID of the subnet.
transit-gateway-attachment-id - The id of the transit gateway attachment.
(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
{
'MulticastGroups': [
{
'GroupIpAddress': 'string',
'TransitGatewayAttachmentId': 'string',
'SubnetId': 'string',
'ResourceId': 'string',
'ResourceType': 'vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function'|'client-vpn',
'ResourceOwnerId': 'string',
'NetworkInterfaceId': 'string',
'GroupMember': True|False,
'GroupSource': True|False,
'MemberType': 'static'|'igmp',
'SourceType': 'static'|'igmp'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
MulticastGroups (list) --
Information about the transit gateway multicast group.
(dict) --
Describes the transit gateway multicast group resources.
GroupIpAddress (string) --
The IP address assigned to the transit gateway multicast group.
TransitGatewayAttachmentId (string) --
The ID of the transit gateway attachment.
SubnetId (string) --
The ID of the subnet.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The type of resource, for example a VPC attachment.
ResourceOwnerId (string) --
The ID of the Amazon Web Services account that owns the transit gateway multicast domain group resource.
NetworkInterfaceId (string) --
The ID of the transit gateway attachment.
GroupMember (boolean) --
Indicates that the resource is a transit gateway multicast group member.
GroupSource (boolean) --
Indicates that the resource is a transit gateway multicast group member.
MemberType (string) --
The member type (for example, static).
SourceType (string) --
The source type.
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.
{'Routes': {'TransitGatewayAttachments': {'ResourceType': {'client-vpn'}}}}
Searches for routes in the specified transit gateway route table.
See also: AWS API Documentation
Request Syntax
client.search_transit_gateway_routes(
TransitGatewayRouteTableId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
DryRun=True|False,
NextToken='string'
)
string
[REQUIRED]
The ID of the transit gateway route table.
list
[REQUIRED]
One or more filters. The possible values are:
attachment.transit-gateway-attachment-id- The id of the transit gateway attachment.
attachment.resource-id - The resource id of the transit gateway attachment.
attachment.resource-type - The attachment resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
prefix-list-id - The ID of the prefix list.
route-search.exact-match - The exact match of the specified filter.
route-search.longest-prefix-match - The longest prefix that matches the route.
route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
state - The state of the route ( active | blackhole).
type - The type of route ( propagated | static).
(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 routes to return. If a value is not provided, the default is 1000.
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 token for the next page of results.
dict
Response Syntax
{
'Routes': [
{
'DestinationCidrBlock': 'string',
'PrefixListId': 'string',
'TransitGatewayRouteTableAnnouncementId': 'string',
'TransitGatewayAttachments': [
{
'ResourceId': 'string',
'TransitGatewayAttachmentId': 'string',
'ResourceType': 'vpc'|'vpn'|'vpn-concentrator'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function'|'client-vpn'
},
],
'Type': 'static'|'propagated',
'State': 'pending'|'active'|'blackhole'|'deleting'|'deleted'
},
],
'AdditionalRoutesAvailable': True|False,
'NextToken': 'string'
}
Response Structure
(dict) --
Routes (list) --
Information about the routes.
(dict) --
Describes a route for a transit gateway route table.
DestinationCidrBlock (string) --
The CIDR block used for destination matches.
PrefixListId (string) --
The ID of the prefix list used for destination matches.
TransitGatewayRouteTableAnnouncementId (string) --
The ID of the transit gateway route table announcement.
TransitGatewayAttachments (list) --
The attachments.
(dict) --
Describes a route attachment.
ResourceId (string) --
The ID of the resource.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
ResourceType (string) --
The resource type. Note that the tgw-peering resource type has been deprecated.
Type (string) --
The route type.
State (string) --
The state of the route.
AdditionalRoutesAvailable (boolean) --
Indicates whether there are additional routes 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.