2025/05/05 - Amazon Elastic Compute Cloud - 6 new10 updated api methods
Changes This update introduces API operations to manage and create local gateway VIF and VIF groups. It also includes API operations to describe Outpost LAGs and service link VIFs.
Describes the Outpost service link virtual interfaces.
See also: AWS API Documentation
Request Syntax
client.describe_service_link_virtual_interfaces(
ServiceLinkVirtualInterfaceIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
list
The IDs of the service link virtual interfaces.
(string) --
list
The filters to use for narrowing down the request. The following filters are supported:
outpost-lag-id - The ID of the Outpost LAG.
outpost-arn - The Outpost ARN.
owner-id - The ID of the Amazon Web Services account that owns the service link virtual interface.
state - The state of the Outpost LAG.
vlan - The ID of the address pool.
service-link-virtual-interface-id - The ID of the service link virtual interface.
local-gateway-virtual-interface-id - The ID of the local gateway virtual interface.
(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
{
'ServiceLinkVirtualInterfaces': [
{
'ServiceLinkVirtualInterfaceId': 'string',
'ServiceLinkVirtualInterfaceArn': 'string',
'OutpostId': 'string',
'OutpostArn': 'string',
'OwnerId': 'string',
'LocalAddress': 'string',
'PeerAddress': 'string',
'PeerBgpAsn': 123,
'Vlan': 123,
'OutpostLagId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ConfigurationState': 'pending'|'available'|'deleting'|'deleted'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ServiceLinkVirtualInterfaces (list) --
Describes the service link virtual interfaces.
(dict) --
Describes the service link virtual interfaces that establish connectivity between Amazon Web Services Outpost and on-premises networks.
ServiceLinkVirtualInterfaceId (string) --
The ID of the service link virtual interface.
ServiceLinkVirtualInterfaceArn (string) --
The Amazon Resource Number (ARN) for the service link virtual interface.
OutpostId (string) --
The Outpost ID for the service link virtual interface.
OutpostArn (string) --
The Outpost Amazon Resource Number (ARN) for the service link virtual interface.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the service link virtual interface..
LocalAddress (string) --
The IPv4 address assigned to the local gateway virtual interface on the Outpost side.
PeerAddress (string) --
The IPv4 peer address for the service link virtual interface.
PeerBgpAsn (integer) --
The ASN for the Border Gateway Protocol (BGP) associated with the service link virtual interface.
Vlan (integer) --
The virtual local area network for the service link virtual interface.
OutpostLagId (string) --
The link aggregation group (LAG) ID for the service link virtual interface.
Tags (list) --
The tags associated with the service link virtual interface.
(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.
ConfigurationState (string) --
The current state of the service link virtual interface.
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.
Create a local gateway virtual interface group.
See also: AWS API Documentation
Request Syntax
client.create_local_gateway_virtual_interface_group(
LocalGatewayId='string',
LocalBgpAsn=123,
LocalBgpAsnExtended=123,
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'|'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-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'|'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',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False
)
string
[REQUIRED]
The ID of the local gateway.
integer
The Autonomous System Number(ASN) for the local Border Gateway Protocol (BGP).
integer
The extended 32-bit ASN for the local BGP configuration.
list
The tags to apply to the local gateway virtual interface group when the resource is being created.
(dict) --
The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
ResourceType (string) --
The type of resource to tag on creation.
Tags (list) --
The tags to apply to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'LocalGatewayVirtualInterfaceGroup': {
'LocalGatewayVirtualInterfaceGroupId': 'string',
'LocalGatewayVirtualInterfaceIds': [
'string',
],
'LocalGatewayId': 'string',
'OwnerId': 'string',
'LocalBgpAsn': 123,
'LocalBgpAsnExtended': 123,
'LocalGatewayVirtualInterfaceGroupArn': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ConfigurationState': 'pending'|'incomplete'|'available'|'deleting'|'deleted'
}
}
Response Structure
(dict) --
LocalGatewayVirtualInterfaceGroup (dict) --
Information about the created local gateway virtual interface group.
LocalGatewayVirtualInterfaceGroupId (string) --
The ID of the virtual interface group.
LocalGatewayVirtualInterfaceIds (list) --
The IDs of the virtual interfaces.
(string) --
LocalGatewayId (string) --
The ID of the local gateway.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the local gateway virtual interface group.
LocalBgpAsn (integer) --
The Autonomous System Number(ASN) for the local Border Gateway Protocol (BGP).
LocalBgpAsnExtended (integer) --
The extended 32-bit ASN for the local BGP configuration.
LocalGatewayVirtualInterfaceGroupArn (string) --
The Amazon Resource Number (ARN) of the local gateway virtual interface group.
Tags (list) --
The tags assigned to the virtual interface group.
(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.
ConfigurationState (string) --
The current state of the local gateway virtual interface group.
Create a virtual interface for a local gateway.
See also: AWS API Documentation
Request Syntax
client.create_local_gateway_virtual_interface(
LocalGatewayVirtualInterfaceGroupId='string',
OutpostLagId='string',
Vlan=123,
LocalAddress='string',
PeerAddress='string',
PeerBgpAsn=123,
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'|'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-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'|'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',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False,
PeerBgpAsnExtended=123
)
string
[REQUIRED]
The ID of the local gateway virtual interface group.
string
[REQUIRED]
References the Link Aggregation Group (LAG) that connects the Outpost to on-premises network devices.
integer
[REQUIRED]
The virtual local area network (VLAN) used for the local gateway virtual interface.
string
[REQUIRED]
The IP address assigned to the local gateway virtual interface on the Outpost side. Only IPv4 is supported.
string
[REQUIRED]
The peer IP address for the local gateway virtual interface. Only IPv4 is supported.
integer
The Autonomous System Number (ASN) of the Border Gateway Protocol (BGP) peer.
list
The tags to apply to a resource when the local gateway virtual interface is being created.
(dict) --
The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
ResourceType (string) --
The type of resource to tag on creation.
Tags (list) --
The tags to apply to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
integer
The extended 32-bit ASN of the BGP peer for use with larger ASN values.
dict
Response Syntax
{
'LocalGatewayVirtualInterface': {
'LocalGatewayVirtualInterfaceId': 'string',
'LocalGatewayId': 'string',
'LocalGatewayVirtualInterfaceGroupId': 'string',
'LocalGatewayVirtualInterfaceArn': 'string',
'OutpostLagId': 'string',
'Vlan': 123,
'LocalAddress': 'string',
'PeerAddress': 'string',
'LocalBgpAsn': 123,
'PeerBgpAsn': 123,
'PeerBgpAsnExtended': 123,
'OwnerId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ConfigurationState': 'pending'|'available'|'deleting'|'deleted'
}
}
Response Structure
(dict) --
LocalGatewayVirtualInterface (dict) --
Information about the local gateway virtual interface.
LocalGatewayVirtualInterfaceId (string) --
The ID of the virtual interface.
LocalGatewayId (string) --
The ID of the local gateway.
LocalGatewayVirtualInterfaceGroupId (string) --
The ID of the local gateway virtual interface group.
LocalGatewayVirtualInterfaceArn (string) --
The Amazon Resource Number (ARN) of the local gateway virtual interface.
OutpostLagId (string) --
The Outpost LAG ID.
Vlan (integer) --
The ID of the VLAN.
LocalAddress (string) --
The local address.
PeerAddress (string) --
The peer address.
LocalBgpAsn (integer) --
The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.
PeerBgpAsn (integer) --
The peer BGP ASN.
PeerBgpAsnExtended (integer) --
The extended 32-bit ASN of the BGP peer for use with larger ASN values.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the local gateway virtual interface.
Tags (list) --
The tags assigned to the virtual interface.
(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.
ConfigurationState (string) --
The current state of the local gateway virtual interface.
Delete the specified local gateway interface group.
See also: AWS API Documentation
Request Syntax
client.delete_local_gateway_virtual_interface_group(
LocalGatewayVirtualInterfaceGroupId='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the local gateway virtual interface group 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
{
'LocalGatewayVirtualInterfaceGroup': {
'LocalGatewayVirtualInterfaceGroupId': 'string',
'LocalGatewayVirtualInterfaceIds': [
'string',
],
'LocalGatewayId': 'string',
'OwnerId': 'string',
'LocalBgpAsn': 123,
'LocalBgpAsnExtended': 123,
'LocalGatewayVirtualInterfaceGroupArn': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ConfigurationState': 'pending'|'incomplete'|'available'|'deleting'|'deleted'
}
}
Response Structure
(dict) --
LocalGatewayVirtualInterfaceGroup (dict) --
Information about the deleted local gateway virtual interface group.
LocalGatewayVirtualInterfaceGroupId (string) --
The ID of the virtual interface group.
LocalGatewayVirtualInterfaceIds (list) --
The IDs of the virtual interfaces.
(string) --
LocalGatewayId (string) --
The ID of the local gateway.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the local gateway virtual interface group.
LocalBgpAsn (integer) --
The Autonomous System Number(ASN) for the local Border Gateway Protocol (BGP).
LocalBgpAsnExtended (integer) --
The extended 32-bit ASN for the local BGP configuration.
LocalGatewayVirtualInterfaceGroupArn (string) --
The Amazon Resource Number (ARN) of the local gateway virtual interface group.
Tags (list) --
The tags assigned to the virtual interface group.
(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.
ConfigurationState (string) --
The current state of the local gateway virtual interface group.
Describes the Outposts link aggregation groups (LAGs).
See also: AWS API Documentation
Request Syntax
client.describe_outpost_lags(
OutpostLagIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
list
The IDs of the Outpost LAGs.
(string) --
list
The filters to use for narrowing down the request. The following filters are supported:
service-link-virtual-interface-id - The ID of the service link virtual interface.
service-link-virtual-interface-arn - The ARN of the service link virtual interface.
outpost-id - The Outpost ID.
outpost-arn - The Outpost ARN.
owner-id - The ID of the Amazon Web Services account that owns the service link virtual interface.
vlan - The ID of the address pool.
local-address - The local address.
peer-address - The peer address.
peer-bgp-asn - The peer BGP ASN.
outpost-lag-id - The Outpost LAG ID.
configuration-state - The configuration state of the service link virtual interface.
(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
{
'OutpostLags': [
{
'OutpostArn': 'string',
'OwnerId': 'string',
'State': 'string',
'OutpostLagId': 'string',
'LocalGatewayVirtualInterfaceIds': [
'string',
],
'ServiceLinkVirtualInterfaceIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
OutpostLags (list) --
The Outpost LAGs.
(dict) --
Describes an Outpost link aggregation group (LAG).
OutpostArn (string) --
The Amazon Resource Number (ARN) of the Outpost LAG.
OwnerId (string) --
The ID of the Outpost LAG owner.
State (string) --
The current state of the Outpost LAG.
OutpostLagId (string) --
The ID of the Outpost LAG.
LocalGatewayVirtualInterfaceIds (list) --
The IDs of the local gateway virtual interfaces associated with the Outpost LAG.
(string) --
ServiceLinkVirtualInterfaceIds (list) --
The service link virtual interface IDs associated with the Outpost LAG.
(string) --
Tags (list) --
The tags associated with the Outpost LAG.
(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.
Deletes the specified local gateway virtual interface.
See also: AWS API Documentation
Request Syntax
client.delete_local_gateway_virtual_interface(
LocalGatewayVirtualInterfaceId='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the local virtual interface 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
{
'LocalGatewayVirtualInterface': {
'LocalGatewayVirtualInterfaceId': 'string',
'LocalGatewayId': 'string',
'LocalGatewayVirtualInterfaceGroupId': 'string',
'LocalGatewayVirtualInterfaceArn': 'string',
'OutpostLagId': 'string',
'Vlan': 123,
'LocalAddress': 'string',
'PeerAddress': 'string',
'LocalBgpAsn': 123,
'PeerBgpAsn': 123,
'PeerBgpAsnExtended': 123,
'OwnerId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ConfigurationState': 'pending'|'available'|'deleting'|'deleted'
}
}
Response Structure
(dict) --
LocalGatewayVirtualInterface (dict) --
Information about the deleted local gateway virtual interface.
LocalGatewayVirtualInterfaceId (string) --
The ID of the virtual interface.
LocalGatewayId (string) --
The ID of the local gateway.
LocalGatewayVirtualInterfaceGroupId (string) --
The ID of the local gateway virtual interface group.
LocalGatewayVirtualInterfaceArn (string) --
The Amazon Resource Number (ARN) of the local gateway virtual interface.
OutpostLagId (string) --
The Outpost LAG ID.
Vlan (integer) --
The ID of the VLAN.
LocalAddress (string) --
The local address.
PeerAddress (string) --
The peer address.
LocalBgpAsn (integer) --
The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.
PeerBgpAsn (integer) --
The peer BGP ASN.
PeerBgpAsnExtended (integer) --
The extended 32-bit ASN of the BGP peer for use with larger ASN values.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the local gateway virtual interface.
Tags (list) --
The tags assigned to the virtual interface.
(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.
ConfigurationState (string) --
The current state of the local gateway virtual interface.
{'LaunchTemplateData': {'TagSpecifications': {'ResourceType': {'outpost-lag',
'service-link-virtual-interface'}}}}
{'LaunchTemplateData': {'TagSpecifications': {'ResourceType': {'outpost-lag',
'service-link-virtual-interface'}}}}
Response {'LaunchTemplateVersion': {'LaunchTemplateData': {'TagSpecifications': {'ResourceType': {'outpost-lag',
'service-link-virtual-interface'}}}}}
{'LaunchTemplateVersions': {'LaunchTemplateData': {'TagSpecifications': {'ResourceType': {'outpost-lag',
'service-link-virtual-interface'}}}}}
{'LocalGatewayVirtualInterfaceGroups': {'ConfigurationState': 'pending | '
'incomplete | '
'available | '
'deleting | '
'deleted',
'LocalBgpAsn': 'integer',
'LocalBgpAsnExtended': 'long',
'LocalGatewayVirtualInterfaceGroupArn': 'string'}}
Describes the specified local gateway virtual interface groups.
See also: AWS API Documentation
Request Syntax
client.describe_local_gateway_virtual_interface_groups(
LocalGatewayVirtualInterfaceGroupIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
list
The IDs of the virtual interface groups.
(string) --
list
One or more filters.
local-gateway-id - The ID of a local gateway.
local-gateway-virtual-interface-group-id - The ID of the virtual interface group.
local-gateway-virtual-interface-id - The ID of the virtual interface.
owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface group.
(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
{
'LocalGatewayVirtualInterfaceGroups': [
{
'LocalGatewayVirtualInterfaceGroupId': 'string',
'LocalGatewayVirtualInterfaceIds': [
'string',
],
'LocalGatewayId': 'string',
'OwnerId': 'string',
'LocalBgpAsn': 123,
'LocalBgpAsnExtended': 123,
'LocalGatewayVirtualInterfaceGroupArn': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ConfigurationState': 'pending'|'incomplete'|'available'|'deleting'|'deleted'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
LocalGatewayVirtualInterfaceGroups (list) --
The virtual interface groups.
(dict) --
Describes a local gateway virtual interface group.
LocalGatewayVirtualInterfaceGroupId (string) --
The ID of the virtual interface group.
LocalGatewayVirtualInterfaceIds (list) --
The IDs of the virtual interfaces.
(string) --
LocalGatewayId (string) --
The ID of the local gateway.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the local gateway virtual interface group.
LocalBgpAsn (integer) --
The Autonomous System Number(ASN) for the local Border Gateway Protocol (BGP).
LocalBgpAsnExtended (integer) --
The extended 32-bit ASN for the local BGP configuration.
LocalGatewayVirtualInterfaceGroupArn (string) --
The Amazon Resource Number (ARN) of the local gateway virtual interface group.
Tags (list) --
The tags assigned to the virtual interface group.
(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.
ConfigurationState (string) --
The current state of the local gateway virtual interface group.
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.
{'LocalGatewayVirtualInterfaces': {'ConfigurationState': 'pending | available '
'| deleting | deleted',
'LocalGatewayVirtualInterfaceArn': 'string',
'LocalGatewayVirtualInterfaceGroupId': 'string',
'OutpostLagId': 'string',
'PeerBgpAsnExtended': 'long'}}
Describes the specified local gateway virtual interfaces.
See also: AWS API Documentation
Request Syntax
client.describe_local_gateway_virtual_interfaces(
LocalGatewayVirtualInterfaceIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
list
The IDs of the virtual interfaces.
(string) --
list
One or more filters.
local-address - The local address.
local-bgp-asn - The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.
local-gateway-id - The ID of the local gateway.
local-gateway-virtual-interface-id - The ID of the virtual interface.
owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface.
peer-address - The peer address.
peer-bgp-asn - The peer BGP ASN.
vlan - The ID of the VLAN.
(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
{
'LocalGatewayVirtualInterfaces': [
{
'LocalGatewayVirtualInterfaceId': 'string',
'LocalGatewayId': 'string',
'LocalGatewayVirtualInterfaceGroupId': 'string',
'LocalGatewayVirtualInterfaceArn': 'string',
'OutpostLagId': 'string',
'Vlan': 123,
'LocalAddress': 'string',
'PeerAddress': 'string',
'LocalBgpAsn': 123,
'PeerBgpAsn': 123,
'PeerBgpAsnExtended': 123,
'OwnerId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ConfigurationState': 'pending'|'available'|'deleting'|'deleted'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
LocalGatewayVirtualInterfaces (list) --
Information about the virtual interfaces.
(dict) --
Describes a local gateway virtual interface.
LocalGatewayVirtualInterfaceId (string) --
The ID of the virtual interface.
LocalGatewayId (string) --
The ID of the local gateway.
LocalGatewayVirtualInterfaceGroupId (string) --
The ID of the local gateway virtual interface group.
LocalGatewayVirtualInterfaceArn (string) --
The Amazon Resource Number (ARN) of the local gateway virtual interface.
OutpostLagId (string) --
The Outpost LAG ID.
Vlan (integer) --
The ID of the VLAN.
LocalAddress (string) --
The local address.
PeerAddress (string) --
The peer address.
LocalBgpAsn (integer) --
The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.
PeerBgpAsn (integer) --
The peer BGP ASN.
PeerBgpAsnExtended (integer) --
The extended 32-bit ASN of the BGP peer for use with larger ASN values.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the local gateway virtual interface.
Tags (list) --
The tags assigned to the virtual interface.
(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.
ConfigurationState (string) --
The current state of the local gateway virtual interface.
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.
{'SpotFleetRequestConfigs': {'SpotFleetRequestConfig': {'LaunchSpecifications': {'TagSpecifications': {'ResourceType': {'outpost-lag',
'service-link-virtual-interface'}}},
'TagSpecifications': {'ResourceType': {'outpost-lag',
'service-link-virtual-interface'}}}}}
{'Tags': {'ResourceType': {'service-link-virtual-interface', 'outpost-lag'}}}
Describes the specified tags for your EC2 resources.
For more information about tags, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
See also: AWS API Documentation
Request Syntax
client.describe_tags(
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
The filters.
key - The tag key.
resource-id - The ID of the resource.
resource-type - The resource type. For a list of possible values, see TagSpecification.
tag:<key> - The key/value combination of the tag. For example, specify "tag:Owner" for the filter name and "TeamA" for the filter value to find resources with the tag "Owner=TeamA".
value - 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.
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 items to return for this request. This value can be between 5 and 1000. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
string
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
dict
Response Syntax
{
'NextToken': 'string',
'Tags': [
{
'Key': 'string',
'ResourceId': 'string',
'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'|'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-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'|'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',
'Value': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
Tags (list) --
The tags.
(dict) --
Describes a tag.
Key (string) --
The tag key.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The resource type.
Value (string) --
The tag value.
{'LaunchTemplateData': {'TagSpecifications': {'ResourceType': {'outpost-lag',
'service-link-virtual-interface'}}}}
{'PoolTagSpecifications': {'ResourceType': {'outpost-lag',
'service-link-virtual-interface'}}}
Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr.
Amazon Web Services verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For more information, see Bring your own IP addresses (BYOIP) in the Amazon EC2 User Guide.
Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from pending-provision to provisioned. To monitor the status of an address range, use DescribeByoipCidrs. To allocate an Elastic IP address from your IPv4 address pool, use AllocateAddress with either the specific address from the address pool or the ID of the address pool.
See also: AWS API Documentation
Request Syntax
client.provision_byoip_cidr(
Cidr='string',
CidrAuthorizationContext={
'Message': 'string',
'Signature': 'string'
},
PubliclyAdvertisable=True|False,
Description='string',
DryRun=True|False,
PoolTagSpecifications=[
{
'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'|'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-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'|'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',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
MultiRegion=True|False,
NetworkBorderGroup='string'
)
string
[REQUIRED]
The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can specify is /24. The most specific IPv6 address range that you can bring is /48 for CIDRs that are publicly advertisable and /56 for CIDRs that are not publicly advertisable. The address range cannot overlap with another address range that you've brought to this or another Region.
dict
A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
Message (string) -- [REQUIRED]
The plain-text authorization message for the prefix and account.
Signature (string) -- [REQUIRED]
The signed authorization message for the prefix and account.
boolean
(IPv6 only) Indicate whether the address range will be publicly advertised to the internet.
Default: true
string
A description for the address range and the address pool.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
list
The tags to apply to the address pool.
(dict) --
The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
ResourceType (string) --
The type of resource to tag on creation.
Tags (list) --
The tags to apply to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
boolean
Reserved.
string
If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.
You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:
us-east-1-dfw-2
us-west-2-lax-1
us-west-2-phx-2
dict
Response Syntax
{
'ByoipCidr': {
'Cidr': 'string',
'Description': 'string',
'AsnAssociations': [
{
'Asn': 'string',
'Cidr': 'string',
'StatusMessage': 'string',
'State': 'disassociated'|'failed-disassociation'|'failed-association'|'pending-disassociation'|'pending-association'|'associated'
},
],
'StatusMessage': 'string',
'State': 'advertised'|'deprovisioned'|'failed-deprovision'|'failed-provision'|'pending-deprovision'|'pending-provision'|'provisioned'|'provisioned-not-publicly-advertisable',
'NetworkBorderGroup': 'string'
}
}
Response Structure
(dict) --
ByoipCidr (dict) --
Information about the address range.
Cidr (string) --
The address range, in CIDR notation.
Description (string) --
The description of the address range.
AsnAssociations (list) --
The BYOIP CIDR associations with ASNs.
(dict) --
An Autonomous System Number (ASN) and BYOIP CIDR association.
Asn (string) --
The association's ASN.
Cidr (string) --
The association's CIDR.
StatusMessage (string) --
The association's status message.
State (string) --
The association's state.
StatusMessage (string) --
Upon success, contains the ID of the address pool. Otherwise, contains an error message.
State (string) --
The state of the address range.
advertised: The address range is being advertised to the internet by Amazon Web Services.
deprovisioned: The address range is deprovisioned.
failed-deprovision: The request to deprovision the address range was unsuccessful. Ensure that all EIPs from the range have been deallocated and try again.
failed-provision: The request to provision the address range was unsuccessful.
pending-deprovision: You’ve submitted a request to deprovision an address range and it's pending.
pending-provision: You’ve submitted a request to provision an address range and it's pending.
provisioned: The address range is provisioned and can be advertised. The range is not currently advertised.
provisioned-not-publicly-advertisable: The address range is provisioned and cannot be advertised.
NetworkBorderGroup (string) --
If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.
You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:
us-east-1-dfw-2
us-west-2-lax-1
us-west-2-phx-2
{'SpotFleetRequestConfig': {'LaunchSpecifications': {'TagSpecifications': {'ResourceType': {'outpost-lag',
'service-link-virtual-interface'}}},
'TagSpecifications': {'ResourceType': {'outpost-lag',
'service-link-virtual-interface'}}}}