AWS API Changes

2024/11/26 - Amazon Elastic Compute Cloud - 12 updated api methods

Changes Adds support for Time-based Copy for EBS Snapshots and Cross Region PrivateLink. Time-based Copy ensures that EBS Snapshots are copied within and across AWS Regions in a specified timeframe. Cross Region PrivateLink enables customers to connect to VPC endpoint services hosted in other AWS Regions.

CopySnapshot (updated)

Link ¶
Changes (request)

{'CompletionDurationMinutes': 'integer'}

Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a snapshot within the same Region, from one Region to another, or from a Region to an Outpost. You can't copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.

You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).

When copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless you enable encryption for the snapshot copy operation. By default, encrypted snapshot copies use the default KMS key; however, you can specify a different KMS key. To copy an encrypted snapshot that has been shared from another account, you must have permissions for the KMS key used to encrypt the snapshot.

Snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.

Snapshots created by copying another snapshot have an arbitrary volume ID that should not be used for any purpose.

For more information, see Copy an Amazon EBS snapshot in the Amazon EBS User Guide.

See also: AWS API Documentation

Request Syntax

client.copy_snapshot(
    Description='string',
    DestinationOutpostArn='string',
    DestinationRegion='string',
    Encrypted=True|False,
    KmsKeyId='string',
    PresignedUrl='string',
    SourceRegion='string',
    SourceSnapshotId='string',
    TagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'ipam-external-resource-verification-token',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    CompletionDurationMinutes=123,
    DryRun=True|False
)

type Description:

string

param Description:

A description for the EBS snapshot.

type DestinationOutpostArn:

string

param DestinationOutpostArn:

The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only specify this parameter when copying a snapshot from an Amazon Web Services Region to an Outpost. The snapshot must be in the Region for the destination Outpost. You cannot copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.

For more information, see Copy snapshots from an Amazon Web Services Region to an Outpost in the Amazon EBS User Guide.

type DestinationRegion:

string

param DestinationRegion:

The destination Region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination Region in a PresignedUrl parameter, where it is required.

The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example, ec2.us-east-1.amazonaws.com). With the CLI, this is specified using the --region parameter or the default Region in your Amazon Web Services configuration file.

type Encrypted:

boolean

param Encrypted:

To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Otherwise, omit this parameter. Encrypted snapshots are encrypted, even if you omit this parameter and encryption by default is not enabled. You cannot set this parameter to false. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.

type KmsKeyId:

string

param KmsKeyId:

The identifier of the KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the KMS key using any of the following:

Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

type PresignedUrl:

string

param PresignedUrl:

When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query requests.

The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using Amazon Web Services Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) in the Amazon S3 API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

type SourceRegion:

string

param SourceRegion:

[REQUIRED]

The ID of the Region that contains the snapshot to be copied.

type SourceSnapshotId:

string

param SourceSnapshotId:

[REQUIRED]

The ID of the EBS snapshot to copy.

type TagSpecifications:

list

param TagSpecifications:

The tags to apply to the new snapshot.

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

Note

The Valid Values lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error.
- 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.

type CompletionDurationMinutes:

integer

param CompletionDurationMinutes:

Specify a completion duration, in 15 minute increments, to initiate a time-based snapshot copy. Time-based snapshot copy operations complete within the specified duration. For more information, see Time-based copies.

If you do not specify a value, the snapshot copy operation is completed on a best-effort basis.

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.

rtype:

dict

returns:

Response Syntax

{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'SnapshotId': 'string'
}

Response Structure

