2019/04/17 - Amazon Elastic Compute Cloud - 5 updated api methods
Changes This release adds support for requester-managed Interface VPC Endpoints (powered by AWS PrivateLink). The feature prevents VPC endpoint owners from accidentally deleting or otherwise mismanaging the VPC endpoints of some AWS VPC endpoint services.
{'VpcEndpoint': {'RequesterManaged': 'boolean'}}
Creates a VPC endpoint for a specified service. An endpoint enables you to create a private connection between your VPC and the service. The service may be provided by AWS, an AWS Marketplace partner, or another AWS account. For more information, see VPC Endpoints in the Amazon Virtual Private Cloud User Guide .
A gateway endpoint serves as a target for a route in your route table for traffic destined for the AWS service. You can specify an endpoint policy to attach to the endpoint that will control access to the service from your VPC. You can also specify the VPC route tables that use the endpoint.
An interface endpoint is a network interface in your subnet that serves as an endpoint for communicating with the specified service. You can specify the subnets in which to create an endpoint, and the security groups to associate with the endpoint network interface.
Use DescribeVpcEndpointServices to get a list of supported services.
See also: AWS API Documentation
Request Syntax
client.create_vpc_endpoint(
DryRun=True|False,
VpcEndpointType='Interface'|'Gateway',
VpcId='string',
ServiceName='string',
PolicyDocument='string',
RouteTableIds=[
'string',
],
SubnetIds=[
'string',
],
SecurityGroupIds=[
'string',
],
ClientToken='string',
PrivateDnsEnabled=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 .
string
The type of endpoint.
Default: Gateway
string
[REQUIRED]
The ID of the VPC in which the endpoint will be used.
string
[REQUIRED]
The service name. To get a list of available services, use the DescribeVpcEndpointServices request, or get the name from the service provider.
string
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) One or more route table IDs.
(string) --
list
(Interface endpoint) The ID of one or more subnets in which to create an endpoint network interface.
(string) --
list
(Interface endpoint) The ID of one or more security groups to associate with the endpoint network interface.
(string) --
string
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
boolean
(Interface endpoint) Indicate 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.
Default: false
dict
Response Syntax
{
'VpcEndpoint': {
'VpcEndpointId': 'string',
'VpcEndpointType': 'Interface'|'Gateway',
'VpcId': 'string',
'ServiceName': 'string',
'State': 'PendingAcceptance'|'Pending'|'Available'|'Deleting'|'Deleted'|'Rejected'|'Failed'|'Expired',
'PolicyDocument': 'string',
'RouteTableIds': [
'string',
],
'SubnetIds': [
'string',
],
'Groups': [
{
'GroupId': 'string',
'GroupName': 'string'
},
],
'PrivateDnsEnabled': True|False,
'RequesterManaged': True|False,
'NetworkInterfaceIds': [
'string',
],
'DnsEntries': [
{
'DnsName': 'string',
'HostedZoneId': 'string'
},
],
'CreationTimestamp': datetime(2015, 1, 1)
},
'ClientToken': 'string'
}
Response Structure
(dict) --
Contains the output of CreateVpcEndpoint.
VpcEndpoint (dict) --
Information about the endpoint.
VpcEndpointId (string) --
The ID of the VPC 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 VPC endpoint.
PolicyDocument (string) --
The policy document associated with the endpoint, if applicable.
RouteTableIds (list) --
(Gateway endpoint) One or more route tables associated with the endpoint.
(string) --
SubnetIds (list) --
(Interface endpoint) One or more subnets in which the endpoint is located.
(string) --
Groups (list) --
(Interface endpoint) Information about the security groups 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.
PrivateDnsEnabled (boolean) --
(Interface endpoint) Indicates whether the VPC is associated with a private hosted zone.
RequesterManaged (boolean) --
Indicates whether the VPC Endpoint is being managed by its service.
NetworkInterfaceIds (list) --
(Interface endpoint) One or more 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 the VPC endpoint was created.
ClientToken (string) --
Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
{'ServiceConfiguration': {'ManagesVpcEndpoints': 'boolean'}}
Creates a VPC endpoint service configuration to which service consumers (AWS accounts, IAM users, and IAM roles) can connect. Service consumers can create an interface VPC endpoint to connect to your service.
To create an endpoint service configuration, you must first create a Network Load Balancer for your service. For more information, see VPC Endpoint Services in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
client.create_vpc_endpoint_service_configuration(
DryRun=True|False,
AcceptanceRequired=True|False,
NetworkLoadBalancerArns=[
'string',
],
ClientToken='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 .
boolean
Indicate whether requests from service consumers to create an endpoint to your service must be accepted. To accept a request, use AcceptVpcEndpointConnections.
list
[REQUIRED]
The Amazon Resource Names (ARNs) of one or more Network Load Balancers for your service.
(string) --
string
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
dict
Response Syntax
{
'ServiceConfiguration': {
'ServiceType': [
{
'ServiceType': 'Interface'|'Gateway'
},
],
'ServiceId': 'string',
'ServiceName': 'string',
'ServiceState': 'Pending'|'Available'|'Deleting'|'Deleted'|'Failed',
'AvailabilityZones': [
'string',
],
'AcceptanceRequired': True|False,
'ManagesVpcEndpoints': True|False,
'NetworkLoadBalancerArns': [
'string',
],
'BaseEndpointDnsNames': [
'string',
],
'PrivateDnsName': 'string'
},
'ClientToken': 'string'
}
Response Structure
(dict) --
ServiceConfiguration (dict) --
Information about the service configuration.
ServiceType (list) --
The type of service.
(dict) --
Describes the type of service for a VPC endpoint.
ServiceType (string) --
The type of service.
ServiceId (string) --
The ID of the service.
ServiceName (string) --
The name of the service.
ServiceState (string) --
The service state.
AvailabilityZones (list) --
In the Availability Zones in which the service is available.
(string) --
AcceptanceRequired (boolean) --
Indicates whether requests from other AWS accounts to create an endpoint to the service must first be accepted.
ManagesVpcEndpoints (boolean) --
Indicates whether the service manages it's VPC Endpoints. Management of the service VPC Endpoints using the VPC Endpoint API is restricted.
NetworkLoadBalancerArns (list) --
The Amazon Resource Names (ARNs) of the Network Load Balancers for the service.
(string) --
BaseEndpointDnsNames (list) --
The DNS names for the service.
(string) --
PrivateDnsName (string) --
The private DNS name for the service.
ClientToken (string) --
Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
{'ServiceConfigurations': {'ManagesVpcEndpoints': 'boolean'}}
Describes the VPC endpoint service configurations in your account (your services).
See also: AWS API Documentation
Request Syntax
client.describe_vpc_endpoint_service_configurations(
DryRun=True|False,
ServiceIds=[
'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 one or more services.
(string) --
list
One or more filters.
service-name - The name of the service.
service-id - The ID of the service.
service-state - The state of the service ( Pending | Available | Deleting | Deleted | Failed ).
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. The filters supported by a describe operation are documented with the describe operation. For example:
DescribeAvailabilityZones
DescribeImages
DescribeInstances
DescribeKeyPairs
DescribeSecurityGroups
DescribeSnapshots
DescribeSubnets
DescribeTags
DescribeVolumes
DescribeVpcs
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive.
(string) --
integer
The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned.
string
The token to retrieve the next page of results.
dict
Response Syntax
{
'ServiceConfigurations': [
{
'ServiceType': [
{
'ServiceType': 'Interface'|'Gateway'
},
],
'ServiceId': 'string',
'ServiceName': 'string',
'ServiceState': 'Pending'|'Available'|'Deleting'|'Deleted'|'Failed',
'AvailabilityZones': [
'string',
],
'AcceptanceRequired': True|False,
'ManagesVpcEndpoints': True|False,
'NetworkLoadBalancerArns': [
'string',
],
'BaseEndpointDnsNames': [
'string',
],
'PrivateDnsName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ServiceConfigurations (list) --
Information about one or more services.
(dict) --
Describes a service configuration for a VPC endpoint service.
ServiceType (list) --
The type of service.
(dict) --
Describes the type of service for a VPC endpoint.
ServiceType (string) --
The type of service.
ServiceId (string) --
The ID of the service.
ServiceName (string) --
The name of the service.
ServiceState (string) --
The service state.
AvailabilityZones (list) --
In the Availability Zones in which the service is available.
(string) --
AcceptanceRequired (boolean) --
Indicates whether requests from other AWS accounts to create an endpoint to the service must first be accepted.
ManagesVpcEndpoints (boolean) --
Indicates whether the service manages it's VPC Endpoints. Management of the service VPC Endpoints using the VPC Endpoint API is restricted.
NetworkLoadBalancerArns (list) --
The Amazon Resource Names (ARNs) of the Network Load Balancers for the service.
(string) --
BaseEndpointDnsNames (list) --
The DNS names for the service.
(string) --
PrivateDnsName (string) --
The private DNS name for the service.
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.
{'ServiceDetails': {'ManagesVpcEndpoints': 'boolean'}}
Describes available services to which you can create a VPC endpoint.
See also: AWS API Documentation
Request Syntax
client.describe_vpc_endpoint_services(
DryRun=True|False,
ServiceNames=[
'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
One or more service names.
(string) --
list
One or more filters.
service-name : The name of the service.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. The filters supported by a describe operation are documented with the describe operation. For example:
DescribeAvailabilityZones
DescribeImages
DescribeInstances
DescribeKeyPairs
DescribeSecurityGroups
DescribeSnapshots
DescribeSubnets
DescribeTags
DescribeVolumes
DescribeVpcs
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive.
(string) --
integer
The maximum number of 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 1000, we return only 1000 items.
string
The token for the next set of items to return. (You received this token from a prior call.)
dict
Response Syntax
{
'ServiceNames': [
'string',
],
'ServiceDetails': [
{
'ServiceName': 'string',
'ServiceType': [
{
'ServiceType': 'Interface'|'Gateway'
},
],
'AvailabilityZones': [
'string',
],
'Owner': 'string',
'BaseEndpointDnsNames': [
'string',
],
'PrivateDnsName': 'string',
'VpcEndpointPolicySupported': True|False,
'AcceptanceRequired': True|False,
'ManagesVpcEndpoints': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the output of DescribeVpcEndpointServices.
ServiceNames (list) --
A list of supported services.
(string) --
ServiceDetails (list) --
Information about the service.
(dict) --
Describes a VPC endpoint service.
ServiceName (string) --
The Amazon Resource Name (ARN) of the service.
ServiceType (list) --
The type of service.
(dict) --
Describes the type of service for a VPC endpoint.
ServiceType (string) --
The type of service.
AvailabilityZones (list) --
The Availability Zones in which the service is available.
(string) --
Owner (string) --
The AWS account ID of the service owner.
BaseEndpointDnsNames (list) --
The DNS names for the service.
(string) --
PrivateDnsName (string) --
The private DNS name for the service.
VpcEndpointPolicySupported (boolean) --
Indicates whether the service supports endpoint policies.
AcceptanceRequired (boolean) --
Indicates whether VPC endpoint connection requests to the service must be accepted by the service owner.
ManagesVpcEndpoints (boolean) --
Indicates whether the service manages it's VPC Endpoints. Management of the service VPC Endpoints using the VPC Endpoint API is restricted.
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.
{'VpcEndpoints': {'RequesterManaged': 'boolean'}}
Describes one or more of your VPC endpoints.
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
One or more endpoint IDs.
(string) --
list
One or more filters.
service-name : The name of the service.
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. ( pending | available | deleting | deleted )
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. The filters supported by a describe operation are documented with the describe operation. For example:
DescribeAvailabilityZones
DescribeImages
DescribeInstances
DescribeKeyPairs
DescribeSecurityGroups
DescribeSnapshots
DescribeSubnets
DescribeTags
DescribeVolumes
DescribeVpcs
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive.
(string) --
integer
The maximum number of 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 1000, we return only 1000 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',
'VpcId': 'string',
'ServiceName': 'string',
'State': 'PendingAcceptance'|'Pending'|'Available'|'Deleting'|'Deleted'|'Rejected'|'Failed'|'Expired',
'PolicyDocument': 'string',
'RouteTableIds': [
'string',
],
'SubnetIds': [
'string',
],
'Groups': [
{
'GroupId': 'string',
'GroupName': 'string'
},
],
'PrivateDnsEnabled': True|False,
'RequesterManaged': True|False,
'NetworkInterfaceIds': [
'string',
],
'DnsEntries': [
{
'DnsName': 'string',
'HostedZoneId': 'string'
},
],
'CreationTimestamp': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the output of DescribeVpcEndpoints.
VpcEndpoints (list) --
Information about the endpoints.
(dict) --
Describes a VPC endpoint.
VpcEndpointId (string) --
The ID of the VPC 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 VPC endpoint.
PolicyDocument (string) --
The policy document associated with the endpoint, if applicable.
RouteTableIds (list) --
(Gateway endpoint) One or more route tables associated with the endpoint.
(string) --
SubnetIds (list) --
(Interface endpoint) One or more subnets in which the endpoint is located.
(string) --
Groups (list) --
(Interface endpoint) Information about the security groups 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.
PrivateDnsEnabled (boolean) --
(Interface endpoint) Indicates whether the VPC is associated with a private hosted zone.
RequesterManaged (boolean) --
Indicates whether the VPC Endpoint is being managed by its service.
NetworkInterfaceIds (list) --
(Interface endpoint) One or more 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 the VPC endpoint was created.
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.