AWS API Changes

2022/01/05 - Amazon Elastic Compute Cloud - 1 new 3 updated api methods

Changes This release adds a new API called ModifyVpcEndpointServicePayerResponsibility which allows VPC endpoint service owners to take payer responsibility of their VPC Endpoint connections.

ModifyVpcEndpointServicePayerResponsibility (new)

Link ¶

Modifies the payer responsibility for your VPC endpoint service.

See also: AWS API Documentation

Request Syntax

client.modify_vpc_endpoint_service_payer_responsibility(
    DryRun=True|False,
    ServiceId='string',
    PayerResponsibility='ServiceOwner'
)

type DryRun

boolean

param DryRun

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 .

type ServiceId

string

param ServiceId

[REQUIRED]

The ID of the service.

type PayerResponsibility

string

param PayerResponsibility

[REQUIRED]

The entity that is responsible for the endpoint costs. The default is the endpoint owner. If you set the payer responsibility to the service owner, you cannot set it back to the endpoint owner.

rtype

dict

returns

Response Syntax

{
    'ReturnValue': True|False
}

Response Structure

(dict) --
- ReturnValue (boolean) --
  
  Returns true if the request succeeds; otherwise, it returns an error.

CreateVpcEndpointServiceConfiguration (updated)

Link ¶
Changes (response)

{'ServiceConfiguration': {'PayerResponsibility': 'ServiceOwner'}}

Creates a VPC endpoint service configuration to which service consumers (Amazon Web Services accounts, IAM users, and IAM roles) can connect.

To create an endpoint service configuration, you must first create one of the following for your service:

A Network Load Balancer. Service consumers connect to your service using an interface endpoint.
A Gateway Load Balancer. Service consumers connect to your service using a Gateway Load Balancer endpoint.

For more information, see VPC Endpoint Services in the Amazon Virtual Private Cloud User Guide .

If you set the private DNS name, you must prove that you own the private DNS domain name. For more information, see VPC Endpoint Service Private DNS Name Verification 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,
    PrivateDnsName='string',
    NetworkLoadBalancerArns=[
        'string',
    ],
    GatewayLoadBalancerArns=[
        'string',
    ],
    ClientToken='string',
    TagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-service'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
)

type DryRun

boolean

param DryRun

type AcceptanceRequired

boolean

param AcceptanceRequired

Indicates whether requests from service consumers to create an endpoint to your service must be accepted. To accept a request, use AcceptVpcEndpointConnections.

type PrivateDnsName

string

param PrivateDnsName

(Interface endpoint configuration) The private DNS name to assign to the VPC endpoint service.

type NetworkLoadBalancerArns

list

param NetworkLoadBalancerArns

The Amazon Resource Names (ARNs) of one or more Network Load Balancers for your service.

(string) --

type GatewayLoadBalancerArns

list

param GatewayLoadBalancerArns

The Amazon Resource Names (ARNs) of one or more Gateway Load Balancers.

(string) --

type ClientToken

string

param ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

type TagSpecifications

list

param TagSpecifications

The tags to associate with the service.

(dict) --

The tags to apply to a resource when the resource is being created.
- 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 255 Unicode characters.

rtype

dict

returns

Response Syntax