(dict) --
- Tags (list) --
  
  Any tags applied to the new snapshot.
  - (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.
- SnapshotId (string) --
  
  The ID of the new snapshot.

CreateSnapshot (updated)

Link ¶
Changes (response)

{'CompletionDurationMinutes': 'integer',
 'CompletionTime': 'timestamp',
 'TransferType': 'time-based | standard'}

Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.

You can create snapshots of volumes in a Region and volumes on an Outpost. If you create a snapshot of a volume in a Region, the snapshot must be stored in the same Region as the volume. If you create a snapshot of a volume on an Outpost, the snapshot can be stored on the same Outpost as the volume, or in the Region for that Outpost.

When a snapshot is created, any Amazon Web Services Marketplace product codes that are associated with the source volume are propagated to the snapshot.

You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your Amazon EBS volume at the time the snapshot command is issued; this might exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending.

When you create a snapshot for an EBS volume that serves as a root device, we recommend that you stop the instance before taking the snapshot.

Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.

You can tag your snapshots during creation. For more information, see Tag your Amazon EC2 resources in the Amazon EC2 User Guide.

For more information, see Amazon EBS and Amazon EBS encryption in the Amazon EBS User Guide.

See also: AWS API Documentation

Request Syntax

client.create_snapshot(
    Description='string',
    OutpostArn='string',
    VolumeId='string',
    TagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'ipam-external-resource-verification-token',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    DryRun=True|False
)

type Description:

string

param Description:

A description for the snapshot.

type OutpostArn:

string

param OutpostArn:

The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.

To create a snapshot of a volume in a Region, omit this parameter. The snapshot is created in the same Region as the volume.
To create a snapshot of a volume on an Outpost and store the snapshot in the Region, omit this parameter. The snapshot is created in the Region for the Outpost.
To create a snapshot of a volume on an Outpost and store the snapshot on an Outpost, specify the ARN of the destination Outpost. The snapshot must be created on the same Outpost as the volume.

For more information, see Create local snapshots from volumes on an Outpost in the Amazon EBS User Guide.

type VolumeId:

string

param VolumeId:

[REQUIRED]

The ID of the Amazon EBS volume.

type TagSpecifications:

list

param TagSpecifications:

The tags to apply to the snapshot during creation.

(dict) --

The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.

Note

The Valid Values lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error.
- 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.

type DryRun:

boolean

param DryRun:

rtype:

dict

returns:

Response Syntax

{
    'OwnerAlias': 'string',
    'OutpostArn': 'string',
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'StorageTier': 'archive'|'standard',
    'RestoreExpiryTime': datetime(2015, 1, 1),
    'SseType': 'sse-ebs'|'sse-kms'|'none',
    'TransferType': 'time-based'|'standard',
    'CompletionDurationMinutes': 123,
    'CompletionTime': datetime(2015, 1, 1),
    'SnapshotId': 'string',
    'VolumeId': 'string',
    'State': 'pending'|'completed'|'error'|'recoverable'|'recovering',
    'StateMessage': 'string',
    'StartTime': datetime(2015, 1, 1),
    'Progress': 'string',
    'OwnerId': 'string',
    'Description': 'string',
    'VolumeSize': 123,
    'Encrypted': True|False,
    'KmsKeyId': 'string',
    'DataEncryptionKeyId': 'string'
}

Response Structure

(dict) --

Describes a snapshot.
- OwnerAlias (string) --
  
  The Amazon Web Services owner alias, from an Amazon-maintained list ( amazon). This is not the user-configured Amazon Web Services account alias set using the IAM console.
- OutpostArn (string) --
  
  The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.
- Tags (list) --
  
  Any tags assigned to the snapshot.
  - (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.
- StorageTier (string) --
  
  The storage tier in which the snapshot is stored. standard indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. archive indicates that the snapshot is currently archived and that it must be restored before it can be used.
- RestoreExpiryTime (datetime) --
  
  Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.
- SseType (string) --
  
  Reserved for future use.
- TransferType (string) --
  
  Note
  
  Only for snapshot copies.
  
  Indicates whether the snapshot copy was created with a standard or time-based snapshot copy operation. Time-based snapshot copy operations complete within the completion duration specified in the request. Standard snapshot copy operations are completed on a best-effort basis.
  - standard - The snapshot copy was created with a standard snapshot copy operation.
  - time-based - The snapshot copy was created with a time-based snapshot copy operation.
- CompletionDurationMinutes (integer) --
  
  Note
  
  Only for snapshot copies created with time-based snapshot copy operations.
  
  The completion duration requested for the time-based snapshot copy operation.
- CompletionTime (datetime) --
  
  The time stamp when the snapshot was completed.
- SnapshotId (string) --
  
  The ID of the snapshot. Each snapshot receives a unique identifier when it is created.
- VolumeId (string) --
  
  The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.
- State (string) --
  
  The snapshot state.
- StateMessage (string) --
  
  Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper KMS permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by DescribeSnapshots.
- StartTime (datetime) --
  
  The time stamp when the snapshot was initiated.
- Progress (string) --
  
  The progress of the snapshot, as a percentage.
- OwnerId (string) --
  
  The ID of the Amazon Web Services account that owns the EBS snapshot.
- Description (string) --
  
  The description for the snapshot.
- VolumeSize (integer) --
  
  The size of the volume, in GiB.
- Encrypted (boolean) --
  
  Indicates whether the snapshot is encrypted.
- KmsKeyId (string) --
  
  The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the parent volume.
- DataEncryptionKeyId (string) --
  
  The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots.

CreateVpcEndpoint (updated)

Link ¶
Changes (request, response)
Request

{'ServiceRegion': 'string'}

Response

{'VpcEndpoint': {'ServiceRegion': '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',
    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
    },
    ClientToken='string',
    PrivateDnsEnabled=True|False,
    TagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'ipam-external-resource-verification-token',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    SubnetConfigurations=[
        {
            'SubnetId': 'string',
            'Ipv4': 'string',
            'Ipv6': 'string'
        },
    ],
    ServiceRegion='string'
)

type DryRun:

boolean

param DryRun:

type VpcEndpointType:

string

param VpcEndpointType:

The type of endpoint.

Default: Gateway

type VpcId:

string

param VpcId:

[REQUIRED]

The ID of the VPC.

type ServiceName:

string

param ServiceName:

[REQUIRED]

The name of the endpoint service.

type PolicyDocument:

string

param PolicyDocument:

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

type RouteTableIds:

list

param RouteTableIds:

(Gateway endpoint) The route table IDs.

(string) --

type SubnetIds:

list

param SubnetIds:

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

type SecurityGroupIds:

list

param SecurityGroupIds:

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

type IpAddressType:

string

param IpAddressType:

The IP address type for the endpoint.

type DnsOptions:

dict

param DnsOptions:

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.

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 PrivateDnsEnabled:

boolean

param PrivateDnsEnabled:

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

Default: true

type TagSpecifications:

list

param TagSpecifications:

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.

Note

The Valid Values lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error.
- 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.

type SubnetConfigurations:

list

param SubnetConfigurations:

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.

type ServiceRegion:

string

param ServiceRegion:

The Region where the service is hosted. The default is the current Region.

rtype:

dict

returns:

Response Syntax

{
    'VpcEndpoint': {
        'VpcEndpointId': 'string',
        'VpcEndpointType': 'Interface'|'Gateway'|'GatewayLoadBalancer',
        'VpcId': 'string',
        'ServiceName': 'string',
        'State': 'PendingAcceptance'|'Pending'|'Available'|'Deleting'|'Deleted'|'Rejected'|'Failed'|'Expired',
        '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
        },
        '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'
        },
        '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.
  - 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.
  - 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.

CreateVpcEndpointConnectionNotification (updated)

Link ¶
Changes (response)

{'ConnectionNotification': {'ServiceRegion': 'string'}}

Creates a connection notification for a specified VPC endpoint or VPC endpoint service. A connection notification notifies you of specific endpoint events. You must create an SNS topic to receive notifications. For more information, see Creating an Amazon SNS topic in the Amazon SNS Developer Guide.

You can create a connection notification for interface endpoints only.

See also: AWS API Documentation

Request Syntax

client.create_vpc_endpoint_connection_notification(
    DryRun=True|False,
    ServiceId='string',
    VpcEndpointId='string',
    ConnectionNotificationArn='string',
    ConnectionEvents=[
        'string',
    ],
    ClientToken='string'
)

type DryRun:

boolean

param DryRun:

type ServiceId:

string

param ServiceId:

The ID of the endpoint service.

type VpcEndpointId:

string

param VpcEndpointId:

The ID of the endpoint.

type ConnectionNotificationArn:

string

param ConnectionNotificationArn:

[REQUIRED]

The ARN of the SNS topic for the notifications.

type ConnectionEvents:

list

param ConnectionEvents:

[REQUIRED]

The endpoint events for which to receive notifications. Valid values are Accept, Connect, Delete, and Reject.

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

rtype:

dict

returns:

Response Syntax

{
    'ConnectionNotification': {
        'ConnectionNotificationId': 'string',
        'ServiceId': 'string',
        'VpcEndpointId': 'string',
        'ConnectionNotificationType': 'Topic',
        'ConnectionNotificationArn': 'string',
        'ConnectionEvents': [
            'string',
        ],
        'ConnectionNotificationState': 'Enabled'|'Disabled',
        'ServiceRegion': 'string'
    },
    'ClientToken': 'string'
}

Response Structure

(dict) --
- ConnectionNotification (dict) --
  
  Information about the notification.
  - ConnectionNotificationId (string) --
    
    The ID of the notification.
  - ServiceId (string) --
    
    The ID of the endpoint service.
  - VpcEndpointId (string) --
    
    The ID of the VPC endpoint.
  - ConnectionNotificationType (string) --
    
    The type of notification.
  - ConnectionNotificationArn (string) --
    
    The ARN of the SNS topic for the notification.
  - ConnectionEvents (list) --
    
    The events for the notification. Valid values are Accept, Connect, Delete, and Reject.
    - (string) --
  - ConnectionNotificationState (string) --
    
    The state of the notification.
  - ServiceRegion (string) --
    
    The Region for the endpoint service.
- ClientToken (string) --
  
  Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

CreateVpcEndpointServiceConfiguration (updated)

Link ¶
Changes (request, response)
Request

{'SupportedRegions': ['string']}

Response

{'ServiceConfiguration': {'RemoteAccessEnabled': 'boolean',
                          'SupportedRegions': [{'Region': 'string',
                                                'ServiceState': 'string'}]}}

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

Before you create an endpoint service, you must 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.

If you set the private DNS name, you must prove that you own the private DNS domain name.

For more information, see the Amazon Web Services PrivateLink 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',
    ],
    SupportedIpAddressTypes=[
        'string',
    ],
    SupportedRegions=[
        'string',
    ],
    ClientToken='string',
    TagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'ipam-external-resource-verification-token',
            '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 manually.

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 the Network Load Balancers.

(string) --

type GatewayLoadBalancerArns:

list

param GatewayLoadBalancerArns:

The Amazon Resource Names (ARNs) of the Gateway Load Balancers.

(string) --

type SupportedIpAddressTypes:

list

param SupportedIpAddressTypes:

The supported IP address types. The possible values are ipv4 and ipv6.

(string) --

type SupportedRegions:

list

param SupportedRegions:

The Regions from which service consumers can access the service.

(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. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.

Note

The Valid Values lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error.
- 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.

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',
        ],
        'SupportedIpAddressTypes': [
            'ipv4'|'ipv6',
        ],
        'BaseEndpointDnsNames': [
            'string',
        ],
        'PrivateDnsName': 'string',
        'PrivateDnsNameConfiguration': {
            'State': 'pendingVerification'|'verified'|'failed',
            'Type': 'string',
            'Value': 'string',
            'Name': 'string'
        },
        'PayerResponsibility': 'ServiceOwner',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'SupportedRegions': [
            {
                'Region': 'string',
                'ServiceState': 'string'
            },
        ],
        'RemoteAccessEnabled': True|False
    },
    '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) --
  - SupportedIpAddressTypes (list) --
    
    The supported IP address types.
    - (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) --
    
    The 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 256 Unicode characters.
  - SupportedRegions (list) --
    
    The supported Regions.
    - (dict) --
      
      Describes a supported Region.
      - Region (string) --
        
        The Region code.
      - ServiceState (string) --
        
        The service state. The possible values are Pending, Available, Deleting, Deleted, Failed, and Closed.
  - RemoteAccessEnabled (boolean) --
    
    Indicates whether consumers can access the service from a Region other than the Region where the service is hosted.
