2019/06/07 - Amazon Elastic Compute Cloud - 14 updated api methods
Changes Adds DNS entries and NLB ARNs to describe-vpc-endpoint-connections API response. Adds owner ID to describe-vpc-endpoints and create-vpc-endpoint API responses.
{'Association': {'ResourceType': {'direct-connect-gateway'}}}
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'|'direct-connect-gateway',
'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.
State (string) --
The state of the association.
{'Route': {'TransitGatewayAttachments': {'ResourceType': {'direct-connect-gateway'}}}}
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',
'TransitGatewayAttachments': [
{
'ResourceId': 'string',
'TransitGatewayAttachmentId': 'string',
'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'
},
],
'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.
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.
Type (string) --
The route type.
State (string) --
The state of the route.
{'VpcEndpoint': {'OwnerId': 'string'}}
Creates a VPC endpoint for a specified service. An endpoint enables you to create a private connection between your VPC and the service. The service may be provided by AWS, an AWS Marketplace partner, or another AWS account. For more information, see VPC Endpoints in the Amazon Virtual Private Cloud User Guide .
A gateway endpoint serves as a target for a route in your route table for traffic destined for the AWS service. You can specify an endpoint policy to attach to the endpoint that will control access to the service from your VPC. You can also specify the VPC route tables that use the endpoint.
An interface endpoint is a network interface in your subnet that serves as an endpoint for communicating with the specified service. You can specify the subnets in which to create an endpoint, and the security groups to associate with the endpoint network interface.
Use DescribeVpcEndpointServices to get a list of supported services.
See also: AWS API Documentation
Request Syntax
client.create_vpc_endpoint(
DryRun=True|False,
VpcEndpointType='Interface'|'Gateway',
VpcId='string',
ServiceName='string',
PolicyDocument='string',
RouteTableIds=[
'string',
],
SubnetIds=[
'string',
],
SecurityGroupIds=[
'string',
],
ClientToken='string',
PrivateDnsEnabled=True|False
)
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .
string
The type of endpoint.
Default: Gateway
string
[REQUIRED]
The ID of the VPC in which the endpoint will be used.
string
[REQUIRED]
The service name. To get a list of available services, use the DescribeVpcEndpointServices request, or get the name from the service provider.
string
A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.
list
(Gateway endpoint) One or more route table IDs.
(string) --
list
(Interface endpoint) The ID of one or more subnets in which to create an endpoint network interface.
(string) --
list
(Interface endpoint) The ID of one or more security groups to associate with the endpoint network interface.
(string) --
string
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
boolean
(Interface endpoint) Indicate whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com ) which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.
To use a private hosted zone, you must set the following VPC attributes to true : enableDnsHostnames and enableDnsSupport . Use ModifyVpcAttribute to set the VPC attributes.
Default: true
dict
Response Syntax
{
'VpcEndpoint': {
'VpcEndpointId': 'string',
'VpcEndpointType': 'Interface'|'Gateway',
'VpcId': 'string',
'ServiceName': 'string',
'State': 'PendingAcceptance'|'Pending'|'Available'|'Deleting'|'Deleted'|'Rejected'|'Failed'|'Expired',
'PolicyDocument': 'string',
'RouteTableIds': [
'string',
],
'SubnetIds': [
'string',
],
'Groups': [
{
'GroupId': 'string',
'GroupName': 'string'
},
],
'PrivateDnsEnabled': True|False,
'RequesterManaged': True|False,
'NetworkInterfaceIds': [
'string',
],
'DnsEntries': [
{
'DnsName': 'string',
'HostedZoneId': 'string'
},
],
'CreationTimestamp': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'OwnerId': 'string'
},
'ClientToken': 'string'
}
Response Structure
(dict) --
Contains the output of CreateVpcEndpoint.
VpcEndpoint (dict) --
Information about the endpoint.
VpcEndpointId (string) --
The ID of the VPC endpoint.
VpcEndpointType (string) --
The type of endpoint.
VpcId (string) --
The ID of the VPC to which the endpoint is associated.
ServiceName (string) --
The name of the service to which the endpoint is associated.
State (string) --
The state of the VPC endpoint.
PolicyDocument (string) --
The policy document associated with the endpoint, if applicable.
RouteTableIds (list) --
(Gateway endpoint) One or more route tables associated with the endpoint.
(string) --
SubnetIds (list) --
(Interface endpoint) One or more subnets in which the endpoint is located.
(string) --
Groups (list) --
(Interface endpoint) Information about the security groups associated with the network interface.
(dict) --
Describes a security group.
GroupId (string) --
The ID of the security group.
GroupName (string) --
The name of the security group.
PrivateDnsEnabled (boolean) --
(Interface endpoint) Indicates whether the VPC is associated with a private hosted zone.
RequesterManaged (boolean) --
Indicates whether the VPC endpoint is being managed by its service.
NetworkInterfaceIds (list) --
(Interface endpoint) One or more network interfaces for the endpoint.
(string) --
DnsEntries (list) --
(Interface endpoint) The DNS entries for the endpoint.
(dict) --
Describes a DNS entry.
DnsName (string) --
The DNS name.
HostedZoneId (string) --
The ID of the private hosted zone.
CreationTimestamp (datetime) --
The date and time the VPC endpoint was created.
Tags (list) --
Any tags assigned to the VPC 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 255 Unicode characters.
OwnerId (string) --
The ID of the AWS account that owns the VPC endpoint.
ClientToken (string) --
Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
{'Route': {'TransitGatewayAttachments': {'ResourceType': {'direct-connect-gateway'}}}}
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',
'TransitGatewayAttachments': [
{
'ResourceId': 'string',
'TransitGatewayAttachmentId': 'string',
'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'
},
],
'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.
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.
Type (string) --
The route type.
State (string) --
The state of the route.
{'TransitGatewayAttachments': {'ResourceType': {'direct-connect-gateway'}}}
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 AWS account that owns the resource.
resource-type - The resource type ( vpc | vpn ).
state - The state of the attachment ( available | deleted | deleting | failed | 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 AWS 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. The filters supported by a describe operation are documented with the describe operation. For example:
DescribeAvailabilityZones
DescribeImages
DescribeInstances
DescribeKeyPairs
DescribeSecurityGroups
DescribeSnapshots
DescribeSubnets
DescribeTags
DescribeVolumes
DescribeVpcs
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive.
(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'|'direct-connect-gateway',
'ResourceId': 'string',
'State': '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 AWS account that owns the transit gateway.
ResourceOwnerId (string) --
The ID of the AWS account that owns the resource.
ResourceType (string) --
The resource type.
ResourceId (string) --
The ID of the resource.
State (string) --
The attachment state.
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 255 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.
{'VpcEndpointConnections': {'DnsEntries': [{'DnsName': 'string',
'HostedZoneId': 'string'}],
'NetworkLoadBalancerArns': ['string']}}
Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.
See also: AWS API Documentation
Request Syntax
client.describe_vpc_endpoint_connections(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='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 .
list
One or more filters.
service-id - The ID of the service.
vpc-endpoint-owner - The AWS account number of the owner of the endpoint.
vpc-endpoint-state - The state of the endpoint ( pendingAcceptance | pending | available | deleting | deleted | rejected | failed ).
vpc-endpoint-id - The ID of the endpoint.
(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. The filters supported by a describe operation are documented with the describe operation. For example:
DescribeAvailabilityZones
DescribeImages
DescribeInstances
DescribeKeyPairs
DescribeSecurityGroups
DescribeSnapshots
DescribeSubnets
DescribeTags
DescribeVolumes
DescribeVpcs
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive.
(string) --
integer
The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned.
string
The token to retrieve the next page of results.
dict
Response Syntax
{
'VpcEndpointConnections': [
{
'ServiceId': 'string',
'VpcEndpointId': 'string',
'VpcEndpointOwner': 'string',
'VpcEndpointState': 'PendingAcceptance'|'Pending'|'Available'|'Deleting'|'Deleted'|'Rejected'|'Failed'|'Expired',
'CreationTimestamp': datetime(2015, 1, 1),
'DnsEntries': [
{
'DnsName': 'string',
'HostedZoneId': 'string'
},
],
'NetworkLoadBalancerArns': [
'string',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
VpcEndpointConnections (list) --
Information about one or more VPC endpoint connections.
(dict) --
Describes a VPC endpoint connection to a service.
ServiceId (string) --
The ID of the service to which the endpoint is connected.
VpcEndpointId (string) --
The ID of the VPC endpoint.
VpcEndpointOwner (string) --
The AWS account ID of the owner of the VPC endpoint.
VpcEndpointState (string) --
The state of the VPC endpoint.
CreationTimestamp (datetime) --
The date and time the VPC endpoint was created.
DnsEntries (list) --
The DNS entries for the VPC endpoint.
(dict) --
Describes a DNS entry.
DnsName (string) --
The DNS name.
HostedZoneId (string) --
The ID of the private hosted zone.
NetworkLoadBalancerArns (list) --
The Amazon Resource Names (ARNs) of the network load balancers for the service.
(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.
{'VpcEndpoints': {'OwnerId': 'string'}}
Describes one or more of your VPC endpoints.
See also: AWS API Documentation
Request Syntax
client.describe_vpc_endpoints(
DryRun=True|False,
VpcEndpointIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='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 .
list
One or more endpoint IDs.
(string) --
list
One or more filters.
service-name : The name of the service.
vpc-id : The ID of the VPC in which the endpoint resides.
vpc-endpoint-id : The ID of the endpoint.
vpc-endpoint-state : The state of the endpoint. ( pending | available | deleting | deleted )
tag :<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA , specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
(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. The filters supported by a describe operation are documented with the describe operation. For example:
DescribeAvailabilityZones
DescribeImages
DescribeInstances
DescribeKeyPairs
DescribeSecurityGroups
DescribeSnapshots
DescribeSubnets
DescribeTags
DescribeVolumes
DescribeVpcs
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive.
(string) --
integer
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
Constraint: If the value is greater than 1000, we return only 1000 items.
string
The token for the next set of items to return. (You received this token from a prior call.)
dict
Response Syntax
{
'VpcEndpoints': [
{
'VpcEndpointId': 'string',
'VpcEndpointType': 'Interface'|'Gateway',
'VpcId': 'string',
'ServiceName': 'string',
'State': 'PendingAcceptance'|'Pending'|'Available'|'Deleting'|'Deleted'|'Rejected'|'Failed'|'Expired',
'PolicyDocument': 'string',
'RouteTableIds': [
'string',
],
'SubnetIds': [
'string',
],
'Groups': [
{
'GroupId': 'string',
'GroupName': 'string'
},
],
'PrivateDnsEnabled': True|False,
'RequesterManaged': True|False,
'NetworkInterfaceIds': [
'string',
],
'DnsEntries': [
{
'DnsName': 'string',
'HostedZoneId': 'string'
},
],
'CreationTimestamp': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'OwnerId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the output of DescribeVpcEndpoints.
VpcEndpoints (list) --
Information about the endpoints.
(dict) --
Describes a VPC endpoint.
VpcEndpointId (string) --
The ID of the VPC endpoint.
VpcEndpointType (string) --
The type of endpoint.
VpcId (string) --
The ID of the VPC to which the endpoint is associated.
ServiceName (string) --
The name of the service to which the endpoint is associated.
State (string) --
The state of the VPC endpoint.
PolicyDocument (string) --
The policy document associated with the endpoint, if applicable.
RouteTableIds (list) --
(Gateway endpoint) One or more route tables associated with the endpoint.
(string) --
SubnetIds (list) --
(Interface endpoint) One or more subnets in which the endpoint is located.
(string) --
Groups (list) --
(Interface endpoint) Information about the security groups associated with the network interface.
(dict) --
Describes a security group.
GroupId (string) --
The ID of the security group.
GroupName (string) --
The name of the security group.
PrivateDnsEnabled (boolean) --
(Interface endpoint) Indicates whether the VPC is associated with a private hosted zone.
RequesterManaged (boolean) --
Indicates whether the VPC endpoint is being managed by its service.
NetworkInterfaceIds (list) --
(Interface endpoint) One or more network interfaces for the endpoint.
(string) --
DnsEntries (list) --
(Interface endpoint) The DNS entries for the endpoint.
(dict) --
Describes a DNS entry.
DnsName (string) --
The DNS name.
HostedZoneId (string) --
The ID of the private hosted zone.
CreationTimestamp (datetime) --
The date and time the VPC endpoint was created.
Tags (list) --
Any tags assigned to the VPC 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 255 Unicode characters.
OwnerId (string) --
The ID of the AWS account that owns the VPC endpoint.
NextToken (string) --
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
{'Propagation': {'ResourceType': {'direct-connect-gateway'}}}
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
)
string
[REQUIRED]
The ID of the propagation 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
{
'Propagation': {
'TransitGatewayAttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway',
'TransitGatewayRouteTableId': 'string',
'State': 'enabling'|'enabled'|'disabling'|'disabled'
}
}
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.
TransitGatewayRouteTableId (string) --
The ID of the transit gateway route table.
State (string) --
The state.
{'Association': {'ResourceType': {'direct-connect-gateway'}}}
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'|'direct-connect-gateway',
'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.
State (string) --
The state of the association.
{'Propagation': {'ResourceType': {'direct-connect-gateway'}}}
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
)
string
[REQUIRED]
The ID of the propagation 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
{
'Propagation': {
'TransitGatewayAttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway',
'TransitGatewayRouteTableId': 'string',
'State': 'enabling'|'enabled'|'disabling'|'disabled'
}
}
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.
TransitGatewayRouteTableId (string) --
The ID of the transit gateway route table.
State (string) --
The state.
{'Associations': {'ResourceType': {'direct-connect-gateway'}}}
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 ( vpc | vpn ).
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. The filters supported by a describe operation are documented with the describe operation. For example:
DescribeAvailabilityZones
DescribeImages
DescribeInstances
DescribeKeyPairs
DescribeSecurityGroups
DescribeSnapshots
DescribeSubnets
DescribeTags
DescribeVolumes
DescribeVpcs
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive.
(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'|'direct-connect-gateway',
'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.
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': {'direct-connect-gateway'}}}
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 ( vpc | vpn ).
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. The filters supported by a describe operation are documented with the describe operation. For example:
DescribeAvailabilityZones
DescribeImages
DescribeInstances
DescribeKeyPairs
DescribeSecurityGroups
DescribeSnapshots
DescribeSubnets
DescribeTags
DescribeVolumes
DescribeVpcs
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive.
(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'|'direct-connect-gateway',
'State': 'enabling'|'enabled'|'disabling'|'disabled'
},
],
'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.
State (string) --
The state 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.
{'Route': {'TransitGatewayAttachments': {'ResourceType': {'direct-connect-gateway'}}}}
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',
'TransitGatewayAttachments': [
{
'ResourceId': 'string',
'TransitGatewayAttachmentId': 'string',
'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'
},
],
'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.
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.
Type (string) --
The route type.
State (string) --
The state of the route.
{'Routes': {'TransitGatewayAttachments': {'ResourceType': {'direct-connect-gateway'}}}}
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
)
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 ( vpc | vpn ).
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 roue ( 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. The filters supported by a describe operation are documented with the describe operation. For example:
DescribeAvailabilityZones
DescribeImages
DescribeInstances
DescribeKeyPairs
DescribeSecurityGroups
DescribeSnapshots
DescribeSubnets
DescribeTags
DescribeVolumes
DescribeVpcs
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive.
(string) --
integer
The maximum number of routes to return.
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': [
{
'DestinationCidrBlock': 'string',
'TransitGatewayAttachments': [
{
'ResourceId': 'string',
'TransitGatewayAttachmentId': 'string',
'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'
},
],
'Type': 'static'|'propagated',
'State': 'pending'|'active'|'blackhole'|'deleting'|'deleted'
},
],
'AdditionalRoutesAvailable': True|False
}
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.
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.
Type (string) --
The route type.
State (string) --
The state of the route.
AdditionalRoutesAvailable (boolean) --
Indicates whether there are additional routes available.