2026/11/12 - Amazon Elastic Compute Cloud - 4 new 23 updated api methods
Changes This release adds support for multiple features, including EC2 Image Builder image recipes and container recipes in AMI usage reports, Amazon EC2 Detailed Monitoring adds opt-in metrics, and Global Accelerator and API Gateway V2 as resource exclusions for VPC Encryption Control.
Describes the specified metric categories, or all of your metric categories.
For more information, see Use metric categories for additional metrics in the Amazon EC2 User Guide.
See also: AWS API Documentation
Request Syntax
client.describe_metric_categories(
MetricCategoryIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
list
The IDs of the metric categories. If you specify IDs, you can't specify MaxResults or NextToken.
(string) --
list
The filters.
metric-name - The name of a metric in the metric category.
(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. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
Valid range: 5 - 100.
string
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
boolean
Checks whether you have the required permissions for the operation, 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
{
'MetricCategories': [
{
'MetricCategoryId': 'string',
'Metrics': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
MetricCategories (list) --
Information about the metric categories.
(dict) --
Describes a metric category. A metric category is a set of additional metrics that you can associate with an instance that has detailed monitoring enabled.
MetricCategoryId (string) --
The ID of the metric category.
Metrics (list) --
The names of the metrics in the metric category.
(string) --
Tags (list) --
Any tags assigned to the metric category.
(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 include in another request to get the next page of items. This value is null when there are no more items to return.
Deletes the specified metric category. Associations between the metric category and your instances are removed asynchronously.
For more information, see Use metric categories for additional metrics in the Amazon EC2 User Guide.
See also: AWS API Documentation
Request Syntax
client.delete_metric_category(
MetricCategoryId='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the metric category.
boolean
Checks whether you have the required permissions for the operation, 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
{
'MetricCategoryId': 'string'
}
Response Structure
(dict) --
MetricCategoryId (string) --
The ID of the metric category that was deleted.
Creates a metric category. A metric category is a set of additional metrics that you can associate with an instance that has detailed monitoring enabled.
For more information, see Use metric categories for additional metrics in the Amazon EC2 User Guide.
See also: AWS API Documentation
Request Syntax
client.create_metric_category(
Metrics=[
'string',
],
TagSpecifications=[
{
'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'image-usage-report'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-metering-policy'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'vpc-encryption-control'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task'|'ipam-prefix-list-resolver'|'ipam-policy'|'ipam-prefix-list-resolver-target'|'ipam-internet-registry-association'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator'|'ipam-pool-allocation'|'capacity-reservation-cancellation-quote'|'application-status-check'|'capacity-reservation-modification-quote'|'metric-category',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
ClientToken='string',
DryRun=True|False
)
list
[REQUIRED]
The names of the metrics to include in the metric category.
Specify each metric by its Amazon CloudWatch metric name or its OpenTelemetry metric name. The two names for a measurement are separate entries, and you can include both.
In Regions where Amazon CloudWatch OpenTelemetry metrics aren't available, you can't specify OpenTelemetry metric names.
(string) --
list
The tags to apply to the metric category during creation.
(dict) --
The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
ResourceType (string) --
The type of resource to tag on creation.
Tags (list) --
The tags to apply to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
This field is autopopulated if not provided.
boolean
Checks whether you have the required permissions for the operation, 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
{
'MetricCategory': {
'MetricCategoryId': 'string',
'Metrics': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
MetricCategory (dict) --
Information about the metric category.
MetricCategoryId (string) --
The ID of the metric category.
Metrics (list) --
The names of the metrics in the metric category.
(string) --
Tags (list) --
Any tags assigned to the metric category.
(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.
Modifies the metrics in the specified metric category. The metrics that you specify replace the existing metrics.
Instances that are associated with the metric category are updated asynchronously.
For more information, see Use metric categories for additional metrics in the Amazon EC2 User Guide.
See also: AWS API Documentation
Request Syntax
client.modify_metric_category(
MetricCategoryId='string',
Metrics=[
'string',
],
DryRun=True|False
)
string
[REQUIRED]
The ID of the metric category.
list
[REQUIRED]
The names of the metrics for the metric category. These metrics replace the existing metrics, and must differ from the current set.
Specify each metric by its Amazon CloudWatch metric name or its OpenTelemetry metric name. The two names for a measurement are separate entries, and you can include both.
In Regions where Amazon CloudWatch OpenTelemetry metrics aren't available, you can't specify OpenTelemetry metric names.
(string) --
boolean
Checks whether you have the required permissions for the operation, 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
{
'MetricCategory': {
'MetricCategoryId': 'string',
'Metrics': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
MetricCategory (dict) --
Information about the metric category.
MetricCategoryId (string) --
The ID of the metric category.
Metrics (list) --
The names of the metrics in the metric category.
(string) --
Tags (list) --
Any tags assigned to the metric category.
(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.
{'Vpc': {'EncryptionControl': {'ResourceExclusions': {'ApiGatewayV2': {'State': 'enabling '
'| '
'enabled '
'| '
'disabling '
'| '
'disabled',
'StateMessage': 'string'},
'GlobalAccelerator': {'State': 'enabling '
'| '
'enabled '
'| '
'disabling '
'| '
'disabled',
'StateMessage': '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'|'creating'|'delete-failed',
'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'
},
'Lambda': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'VpcLattice': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'ElasticFileSystem': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'GlobalAccelerator': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'ApiGatewayV2': {
'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'|'deleting',
'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) --
Describes the configuration and state of VPC encryption controls.
For more information, see Enforce VPC encryption in transit in the Amazon VPC User Guide.
VpcId (string) --
The ID of the VPC associated with the encryption control configuration.
VpcEncryptionControlId (string) --
The ID of the VPC Encryption Control configuration.
Mode (string) --
The encryption mode for the VPC Encryption Control configuration.
State (string) --
The current state of the VPC Encryption Control configuration.
StateMessage (string) --
A message providing additional information about the encryption control state.
ResourceExclusions (dict) --
Information about resource exclusions for the VPC Encryption Control configuration.
InternetGateway (dict) --
The exclusion configuration for internet gateway traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
EgressOnlyInternetGateway (dict) --
The exclusion configuration for egress-only internet gateway traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
NatGateway (dict) --
The exclusion configuration for NAT gateway traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
VirtualPrivateGateway (dict) --
The exclusion configuration for virtual private gateway traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
VpcPeering (dict) --
The exclusion configuration for VPC peering connection traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
Lambda (dict) --
The exclusion configuration for Lambda function traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
VpcLattice (dict) --
The exclusion configuration for VPC Lattice traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
ElasticFileSystem (dict) --
The exclusion configuration for Elastic File System traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
GlobalAccelerator (dict) --
The exclusion configuration for AWS Global Accelerator traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
ApiGatewayV2 (dict) --
The exclusion configuration for Amazon API Gateway V2 traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
Tags (list) --
The tags assigned to the VPC Encryption Control configuration.
(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.
{'LaunchTemplateData': {'Monitoring': {'MetricCategoryIds': ['string']},
'TagSpecifications': {'ResourceType': {'metric-category'}}}}
{'LaunchTemplateData': {'Monitoring': {'MetricCategoryIds': ['string']},
'TagSpecifications': {'ResourceType': {'metric-category'}}}}
Response {'LaunchTemplateVersion': {'LaunchTemplateData': {'Monitoring': {'MetricCategoryIds': ['string']},
'TagSpecifications': {'ResourceType': {'metric-category'}}}}}
{'VpcEncryptionControl': {'ApiGatewayV2Exclusion': 'enable | disable',
'GlobalAcceleratorExclusion': 'enable | disable'}}
Response {'Vpc': {'EncryptionControl': {'ResourceExclusions': {'ApiGatewayV2': {'State': 'enabling '
'| '
'enabled '
'| '
'disabling '
'| '
'disabled',
'StateMessage': 'string'},
'GlobalAccelerator': {'State': 'enabling '
'| '
'enabled '
'| '
'disabling '
'| '
'disabled',
'StateMessage': 'string'}}}}}
Creates a VPC with the specified CIDR blocks.
A VPC must have an associated IPv4 CIDR block. You can choose an IPv4 CIDR block or an IPAM-allocated IPv4 CIDR block. You can optionally associate an IPv6 CIDR block with a VPC. You can choose an IPv6 CIDR block, an Amazon-provided IPv6 CIDR block, an IPAM-allocated IPv6 CIDR block, or an IPv6 CIDR block that you brought to Amazon Web Services. For more information, see IP addressing for your VPCs and subnets in the Amazon VPC User Guide.
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 DNS options and tenancy for a VPC when you create it. You can't change the tenancy of a VPC after you create it. For more information, see VPC configuration options in the Amazon VPC 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',
VpcEncryptionControl={
'Mode': 'monitor'|'enforce',
'InternetGatewayExclusion': 'enable'|'disable',
'EgressOnlyInternetGatewayExclusion': 'enable'|'disable',
'NatGatewayExclusion': 'enable'|'disable',
'VirtualPrivateGatewayExclusion': 'enable'|'disable',
'VpcPeeringExclusion': 'enable'|'disable',
'LambdaExclusion': 'enable'|'disable',
'VpcLatticeExclusion': 'enable'|'disable',
'ElasticFileSystemExclusion': 'enable'|'disable',
'GlobalAcceleratorExclusion': 'enable'|'disable',
'ApiGatewayV2Exclusion': 'enable'|'disable'
},
TagSpecifications=[
{
'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'image-usage-report'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-metering-policy'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'vpc-encryption-control'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task'|'ipam-prefix-list-resolver'|'ipam-policy'|'ipam-prefix-list-resolver-target'|'ipam-internet-registry-association'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator'|'ipam-pool-allocation'|'capacity-reservation-cancellation-quote'|'application-status-check'|'capacity-reservation-modification-quote'|'metric-category',
'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.
dict
Specifies the encryption control configuration to apply to the VPC during creation. VPC Encryption Control enables you to enforce encryption for all data in transit within and between VPCs to meet compliance requirements.
For more information, see Enforce VPC encryption in transit in the Amazon VPC User Guide.
Mode (string) -- [REQUIRED]
The encryption mode for the VPC Encryption Control configuration.
InternetGatewayExclusion (string) --
Specifies whether to exclude internet gateway traffic from encryption enforcement.
EgressOnlyInternetGatewayExclusion (string) --
Specifies whether to exclude egress-only internet gateway traffic from encryption enforcement.
NatGatewayExclusion (string) --
Specifies whether to exclude NAT gateway traffic from encryption enforcement.
VirtualPrivateGatewayExclusion (string) --
Specifies whether to exclude virtual private gateway traffic from encryption enforcement.
VpcPeeringExclusion (string) --
Specifies whether to exclude VPC peering connection traffic from encryption enforcement.
LambdaExclusion (string) --
Specifies whether to exclude Lambda function traffic from encryption enforcement.
VpcLatticeExclusion (string) --
Specifies whether to exclude VPC Lattice traffic from encryption enforcement.
ElasticFileSystemExclusion (string) --
Specifies whether to exclude Elastic File System traffic from encryption enforcement.
GlobalAcceleratorExclusion (string) --
Specifies whether to exclude AWS Global Accelerator traffic from encryption enforcement.
ApiGatewayV2Exclusion (string) --
Specifies whether to exclude Amazon API Gateway V2 traffic from encryption enforcement.
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'|'creating'|'delete-failed',
'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'
},
'Lambda': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'VpcLattice': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'ElasticFileSystem': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'GlobalAccelerator': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'ApiGatewayV2': {
'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'|'deleting',
'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) --
Describes the configuration and state of VPC encryption controls.
For more information, see Enforce VPC encryption in transit in the Amazon VPC User Guide.
VpcId (string) --
The ID of the VPC associated with the encryption control configuration.
VpcEncryptionControlId (string) --
The ID of the VPC Encryption Control configuration.
Mode (string) --
The encryption mode for the VPC Encryption Control configuration.
State (string) --
The current state of the VPC Encryption Control configuration.
StateMessage (string) --
A message providing additional information about the encryption control state.
ResourceExclusions (dict) --
Information about resource exclusions for the VPC Encryption Control configuration.
InternetGateway (dict) --
The exclusion configuration for internet gateway traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
EgressOnlyInternetGateway (dict) --
The exclusion configuration for egress-only internet gateway traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
NatGateway (dict) --
The exclusion configuration for NAT gateway traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
VirtualPrivateGateway (dict) --
The exclusion configuration for virtual private gateway traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
VpcPeering (dict) --
The exclusion configuration for VPC peering connection traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
Lambda (dict) --
The exclusion configuration for Lambda function traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
VpcLattice (dict) --
The exclusion configuration for VPC Lattice traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
ElasticFileSystem (dict) --
The exclusion configuration for Elastic File System traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
GlobalAccelerator (dict) --
The exclusion configuration for AWS Global Accelerator traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
ApiGatewayV2 (dict) --
The exclusion configuration for Amazon API Gateway V2 traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
Tags (list) --
The tags assigned to the VPC Encryption Control configuration.
(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.
{'VpcEncryptionControl': {'ResourceExclusions': {'ApiGatewayV2': {'State': 'enabling '
'| '
'enabled '
'| '
'disabling '
'| '
'disabled',
'StateMessage': 'string'},
'GlobalAccelerator': {'State': 'enabling '
'| '
'enabled '
'| '
'disabling '
'| '
'disabled',
'StateMessage': 'string'}}}}
Creates a VPC Encryption Control configuration for a specified VPC. VPC Encryption Control enables you to enforce encryption for all data in transit within and between VPCs to meet compliance requirements for standards like HIPAA, FedRAMP, and PCI DSS.
For more information, see Enforce VPC encryption in transit in the Amazon VPC User Guide.
See also: AWS API Documentation
Request Syntax
client.create_vpc_encryption_control(
DryRun=True|False,
VpcId='string',
TagSpecifications=[
{
'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'image-usage-report'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-metering-policy'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'vpc-encryption-control'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task'|'ipam-prefix-list-resolver'|'ipam-policy'|'ipam-prefix-list-resolver-target'|'ipam-internet-registry-association'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator'|'ipam-pool-allocation'|'capacity-reservation-cancellation-quote'|'application-status-check'|'capacity-reservation-modification-quote'|'metric-category',
'Tags': [
{
'Key': 'string',
'Value': '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.
string
[REQUIRED]
The ID of the VPC for which to create the encryption control configuration.
list
The tags to apply to the VPC Encryption Control resource.
(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.
dict
Response Syntax
{
'VpcEncryptionControl': {
'VpcId': 'string',
'VpcEncryptionControlId': 'string',
'Mode': 'monitor'|'enforce',
'State': 'enforce-in-progress'|'monitor-in-progress'|'enforce-failed'|'monitor-failed'|'deleting'|'deleted'|'available'|'creating'|'delete-failed',
'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'
},
'Lambda': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'VpcLattice': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'ElasticFileSystem': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'GlobalAccelerator': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'ApiGatewayV2': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
}
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
VpcEncryptionControl (dict) --
Information about the VPC Encryption Control configuration.
VpcId (string) --
The ID of the VPC associated with the encryption control configuration.
VpcEncryptionControlId (string) --
The ID of the VPC Encryption Control configuration.
Mode (string) --
The encryption mode for the VPC Encryption Control configuration.
State (string) --
The current state of the VPC Encryption Control configuration.
StateMessage (string) --
A message providing additional information about the encryption control state.
ResourceExclusions (dict) --
Information about resource exclusions for the VPC Encryption Control configuration.
InternetGateway (dict) --
The exclusion configuration for internet gateway traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
EgressOnlyInternetGateway (dict) --
The exclusion configuration for egress-only internet gateway traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
NatGateway (dict) --
The exclusion configuration for NAT gateway traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
VirtualPrivateGateway (dict) --
The exclusion configuration for virtual private gateway traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
VpcPeering (dict) --
The exclusion configuration for VPC peering connection traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
Lambda (dict) --
The exclusion configuration for Lambda function traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
VpcLattice (dict) --
The exclusion configuration for VPC Lattice traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
ElasticFileSystem (dict) --
The exclusion configuration for Elastic File System traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
GlobalAccelerator (dict) --
The exclusion configuration for AWS Global Accelerator traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
ApiGatewayV2 (dict) --
The exclusion configuration for Amazon API Gateway V2 traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
Tags (list) --
The tags assigned to the VPC Encryption Control configuration.
(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.
{'VpcEncryptionControl': {'ResourceExclusions': {'ApiGatewayV2': {'State': 'enabling '
'| '
'enabled '
'| '
'disabling '
'| '
'disabled',
'StateMessage': 'string'},
'GlobalAccelerator': {'State': 'enabling '
'| '
'enabled '
'| '
'disabling '
'| '
'disabled',
'StateMessage': 'string'}}}}
Deletes a VPC Encryption Control configuration. This removes the encryption policy enforcement from the specified VPC.
For more information, see Enforce VPC encryption in transit in the Amazon VPC User Guide.
See also: AWS API Documentation
Request Syntax
client.delete_vpc_encryption_control(
DryRun=True|False,
VpcEncryptionControlId='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.
string
[REQUIRED]
The ID of the VPC Encryption Control resource to delete.
dict
Response Syntax
{
'VpcEncryptionControl': {
'VpcId': 'string',
'VpcEncryptionControlId': 'string',
'Mode': 'monitor'|'enforce',
'State': 'enforce-in-progress'|'monitor-in-progress'|'enforce-failed'|'monitor-failed'|'deleting'|'deleted'|'available'|'creating'|'delete-failed',
'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'
},
'Lambda': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'VpcLattice': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'ElasticFileSystem': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'GlobalAccelerator': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'ApiGatewayV2': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
}
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
VpcEncryptionControl (dict) --
Information about the deleted VPC Encryption Control configuration.
VpcId (string) --
The ID of the VPC associated with the encryption control configuration.
VpcEncryptionControlId (string) --
The ID of the VPC Encryption Control configuration.
Mode (string) --
The encryption mode for the VPC Encryption Control configuration.
State (string) --
The current state of the VPC Encryption Control configuration.
StateMessage (string) --
A message providing additional information about the encryption control state.
ResourceExclusions (dict) --
Information about resource exclusions for the VPC Encryption Control configuration.
InternetGateway (dict) --
The exclusion configuration for internet gateway traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
EgressOnlyInternetGateway (dict) --
The exclusion configuration for egress-only internet gateway traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
NatGateway (dict) --
The exclusion configuration for NAT gateway traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
VirtualPrivateGateway (dict) --
The exclusion configuration for virtual private gateway traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
VpcPeering (dict) --
The exclusion configuration for VPC peering connection traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
Lambda (dict) --
The exclusion configuration for Lambda function traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
VpcLattice (dict) --
The exclusion configuration for VPC Lattice traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
ElasticFileSystem (dict) --
The exclusion configuration for Elastic File System traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
GlobalAccelerator (dict) --
The exclusion configuration for AWS Global Accelerator traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
ApiGatewayV2 (dict) --
The exclusion configuration for Amazon API Gateway V2 traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
Tags (list) --
The tags assigned to the VPC Encryption Control configuration.
(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.
{'AccountVpcEncryptionControl': {'Exclusions': {'ApiGatewayV2': 'enabling | '
'enabled | '
'disabling | '
'disabled',
'GlobalAccelerator': 'enabling '
'| '
'enabled '
'| '
'disabling '
'| '
'disabled'}}}
Describes the account-level VPC Encryption Control configuration for your account. VPC Encryption Control enables you to enforce encryption for all data in transit within and between VPCs to meet compliance requirements.
For more information, see Enforce VPC encryption in transit in the Amazon VPC User Guide.
See also: AWS API Documentation
Request Syntax
client.describe_account_vpc_encryption_control(
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
{
'AccountVpcEncryptionControl': {
'State': 'default-state'|'transitions-in-progress'|'transitions-partially-successful'|'transitions-successful'|'transitions-failed',
'Mode': 'unmanaged'|'attempt-monitor'|'attempt-enforce',
'Exclusions': {
'InternetGateway': 'enabling'|'enabled'|'disabling'|'disabled',
'EgressOnlyInternetGateway': 'enabling'|'enabled'|'disabling'|'disabled',
'NatGateway': 'enabling'|'enabled'|'disabling'|'disabled',
'VirtualPrivateGateway': 'enabling'|'enabled'|'disabling'|'disabled',
'VpcPeering': 'enabling'|'enabled'|'disabling'|'disabled',
'Lambda': 'enabling'|'enabled'|'disabling'|'disabled',
'VpcLattice': 'enabling'|'enabled'|'disabling'|'disabled',
'ElasticFileSystem': 'enabling'|'enabled'|'disabling'|'disabled',
'GlobalAccelerator': 'enabling'|'enabled'|'disabling'|'disabled',
'ApiGatewayV2': 'enabling'|'enabled'|'disabling'|'disabled'
},
'ManagedBy': 'account'|'declarative-policy',
'LastUpdateTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
AccountVpcEncryptionControl (dict) --
Information about the account-level VPC Encryption Control configuration.
State (string) --
The current state of the account-level VPC Encryption Control configuration.
Mode (string) --
The encryption mode for the account-level VPC Encryption Control configuration.
Exclusions (dict) --
Information about the traffic exclusions for the account-level VPC Encryption Control configuration.
InternetGateway (string) --
The exclusion configuration for internet gateway resource.
EgressOnlyInternetGateway (string) --
The exclusion configuration for egress-only internet gateway resource.
NatGateway (string) --
The exclusion configuration for NAT gateway resource.
VirtualPrivateGateway (string) --
The exclusion configuration for virtual private gateway resource.
VpcPeering (string) --
The exclusion configuration for VPC peering connection resource.
Lambda (string) --
The exclusion configuration for Lambda service.
VpcLattice (string) --
The exclusion configuration for VPC Lattice service.
ElasticFileSystem (string) --
The exclusion configuration for Elastic File System service.
GlobalAccelerator (string) --
The exclusion configuration for AWS Global Accelerator.
ApiGatewayV2 (string) --
The exclusion configuration for Amazon API Gateway V2.
ManagedBy (string) --
The entity that manages the account-level VPC Encryption Control configuration.
LastUpdateTimestamp (datetime) --
The date and time when the account-level VPC Encryption Control configuration was last updated.
{'Reservations': {'Instances': {'Monitoring': {'MetricCategoryIds': ['string']}}}}
{'LaunchTemplateVersions': {'LaunchTemplateData': {'Monitoring': {'MetricCategoryIds': ['string']},
'TagSpecifications': {'ResourceType': {'metric-category'}}}}}
{'SpotFleetRequestConfigs': {'SpotFleetRequestConfig': {'LaunchSpecifications': {'TagSpecifications': {'ResourceType': {'metric-category'}}},
'TagSpecifications': {'ResourceType': {'metric-category'}}}}}
{'SpotInstanceRequests': {'LaunchSpecification': {'Monitoring': {'MetricCategoryIds': ['string']}}}}
{'Tags': {'ResourceType': {'metric-category'}}}
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'|'image-usage-report'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-metering-policy'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'vpc-encryption-control'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task'|'ipam-prefix-list-resolver'|'ipam-policy'|'ipam-prefix-list-resolver-target'|'ipam-internet-registry-association'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator'|'ipam-pool-allocation'|'capacity-reservation-cancellation-quote'|'application-status-check'|'capacity-reservation-modification-quote'|'metric-category',
'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.
{'VpcEncryptionControls': {'ResourceExclusions': {'ApiGatewayV2': {'State': 'enabling '
'| '
'enabled '
'| '
'disabling '
'| '
'disabled',
'StateMessage': 'string'},
'GlobalAccelerator': {'State': 'enabling '
'| '
'enabled '
'| '
'disabling '
'| '
'disabled',
'StateMessage': 'string'}}}}
Describes one or more VPC Encryption Control configurations. VPC Encryption Control enables you to enforce encryption for all data in transit within and between VPCs to meet compliance requirements You can filter the results to return information about specific encryption controls or VPCs.
For more information, see Enforce VPC encryption in transit in the Amazon VPC User Guide.
See also: AWS API Documentation
Request Syntax
client.describe_vpc_encryption_controls(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
VpcEncryptionControlIds=[
'string',
],
VpcIds=[
'string',
],
NextToken='string',
MaxResults=123
)
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 to apply to the request.
(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 VPC Encryption Control configurations to describe.
(string) --
list
The IDs of the VPCs to describe encryption control configurations for.
(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.
dict
Response Syntax
{
'VpcEncryptionControls': [
{
'VpcId': 'string',
'VpcEncryptionControlId': 'string',
'Mode': 'monitor'|'enforce',
'State': 'enforce-in-progress'|'monitor-in-progress'|'enforce-failed'|'monitor-failed'|'deleting'|'deleted'|'available'|'creating'|'delete-failed',
'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'
},
'Lambda': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'VpcLattice': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'ElasticFileSystem': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'GlobalAccelerator': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'ApiGatewayV2': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
}
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
VpcEncryptionControls (list) --
Information about the VPC Encryption Control configurations.
(dict) --
Describes the configuration and state of VPC encryption controls.
For more information, see Enforce VPC encryption in transit in the Amazon VPC User Guide.
VpcId (string) --
The ID of the VPC associated with the encryption control configuration.
VpcEncryptionControlId (string) --
The ID of the VPC Encryption Control configuration.
Mode (string) --
The encryption mode for the VPC Encryption Control configuration.
State (string) --
The current state of the VPC Encryption Control configuration.
StateMessage (string) --
A message providing additional information about the encryption control state.
ResourceExclusions (dict) --
Information about resource exclusions for the VPC Encryption Control configuration.
InternetGateway (dict) --
The exclusion configuration for internet gateway traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
EgressOnlyInternetGateway (dict) --
The exclusion configuration for egress-only internet gateway traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
NatGateway (dict) --
The exclusion configuration for NAT gateway traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
VirtualPrivateGateway (dict) --
The exclusion configuration for virtual private gateway traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
VpcPeering (dict) --
The exclusion configuration for VPC peering connection traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
Lambda (dict) --
The exclusion configuration for Lambda function traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
VpcLattice (dict) --
The exclusion configuration for VPC Lattice traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
ElasticFileSystem (dict) --
The exclusion configuration for Elastic File System traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
GlobalAccelerator (dict) --
The exclusion configuration for AWS Global Accelerator traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
ApiGatewayV2 (dict) --
The exclusion configuration for Amazon API Gateway V2 traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
Tags (list) --
The tags assigned to the VPC Encryption Control configuration.
(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 include in another request to get the next page of items. This value is null when there are no more items to return.
{'Vpcs': {'EncryptionControl': {'ResourceExclusions': {'ApiGatewayV2': {'State': 'enabling '
'| '
'enabled '
'| '
'disabling '
'| '
'disabled',
'StateMessage': 'string'},
'GlobalAccelerator': {'State': 'enabling '
'| '
'enabled '
'| '
'disabling '
'| '
'disabled',
'StateMessage': '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'|'creating'|'delete-failed',
'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'
},
'Lambda': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'VpcLattice': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'ElasticFileSystem': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'GlobalAccelerator': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'ApiGatewayV2': {
'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'|'deleting',
'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) --
Describes the configuration and state of VPC encryption controls.
For more information, see Enforce VPC encryption in transit in the Amazon VPC User Guide.
VpcId (string) --
The ID of the VPC associated with the encryption control configuration.
VpcEncryptionControlId (string) --
The ID of the VPC Encryption Control configuration.
Mode (string) --
The encryption mode for the VPC Encryption Control configuration.
State (string) --
The current state of the VPC Encryption Control configuration.
StateMessage (string) --
A message providing additional information about the encryption control state.
ResourceExclusions (dict) --
Information about resource exclusions for the VPC Encryption Control configuration.
InternetGateway (dict) --
The exclusion configuration for internet gateway traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
EgressOnlyInternetGateway (dict) --
The exclusion configuration for egress-only internet gateway traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
NatGateway (dict) --
The exclusion configuration for NAT gateway traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
VirtualPrivateGateway (dict) --
The exclusion configuration for virtual private gateway traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
VpcPeering (dict) --
The exclusion configuration for VPC peering connection traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
Lambda (dict) --
The exclusion configuration for Lambda function traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
VpcLattice (dict) --
The exclusion configuration for VPC Lattice traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
ElasticFileSystem (dict) --
The exclusion configuration for Elastic File System traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
GlobalAccelerator (dict) --
The exclusion configuration for AWS Global Accelerator traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
ApiGatewayV2 (dict) --
The exclusion configuration for Amazon API Gateway V2 traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
Tags (list) --
The tags assigned to the VPC Encryption Control configuration.
(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.
{'LaunchTemplateData': {'Monitoring': {'MetricCategoryIds': ['string']},
'TagSpecifications': {'ResourceType': {'metric-category'}}}}
{'ApiGatewayV2': 'enable | disable', 'GlobalAccelerator': 'enable | disable'}
Response {'AccountVpcEncryptionControl': {'Exclusions': {'ApiGatewayV2': 'enabling | '
'enabled | '
'disabling | '
'disabled',
'GlobalAccelerator': 'enabling '
'| '
'enabled '
'| '
'disabling '
'| '
'disabled'}}}
Modifies the account-level VPC Encryption Control configuration. This sets the encryption control mode and resource exclusions that apply to the VPCs in your account. VPC Encryption Control enables you to enforce encryption for all data in transit within and between VPCs to meet compliance requirements.
For more information, see Enforce VPC encryption in transit in the Amazon VPC User Guide.
See also: AWS API Documentation
Request Syntax
client.modify_account_vpc_encryption_control(
DryRun=True|False,
Mode='unmanaged'|'attempt-monitor'|'attempt-enforce',
InternetGateway='enable'|'disable',
EgressOnlyInternetGateway='enable'|'disable',
NatGateway='enable'|'disable',
VirtualPrivateGateway='enable'|'disable',
VpcPeering='enable'|'disable',
Lambda='enable'|'disable',
VpcLattice='enable'|'disable',
ElasticFileSystem='enable'|'disable',
GlobalAccelerator='enable'|'disable',
ApiGatewayV2='enable'|'disable'
)
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 encryption mode for the account encryption control configuration.
string
Specifies whether to exclude internet gateway resource from account-level encryption enforcement.
string
Specifies whether to exclude egress-only internet gateway resource from account-level encryption enforcement.
string
Specifies whether to exclude NAT gateway resource from account-level encryption enforcement.
string
Specifies whether to exclude virtual private gateway resource from account-level encryption enforcement.
string
Specifies whether to exclude VPC peering connection resource from account-level encryption enforcement.
string
Specifies whether to exclude Lambda service from account-level encryption enforcement.
string
Specifies whether to exclude VPC Lattice service from account-level encryption enforcement.
string
Specifies whether to exclude Elastic File System service from account-level encryption enforcement.
string
Specifies whether to exclude AWS Global Accelerator from account-level encryption enforcement.
string
Specifies whether to exclude Amazon API Gateway V2 from account-level encryption enforcement.
dict
Response Syntax
{
'AccountVpcEncryptionControl': {
'State': 'default-state'|'transitions-in-progress'|'transitions-partially-successful'|'transitions-successful'|'transitions-failed',
'Mode': 'unmanaged'|'attempt-monitor'|'attempt-enforce',
'Exclusions': {
'InternetGateway': 'enabling'|'enabled'|'disabling'|'disabled',
'EgressOnlyInternetGateway': 'enabling'|'enabled'|'disabling'|'disabled',
'NatGateway': 'enabling'|'enabled'|'disabling'|'disabled',
'VirtualPrivateGateway': 'enabling'|'enabled'|'disabling'|'disabled',
'VpcPeering': 'enabling'|'enabled'|'disabling'|'disabled',
'Lambda': 'enabling'|'enabled'|'disabling'|'disabled',
'VpcLattice': 'enabling'|'enabled'|'disabling'|'disabled',
'ElasticFileSystem': 'enabling'|'enabled'|'disabling'|'disabled',
'GlobalAccelerator': 'enabling'|'enabled'|'disabling'|'disabled',
'ApiGatewayV2': 'enabling'|'enabled'|'disabling'|'disabled'
},
'ManagedBy': 'account'|'declarative-policy',
'LastUpdateTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
AccountVpcEncryptionControl (dict) --
Information about the account-level VPC Encryption Control configuration.
State (string) --
The current state of the account-level VPC Encryption Control configuration.
Mode (string) --
The encryption mode for the account-level VPC Encryption Control configuration.
Exclusions (dict) --
Information about the traffic exclusions for the account-level VPC Encryption Control configuration.
InternetGateway (string) --
The exclusion configuration for internet gateway resource.
EgressOnlyInternetGateway (string) --
The exclusion configuration for egress-only internet gateway resource.
NatGateway (string) --
The exclusion configuration for NAT gateway resource.
VirtualPrivateGateway (string) --
The exclusion configuration for virtual private gateway resource.
VpcPeering (string) --
The exclusion configuration for VPC peering connection resource.
Lambda (string) --
The exclusion configuration for Lambda service.
VpcLattice (string) --
The exclusion configuration for VPC Lattice service.
ElasticFileSystem (string) --
The exclusion configuration for Elastic File System service.
GlobalAccelerator (string) --
The exclusion configuration for AWS Global Accelerator.
ApiGatewayV2 (string) --
The exclusion configuration for Amazon API Gateway V2.
ManagedBy (string) --
The entity that manages the account-level VPC Encryption Control configuration.
LastUpdateTimestamp (datetime) --
The date and time when the account-level VPC Encryption Control configuration was last updated.
{'ApiGatewayV2Exclusion': 'enable | disable',
'GlobalAcceleratorExclusion': 'enable | disable'}
Response {'VpcEncryptionControl': {'ResourceExclusions': {'ApiGatewayV2': {'State': 'enabling '
'| '
'enabled '
'| '
'disabling '
'| '
'disabled',
'StateMessage': 'string'},
'GlobalAccelerator': {'State': 'enabling '
'| '
'enabled '
'| '
'disabling '
'| '
'disabled',
'StateMessage': 'string'}}}}
Modifies the encryption control configuration for a VPC. You can update the encryption mode and exclusion settings for various gateway types and peering connections.
For more information, see Enforce VPC encryption in transit in the Amazon VPC User Guide.
See also: AWS API Documentation
Request Syntax
client.modify_vpc_encryption_control(
DryRun=True|False,
VpcEncryptionControlId='string',
Mode='monitor'|'enforce',
InternetGatewayExclusion='enable'|'disable',
EgressOnlyInternetGatewayExclusion='enable'|'disable',
NatGatewayExclusion='enable'|'disable',
VirtualPrivateGatewayExclusion='enable'|'disable',
VpcPeeringExclusion='enable'|'disable',
LambdaExclusion='enable'|'disable',
VpcLatticeExclusion='enable'|'disable',
ElasticFileSystemExclusion='enable'|'disable',
GlobalAcceleratorExclusion='enable'|'disable',
ApiGatewayV2Exclusion='enable'|'disable'
)
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
[REQUIRED]
The ID of the VPC Encryption Control resource to modify.
string
The encryption mode for the VPC Encryption Control configuration.
string
Specifies whether to exclude internet gateway traffic from encryption enforcement.
string
Specifies whether to exclude egress-only internet gateway traffic from encryption enforcement.
string
Specifies whether to exclude NAT gateway traffic from encryption enforcement.
string
Specifies whether to exclude virtual private gateway traffic from encryption enforcement.
string
Specifies whether to exclude VPC peering connection traffic from encryption enforcement.
string
Specifies whether to exclude Lambda function traffic from encryption enforcement.
string
Specifies whether to exclude VPC Lattice traffic from encryption enforcement.
string
Specifies whether to exclude Elastic File System traffic from encryption enforcement.
string
Specifies whether to exclude AWS Global Accelerator traffic from encryption enforcement.
string
Specifies whether to exclude Amazon API Gateway V2 traffic from encryption enforcement.
dict
Response Syntax
{
'VpcEncryptionControl': {
'VpcId': 'string',
'VpcEncryptionControlId': 'string',
'Mode': 'monitor'|'enforce',
'State': 'enforce-in-progress'|'monitor-in-progress'|'enforce-failed'|'monitor-failed'|'deleting'|'deleted'|'available'|'creating'|'delete-failed',
'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'
},
'Lambda': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'VpcLattice': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'ElasticFileSystem': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'GlobalAccelerator': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'ApiGatewayV2': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
}
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
VpcEncryptionControl (dict) --
Information about the VPC Encryption Control configuration.
VpcId (string) --
The ID of the VPC associated with the encryption control configuration.
VpcEncryptionControlId (string) --
The ID of the VPC Encryption Control configuration.
Mode (string) --
The encryption mode for the VPC Encryption Control configuration.
State (string) --
The current state of the VPC Encryption Control configuration.
StateMessage (string) --
A message providing additional information about the encryption control state.
ResourceExclusions (dict) --
Information about resource exclusions for the VPC Encryption Control configuration.
InternetGateway (dict) --
The exclusion configuration for internet gateway traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
EgressOnlyInternetGateway (dict) --
The exclusion configuration for egress-only internet gateway traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
NatGateway (dict) --
The exclusion configuration for NAT gateway traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
VirtualPrivateGateway (dict) --
The exclusion configuration for virtual private gateway traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
VpcPeering (dict) --
The exclusion configuration for VPC peering connection traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
Lambda (dict) --
The exclusion configuration for Lambda function traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
VpcLattice (dict) --
The exclusion configuration for VPC Lattice traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
ElasticFileSystem (dict) --
The exclusion configuration for Elastic File System traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
GlobalAccelerator (dict) --
The exclusion configuration for AWS Global Accelerator traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
ApiGatewayV2 (dict) --
The exclusion configuration for Amazon API Gateway V2 traffic.
State (string) --
The current state of the exclusion configuration.
StateMessage (string) --
A message providing additional information about the exclusion state.
Tags (list) --
The tags assigned to the VPC Encryption Control configuration.
(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.
{'MetricCategoryIds': ['string']}
Response {'InstanceMonitorings': {'Monitoring': {'MetricCategoryIds': ['string']}}}
Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitor your instances using CloudWatch in the Amazon EC2 User Guide.
To disable detailed monitoring, see UnmonitorInstances.
See also: AWS API Documentation
Request Syntax
client.monitor_instances(
InstanceIds=[
'string',
],
MetricCategoryIds=[
'string',
],
DryRun=True|False
)
list
[REQUIRED]
The IDs of the instances.
(string) --
list
The IDs of the metric categories to associate with the instances. The specified metric categories are added to any metric categories that are already associated with the instances.
(string) --
boolean
Checks whether you have the required permissions for the operation, 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
{
'InstanceMonitorings': [
{
'InstanceId': 'string',
'Monitoring': {
'MetricCategoryIds': [
'string',
],
'State': 'disabled'|'disabling'|'enabled'|'pending'
}
},
]
}
Response Structure
(dict) --
InstanceMonitorings (list) --
The monitoring information.
(dict) --
Describes the monitoring of an instance.
InstanceId (string) --
The ID of the instance.
Monitoring (dict) --
The monitoring for the instance.
MetricCategoryIds (list) --
The IDs of the metric categories that are associated with the instance.
(string) --
State (string) --
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
{'PoolTagSpecifications': {'ResourceType': {'metric-category'}}}
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.
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 the Amazon Web Services GovCloud (US) Regions, authorize only ASN 8987. For the Amazon Web Services European Sovereign Cloud, authorize ASNs 16509 and 214101. 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. For more information, see Onboard your address range.
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'|'image-usage-report'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-metering-policy'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'vpc-encryption-control'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task'|'ipam-prefix-list-resolver'|'ipam-policy'|'ipam-prefix-list-resolver-target'|'ipam-internet-registry-association'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator'|'ipam-pool-allocation'|'capacity-reservation-cancellation-quote'|'application-status-check'|'capacity-reservation-modification-quote'|'metric-category',
'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-advertising'|'pending-deprovision'|'pending-provision'|'pending-withdrawal'|'provisioned'|'provisioned-not-publicly-advertisable',
'NetworkBorderGroup': 'string',
'AdvertisementType': 'string',
'PoolId': 'string',
'IpamPoolId': '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
AdvertisementType (string) --
Specifies the advertisement method for the BYOIP CIDR. Valid values are:
unicast: IP is advertised from a single location (regional services like EC2)
anycast: IP is advertised from multiple global locations simultaneously (global services like CloudFront)
For more information, see Bring your own IP to CloudFront using IPAM in the Amazon VPC IPAM User Guide.
PoolId (string) --
The ID of the address pool associated with the CIDR.
IpamPoolId (string) --
The ID of the IPAM pool associated with the CIDR.
{'SpotFleetRequestConfig': {'LaunchSpecifications': {'TagSpecifications': {'ResourceType': {'metric-category'}}},
'TagSpecifications': {'ResourceType': {'metric-category'}}}}
{'LaunchSpecification': {'Monitoring': {'MetricCategoryIds': ['string']}}}
Response {'SpotInstanceRequests': {'LaunchSpecification': {'Monitoring': {'MetricCategoryIds': ['string']}}}}
{'Monitoring': {'MetricCategoryIds': ['string']}}
Response {'Instances': {'Monitoring': {'MetricCategoryIds': ['string']}}}
{'MetricCategoryIds': ['string']}
Response {'InstanceMonitorings': {'Monitoring': {'MetricCategoryIds': ['string']}}}
Disables detailed monitoring for a running instance. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide.
See also: AWS API Documentation
Request Syntax
client.unmonitor_instances(
InstanceIds=[
'string',
],
MetricCategoryIds=[
'string',
],
DryRun=True|False
)
list
[REQUIRED]
The IDs of the instances.
(string) --
list
The IDs of the metric categories to remove from the instances. If you specify metric categories, only those metric categories are removed and detailed monitoring remains enabled. If you don't specify metric categories, detailed monitoring and all metric categories are turned off.
(string) --
boolean
Checks whether you have the required permissions for the operation, 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
{
'InstanceMonitorings': [
{
'InstanceId': 'string',
'Monitoring': {
'MetricCategoryIds': [
'string',
],
'State': 'disabled'|'disabling'|'enabled'|'pending'
}
},
]
}
Response Structure
(dict) --
InstanceMonitorings (list) --
The monitoring information.
(dict) --
Describes the monitoring of an instance.
InstanceId (string) --
The ID of the instance.
Monitoring (dict) --
The monitoring for the instance.
MetricCategoryIds (list) --
The IDs of the metric categories that are associated with the instance.
(string) --
State (string) --
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.