- ClientToken (string) --
  
  Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

DescribeSnapshots (updated)

Link ¶
Changes (response)

{'Snapshots': {'CompletionDurationMinutes': 'integer',
               'CompletionTime': 'timestamp',
               'TransferType': 'time-based | standard'}}

Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you.

The snapshots available to you include public snapshots, private snapshots that you own, and private snapshots owned by other Amazon Web Services accounts for which you have explicit create volume permissions.

The create volume permissions fall into the following categories:

public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All Amazon Web Services accounts have create volume permissions for these snapshots.
explicit: The owner of the snapshot granted create volume permissions to a specific Amazon Web Services account.
implicit: An Amazon Web Services account has implicit create volume permissions for all snapshots it owns.

The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot owners, or Amazon Web Services accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.

If you specify one or more snapshot owners using the OwnerIds option, only snapshots from the specified owners and for which you have access are returned. The results can include the Amazon Web Services account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.

If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify Amazon Web Services account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.

If you are describing a long list of snapshots, we recommend that you paginate the output to make the list more manageable. For more information, see Pagination.

To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.

For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon EBS User Guide.

See also: AWS API Documentation

Request Syntax

client.describe_snapshots(
    MaxResults=123,
    NextToken='string',
    OwnerIds=[
        'string',
    ],
    RestorableByUserIds=[
        'string',
    ],
    SnapshotIds=[
        'string',
    ],
    DryRun=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ]
)