{
    'ServiceConfiguration': {
        'ServiceType': [
            {
                'ServiceType': 'Interface'|'Gateway'|'GatewayLoadBalancer'
            },
        ],
        'ServiceId': 'string',
        'ServiceName': 'string',
        'ServiceState': 'Pending'|'Available'|'Deleting'|'Deleted'|'Failed',
        'AvailabilityZones': [
            'string',
        ],
        'AcceptanceRequired': True|False,
        'ManagesVpcEndpoints': True|False,
        'NetworkLoadBalancerArns': [
            'string',
        ],
        'GatewayLoadBalancerArns': [
            'string',
        ],
        'BaseEndpointDnsNames': [
            'string',
        ],
        'PrivateDnsName': 'string',
        'PrivateDnsNameConfiguration': {
            'State': 'pendingVerification'|'verified'|'failed',
            'Type': 'string',
            'Value': 'string',
            'Name': 'string'
        },
        'PayerResponsibility': 'ServiceOwner',
        'Tags': [
            {
                'Key': 'string',
                'Value': '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) --
    
    The Availability Zones in which the service is available.
    - (string) --
  - AcceptanceRequired (boolean) --
    
    Indicates whether requests from other Amazon Web Services accounts to create an endpoint to the service must first be accepted.
  - ManagesVpcEndpoints (boolean) --
    
    Indicates whether the service manages its 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) --
  - GatewayLoadBalancerArns (list) --
    
    The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.
    - (string) --
  - BaseEndpointDnsNames (list) --
    
    The DNS names for the service.
    - (string) --
  - PrivateDnsName (string) --
    
    The private DNS name for the service.
  - PrivateDnsNameConfiguration (dict) --
    
    Information about the endpoint service private DNS name configuration.
    - State (string) --
      
      The verification state of the VPC endpoint service.
      
      >Consumers of the endpoint service can use the private name only when the state is verified .
    - Type (string) --
      
      The endpoint service verification type, for example TXT.
    - Value (string) --
      
      The value the service provider adds to the private DNS name domain record before verification.
    - Name (string) --
      
      The name of the record subdomain the service provider needs to create. The service provider adds the value text to the name .
  - PayerResponsibility (string) --
    
    The payer responsibility.
  - Tags (list) --
    
    Any tags assigned to the service.
    - (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 255 Unicode characters.
- ClientToken (string) --
  
  Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

DescribeVpcEndpointServiceConfigurations (updated)

Link ¶
Changes (response)

{'ServiceConfigurations': {'PayerResponsibility': 'ServiceOwner'}}

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'
)

type DryRun

boolean

param DryRun

type ServiceIds

list

param ServiceIds

The IDs of one or more services.

(string) --

type Filters

list

param Filters

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 ).
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.

(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.
- Name (string) --
  
  The name of the filter. Filter names are case-sensitive.
- Values (list) --
  
  The filter values. Filter values are case-sensitive.
  - (string) --

type MaxResults

integer

param MaxResults

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 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned.

type NextToken

string

param NextToken

The token to retrieve the next page of results.

rtype

dict

returns

Response Syntax

{
    'ServiceConfigurations': [
        {
            'ServiceType': [
                {
                    'ServiceType': 'Interface'|'Gateway'|'GatewayLoadBalancer'
                },
            ],
            'ServiceId': 'string',
            'ServiceName': 'string',
            'ServiceState': 'Pending'|'Available'|'Deleting'|'Deleted'|'Failed',
            'AvailabilityZones': [
                'string',
            ],
            'AcceptanceRequired': True|False,
            'ManagesVpcEndpoints': True|False,
            'NetworkLoadBalancerArns': [
                'string',
            ],
            'GatewayLoadBalancerArns': [
                'string',
            ],
            'BaseEndpointDnsNames': [
                'string',
            ],
            'PrivateDnsName': 'string',
            'PrivateDnsNameConfiguration': {
                'State': 'pendingVerification'|'verified'|'failed',
                'Type': 'string',
                'Value': 'string',
                'Name': 'string'
            },
            'PayerResponsibility': 'ServiceOwner',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': '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) --
      
      The Availability Zones in which the service is available.
      - (string) --
    - AcceptanceRequired (boolean) --
      
      Indicates whether requests from other Amazon Web Services accounts to create an endpoint to the service must first be accepted.
    - ManagesVpcEndpoints (boolean) --
      
      Indicates whether the service manages its 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) --
    - GatewayLoadBalancerArns (list) --
      
      The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.
      - (string) --
    - BaseEndpointDnsNames (list) --
      
      The DNS names for the service.
      - (string) --
    - PrivateDnsName (string) --
      
      The private DNS name for the service.
    - PrivateDnsNameConfiguration (dict) --
      
      Information about the endpoint service private DNS name configuration.
      - State (string) --
        
        The verification state of the VPC endpoint service.
        
        >Consumers of the endpoint service can use the private name only when the state is verified .
      - Type (string) --
        
        The endpoint service verification type, for example TXT.
      - Value (string) --
        
        The value the service provider adds to the private DNS name domain record before verification.
      - Name (string) --
        
        The name of the record subdomain the service provider needs to create. The service provider adds the value text to the name .
    - PayerResponsibility (string) --
      
      The payer responsibility.
    - Tags (list) --
      
      Any tags assigned to the service.
      - (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 255 Unicode characters.
- NextToken (string) --
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.

DescribeVpcEndpointServices (updated)

Link ¶
Changes (response)

{'ServiceDetails': {'PayerResponsibility': 'ServiceOwner'}}

Describes available services to which you can create a VPC endpoint.

When the service provider and the consumer have different accounts in multiple Availability Zones, and the consumer views the VPC endpoint service information, the response only includes the common Availability Zones. For example, when the service provider account uses us-east-1a and us-east-1c and the consumer uses us-east-1a and us-east-1b , the response includes the VPC endpoint services in the common Availability Zone, us-east-1a .

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'
)

type DryRun

boolean

param DryRun

type ServiceNames

list

param ServiceNames

One or more service names.

(string) --

type Filters

list

param Filters

One or more filters.

service-name - The name of the service.
service-type - The type of service ( Interface | Gateway ).
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.

(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.
- Name (string) --
  
  The name of the filter. Filter names are case-sensitive.
- Values (list) --
  
  The filter values. Filter values are case-sensitive.
  - (string) --

type MaxResults

integer

param MaxResults

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.

type NextToken

string

param NextToken

The token for the next set of items to return. (You received this token from a prior call.)

rtype

dict

returns

Response Syntax

{
    'ServiceNames': [
        'string',
    ],
    'ServiceDetails': [
        {
            'ServiceName': 'string',
            'ServiceId': 'string',
            'ServiceType': [
                {
                    'ServiceType': 'Interface'|'Gateway'|'GatewayLoadBalancer'
                },
            ],
            'AvailabilityZones': [
                'string',
            ],
            'Owner': 'string',
            'BaseEndpointDnsNames': [
                'string',
            ],
            'PrivateDnsName': 'string',
            'PrivateDnsNames': [
                {
                    'PrivateDnsName': 'string'
                },
            ],
            'VpcEndpointPolicySupported': True|False,
            'AcceptanceRequired': True|False,
            'ManagesVpcEndpoints': True|False,
            'PayerResponsibility': 'ServiceOwner',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'PrivateDnsNameVerificationState': 'pendingVerification'|'verified'|'failed'
        },
    ],
    '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.
    - ServiceId (string) --
      
      The ID of the endpoint 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 Amazon Web Services account ID of the service owner.
    - BaseEndpointDnsNames (list) --
      
      The DNS names for the service.
      - (string) --
    - PrivateDnsName (string) --
      
      The private DNS name for the service.
    - PrivateDnsNames (list) --
      
      The private DNS names assigned to the VPC endpoint service.
      - (dict) --
        
        Information about the Private DNS name for interface endpoints.
        
        PrivateDnsName (string) --
        
        The private DNS name assigned to the VPC endpoint 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 its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted.
    - PayerResponsibility (string) --
      
      The payer responsibility.
    - Tags (list) --
      
      Any tags assigned to the service.
      - (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 255 Unicode characters.
    - PrivateDnsNameVerificationState (string) --
      
      The verification state of the VPC endpoint service.
      
      Consumers of the endpoint service cannot use the private name when the state is not verified .
- 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.