2020/09/25 - Amazon Elastic Compute Cloud - 8 updated api methods
Changes This release supports returning additional information about local gateway resources, such as the local gateway route table.
{'Route': {'LocalGatewayRouteTableArn': 'string', 'OwnerId': 'string'}}
Creates a static route for the specified local gateway route table.
See also: AWS API Documentation
Request Syntax
client.create_local_gateway_route(
DestinationCidrBlock='string',
LocalGatewayRouteTableId='string',
LocalGatewayVirtualInterfaceGroupId='string',
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 local gateway route table.
string
[REQUIRED]
The ID of the virtual interface group.
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',
'LocalGatewayVirtualInterfaceGroupId': 'string',
'Type': 'static'|'propagated',
'State': 'pending'|'active'|'blackhole'|'deleting'|'deleted',
'LocalGatewayRouteTableId': 'string',
'LocalGatewayRouteTableArn': 'string',
'OwnerId': 'string'
}
}
Response Structure
(dict) --
Route (dict) --
Information about the route.
DestinationCidrBlock (string) --
The CIDR block used for destination matches.
LocalGatewayVirtualInterfaceGroupId (string) --
The ID of the virtual interface group.
Type (string) --
The route type.
State (string) --
The state of the route.
LocalGatewayRouteTableId (string) --
The ID of the local gateway route table.
LocalGatewayRouteTableArn (string) --
The Amazon Resource Name (ARN) of the local gateway route table.
OwnerId (string) --
The AWS account ID that owns the local gateway route.
{'LocalGatewayRouteTableVpcAssociation': {'LocalGatewayRouteTableArn': 'string',
'OwnerId': 'string'}}
Associates the specified VPC with the specified local gateway route table.
See also: AWS API Documentation
Request Syntax
client.create_local_gateway_route_table_vpc_association(
LocalGatewayRouteTableId='string',
VpcId='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False
)
string
[REQUIRED]
The ID of the local gateway route table.
string
[REQUIRED]
The ID of the VPC.
list
The tags to assign to the local gateway route table VPC association.
(dict) --
The tags to apply to a resource when the resource is being created.
ResourceType (string) --
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | import-image-task | import-snapshot-task | instance | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | placement-group | prefix-list | natgateway | network-acl | route-table | security-group | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-route-table | volume | vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags.
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 255 Unicode characters.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .
dict
Response Syntax
{
'LocalGatewayRouteTableVpcAssociation': {
'LocalGatewayRouteTableVpcAssociationId': 'string',
'LocalGatewayRouteTableId': 'string',
'LocalGatewayRouteTableArn': 'string',
'LocalGatewayId': 'string',
'VpcId': 'string',
'OwnerId': 'string',
'State': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
LocalGatewayRouteTableVpcAssociation (dict) --
Information about the association.
LocalGatewayRouteTableVpcAssociationId (string) --
The ID of the association.
LocalGatewayRouteTableId (string) --
The ID of the local gateway route table.
LocalGatewayRouteTableArn (string) --
The Amazon Resource Name (ARN) of the local gateway route table for the association.
LocalGatewayId (string) --
The ID of the local gateway.
VpcId (string) --
The ID of the VPC.
OwnerId (string) --
The AWS account ID that owns the local gateway route table for the association.
State (string) --
The state of the association.
Tags (list) --
The tags assigned to the association.
(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.
{'Route': {'LocalGatewayRouteTableArn': 'string', 'OwnerId': 'string'}}
Deletes the specified route from the specified local gateway route table.
See also: AWS API Documentation
Request Syntax
client.delete_local_gateway_route(
DestinationCidrBlock='string',
LocalGatewayRouteTableId='string',
DryRun=True|False
)
string
[REQUIRED]
The CIDR range for the route. This must match the CIDR for the route exactly.
string
[REQUIRED]
The ID of the local gateway route 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
{
'Route': {
'DestinationCidrBlock': 'string',
'LocalGatewayVirtualInterfaceGroupId': 'string',
'Type': 'static'|'propagated',
'State': 'pending'|'active'|'blackhole'|'deleting'|'deleted',
'LocalGatewayRouteTableId': 'string',
'LocalGatewayRouteTableArn': 'string',
'OwnerId': 'string'
}
}
Response Structure
(dict) --
Route (dict) --
Information about the route.
DestinationCidrBlock (string) --
The CIDR block used for destination matches.
LocalGatewayVirtualInterfaceGroupId (string) --
The ID of the virtual interface group.
Type (string) --
The route type.
State (string) --
The state of the route.
LocalGatewayRouteTableId (string) --
The ID of the local gateway route table.
LocalGatewayRouteTableArn (string) --
The Amazon Resource Name (ARN) of the local gateway route table.
OwnerId (string) --
The AWS account ID that owns the local gateway route.
{'LocalGatewayRouteTableVpcAssociation': {'LocalGatewayRouteTableArn': 'string',
'OwnerId': 'string'}}
Deletes the specified association between a VPC and local gateway route table.
See also: AWS API Documentation
Request Syntax
client.delete_local_gateway_route_table_vpc_association(
LocalGatewayRouteTableVpcAssociationId='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the association.
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
{
'LocalGatewayRouteTableVpcAssociation': {
'LocalGatewayRouteTableVpcAssociationId': 'string',
'LocalGatewayRouteTableId': 'string',
'LocalGatewayRouteTableArn': 'string',
'LocalGatewayId': 'string',
'VpcId': 'string',
'OwnerId': 'string',
'State': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
LocalGatewayRouteTableVpcAssociation (dict) --
Information about the association.
LocalGatewayRouteTableVpcAssociationId (string) --
The ID of the association.
LocalGatewayRouteTableId (string) --
The ID of the local gateway route table.
LocalGatewayRouteTableArn (string) --
The Amazon Resource Name (ARN) of the local gateway route table for the association.
LocalGatewayId (string) --
The ID of the local gateway.
VpcId (string) --
The ID of the VPC.
OwnerId (string) --
The AWS account ID that owns the local gateway route table for the association.
State (string) --
The state of the association.
Tags (list) --
The tags assigned to the association.
(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.
{'LocalGatewayRouteTableVirtualInterfaceGroupAssociations': {'LocalGatewayRouteTableArn': 'string',
'OwnerId': 'string'}}
Describes the associations between virtual interface groups and local gateway route tables.
See also: AWS API Documentation
Request Syntax
client.describe_local_gateway_route_table_virtual_interface_group_associations(
LocalGatewayRouteTableVirtualInterfaceGroupAssociationIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
list
The IDs of the associations.
(string) --
list
One or more filters.
local-gateway-id - The ID of a local gateway.
local-gateway-route-table-id - The ID of the local gateway route table.
local-gateway-route-table-virtual-interface-group-association-id - The ID of the association.
local-gateway-route-table-virtual-interface-group-id - The ID of the virtual interface group.
state - The state of the association.
(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
{
'LocalGatewayRouteTableVirtualInterfaceGroupAssociations': [
{
'LocalGatewayRouteTableVirtualInterfaceGroupAssociationId': 'string',
'LocalGatewayVirtualInterfaceGroupId': 'string',
'LocalGatewayId': 'string',
'LocalGatewayRouteTableId': 'string',
'LocalGatewayRouteTableArn': 'string',
'OwnerId': 'string',
'State': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
LocalGatewayRouteTableVirtualInterfaceGroupAssociations (list) --
Information about the associations.
(dict) --
Describes an association between a local gateway route table and a virtual interface group.
LocalGatewayRouteTableVirtualInterfaceGroupAssociationId (string) --
The ID of the association.
LocalGatewayVirtualInterfaceGroupId (string) --
The ID of the virtual interface group.
LocalGatewayId (string) --
The ID of the local gateway.
LocalGatewayRouteTableId (string) --
The ID of the local gateway route table.
LocalGatewayRouteTableArn (string) --
The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group.
OwnerId (string) --
The AWS account ID that owns the local gateway virtual interface group association.
State (string) --
The state of the association.
Tags (list) --
The tags assigned to the association.
(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.
{'LocalGatewayRouteTableVpcAssociations': {'LocalGatewayRouteTableArn': 'string',
'OwnerId': 'string'}}
Describes the specified associations between VPCs and local gateway route tables.
See also: AWS API Documentation
Request Syntax
client.describe_local_gateway_route_table_vpc_associations(
LocalGatewayRouteTableVpcAssociationIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
list
The IDs of the associations.
(string) --
list
One or more filters.
local-gateway-id - The ID of a local gateway.
local-gateway-route-table-id - The ID of the local gateway route table.
local-gateway-route-table-vpc-association-id - The ID of the association.
state - The state of the association.
vpc-id - The ID of the VPC.
(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
{
'LocalGatewayRouteTableVpcAssociations': [
{
'LocalGatewayRouteTableVpcAssociationId': 'string',
'LocalGatewayRouteTableId': 'string',
'LocalGatewayRouteTableArn': 'string',
'LocalGatewayId': 'string',
'VpcId': 'string',
'OwnerId': 'string',
'State': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
LocalGatewayRouteTableVpcAssociations (list) --
Information about the associations.
(dict) --
Describes an association between a local gateway route table and a VPC.
LocalGatewayRouteTableVpcAssociationId (string) --
The ID of the association.
LocalGatewayRouteTableId (string) --
The ID of the local gateway route table.
LocalGatewayRouteTableArn (string) --
The Amazon Resource Name (ARN) of the local gateway route table for the association.
LocalGatewayId (string) --
The ID of the local gateway.
VpcId (string) --
The ID of the VPC.
OwnerId (string) --
The AWS account ID that owns the local gateway route table for the association.
State (string) --
The state of the association.
Tags (list) --
The tags assigned to the association.
(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.
{'LocalGatewayRouteTables': {'LocalGatewayRouteTableArn': 'string',
'OwnerId': 'string'}}
Describes one or more local gateway route tables. By default, all local gateway route tables are described. Alternatively, you can filter the results.
See also: AWS API Documentation
Request Syntax
client.describe_local_gateway_route_tables(
LocalGatewayRouteTableIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
list
The IDs of the local gateway route tables.
(string) --
list
One or more filters.
local-gateway-id - The ID of a local gateway.
local-gateway-route-table-id - The ID of a local gateway route table.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
state - The state of the local gateway route 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. 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
{
'LocalGatewayRouteTables': [
{
'LocalGatewayRouteTableId': 'string',
'LocalGatewayRouteTableArn': 'string',
'LocalGatewayId': 'string',
'OutpostArn': 'string',
'OwnerId': 'string',
'State': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
LocalGatewayRouteTables (list) --
Information about the local gateway route tables.
(dict) --
Describes a local gateway route table.
LocalGatewayRouteTableId (string) --
The ID of the local gateway route table.
LocalGatewayRouteTableArn (string) --
The Amazon Resource Name (ARN) of the local gateway route table.
LocalGatewayId (string) --
The ID of the local gateway.
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost.
OwnerId (string) --
The AWS account ID that owns the local gateway route table.
State (string) --
The state of the local gateway route table.
Tags (list) --
The tags assigned to the local gateway route table.
(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.
{'Routes': {'LocalGatewayRouteTableArn': 'string', 'OwnerId': 'string'}}
Searches for routes in the specified local gateway route table.
See also: AWS API Documentation
Request Syntax
client.search_local_gateway_routes(
LocalGatewayRouteTableId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the local gateway route table.
list
[REQUIRED]
One or more filters.
(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
{
'Routes': [
{
'DestinationCidrBlock': 'string',
'LocalGatewayVirtualInterfaceGroupId': 'string',
'Type': 'static'|'propagated',
'State': 'pending'|'active'|'blackhole'|'deleting'|'deleted',
'LocalGatewayRouteTableId': 'string',
'LocalGatewayRouteTableArn': 'string',
'OwnerId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Routes (list) --
Information about the routes.
(dict) --
Describes a route for a local gateway route table.
DestinationCidrBlock (string) --
The CIDR block used for destination matches.
LocalGatewayVirtualInterfaceGroupId (string) --
The ID of the virtual interface group.
Type (string) --
The route type.
State (string) --
The state of the route.
LocalGatewayRouteTableId (string) --
The ID of the local gateway route table.
LocalGatewayRouteTableArn (string) --
The Amazon Resource Name (ARN) of the local gateway route table.
OwnerId (string) --
The AWS account ID that owns the local gateway route.
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.