type MaxResults:

integer

param MaxResults:

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

type NextToken:

string

param NextToken:

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

type OwnerIds:

list

param OwnerIds:

Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services account IDs, self, and amazon.

(string) --

type RestorableByUserIds:

list

param RestorableByUserIds:

The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.

(string) --

type SnapshotIds:

list

param SnapshotIds:

The snapshot IDs.

Default: Describes the snapshots for which you have create volume permissions.

(string) --

type DryRun:

boolean

param DryRun:

type Filters:

list

param Filters:

The filters.

description - A description of the snapshot.
encrypted - Indicates whether the snapshot is encrypted ( true | false)
owner-alias - The owner alias, from an Amazon-maintained list ( amazon). This is not the user-configured Amazon Web Services account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.
owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the related parameter instead of this filter.
progress - The progress of the snapshot, as a percentage (for example, 80%).
snapshot-id - The snapshot ID.
start-time - The time stamp when the snapshot was initiated.
status - The status of the snapshot ( pending | completed | error).
storage-tier - The storage tier of the snapshot ( archive | standard).
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.
volume-id - The ID of the volume the snapshot is for.
volume-size - The size of the volume, in GiB.

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

rtype:

dict

returns:

Response Syntax

{
    'NextToken': 'string',
    'Snapshots': [
        {
            'OwnerAlias': 'string',
            'OutpostArn': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'StorageTier': 'archive'|'standard',
            'RestoreExpiryTime': datetime(2015, 1, 1),
            'SseType': 'sse-ebs'|'sse-kms'|'none',
            'TransferType': 'time-based'|'standard',
            'CompletionDurationMinutes': 123,
            'CompletionTime': datetime(2015, 1, 1),
            'SnapshotId': 'string',
            'VolumeId': 'string',
            'State': 'pending'|'completed'|'error'|'recoverable'|'recovering',
            'StateMessage': 'string',
            'StartTime': datetime(2015, 1, 1),
            'Progress': 'string',
            'OwnerId': 'string',
            'Description': 'string',
            'VolumeSize': 123,
            'Encrypted': True|False,
            'KmsKeyId': 'string',
            'DataEncryptionKeyId': 'string'
        },
    ]
}

