2025/03/03 - Amazon Elastic Compute Cloud - 3 updated api methods
Changes Update the DescribeVpcs response
{'Vpc': {'EncryptionControl': {'Mode': 'monitor | enforce',
'ResourceExclusions': {'EgressOnlyInternetGateway': {'State': 'enabling '
'| '
'enabled '
'| '
'disabling '
'| '
'disabled',
'StateMessage': 'string'},
'InternetGateway': {'State': 'enabling '
'| '
'enabled '
'| '
'disabling '
'| '
'disabled',
'StateMessage': 'string'},
'NatGateway': {'State': 'enabling '
'| '
'enabled '
'| '
'disabling '
'| '
'disabled',
'StateMessage': 'string'},
'VirtualPrivateGateway': {'State': 'enabling '
'| '
'enabled '
'| '
'disabling '
'| '
'disabled',
'StateMessage': 'string'},
'VpcPeering': {'State': 'enabling '
'| '
'enabled '
'| '
'disabling '
'| '
'disabled',
'StateMessage': 'string'}},
'State': 'enforce-in-progress | '
'monitor-in-progress | enforce-failed '
'| monitor-failed | deleting | deleted '
'| available',
'StateMessage': 'string',
'Tags': [{'Key': 'string', 'Value': 'string'}],
'VpcEncryptionControlId': 'string',
'VpcId': 'string'}}}
Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet in each Availability Zone. For more information about the components of a default VPC, see Default VPCs in the Amazon VPC User Guide. You cannot specify the components of the default VPC yourself.
If you deleted your previous default VPC, you can create a default VPC. You cannot have more than one default VPC per Region.
See also: AWS API Documentation
Request Syntax
client.create_default_vpc(
DryRun=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.
dict
Response Syntax
{
'Vpc': {
'OwnerId': 'string',
'InstanceTenancy': 'default'|'dedicated'|'host',
'Ipv6CidrBlockAssociationSet': [
{
'AssociationId': 'string',
'Ipv6CidrBlock': 'string',
'Ipv6CidrBlockState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
'StatusMessage': 'string'
},
'NetworkBorderGroup': 'string',
'Ipv6Pool': 'string',
'Ipv6AddressAttribute': 'public'|'private',
'IpSource': 'amazon'|'byoip'|'none'
},
],
'CidrBlockAssociationSet': [
{
'AssociationId': 'string',
'CidrBlock': 'string',
'CidrBlockState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
'StatusMessage': 'string'
}
},
],
'IsDefault': True|False,
'EncryptionControl': {
'VpcId': 'string',
'VpcEncryptionControlId': 'string',
'Mode': 'monitor'|'enforce',
'State': 'enforce-in-progress'|'monitor-in-progress'|'enforce-failed'|'monitor-failed'|'deleting'|'deleted'|'available',
'StateMessage': 'string',
'ResourceExclusions': {
'InternetGateway': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'EgressOnlyInternetGateway': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'NatGateway': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'VirtualPrivateGateway': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'VpcPeering': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
}
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'BlockPublicAccessStates': {
'InternetGatewayBlockMode': 'off'|'block-bidirectional'|'block-ingress'
},
'VpcId': 'string',
'State': 'pending'|'available',
'CidrBlock': 'string',
'DhcpOptionsId': 'string'
}
}
Response Structure
(dict) --
Vpc (dict) --
Information about the VPC.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the VPC.
InstanceTenancy (string) --
The allowed tenancy of instances launched into the VPC.
Ipv6CidrBlockAssociationSet (list) --
Information about the IPv6 CIDR blocks associated with the VPC.
(dict) --
Describes an IPv6 CIDR block associated with a VPC.
AssociationId (string) --
The association ID for the IPv6 CIDR block.
Ipv6CidrBlock (string) --
The IPv6 CIDR block.
Ipv6CidrBlockState (dict) --
Information about the state of the CIDR block.
State (string) --
The state of the CIDR block.
StatusMessage (string) --
A message about the status of the CIDR block, if applicable.
NetworkBorderGroup (string) --
The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses, for example, us-east-1-wl1-bos-wlz-1.
Ipv6Pool (string) --
The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
Ipv6AddressAttribute (string) --
Public IPv6 addresses are those advertised on the internet from Amazon Web Services. Private IP addresses are not and cannot be advertised on the internet from Amazon Web Services.
IpSource (string) --
The source that allocated the IP address space. byoip or amazon indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). none indicates private space.
CidrBlockAssociationSet (list) --
Information about the IPv4 CIDR blocks associated with the VPC.
(dict) --
Describes an IPv4 CIDR block associated with a VPC.
AssociationId (string) --
The association ID for the IPv4 CIDR block.
CidrBlock (string) --
The IPv4 CIDR block.
CidrBlockState (dict) --
Information about the state of the CIDR block.
State (string) --
The state of the CIDR block.
StatusMessage (string) --
A message about the status of the CIDR block, if applicable.
IsDefault (boolean) --
Indicates whether the VPC is the default VPC.
EncryptionControl (dict) --
VpcId (string) --
VpcEncryptionControlId (string) --
Mode (string) --
State (string) --
StateMessage (string) --
ResourceExclusions (dict) --
InternetGateway (dict) --
State (string) --
StateMessage (string) --
EgressOnlyInternetGateway (dict) --
State (string) --
StateMessage (string) --
NatGateway (dict) --
State (string) --
StateMessage (string) --
VirtualPrivateGateway (dict) --
State (string) --
StateMessage (string) --
VpcPeering (dict) --
State (string) --
StateMessage (string) --
Tags (list) --
(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.
Tags (list) --
Any tags assigned to the VPC.
(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.
BlockPublicAccessStates (dict) --
The state of VPC Block Public Access (BPA).
InternetGatewayBlockMode (string) --
The mode of VPC BPA.
off: VPC BPA is not enabled and traffic is allowed to and from internet gateways and egress-only internet gateways in this Region.
block-bidirectional: Block all traffic to and from internet gateways and egress-only internet gateways in this Region (except for excluded VPCs and subnets).
block-ingress: Block all internet traffic to the VPCs in this Region (except for VPCs or subnets which are excluded). Only traffic to and from NAT gateways and egress-only internet gateways is allowed because these gateways only allow outbound connections to be established.
VpcId (string) --
The ID of the VPC.
State (string) --
The current state of the VPC.
CidrBlock (string) --
The primary IPv4 CIDR block for the VPC.
DhcpOptionsId (string) --
The ID of the set of DHCP options you've associated with the VPC.
{'Vpc': {'EncryptionControl': {'Mode': 'monitor | enforce',
'ResourceExclusions': {'EgressOnlyInternetGateway': {'State': 'enabling '
'| '
'enabled '
'| '
'disabling '
'| '
'disabled',
'StateMessage': 'string'},
'InternetGateway': {'State': 'enabling '
'| '
'enabled '
'| '
'disabling '
'| '
'disabled',
'StateMessage': 'string'},
'NatGateway': {'State': 'enabling '
'| '
'enabled '
'| '
'disabling '
'| '
'disabled',
'StateMessage': 'string'},
'VirtualPrivateGateway': {'State': 'enabling '
'| '
'enabled '
'| '
'disabling '
'| '
'disabled',
'StateMessage': 'string'},
'VpcPeering': {'State': 'enabling '
'| '
'enabled '
'| '
'disabling '
'| '
'disabled',
'StateMessage': 'string'}},
'State': 'enforce-in-progress | '
'monitor-in-progress | enforce-failed '
'| monitor-failed | deleting | deleted '
'| available',
'StateMessage': 'string',
'Tags': [{'Key': 'string', 'Value': 'string'}],
'VpcEncryptionControlId': 'string',
'VpcId': 'string'}}}
Creates a VPC with the specified CIDR blocks. For more information, see IP addressing for your VPCs and subnets in the Amazon VPC User Guide.
You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon's pool of IPv6 addresses or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses ( BYOIP).
By default, each instance that you launch in the VPC has the default DHCP options, which include only a default DNS server that we provide (AmazonProvidedDNS). For more information, see DHCP option sets in the Amazon VPC User Guide.
You can specify the instance tenancy value for the VPC when you create it. You can't change this value for the VPC after you create it. For more information, see Dedicated Instances in the Amazon EC2 User Guide.
See also: AWS API Documentation
Request Syntax
client.create_vpc(
CidrBlock='string',
Ipv6Pool='string',
Ipv6CidrBlock='string',
Ipv4IpamPoolId='string',
Ipv4NetmaskLength=123,
Ipv6IpamPoolId='string',
Ipv6NetmaskLength=123,
Ipv6CidrBlockNetworkBorderGroup='string',
TagSpecifications=[
{
'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'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'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'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'|'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,
InstanceTenancy='default'|'dedicated'|'host',
AmazonProvidedIpv6CidrBlock=True|False
)
string
The IPv4 network range for the VPC, in CIDR notation. For example, 10.0.0.0/16. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
string
The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.
string
The IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.
To let Amazon choose the IPv6 CIDR block for you, omit this parameter.
string
The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.
integer
The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.
string
The ID of an IPv6 IPAM pool which will be used to allocate this VPC an IPv6 CIDR. IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.
integer
The netmask length of the IPv6 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.
string
The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the address to this location.
You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.
list
The tags to assign to the VPC.
(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.
string
The tenancy options for instances launched into the VPC. For default, instances are launched with shared tenancy by default. You can launch instances with any tenancy into a shared tenancy VPC. For dedicated, instances are launched as dedicated tenancy instances by default. You can only launch instances with a tenancy of dedicated or host into a dedicated tenancy VPC.
Important: The host value cannot be used with this parameter. Use the default or dedicated values only.
Default: default
boolean
Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IP addresses, or the size of the CIDR block.
dict
Response Syntax
{
'Vpc': {
'OwnerId': 'string',
'InstanceTenancy': 'default'|'dedicated'|'host',
'Ipv6CidrBlockAssociationSet': [
{
'AssociationId': 'string',
'Ipv6CidrBlock': 'string',
'Ipv6CidrBlockState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
'StatusMessage': 'string'
},
'NetworkBorderGroup': 'string',
'Ipv6Pool': 'string',
'Ipv6AddressAttribute': 'public'|'private',
'IpSource': 'amazon'|'byoip'|'none'
},
],
'CidrBlockAssociationSet': [
{
'AssociationId': 'string',
'CidrBlock': 'string',
'CidrBlockState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
'StatusMessage': 'string'
}
},
],
'IsDefault': True|False,
'EncryptionControl': {
'VpcId': 'string',
'VpcEncryptionControlId': 'string',
'Mode': 'monitor'|'enforce',
'State': 'enforce-in-progress'|'monitor-in-progress'|'enforce-failed'|'monitor-failed'|'deleting'|'deleted'|'available',
'StateMessage': 'string',
'ResourceExclusions': {
'InternetGateway': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'EgressOnlyInternetGateway': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'NatGateway': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'VirtualPrivateGateway': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'VpcPeering': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
}
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'BlockPublicAccessStates': {
'InternetGatewayBlockMode': 'off'|'block-bidirectional'|'block-ingress'
},
'VpcId': 'string',
'State': 'pending'|'available',
'CidrBlock': 'string',
'DhcpOptionsId': 'string'
}
}
Response Structure
(dict) --
Vpc (dict) --
Information about the VPC.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the VPC.
InstanceTenancy (string) --
The allowed tenancy of instances launched into the VPC.
Ipv6CidrBlockAssociationSet (list) --
Information about the IPv6 CIDR blocks associated with the VPC.
(dict) --
Describes an IPv6 CIDR block associated with a VPC.
AssociationId (string) --
The association ID for the IPv6 CIDR block.
Ipv6CidrBlock (string) --
The IPv6 CIDR block.
Ipv6CidrBlockState (dict) --
Information about the state of the CIDR block.
State (string) --
The state of the CIDR block.
StatusMessage (string) --
A message about the status of the CIDR block, if applicable.
NetworkBorderGroup (string) --
The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses, for example, us-east-1-wl1-bos-wlz-1.
Ipv6Pool (string) --
The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
Ipv6AddressAttribute (string) --
Public IPv6 addresses are those advertised on the internet from Amazon Web Services. Private IP addresses are not and cannot be advertised on the internet from Amazon Web Services.
IpSource (string) --
The source that allocated the IP address space. byoip or amazon indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). none indicates private space.
CidrBlockAssociationSet (list) --
Information about the IPv4 CIDR blocks associated with the VPC.
(dict) --
Describes an IPv4 CIDR block associated with a VPC.
AssociationId (string) --
The association ID for the IPv4 CIDR block.
CidrBlock (string) --
The IPv4 CIDR block.
CidrBlockState (dict) --
Information about the state of the CIDR block.
State (string) --
The state of the CIDR block.
StatusMessage (string) --
A message about the status of the CIDR block, if applicable.
IsDefault (boolean) --
Indicates whether the VPC is the default VPC.
EncryptionControl (dict) --
VpcId (string) --
VpcEncryptionControlId (string) --
Mode (string) --
State (string) --
StateMessage (string) --
ResourceExclusions (dict) --
InternetGateway (dict) --
State (string) --
StateMessage (string) --
EgressOnlyInternetGateway (dict) --
State (string) --
StateMessage (string) --
NatGateway (dict) --
State (string) --
StateMessage (string) --
VirtualPrivateGateway (dict) --
State (string) --
StateMessage (string) --
VpcPeering (dict) --
State (string) --
StateMessage (string) --
Tags (list) --
(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.
Tags (list) --
Any tags assigned to the VPC.
(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.
BlockPublicAccessStates (dict) --
The state of VPC Block Public Access (BPA).
InternetGatewayBlockMode (string) --
The mode of VPC BPA.
off: VPC BPA is not enabled and traffic is allowed to and from internet gateways and egress-only internet gateways in this Region.
block-bidirectional: Block all traffic to and from internet gateways and egress-only internet gateways in this Region (except for excluded VPCs and subnets).
block-ingress: Block all internet traffic to the VPCs in this Region (except for VPCs or subnets which are excluded). Only traffic to and from NAT gateways and egress-only internet gateways is allowed because these gateways only allow outbound connections to be established.
VpcId (string) --
The ID of the VPC.
State (string) --
The current state of the VPC.
CidrBlock (string) --
The primary IPv4 CIDR block for the VPC.
DhcpOptionsId (string) --
The ID of the set of DHCP options you've associated with the VPC.
{'Vpcs': {'EncryptionControl': {'Mode': 'monitor | enforce',
'ResourceExclusions': {'EgressOnlyInternetGateway': {'State': 'enabling '
'| '
'enabled '
'| '
'disabling '
'| '
'disabled',
'StateMessage': 'string'},
'InternetGateway': {'State': 'enabling '
'| '
'enabled '
'| '
'disabling '
'| '
'disabled',
'StateMessage': 'string'},
'NatGateway': {'State': 'enabling '
'| '
'enabled '
'| '
'disabling '
'| '
'disabled',
'StateMessage': 'string'},
'VirtualPrivateGateway': {'State': 'enabling '
'| '
'enabled '
'| '
'disabling '
'| '
'disabled',
'StateMessage': 'string'},
'VpcPeering': {'State': 'enabling '
'| '
'enabled '
'| '
'disabling '
'| '
'disabled',
'StateMessage': 'string'}},
'State': 'enforce-in-progress | '
'monitor-in-progress | enforce-failed '
'| monitor-failed | deleting | '
'deleted | available',
'StateMessage': 'string',
'Tags': [{'Key': 'string', 'Value': 'string'}],
'VpcEncryptionControlId': 'string',
'VpcId': 'string'}}}
Describes your VPCs. The default is to describe all your VPCs. Alternatively, you can specify specific VPC IDs or filter the results to include only the VPCs that match specific criteria.
See also: AWS API Documentation
Request Syntax
client.describe_vpcs(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
VpcIds=[
'string',
],
NextToken='string',
MaxResults=123,
DryRun=True|False
)
list
The filters.
cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28).
cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC.
cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with the VPC.
cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC.
dhcp-options-id - The ID of a set of DHCP options.
ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC.
ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block associated with the VPC.
ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC.
is-default - Indicates whether the VPC is the default VPC.
owner-id - The ID of the Amazon Web Services account that owns the VPC.
state - The state of the VPC ( pending | available).
tag - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-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.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
list
The IDs of the VPCs.
(string) --
string
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
integer
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'NextToken': 'string',
'Vpcs': [
{
'OwnerId': 'string',
'InstanceTenancy': 'default'|'dedicated'|'host',
'Ipv6CidrBlockAssociationSet': [
{
'AssociationId': 'string',
'Ipv6CidrBlock': 'string',
'Ipv6CidrBlockState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
'StatusMessage': 'string'
},
'NetworkBorderGroup': 'string',
'Ipv6Pool': 'string',
'Ipv6AddressAttribute': 'public'|'private',
'IpSource': 'amazon'|'byoip'|'none'
},
],
'CidrBlockAssociationSet': [
{
'AssociationId': 'string',
'CidrBlock': 'string',
'CidrBlockState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
'StatusMessage': 'string'
}
},
],
'IsDefault': True|False,
'EncryptionControl': {
'VpcId': 'string',
'VpcEncryptionControlId': 'string',
'Mode': 'monitor'|'enforce',
'State': 'enforce-in-progress'|'monitor-in-progress'|'enforce-failed'|'monitor-failed'|'deleting'|'deleted'|'available',
'StateMessage': 'string',
'ResourceExclusions': {
'InternetGateway': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'EgressOnlyInternetGateway': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'NatGateway': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'VirtualPrivateGateway': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'VpcPeering': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
}
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'BlockPublicAccessStates': {
'InternetGatewayBlockMode': 'off'|'block-bidirectional'|'block-ingress'
},
'VpcId': 'string',
'State': 'pending'|'available',
'CidrBlock': 'string',
'DhcpOptionsId': '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.
Vpcs (list) --
Information about the VPCs.
(dict) --
Describes a VPC.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the VPC.
InstanceTenancy (string) --
The allowed tenancy of instances launched into the VPC.
Ipv6CidrBlockAssociationSet (list) --
Information about the IPv6 CIDR blocks associated with the VPC.
(dict) --
Describes an IPv6 CIDR block associated with a VPC.
AssociationId (string) --
The association ID for the IPv6 CIDR block.
Ipv6CidrBlock (string) --
The IPv6 CIDR block.
Ipv6CidrBlockState (dict) --
Information about the state of the CIDR block.
State (string) --
The state of the CIDR block.
StatusMessage (string) --
A message about the status of the CIDR block, if applicable.
NetworkBorderGroup (string) --
The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses, for example, us-east-1-wl1-bos-wlz-1.
Ipv6Pool (string) --
The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
Ipv6AddressAttribute (string) --
Public IPv6 addresses are those advertised on the internet from Amazon Web Services. Private IP addresses are not and cannot be advertised on the internet from Amazon Web Services.
IpSource (string) --
The source that allocated the IP address space. byoip or amazon indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). none indicates private space.
CidrBlockAssociationSet (list) --
Information about the IPv4 CIDR blocks associated with the VPC.
(dict) --
Describes an IPv4 CIDR block associated with a VPC.
AssociationId (string) --
The association ID for the IPv4 CIDR block.
CidrBlock (string) --
The IPv4 CIDR block.
CidrBlockState (dict) --
Information about the state of the CIDR block.
State (string) --
The state of the CIDR block.
StatusMessage (string) --
A message about the status of the CIDR block, if applicable.
IsDefault (boolean) --
Indicates whether the VPC is the default VPC.
EncryptionControl (dict) --
VpcId (string) --
VpcEncryptionControlId (string) --
Mode (string) --
State (string) --
StateMessage (string) --
ResourceExclusions (dict) --
InternetGateway (dict) --
State (string) --
StateMessage (string) --
EgressOnlyInternetGateway (dict) --
State (string) --
StateMessage (string) --
NatGateway (dict) --
State (string) --
StateMessage (string) --
VirtualPrivateGateway (dict) --
State (string) --
StateMessage (string) --
VpcPeering (dict) --
State (string) --
StateMessage (string) --
Tags (list) --
(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.
Tags (list) --
Any tags assigned to the VPC.
(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.
BlockPublicAccessStates (dict) --
The state of VPC Block Public Access (BPA).
InternetGatewayBlockMode (string) --
The mode of VPC BPA.
off: VPC BPA is not enabled and traffic is allowed to and from internet gateways and egress-only internet gateways in this Region.
block-bidirectional: Block all traffic to and from internet gateways and egress-only internet gateways in this Region (except for excluded VPCs and subnets).
block-ingress: Block all internet traffic to the VPCs in this Region (except for VPCs or subnets which are excluded). Only traffic to and from NAT gateways and egress-only internet gateways is allowed because these gateways only allow outbound connections to be established.
VpcId (string) --
The ID of the VPC.
State (string) --
The current state of the VPC.
CidrBlock (string) --
The primary IPv4 CIDR block for the VPC.
DhcpOptionsId (string) --
The ID of the set of DHCP options you've associated with the VPC.