2025/11/07 - Amazon Elastic Compute Cloud - 7 updated api methods
Changes Adds PrivateDnsPreference and PrivateDnsSpecifiedDomains to control private DNS resolution for resource and service network VPC endpoints and IpamScopeExternalAuthorityConfiguration to integrate Amazon VPC IPAM with a third-party IPAM service
{'ExternalAuthorityConfiguration': {'ExternalResourceIdentifier': 'string',
'Type': 'infoblox'}}
Response {'IpamScope': {'ExternalAuthorityConfiguration': {'ExternalResourceIdentifier': 'string',
'Type': 'infoblox'}}}
Create an IPAM scope. In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
For more information, see Add a scope in the Amazon VPC IPAM User Guide.
See also: AWS API Documentation
Request Syntax
client.create_ipam_scope(
DryRun=True|False,
IpamId='string',
Description='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-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task'|'ipam-prefix-list-resolver'|'ipam-prefix-list-resolver-target'|'capacity-manager-data-export',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
ClientToken='string',
ExternalAuthorityConfiguration={
'Type': 'infoblox',
'ExternalResourceIdentifier': 'string'
}
)
boolean
A check for 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 IPAM for which you're creating this scope.
string
A description for the scope you're creating.
list
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.
(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
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
dict
The configuration that links an Amazon VPC IPAM scope to an external authority system. It specifies the type of external system and the external resource identifier that identifies your account or instance in that system.
In IPAM, an external authority is a third-party IP address management system that provides CIDR blocks when you provision address space for top-level IPAM pools. This allows you to use your existing IP management system to control which address ranges are allocated to Amazon Web Services while using Amazon VPC IPAM to manage subnets within those ranges.
Type (string) --
The type of external authority.
ExternalResourceIdentifier (string) --
The identifier for the external resource managing this scope. For Infoblox integrations, this is the Infoblox resource identifier in the format <version>.identity.account.<entity_realm>.<entity_id>.
dict
Response Syntax
{
'IpamScope': {
'OwnerId': 'string',
'IpamScopeId': 'string',
'IpamScopeArn': 'string',
'IpamArn': 'string',
'IpamRegion': 'string',
'IpamScopeType': 'public'|'private',
'IsDefault': True|False,
'Description': 'string',
'PoolCount': 123,
'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'isolate-in-progress'|'isolate-complete'|'restore-in-progress',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ExternalAuthorityConfiguration': {
'Type': 'infoblox',
'ExternalResourceIdentifier': 'string'
}
}
}
Response Structure
(dict) --
IpamScope (dict) --
Information about the created scope.
OwnerId (string) --
The Amazon Web Services account ID of the owner of the scope.
IpamScopeId (string) --
The ID of the scope.
IpamScopeArn (string) --
The Amazon Resource Name (ARN) of the scope.
IpamArn (string) --
The ARN of the IPAM.
IpamRegion (string) --
The Amazon Web Services Region of the IPAM scope.
IpamScopeType (string) --
The type of the scope.
IsDefault (boolean) --
Defines if the scope is the default scope or not.
Description (string) --
The description of the scope.
PoolCount (integer) --
The number of pools in the scope.
State (string) --
The state of the IPAM scope.
Tags (list) --
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.
(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.
ExternalAuthorityConfiguration (dict) --
The external authority configuration for this IPAM scope, if configured.
The configuration that links an Amazon VPC IPAM scope to an external authority system. It specifies the type of external system and the external resource identifier that identifies your account or instance in that system.
In IPAM, an external authority is a third-party IP address management system that provides CIDR blocks when you provision address space for top-level IPAM pools. This allows you to use your existing IP management system to control which address ranges are allocated to Amazon Web Services while using Amazon VPC IPAM to manage subnets within those ranges.
Type (string) --
The type of external authority managing this scope. Currently supports Infoblox for integration with Infoblox Universal DDI.
ExternalResourceIdentifier (string) --
The identifier for the external resource managing this scope. For Infoblox integrations, this is the Infoblox resource identifier in the format <version>.identity.account.<entity_realm>.<entity_id>.
{'DnsOptions': {'PrivateDnsPreference': 'string',
'PrivateDnsSpecifiedDomains': ['string']}}
Response {'VpcEndpoint': {'DnsOptions': {'PrivateDnsPreference': 'string',
'PrivateDnsSpecifiedDomains': ['string']}}}
Creates a VPC endpoint. A VPC endpoint provides a private connection between the specified VPC and the specified endpoint service. You can use an endpoint service provided by Amazon Web Services, an Amazon Web Services Marketplace Partner, or another Amazon Web Services account. For more information, see the Amazon Web Services PrivateLink User Guide.
See also: AWS API Documentation
Request Syntax
client.create_vpc_endpoint(
DryRun=True|False,
VpcEndpointType='Interface'|'Gateway'|'GatewayLoadBalancer'|'Resource'|'ServiceNetwork',
VpcId='string',
ServiceName='string',
PolicyDocument='string',
RouteTableIds=[
'string',
],
SubnetIds=[
'string',
],
SecurityGroupIds=[
'string',
],
IpAddressType='ipv4'|'dualstack'|'ipv6',
DnsOptions={
'DnsRecordIpType': 'ipv4'|'dualstack'|'ipv6'|'service-defined',
'PrivateDnsOnlyForInboundResolverEndpoint': True|False,
'PrivateDnsPreference': 'string',
'PrivateDnsSpecifiedDomains': [
'string',
]
},
ClientToken='string',
PrivateDnsEnabled=True|False,
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-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task'|'ipam-prefix-list-resolver'|'ipam-prefix-list-resolver-target'|'capacity-manager-data-export',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
SubnetConfigurations=[
{
'SubnetId': 'string',
'Ipv4': 'string',
'Ipv6': 'string'
},
],
ServiceNetworkArn='string',
ResourceConfigurationArn='string',
ServiceRegion='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
The type of endpoint.
Default: Gateway
string
[REQUIRED]
The ID of the VPC.
string
The name of the endpoint service.
string
(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.
list
(Gateway endpoint) The route table IDs.
(string) --
list
(Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to create endpoint network interfaces. For a Gateway Load Balancer endpoint, you can specify only one subnet.
(string) --
list
(Interface endpoint) The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC.
(string) --
string
The IP address type for the endpoint.
dict
The DNS options for the endpoint.
DnsRecordIpType (string) --
The DNS records created for the endpoint.
PrivateDnsOnlyForInboundResolverEndpoint (boolean) --
Indicates whether to enable private DNS only for inbound endpoints. This option is available only for services that support both gateway and interface endpoints. It routes traffic that originates from the VPC to the gateway endpoint and traffic that originates from on-premises to the interface endpoint.
PrivateDnsPreference (string) --
The preference for which private domains have a private hosted zone created for and associated with the specified VPC. Only supported when private DNS is enabled and when the VPC endpoint type is ServiceNetwork or Resource.
ALL_DOMAINS - VPC Lattice provisions private hosted zones for all custom domain names.
VERIFIED_DOMAINS_ONLY - VPC Lattice provisions a private hosted zone only if custom domain name has been verified by the provider.
VERIFIED_DOMAINS_AND_SPECIFIED_DOMAINS - VPC Lattice provisions private hosted zones for all verified custom domain names and other domain names that the resource consumer specifies. The resource consumer specifies the domain names in the PrivateDnsSpecifiedDomains parameter.
SPECIFIED_DOMAINS_ONLY - VPC Lattice provisions a private hosted zone for domain names specified by the resource consumer. The resource consumer specifies the domain names in the PrivateDnsSpecifiedDomains parameter.
PrivateDnsSpecifiedDomains (list) --
Indicates which of the private domains to create private hosted zones for and associate with the specified VPC. Only supported when private DNS is enabled and the private DNS preference is verified-domains-and-specified-domains or specified-domains-only.
(string) --
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
boolean
(Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.
To use a private hosted zone, you must set the following VPC attributes to true: enableDnsHostnames and enableDnsSupport. Use ModifyVpcAttribute to set the VPC attributes.
list
The tags to associate with the endpoint.
(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.
list
The subnet configurations for the endpoint.
(dict) --
Describes the configuration of a subnet for a VPC endpoint.
SubnetId (string) --
The ID of the subnet.
Ipv4 (string) --
The IPv4 address to assign to the endpoint network interface in the subnet. You must provide an IPv4 address if the VPC endpoint supports IPv4.
If you specify an IPv4 address when modifying a VPC endpoint, we replace the existing endpoint network interface with a new endpoint network interface with this IP address. This process temporarily disconnects the subnet and the VPC endpoint.
Ipv6 (string) --
The IPv6 address to assign to the endpoint network interface in the subnet. You must provide an IPv6 address if the VPC endpoint supports IPv6.
If you specify an IPv6 address when modifying a VPC endpoint, we replace the existing endpoint network interface with a new endpoint network interface with this IP address. This process temporarily disconnects the subnet and the VPC endpoint.
string
The Amazon Resource Name (ARN) of a service network that will be associated with the VPC endpoint of type service-network.
string
The Amazon Resource Name (ARN) of a resource configuration that will be associated with the VPC endpoint of type resource.
string
The Region where the service is hosted. The default is the current Region.
dict
Response Syntax
{
'VpcEndpoint': {
'VpcEndpointId': 'string',
'VpcEndpointType': 'Interface'|'Gateway'|'GatewayLoadBalancer'|'Resource'|'ServiceNetwork',
'VpcId': 'string',
'ServiceName': 'string',
'State': 'PendingAcceptance'|'Pending'|'Available'|'Deleting'|'Deleted'|'Rejected'|'Failed'|'Expired'|'Partial',
'PolicyDocument': 'string',
'RouteTableIds': [
'string',
],
'SubnetIds': [
'string',
],
'Groups': [
{
'GroupId': 'string',
'GroupName': 'string'
},
],
'IpAddressType': 'ipv4'|'dualstack'|'ipv6',
'DnsOptions': {
'DnsRecordIpType': 'ipv4'|'dualstack'|'ipv6'|'service-defined',
'PrivateDnsOnlyForInboundResolverEndpoint': True|False,
'PrivateDnsPreference': 'string',
'PrivateDnsSpecifiedDomains': [
'string',
]
},
'PrivateDnsEnabled': True|False,
'RequesterManaged': True|False,
'NetworkInterfaceIds': [
'string',
],
'DnsEntries': [
{
'DnsName': 'string',
'HostedZoneId': 'string'
},
],
'CreationTimestamp': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'OwnerId': 'string',
'LastError': {
'Message': 'string',
'Code': 'string'
},
'Ipv4Prefixes': [
{
'SubnetId': 'string',
'IpPrefixes': [
'string',
]
},
],
'Ipv6Prefixes': [
{
'SubnetId': 'string',
'IpPrefixes': [
'string',
]
},
],
'FailureReason': 'string',
'ServiceNetworkArn': 'string',
'ResourceConfigurationArn': 'string',
'ServiceRegion': 'string'
},
'ClientToken': 'string'
}
Response Structure
(dict) --
VpcEndpoint (dict) --
Information about the endpoint.
VpcEndpointId (string) --
The ID of the endpoint.
VpcEndpointType (string) --
The type of endpoint.
VpcId (string) --
The ID of the VPC to which the endpoint is associated.
ServiceName (string) --
The name of the service to which the endpoint is associated.
State (string) --
The state of the endpoint.
PolicyDocument (string) --
The policy document associated with the endpoint, if applicable.
RouteTableIds (list) --
(Gateway endpoint) The IDs of the route tables associated with the endpoint.
(string) --
SubnetIds (list) --
(Interface endpoint) The subnets for the endpoint.
(string) --
Groups (list) --
(Interface endpoint) Information about the security groups that are associated with the network interface.
(dict) --
Describes a security group.
GroupId (string) --
The ID of the security group.
GroupName (string) --
The name of the security group.
IpAddressType (string) --
The IP address type for the endpoint.
DnsOptions (dict) --
The DNS options for the endpoint.
DnsRecordIpType (string) --
The DNS records created for the endpoint.
PrivateDnsOnlyForInboundResolverEndpoint (boolean) --
Indicates whether to enable private DNS only for inbound endpoints.
PrivateDnsPreference (string) --
The preference for which private domains have a private hosted zone created for and associated with the specified VPC. Only supported when private DNS is enabled and when the VPC endpoint type is ServiceNetwork or Resource.
ALL_DOMAINS - VPC Lattice provisions private hosted zones for all custom domain names.
VERIFIED_DOMAINS_ONLY - VPC Lattice provisions a private hosted zone only if custom domain name has been verified by the provider.
VERIFIED_DOMAINS_AND_SPECIFIED_DOMAINS - VPC Lattice provisions private hosted zones for all verified custom domain names and other domain names that the resource consumer specifies. The resource consumer specifies the domain names in the PrivateDnsSpecifiedDomains parameter.
SPECIFIED_DOMAINS_ONLY - VPC Lattice provisions a private hosted zone for domain names specified by the resource consumer. The resource consumer specifies the domain names in the PrivateDnsSpecifiedDomains parameter.
PrivateDnsSpecifiedDomains (list) --
Indicates which of the private domains to create private hosted zones for and associate with the specified VPC. Only supported when private DNS is enabled and the private DNS preference is VERIFIED_DOMAINS_AND_SPECIFIED_DOMAINS or SPECIFIED_DOMAINS_ONLY.
(string) --
PrivateDnsEnabled (boolean) --
(Interface endpoint) Indicates whether the VPC is associated with a private hosted zone.
RequesterManaged (boolean) --
Indicates whether the endpoint is being managed by its service.
NetworkInterfaceIds (list) --
(Interface endpoint) The network interfaces for the endpoint.
(string) --
DnsEntries (list) --
(Interface endpoint) The DNS entries for the endpoint.
(dict) --
Describes a DNS entry.
DnsName (string) --
The DNS name.
HostedZoneId (string) --
The ID of the private hosted zone.
CreationTimestamp (datetime) --
The date and time that the endpoint was created.
Tags (list) --
The tags assigned to the endpoint.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the endpoint.
LastError (dict) --
The last error that occurred for endpoint.
Message (string) --
The error message for the VPC endpoint error.
Code (string) --
The error code for the VPC endpoint error.
Ipv4Prefixes (list) --
Array of IPv4 prefixes.
(dict) --
Prefixes of the subnet IP.
SubnetId (string) --
ID of the subnet.
IpPrefixes (list) --
Array of SubnetIpPrefixes objects.
(string) --
Ipv6Prefixes (list) --
Array of IPv6 prefixes.
(dict) --
Prefixes of the subnet IP.
SubnetId (string) --
ID of the subnet.
IpPrefixes (list) --
Array of SubnetIpPrefixes objects.
(string) --
FailureReason (string) --
Reason for the failure.
ServiceNetworkArn (string) --
The Amazon Resource Name (ARN) of the service network.
ResourceConfigurationArn (string) --
The Amazon Resource Name (ARN) of the resource configuration.
ServiceRegion (string) --
The Region where the service is hosted.
ClientToken (string) --
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
{'IpamScope': {'ExternalAuthorityConfiguration': {'ExternalResourceIdentifier': 'string',
'Type': 'infoblox'}}}
Delete the scope for an IPAM. You cannot delete the default scopes.
For more information, see Delete a scope in the Amazon VPC IPAM User Guide.
See also: AWS API Documentation
Request Syntax
client.delete_ipam_scope(
DryRun=True|False,
IpamScopeId='string'
)
boolean
A check for 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 scope to delete.
dict
Response Syntax
{
'IpamScope': {
'OwnerId': 'string',
'IpamScopeId': 'string',
'IpamScopeArn': 'string',
'IpamArn': 'string',
'IpamRegion': 'string',
'IpamScopeType': 'public'|'private',
'IsDefault': True|False,
'Description': 'string',
'PoolCount': 123,
'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'isolate-in-progress'|'isolate-complete'|'restore-in-progress',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ExternalAuthorityConfiguration': {
'Type': 'infoblox',
'ExternalResourceIdentifier': 'string'
}
}
}
Response Structure
(dict) --
IpamScope (dict) --
Information about the results of the deletion.
OwnerId (string) --
The Amazon Web Services account ID of the owner of the scope.
IpamScopeId (string) --
The ID of the scope.
IpamScopeArn (string) --
The Amazon Resource Name (ARN) of the scope.
IpamArn (string) --
The ARN of the IPAM.
IpamRegion (string) --
The Amazon Web Services Region of the IPAM scope.
IpamScopeType (string) --
The type of the scope.
IsDefault (boolean) --
Defines if the scope is the default scope or not.
Description (string) --
The description of the scope.
PoolCount (integer) --
The number of pools in the scope.
State (string) --
The state of the IPAM scope.
Tags (list) --
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.
(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.
ExternalAuthorityConfiguration (dict) --
The external authority configuration for this IPAM scope, if configured.
The configuration that links an Amazon VPC IPAM scope to an external authority system. It specifies the type of external system and the external resource identifier that identifies your account or instance in that system.
In IPAM, an external authority is a third-party IP address management system that provides CIDR blocks when you provision address space for top-level IPAM pools. This allows you to use your existing IP management system to control which address ranges are allocated to Amazon Web Services while using Amazon VPC IPAM to manage subnets within those ranges.
Type (string) --
The type of external authority managing this scope. Currently supports Infoblox for integration with Infoblox Universal DDI.
ExternalResourceIdentifier (string) --
The identifier for the external resource managing this scope. For Infoblox integrations, this is the Infoblox resource identifier in the format <version>.identity.account.<entity_realm>.<entity_id>.
{'IpamScopes': {'ExternalAuthorityConfiguration': {'ExternalResourceIdentifier': 'string',
'Type': 'infoblox'}}}
Get information about your IPAM scopes.
See also: AWS API Documentation
Request Syntax
client.describe_ipam_scopes(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
IpamScopeIds=[
'string',
]
)
boolean
A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
list
One or more filters for the request. For more information about filtering, see Filtering CLI output.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
integer
The maximum number of results to return in the request.
string
The token for the next page of results.
list
The IDs of the scopes you want information on.
(string) --
dict
Response Syntax
{
'NextToken': 'string',
'IpamScopes': [
{
'OwnerId': 'string',
'IpamScopeId': 'string',
'IpamScopeArn': 'string',
'IpamArn': 'string',
'IpamRegion': 'string',
'IpamScopeType': 'public'|'private',
'IsDefault': True|False,
'Description': 'string',
'PoolCount': 123,
'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'isolate-in-progress'|'isolate-complete'|'restore-in-progress',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ExternalAuthorityConfiguration': {
'Type': 'infoblox',
'ExternalResourceIdentifier': 'string'
}
},
]
}
Response Structure
(dict) --
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
IpamScopes (list) --
The scopes you want information on.
(dict) --
In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
For more information, see How IPAM works in the Amazon VPC IPAM User Guide.
OwnerId (string) --
The Amazon Web Services account ID of the owner of the scope.
IpamScopeId (string) --
The ID of the scope.
IpamScopeArn (string) --
The Amazon Resource Name (ARN) of the scope.
IpamArn (string) --
The ARN of the IPAM.
IpamRegion (string) --
The Amazon Web Services Region of the IPAM scope.
IpamScopeType (string) --
The type of the scope.
IsDefault (boolean) --
Defines if the scope is the default scope or not.
Description (string) --
The description of the scope.
PoolCount (integer) --
The number of pools in the scope.
State (string) --
The state of the IPAM scope.
Tags (list) --
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.
(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.
ExternalAuthorityConfiguration (dict) --
The external authority configuration for this IPAM scope, if configured.
The configuration that links an Amazon VPC IPAM scope to an external authority system. It specifies the type of external system and the external resource identifier that identifies your account or instance in that system.
In IPAM, an external authority is a third-party IP address management system that provides CIDR blocks when you provision address space for top-level IPAM pools. This allows you to use your existing IP management system to control which address ranges are allocated to Amazon Web Services while using Amazon VPC IPAM to manage subnets within those ranges.
Type (string) --
The type of external authority managing this scope. Currently supports Infoblox for integration with Infoblox Universal DDI.
ExternalResourceIdentifier (string) --
The identifier for the external resource managing this scope. For Infoblox integrations, this is the Infoblox resource identifier in the format <version>.identity.account.<entity_realm>.<entity_id>.
{'VpcEndpoints': {'DnsOptions': {'PrivateDnsPreference': 'string',
'PrivateDnsSpecifiedDomains': ['string']}}}
Describes your VPC endpoints. The default is to describe all your VPC endpoints. Alternatively, you can specify specific VPC endpoint IDs or filter the results to include only the VPC endpoints that match specific criteria.
See also: AWS API Documentation
Request Syntax
client.describe_vpc_endpoints(
DryRun=True|False,
VpcEndpointIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
list
The IDs of the VPC endpoints.
(string) --
list
The filters.
ip-address-type - The IP address type ( ipv4 | ipv6).
service-name - The name of the service.
service-region - The Region of the service.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC in which the endpoint resides.
vpc-endpoint-id - The ID of the endpoint.
vpc-endpoint-state - The state of the endpoint ( pendingAcceptance | pending | available | deleting | deleted | rejected | failed).
vpc-endpoint-type - The type of VPC endpoint ( Interface | Gateway | GatewayLoadBalancer | Resource | ServiceNetwork).
(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. The request returns a token that you can specify in a subsequent call to get the next set of results.
Constraint: If the value is greater than 1,000, we return only 1,000 items.
string
The token for the next set of items to return. (You received this token from a prior call.)
dict
Response Syntax
{
'VpcEndpoints': [
{
'VpcEndpointId': 'string',
'VpcEndpointType': 'Interface'|'Gateway'|'GatewayLoadBalancer'|'Resource'|'ServiceNetwork',
'VpcId': 'string',
'ServiceName': 'string',
'State': 'PendingAcceptance'|'Pending'|'Available'|'Deleting'|'Deleted'|'Rejected'|'Failed'|'Expired'|'Partial',
'PolicyDocument': 'string',
'RouteTableIds': [
'string',
],
'SubnetIds': [
'string',
],
'Groups': [
{
'GroupId': 'string',
'GroupName': 'string'
},
],
'IpAddressType': 'ipv4'|'dualstack'|'ipv6',
'DnsOptions': {
'DnsRecordIpType': 'ipv4'|'dualstack'|'ipv6'|'service-defined',
'PrivateDnsOnlyForInboundResolverEndpoint': True|False,
'PrivateDnsPreference': 'string',
'PrivateDnsSpecifiedDomains': [
'string',
]
},
'PrivateDnsEnabled': True|False,
'RequesterManaged': True|False,
'NetworkInterfaceIds': [
'string',
],
'DnsEntries': [
{
'DnsName': 'string',
'HostedZoneId': 'string'
},
],
'CreationTimestamp': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'OwnerId': 'string',
'LastError': {
'Message': 'string',
'Code': 'string'
},
'Ipv4Prefixes': [
{
'SubnetId': 'string',
'IpPrefixes': [
'string',
]
},
],
'Ipv6Prefixes': [
{
'SubnetId': 'string',
'IpPrefixes': [
'string',
]
},
],
'FailureReason': 'string',
'ServiceNetworkArn': 'string',
'ResourceConfigurationArn': 'string',
'ServiceRegion': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
VpcEndpoints (list) --
Information about the VPC endpoints.
(dict) --
Describes a VPC endpoint.
VpcEndpointId (string) --
The ID of the endpoint.
VpcEndpointType (string) --
The type of endpoint.
VpcId (string) --
The ID of the VPC to which the endpoint is associated.
ServiceName (string) --
The name of the service to which the endpoint is associated.
State (string) --
The state of the endpoint.
PolicyDocument (string) --
The policy document associated with the endpoint, if applicable.
RouteTableIds (list) --
(Gateway endpoint) The IDs of the route tables associated with the endpoint.
(string) --
SubnetIds (list) --
(Interface endpoint) The subnets for the endpoint.
(string) --
Groups (list) --
(Interface endpoint) Information about the security groups that are associated with the network interface.
(dict) --
Describes a security group.
GroupId (string) --
The ID of the security group.
GroupName (string) --
The name of the security group.
IpAddressType (string) --
The IP address type for the endpoint.
DnsOptions (dict) --
The DNS options for the endpoint.
DnsRecordIpType (string) --
The DNS records created for the endpoint.
PrivateDnsOnlyForInboundResolverEndpoint (boolean) --
Indicates whether to enable private DNS only for inbound endpoints.
PrivateDnsPreference (string) --
The preference for which private domains have a private hosted zone created for and associated with the specified VPC. Only supported when private DNS is enabled and when the VPC endpoint type is ServiceNetwork or Resource.
ALL_DOMAINS - VPC Lattice provisions private hosted zones for all custom domain names.
VERIFIED_DOMAINS_ONLY - VPC Lattice provisions a private hosted zone only if custom domain name has been verified by the provider.
VERIFIED_DOMAINS_AND_SPECIFIED_DOMAINS - VPC Lattice provisions private hosted zones for all verified custom domain names and other domain names that the resource consumer specifies. The resource consumer specifies the domain names in the PrivateDnsSpecifiedDomains parameter.
SPECIFIED_DOMAINS_ONLY - VPC Lattice provisions a private hosted zone for domain names specified by the resource consumer. The resource consumer specifies the domain names in the PrivateDnsSpecifiedDomains parameter.
PrivateDnsSpecifiedDomains (list) --
Indicates which of the private domains to create private hosted zones for and associate with the specified VPC. Only supported when private DNS is enabled and the private DNS preference is VERIFIED_DOMAINS_AND_SPECIFIED_DOMAINS or SPECIFIED_DOMAINS_ONLY.
(string) --
PrivateDnsEnabled (boolean) --
(Interface endpoint) Indicates whether the VPC is associated with a private hosted zone.
RequesterManaged (boolean) --
Indicates whether the endpoint is being managed by its service.
NetworkInterfaceIds (list) --
(Interface endpoint) The network interfaces for the endpoint.
(string) --
DnsEntries (list) --
(Interface endpoint) The DNS entries for the endpoint.
(dict) --
Describes a DNS entry.
DnsName (string) --
The DNS name.
HostedZoneId (string) --
The ID of the private hosted zone.
CreationTimestamp (datetime) --
The date and time that the endpoint was created.
Tags (list) --
The tags assigned to the endpoint.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the endpoint.
LastError (dict) --
The last error that occurred for endpoint.
Message (string) --
The error message for the VPC endpoint error.
Code (string) --
The error code for the VPC endpoint error.
Ipv4Prefixes (list) --
Array of IPv4 prefixes.
(dict) --
Prefixes of the subnet IP.
SubnetId (string) --
ID of the subnet.
IpPrefixes (list) --
Array of SubnetIpPrefixes objects.
(string) --
Ipv6Prefixes (list) --
Array of IPv6 prefixes.
(dict) --
Prefixes of the subnet IP.
SubnetId (string) --
ID of the subnet.
IpPrefixes (list) --
Array of SubnetIpPrefixes objects.
(string) --
FailureReason (string) --
Reason for the failure.
ServiceNetworkArn (string) --
The Amazon Resource Name (ARN) of the service network.
ResourceConfigurationArn (string) --
The Amazon Resource Name (ARN) of the resource configuration.
ServiceRegion (string) --
The Region where the service is hosted.
NextToken (string) --
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
{'ExternalAuthorityConfiguration': {'ExternalResourceIdentifier': 'string',
'Type': 'infoblox'},
'RemoveExternalAuthorityConfiguration': 'boolean'}
Response {'IpamScope': {'ExternalAuthorityConfiguration': {'ExternalResourceIdentifier': 'string',
'Type': 'infoblox'}}}
Modify an IPAM scope.
See also: AWS API Documentation
Request Syntax
client.modify_ipam_scope(
DryRun=True|False,
IpamScopeId='string',
Description='string',
ExternalAuthorityConfiguration={
'Type': 'infoblox',
'ExternalResourceIdentifier': 'string'
},
RemoveExternalAuthorityConfiguration=True|False
)
boolean
A check for 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 scope you want to modify.
string
The description of the scope you want to modify.
dict
The configuration that links an Amazon VPC IPAM scope to an external authority system. It specifies the type of external system and the external resource identifier that identifies your account or instance in that system.
In IPAM, an external authority is a third-party IP address management system that provides CIDR blocks when you provision address space for top-level IPAM pools. This allows you to use your existing IP management system to control which address ranges are allocated to Amazon Web Services while using Amazon VPC IPAM to manage subnets within those ranges.
Type (string) --
The type of external authority.
ExternalResourceIdentifier (string) --
The identifier for the external resource managing this scope. For Infoblox integrations, this is the Infoblox resource identifier in the format <version>.identity.account.<entity_realm>.<entity_id>.
boolean
Remove the external authority configuration. true to remove.
dict
Response Syntax
{
'IpamScope': {
'OwnerId': 'string',
'IpamScopeId': 'string',
'IpamScopeArn': 'string',
'IpamArn': 'string',
'IpamRegion': 'string',
'IpamScopeType': 'public'|'private',
'IsDefault': True|False,
'Description': 'string',
'PoolCount': 123,
'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'isolate-in-progress'|'isolate-complete'|'restore-in-progress',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ExternalAuthorityConfiguration': {
'Type': 'infoblox',
'ExternalResourceIdentifier': 'string'
}
}
}
Response Structure
(dict) --
IpamScope (dict) --
The results of the modification.
OwnerId (string) --
The Amazon Web Services account ID of the owner of the scope.
IpamScopeId (string) --
The ID of the scope.
IpamScopeArn (string) --
The Amazon Resource Name (ARN) of the scope.
IpamArn (string) --
The ARN of the IPAM.
IpamRegion (string) --
The Amazon Web Services Region of the IPAM scope.
IpamScopeType (string) --
The type of the scope.
IsDefault (boolean) --
Defines if the scope is the default scope or not.
Description (string) --
The description of the scope.
PoolCount (integer) --
The number of pools in the scope.
State (string) --
The state of the IPAM scope.
Tags (list) --
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.
(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.
ExternalAuthorityConfiguration (dict) --
The external authority configuration for this IPAM scope, if configured.
The configuration that links an Amazon VPC IPAM scope to an external authority system. It specifies the type of external system and the external resource identifier that identifies your account or instance in that system.
In IPAM, an external authority is a third-party IP address management system that provides CIDR blocks when you provision address space for top-level IPAM pools. This allows you to use your existing IP management system to control which address ranges are allocated to Amazon Web Services while using Amazon VPC IPAM to manage subnets within those ranges.
Type (string) --
The type of external authority managing this scope. Currently supports Infoblox for integration with Infoblox Universal DDI.
ExternalResourceIdentifier (string) --
The identifier for the external resource managing this scope. For Infoblox integrations, this is the Infoblox resource identifier in the format <version>.identity.account.<entity_realm>.<entity_id>.
{'DnsOptions': {'PrivateDnsPreference': 'string',
'PrivateDnsSpecifiedDomains': ['string']}}
Modifies attributes of a specified VPC endpoint. The attributes that you can modify depend on the type of VPC endpoint (interface, gateway, or Gateway Load Balancer). For more information, see the Amazon Web Services PrivateLink Guide.
See also: AWS API Documentation
Request Syntax
client.modify_vpc_endpoint(
DryRun=True|False,
VpcEndpointId='string',
ResetPolicy=True|False,
PolicyDocument='string',
AddRouteTableIds=[
'string',
],
RemoveRouteTableIds=[
'string',
],
AddSubnetIds=[
'string',
],
RemoveSubnetIds=[
'string',
],
AddSecurityGroupIds=[
'string',
],
RemoveSecurityGroupIds=[
'string',
],
IpAddressType='ipv4'|'dualstack'|'ipv6',
DnsOptions={
'DnsRecordIpType': 'ipv4'|'dualstack'|'ipv6'|'service-defined',
'PrivateDnsOnlyForInboundResolverEndpoint': True|False,
'PrivateDnsPreference': 'string',
'PrivateDnsSpecifiedDomains': [
'string',
]
},
PrivateDnsEnabled=True|False,
SubnetConfigurations=[
{
'SubnetId': 'string',
'Ipv4': 'string',
'Ipv6': '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 endpoint.
boolean
(Gateway endpoint) Specify true to reset the policy document to the default policy. The default policy allows full access to the service.
string
(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format.
list
(Gateway endpoint) The IDs of the route tables to associate with the endpoint.
(string) --
list
(Gateway endpoint) The IDs of the route tables to disassociate from the endpoint.
(string) --
list
(Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to serve the endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.
(string) --
list
(Interface endpoint) The IDs of the subnets from which to remove the endpoint.
(string) --
list
(Interface endpoint) The IDs of the security groups to associate with the endpoint network interfaces.
(string) --
list
(Interface endpoint) The IDs of the security groups to disassociate from the endpoint network interfaces.
(string) --
string
The IP address type for the endpoint.
dict
The DNS options for the endpoint.
DnsRecordIpType (string) --
The DNS records created for the endpoint.
PrivateDnsOnlyForInboundResolverEndpoint (boolean) --
Indicates whether to enable private DNS only for inbound endpoints. This option is available only for services that support both gateway and interface endpoints. It routes traffic that originates from the VPC to the gateway endpoint and traffic that originates from on-premises to the interface endpoint.
PrivateDnsPreference (string) --
The preference for which private domains have a private hosted zone created for and associated with the specified VPC. Only supported when private DNS is enabled and when the VPC endpoint type is ServiceNetwork or Resource.
ALL_DOMAINS - VPC Lattice provisions private hosted zones for all custom domain names.
VERIFIED_DOMAINS_ONLY - VPC Lattice provisions a private hosted zone only if custom domain name has been verified by the provider.
VERIFIED_DOMAINS_AND_SPECIFIED_DOMAINS - VPC Lattice provisions private hosted zones for all verified custom domain names and other domain names that the resource consumer specifies. The resource consumer specifies the domain names in the PrivateDnsSpecifiedDomains parameter.
SPECIFIED_DOMAINS_ONLY - VPC Lattice provisions a private hosted zone for domain names specified by the resource consumer. The resource consumer specifies the domain names in the PrivateDnsSpecifiedDomains parameter.
PrivateDnsSpecifiedDomains (list) --
Indicates which of the private domains to create private hosted zones for and associate with the specified VPC. Only supported when private DNS is enabled and the private DNS preference is verified-domains-and-specified-domains or specified-domains-only.
(string) --
boolean
(Interface endpoint) Indicates whether a private hosted zone is associated with the VPC.
list
The subnet configurations for the endpoint.
(dict) --
Describes the configuration of a subnet for a VPC endpoint.
SubnetId (string) --
The ID of the subnet.
Ipv4 (string) --
The IPv4 address to assign to the endpoint network interface in the subnet. You must provide an IPv4 address if the VPC endpoint supports IPv4.
If you specify an IPv4 address when modifying a VPC endpoint, we replace the existing endpoint network interface with a new endpoint network interface with this IP address. This process temporarily disconnects the subnet and the VPC endpoint.
Ipv6 (string) --
The IPv6 address to assign to the endpoint network interface in the subnet. You must provide an IPv6 address if the VPC endpoint supports IPv6.
If you specify an IPv6 address when modifying a VPC endpoint, we replace the existing endpoint network interface with a new endpoint network interface with this IP address. This process temporarily disconnects the subnet and the VPC endpoint.
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, it returns an error.