Response Structure

(dict) --
- NextToken (string) --
  
  The token to include in another request to get the next page of items. This value is null when there are no more items to return.
- Snapshots (list) --
  
  Information about the snapshots.
  - (dict) --
    
    Describes a snapshot.
    - OwnerAlias (string) --
      
      The Amazon Web Services owner alias, from an Amazon-maintained list ( amazon). This is not the user-configured Amazon Web Services account alias set using the IAM console.
    - OutpostArn (string) --
      
      The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.
    - Tags (list) --
      
      Any tags assigned to the snapshot.
      - (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.
    - StorageTier (string) --
      
      The storage tier in which the snapshot is stored. standard indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. archive indicates that the snapshot is currently archived and that it must be restored before it can be used.
    - RestoreExpiryTime (datetime) --
      
      Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.
    - SseType (string) --
      
      Reserved for future use.
    - TransferType (string) --
      
      Note
      
      Only for snapshot copies.
      
      Indicates whether the snapshot copy was created with a standard or time-based snapshot copy operation. Time-based snapshot copy operations complete within the completion duration specified in the request. Standard snapshot copy operations are completed on a best-effort basis.
      - standard - The snapshot copy was created with a standard snapshot copy operation.
      - time-based - The snapshot copy was created with a time-based snapshot copy operation.
    - CompletionDurationMinutes (integer) --
      
      Note
      
      Only for snapshot copies created with time-based snapshot copy operations.
      
      The completion duration requested for the time-based snapshot copy operation.
    - CompletionTime (datetime) --
      
      The time stamp when the snapshot was completed.
    - SnapshotId (string) --
      
      The ID of the snapshot. Each snapshot receives a unique identifier when it is created.
    - VolumeId (string) --
      
      The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.
    - State (string) --
      
      The snapshot state.
    - StateMessage (string) --
      
      Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper KMS permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by DescribeSnapshots.
    - StartTime (datetime) --
      
      The time stamp when the snapshot was initiated.
    - Progress (string) --
      
      The progress of the snapshot, as a percentage.
    - OwnerId (string) --
      
      The ID of the Amazon Web Services account that owns the EBS snapshot.
    - Description (string) --
      
      The description for the snapshot.
    - VolumeSize (integer) --
      
      The size of the volume, in GiB.
    - Encrypted (boolean) --
      
      Indicates whether the snapshot is encrypted.
    - KmsKeyId (string) --
      
      The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the parent volume.
    - DataEncryptionKeyId (string) --
      
      The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots.

DescribeVpcEndpointConnectionNotifications (updated)

Link ¶
Changes (response)

{'ConnectionNotificationSet': {'ServiceRegion': 'string'}}

Describes the connection notifications for VPC endpoints and VPC endpoint services.

See also: AWS API Documentation

Request Syntax

client.describe_vpc_endpoint_connection_notifications(
    DryRun=True|False,
    ConnectionNotificationId='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)

type DryRun:

boolean

param DryRun:

type ConnectionNotificationId:

string

param ConnectionNotificationId:

The ID of the notification.

type Filters:

list

param Filters:

The filters.

connection-notification-arn - The ARN of the SNS topic for the notification.
connection-notification-id - The ID of the notification.
connection-notification-state - The state of the notification ( Enabled | Disabled).
connection-notification-type - The type of notification ( Topic).
service-id - The ID of the endpoint service.
vpc-endpoint-id - The ID of the VPC endpoint.

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

type MaxResults:

integer

param MaxResults:

The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value.

type NextToken:

string

param NextToken:

The token to request the next page of results.

rtype:

dict

returns:

Response Syntax

{
    'ConnectionNotificationSet': [
        {
            'ConnectionNotificationId': 'string',
            'ServiceId': 'string',
            'VpcEndpointId': 'string',
            'ConnectionNotificationType': 'Topic',
            'ConnectionNotificationArn': 'string',
            'ConnectionEvents': [
                'string',
            ],
            'ConnectionNotificationState': 'Enabled'|'Disabled',
            'ServiceRegion': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- ConnectionNotificationSet (list) --
  
  The notifications.
  - (dict) --
    
    Describes a connection notification for a VPC endpoint or VPC endpoint service.
    - ConnectionNotificationId (string) --
      
      The ID of the notification.
    - ServiceId (string) --
      
      The ID of the endpoint service.
    - VpcEndpointId (string) --
      
      The ID of the VPC endpoint.
    - ConnectionNotificationType (string) --
      
      The type of notification.
    - ConnectionNotificationArn (string) --
      
      The ARN of the SNS topic for the notification.
    - ConnectionEvents (list) --
      
      The events for the notification. Valid values are Accept, Connect, Delete, and Reject.
      - (string) --
    - ConnectionNotificationState (string) --
      
      The state of the notification.
    - ServiceRegion (string) --
      
      The Region for the endpoint 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.

DescribeVpcEndpointConnections (updated)

Link ¶
Changes (response)

{'VpcEndpointConnections': {'VpcEndpointRegion': 'string'}}

Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.

See also: AWS API Documentation

Request Syntax

client.describe_vpc_endpoint_connections(
    DryRun=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)

type DryRun:

boolean

param DryRun:

type Filters:

list

param Filters:

The filters.

ip-address-type - The IP address type ( ipv4 | ipv6).
service-id - The ID of the service.
vpc-endpoint-owner - The ID of the Amazon Web Services account ID that owns the endpoint.
vpc-endpoint-region - The Region of the endpoint or cross-region to find endpoints for other Regions.
vpc-endpoint-state - The state of the endpoint ( pendingAcceptance | pending | available | deleting | deleted | rejected | failed).
vpc-endpoint-id - The ID of the endpoint.

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

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

{
    'VpcEndpointConnections': [
        {
            'ServiceId': 'string',
            'VpcEndpointId': 'string',
            'VpcEndpointOwner': 'string',
            'VpcEndpointState': 'PendingAcceptance'|'Pending'|'Available'|'Deleting'|'Deleted'|'Rejected'|'Failed'|'Expired',
            'CreationTimestamp': datetime(2015, 1, 1),
            'DnsEntries': [
                {
                    'DnsName': 'string',
                    'HostedZoneId': 'string'
                },
            ],
            'NetworkLoadBalancerArns': [
                'string',
            ],
            'GatewayLoadBalancerArns': [
                'string',
            ],
            'IpAddressType': 'ipv4'|'dualstack'|'ipv6',
            'VpcEndpointConnectionId': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'VpcEndpointRegion': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- VpcEndpointConnections (list) --
  
  Information about the VPC endpoint connections.
  - (dict) --
    
    Describes a VPC endpoint connection to a service.
    - ServiceId (string) --
      
      The ID of the service to which the endpoint is connected.
    - VpcEndpointId (string) --
      
      The ID of the VPC endpoint.
    - VpcEndpointOwner (string) --
      
      The ID of the Amazon Web Services account that owns the VPC endpoint.
    - VpcEndpointState (string) --
      
      The state of the VPC endpoint.
    - CreationTimestamp (datetime) --
      
      The date and time that the VPC endpoint was created.
    - DnsEntries (list) --
      
      The DNS entries for the VPC endpoint.
      - (dict) --
        
        Describes a DNS entry.
        
        DnsName (string) --
        
        The DNS name.
        
        HostedZoneId (string) --
        
        The ID of the private hosted zone.
    - 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) --
    - IpAddressType (string) --
      
      The IP address type for the endpoint.
    - VpcEndpointConnectionId (string) --
      
      The ID of the VPC endpoint connection.
    - Tags (list) --
      
      The tags.
      - (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.
    - VpcEndpointRegion (string) --
      
      The Region of the endpoint.
- 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.

DescribeVpcEndpointServiceConfigurations (updated)

Link ¶
Changes (response)

{'ServiceConfigurations': {'RemoteAccessEnabled': 'boolean',
                           'SupportedRegions': [{'Region': 'string',
                                                 'ServiceState': 'string'}]}}

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 the endpoint services.

(string) --

type Filters:

list

param Filters:

The 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).
supported-ip-address-types - The IP address type ( ipv4 | ipv6).
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.

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

type MaxResults:

integer

param MaxResults:

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',
            ],
            'SupportedIpAddressTypes': [
                'ipv4'|'ipv6',
            ],
            'BaseEndpointDnsNames': [
                'string',
            ],
            'PrivateDnsName': 'string',
            'PrivateDnsNameConfiguration': {
                'State': 'pendingVerification'|'verified'|'failed',
                'Type': 'string',
                'Value': 'string',
                'Name': 'string'
            },
            'PayerResponsibility': 'ServiceOwner',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'SupportedRegions': [
                {
                    'Region': 'string',
                    'ServiceState': 'string'
                },
            ],
            'RemoteAccessEnabled': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- ServiceConfigurations (list) --
  
  Information about the 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) --
    - SupportedIpAddressTypes (list) --
      
      The supported IP address types.
      - (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) --
      
      The 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 256 Unicode characters.
    - SupportedRegions (list) --
      
      The supported Regions.
      - (dict) --
        
        Describes a supported Region.
        
        Region (string) --
        
        The Region code.
        
        ServiceState (string) --
        
        The service state. The possible values are Pending, Available, Deleting, Deleted, Failed, and Closed.
    - RemoteAccessEnabled (boolean) --
      
      Indicates whether consumers can access the service from a Region other than the Region where the service is hosted.
- 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 (request, response)
Request

{'ServiceRegions': ['string']}

Response

{'ServiceDetails': {'ServiceRegion': 'string'}}

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',
    ServiceRegions=[
        'string',
    ]
)

type DryRun:

boolean

param DryRun:

type ServiceNames:

list

param ServiceNames:

The service names.

(string) --

type Filters:

list

param Filters:

The filters.

owner - The ID or alias of the Amazon Web Services account that owns the service.
service-name - The name of the service.
service-region - The Region of the service.
service-type - The type of service ( Interface | Gateway | GatewayLoadBalancer).
supported-ip-address-types - The IP address type ( ipv4 | ipv6).
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.

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

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

type ServiceRegions:

list

param ServiceRegions:

The service Regions.

(string) --

rtype:

dict

returns:

Response Syntax

{
    'ServiceNames': [
        'string',
    ],
    'ServiceDetails': [
        {
            'ServiceName': 'string',
            'ServiceId': 'string',
            'ServiceType': [
                {
                    'ServiceType': 'Interface'|'Gateway'|'GatewayLoadBalancer'
                },
            ],
            'ServiceRegion': 'string',
            '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',
            'SupportedIpAddressTypes': [
                'ipv4'|'ipv6',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- ServiceNames (list) --
  
  The supported services.
  - (string) --
- ServiceDetails (list) --
  
  Information about the service.
  - (dict) --
    
    Describes a VPC endpoint service.
    - ServiceName (string) --
      
      The name 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.
    - ServiceRegion (string) --
      
      The Region where the service is hosted.
    - 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) --
      
      The 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 256 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.
    - SupportedIpAddressTypes (list) --
      
      The supported IP address types.
      - (string) --
- 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.

DescribeVpcEndpoints (updated)

Link ¶
Changes (response)

{'VpcEndpoints': {'ServiceRegion': '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'
)

type DryRun:

boolean

param DryRun:

type VpcEndpointIds:

list

param VpcEndpointIds:

The IDs of the VPC endpoints.

(string) --

type Filters:

list

param Filters:

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

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

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

{
    'VpcEndpoints': [
        {
            'VpcEndpointId': 'string',
            'VpcEndpointType': 'Interface'|'Gateway'|'GatewayLoadBalancer',
            'VpcId': 'string',
            'ServiceName': 'string',
            'State': 'PendingAcceptance'|'Pending'|'Available'|'Deleting'|'Deleted'|'Rejected'|'Failed'|'Expired',
            '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
            },
            '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'
            },
            '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.
    - 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.
    - 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.

ModifyVpcEndpointServiceConfiguration (updated)

Link ¶
Changes (request)

{'AddSupportedRegions': ['string'], 'RemoveSupportedRegions': ['string']}

Modifies the attributes of the specified VPC endpoint service configuration.

If you set or modify the private DNS name, you must prove that you own the private DNS domain name.

See also: AWS API Documentation

Request Syntax

client.modify_vpc_endpoint_service_configuration(
    DryRun=True|False,
    ServiceId='string',
    PrivateDnsName='string',
    RemovePrivateDnsName=True|False,
    AcceptanceRequired=True|False,
    AddNetworkLoadBalancerArns=[
        'string',
    ],
    RemoveNetworkLoadBalancerArns=[
        'string',
    ],
    AddGatewayLoadBalancerArns=[
        'string',
    ],
    RemoveGatewayLoadBalancerArns=[
        'string',
    ],
    AddSupportedIpAddressTypes=[
        'string',
    ],
    RemoveSupportedIpAddressTypes=[
        'string',
    ],
    AddSupportedRegions=[
        'string',
    ],
    RemoveSupportedRegions=[
        'string',
    ]
)

type DryRun:

boolean

param DryRun:

type ServiceId:

string

param ServiceId:

[REQUIRED]

The ID of the service.

type PrivateDnsName:

string

param PrivateDnsName:

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

type RemovePrivateDnsName:

boolean

param RemovePrivateDnsName:

(Interface endpoint configuration) Removes the private DNS name of the endpoint service.

type AcceptanceRequired:

boolean

param AcceptanceRequired:

Indicates whether requests to create an endpoint to the service must be accepted.

type AddNetworkLoadBalancerArns:

list

param AddNetworkLoadBalancerArns:

The Amazon Resource Names (ARNs) of Network Load Balancers to add to the service configuration.

(string) --

type RemoveNetworkLoadBalancerArns:

list

param RemoveNetworkLoadBalancerArns:

The Amazon Resource Names (ARNs) of Network Load Balancers to remove from the service configuration.

(string) --

type AddGatewayLoadBalancerArns:

list

param AddGatewayLoadBalancerArns:

The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to the service configuration.

(string) --

type RemoveGatewayLoadBalancerArns:

list

param RemoveGatewayLoadBalancerArns:

The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from the service configuration.

(string) --

type AddSupportedIpAddressTypes:

list

param AddSupportedIpAddressTypes:

The IP address types to add to the service configuration.

(string) --

type RemoveSupportedIpAddressTypes:

list

param RemoveSupportedIpAddressTypes:

The IP address types to remove from the service configuration.

(string) --

type AddSupportedRegions:

list

param AddSupportedRegions:

The supported Regions to add to the service configuration.

(string) --

type RemoveSupportedRegions:

list

param RemoveSupportedRegions:

The supported Regions to remove from the service configuration.

(string) --

rtype:

dict

returns:

Response Syntax

{
    'Return': True|False
}

Response Structure

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