2026/11/16 - Amazon Elastic Compute Cloud - 6 new7 updated api methods
Changes Adds a new Transit Gateway Attachment type called Network Function. Launches associated KMS Keys for EBS Snapshots - associated KMS keys enable customers to share and copy snapshots encrypted with AWS Managed Keys across AWS accounts.
Creates a network function attachment that connects the specified transit gateway to a Gateway Load Balancer endpoint service. Traffic that you route to the attachment is sent to the network function appliances behind the endpoint service. To use this operation, you must be the owner of the transit gateway.
You can create one network function attachment for each combination of transit gateway and endpoint service. The attachment remains in the pendingAcceptance state until the endpoint service owner accepts the endpoint connection.
See also: AWS API Documentation
Request Syntax
client.create_transit_gateway_network_function_attachment(
TransitGatewayId='string',
ServiceName='string',
AvailabilityZones=[
'string',
],
AvailabilityZoneIds=[
'string',
],
TagSpecifications=[
{
'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fca-policy'|'fleet'|'fpga-image'|'host-reservation'|'image'|'image-usage-report'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-metering-policy'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'vpc-encryption-control'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task'|'ipam-prefix-list-resolver'|'ipam-policy'|'ipam-prefix-list-resolver-target'|'ipam-internet-registry-association'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator'|'ipam-pool-allocation'|'capacity-reservation-cancellation-quote'|'application-status-check'|'capacity-reservation-modification-quote'|'metric-category',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False
)
string
[REQUIRED]
The ID of the transit gateway. The transit gateway must be in the available state.
string
[REQUIRED]
The name of the Gateway Load Balancer endpoint service.
list
The names of the Availability Zones for the attachment. You must specify at least one Availability Zone, using this parameter, AvailabilityZoneIds, or both. Each Availability Zone must be supported by both the transit gateway and the endpoint service.
(string) --
list
The IDs of the Availability Zones for the attachment. You must specify at least one Availability Zone, using this parameter, AvailabilityZones, or both. Each Availability Zone must be supported by both the transit gateway and the endpoint service.
(string) --
list
The tags to apply to the network function attachment.
(dict) --
The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
ResourceType (string) --
The type of resource to tag on creation.
Tags (list) --
The tags to apply to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'TransitGatewayNetworkFunctionAttachment': {
'TransitGatewayAttachmentId': 'string',
'TransitGatewayId': 'string',
'TransitGatewayOwnerId': 'string',
'ResourceOwnerId': 'string',
'ResourceId': 'string',
'AvailabilityZones': [
'string',
],
'AvailabilityZoneIds': [
'string',
],
'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
'CreationTime': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
TransitGatewayNetworkFunctionAttachment (dict) --
Information about the network function attachment.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
TransitGatewayId (string) --
The ID of the transit gateway.
TransitGatewayOwnerId (string) --
The ID of the Amazon Web Services account that owns the transit gateway.
ResourceOwnerId (string) --
The ID of the Amazon Web Services account that owns the attachment.
ResourceId (string) --
The name of the Gateway Load Balancer endpoint service.
AvailabilityZones (list) --
The names of the Availability Zones for the attachment.
(string) --
AvailabilityZoneIds (list) --
The IDs of the Availability Zones for the attachment.
(string) --
State (string) --
The state of the attachment.
CreationTime (datetime) --
The date and time the attachment was created.
Tags (list) --
The tags for the attachment.
(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.
Adds Availability Zones to or removes Availability Zones from the specified network function attachment. The attachment must be in the available state. You must specify at least one Availability Zone to add or remove, and the attachment must keep at least one Availability Zone.
Adding an Availability Zone provisions a new Gateway Load Balancer endpoint in that Availability Zone. If the endpoint service doesn't automatically accept connection requests, the endpoint service owner must accept the endpoint connection for each Availability Zone that you add.
See also: AWS API Documentation
Request Syntax
client.modify_transit_gateway_network_function_attachment(
TransitGatewayAttachmentId='string',
AddAvailabilityZones=[
'string',
],
AddAvailabilityZoneIds=[
'string',
],
RemoveAvailabilityZones=[
'string',
],
RemoveAvailabilityZoneIds=[
'string',
],
DryRun=True|False
)
string
[REQUIRED]
The ID of the network function attachment.
list
The names of the Availability Zones to add to the attachment. You can't add and remove the same Availability Zone in a single request.
(string) --
list
The IDs of the Availability Zones to add to the attachment. You can't add and remove the same Availability Zone in a single request.
(string) --
list
The names of the Availability Zones to remove from the attachment. Each Availability Zone must be currently in the attachment.
(string) --
list
The IDs of the Availability Zones to remove from the attachment. Each Availability Zone must be currently in the attachment.
(string) --
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'TransitGatewayNetworkFunctionAttachment': {
'TransitGatewayAttachmentId': 'string',
'TransitGatewayId': 'string',
'TransitGatewayOwnerId': 'string',
'ResourceOwnerId': 'string',
'ResourceId': 'string',
'AvailabilityZones': [
'string',
],
'AvailabilityZoneIds': [
'string',
],
'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
'CreationTime': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
TransitGatewayNetworkFunctionAttachment (dict) --
Information about the network function attachment.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
TransitGatewayId (string) --
The ID of the transit gateway.
TransitGatewayOwnerId (string) --
The ID of the Amazon Web Services account that owns the transit gateway.
ResourceOwnerId (string) --
The ID of the Amazon Web Services account that owns the attachment.
ResourceId (string) --
The name of the Gateway Load Balancer endpoint service.
AvailabilityZones (list) --
The names of the Availability Zones for the attachment.
(string) --
AvailabilityZoneIds (list) --
The IDs of the Availability Zones for the attachment.
(string) --
State (string) --
The state of the attachment.
CreationTime (datetime) --
The date and time the attachment was created.
Tags (list) --
The tags for the attachment.
(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.
Associates an additional KMS key with an encrypted Amazon EBS snapshot. With the associated key, you have a second, independent way to access the snapshot's data, in addition to the key the snapshot is already encrypted under. Associating a key doesn't re-encrypt the snapshot or grant access to its original key.
For more information, see Associated KMS keys in the Amazon EBS User Guide.
See also: AWS API Documentation
Request Syntax
client.associate_kms_key_id(
SnapshotId='string',
KmsKeyId='string',
DryRun=True|False
)
string
The ID of the Amazon EBS snapshot.
string
[REQUIRED]
The ID, alias, or ARN of the KMS key to associate with the snapshot. You can specify a key ID, key alias, key ARN, or alias ARN.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, it returns an error.
Describes one or more network function attachments. You can describe attachments that you own or that are attached to a transit gateway that you own.
See also: AWS API Documentation
Request Syntax
client.describe_transit_gateway_network_function_attachments(
TransitGatewayAttachmentIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
list
The IDs of the network function attachments.
(string) --
list
One or more filters. The possible values are:
service-name - The name of the Gateway Load Balancer endpoint service.
state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting.
transit-gateway-attachment-id - The ID of the attachment.
transit-gateway-id - The ID of the transit gateway.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
integer
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
string
The token for the next page of results.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'TransitGatewayNetworkFunctionAttachments': [
{
'TransitGatewayAttachmentId': 'string',
'TransitGatewayId': 'string',
'TransitGatewayOwnerId': 'string',
'ResourceOwnerId': 'string',
'ResourceId': 'string',
'AvailabilityZones': [
'string',
],
'AvailabilityZoneIds': [
'string',
],
'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
'CreationTime': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TransitGatewayNetworkFunctionAttachments (list) --
Information about the network function attachments.
(dict) --
Contains information about a transit gateway network function attachment, including the attachment ID, the transit gateway, the endpoint service, the Availability Zones, and the state of the attachment.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
TransitGatewayId (string) --
The ID of the transit gateway.
TransitGatewayOwnerId (string) --
The ID of the Amazon Web Services account that owns the transit gateway.
ResourceOwnerId (string) --
The ID of the Amazon Web Services account that owns the attachment.
ResourceId (string) --
The name of the Gateway Load Balancer endpoint service.
AvailabilityZones (list) --
The names of the Availability Zones for the attachment.
(string) --
AvailabilityZoneIds (list) --
The IDs of the Availability Zones for the attachment.
(string) --
State (string) --
The state of the attachment.
CreationTime (datetime) --
The date and time the attachment was created.
Tags (list) --
The tags for the attachment.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Removes an associated KMS key from an Amazon EBS snapshot. After you disassociate the key, it can no longer be used to access the snapshot's data. The snapshot's original encryption key is unaffected.
See also: AWS API Documentation
Request Syntax
client.disassociate_kms_key_id(
SnapshotId='string',
KmsKeyId='string',
DryRun=True|False
)
string
The ID of the Amazon EBS snapshot.
string
[REQUIRED]
The ID, alias, or ARN of the associated KMS key to remove from the snapshot.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, it returns an error.
Deletes the specified network function attachment. The attachment must be in the available or pendingAcceptance state.
See also: AWS API Documentation
Request Syntax
client.delete_transit_gateway_network_function_attachment(
TransitGatewayAttachmentId='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the network function attachment.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'TransitGatewayNetworkFunctionAttachment': {
'TransitGatewayAttachmentId': 'string',
'TransitGatewayId': 'string',
'TransitGatewayOwnerId': 'string',
'ResourceOwnerId': 'string',
'ResourceId': 'string',
'AvailabilityZones': [
'string',
],
'AvailabilityZoneIds': [
'string',
],
'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
'CreationTime': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
TransitGatewayNetworkFunctionAttachment (dict) --
Information about the deleted network function attachment.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
TransitGatewayId (string) --
The ID of the transit gateway.
TransitGatewayOwnerId (string) --
The ID of the Amazon Web Services account that owns the transit gateway.
ResourceOwnerId (string) --
The ID of the Amazon Web Services account that owns the attachment.
ResourceId (string) --
The name of the Gateway Load Balancer endpoint service.
AvailabilityZones (list) --
The names of the Availability Zones for the attachment.
(string) --
AvailabilityZoneIds (list) --
The IDs of the Availability Zones for the attachment.
(string) --
State (string) --
The state of the attachment.
CreationTime (datetime) --
The date and time the attachment was created.
Tags (list) --
The tags for the attachment.
(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.
{'TransitGatewayAttachmentIds': ['string']}
Accepts connection requests to your VPC endpoint service.
See also: AWS API Documentation
Request Syntax
client.accept_vpc_endpoint_connections(
DryRun=True|False,
ServiceId='string',
VpcEndpointIds=[
'string',
],
TransitGatewayAttachmentIds=[
'string',
]
)
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
string
[REQUIRED]
The ID of the VPC endpoint service.
list
[REQUIRED]
The IDs of the interface VPC endpoints.
You must specify either VpcEndpointIds or TransitGatewayAttachmentIds, but not both.
(string) --
list
The IDs of the transit gateway attachments to accept. This parameter is supported only for Gateway Load Balancer endpoint services.
You must specify either VpcEndpointIds or TransitGatewayAttachmentIds, but not both.
(string) --
dict
Response Syntax
{
'Unsuccessful': [
{
'Error': {
'Code': 'string',
'Message': 'string'
},
'ResourceId': 'string'
},
]
}
Response Structure
(dict) --
Unsuccessful (list) --
Information about the interface endpoints that were not accepted, if applicable.
(dict) --
Information about items that were not successfully processed in a batch call.
Error (dict) --
Information about the error.
Code (string) --
The error code.
Message (string) --
The error message accompanying the error code.
ResourceId (string) --
The ID of the resource.
{'AssociatedKmsKeys': [{'KmsKeyId': 'string'}]}
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.
The location of the source EBS volume determines where you can create the snapshot.
If the source volume is in a Region, you must create the snapshot in the same Region as the volume.
If the source volume is in a Local Zone, you can create the snapshot in the same Local Zone or in its parent Amazon Web Services Region.
If the source volume is on an Outpost, you can create the snapshot on the same Outpost or in its parent Amazon Web Services Region.
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. For more information, see 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'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fca-policy'|'fleet'|'fpga-image'|'host-reservation'|'image'|'image-usage-report'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-metering-policy'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'vpc-encryption-control'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task'|'ipam-prefix-list-resolver'|'ipam-policy'|'ipam-prefix-list-resolver-target'|'ipam-internet-registry-association'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator'|'ipam-pool-allocation'|'capacity-reservation-cancellation-quote'|'application-status-check'|'capacity-reservation-modification-quote'|'metric-category',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
Location='regional'|'local',
DryRun=True|False
)
string
A description for the snapshot.
string
To create the snapshot on the same Outpost as the source volume, specify the ARN of that Outpost. The snapshot must be created on the same Outpost as the volume.
To create the snapshot in the parent Region of the Outpost, omit this parameter.
For more information, see Create local snapshots from volumes on an Outpost in the Amazon EBS User Guide.
string
[REQUIRED]
The ID of the Amazon EBS volume.
list
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.
ResourceType (string) --
The type of resource to tag on creation.
Tags (list) --
The tags to apply to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
string
To create a local snapshot in the same Local Zone as the source volume, specify local.
To create a regional snapshot in the parent Region of the Local Zone, specify regional or omit this parameter.
Default value: regional
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'OwnerAlias': 'string',
'OutpostArn': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'StorageTier': 'archive'|'standard',
'RestoreExpiryTime': datetime(2015, 1, 1),
'SseType': 'sse-ebs'|'sse-kms'|'none',
'AvailabilityZone': 'string',
'TransferType': 'time-based'|'standard',
'CompletionDurationMinutes': 123,
'CompletionTime': datetime(2015, 1, 1),
'FullSnapshotSizeInBytes': 123,
'AssociatedKmsKeys': [
{
'KmsKeyId': 'string'
},
],
'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.
AvailabilityZone (string) --
The Availability Zone or Local Zone of the snapshot. For example, us-west-1a (Availability Zone) or us-west-2-lax-1a (Local Zone).
TransferType (string) --
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) --
The completion duration requested for the time-based snapshot copy operation.
CompletionTime (datetime) --
The time stamp when the snapshot was completed.
FullSnapshotSizeInBytes (integer) --
The full size of the snapshot, in bytes.
AssociatedKmsKeys (list) --
The additional KMS keys that are associated with the snapshot.
(dict) --
Describes an KMS key that is associated with an Amazon EBS snapshot, in addition to the key the snapshot is encrypted under. An associated key provides a second way to access the snapshot's data for cross-account sharing and copying.
KmsKeyId (string) --
The Amazon Resource Name (ARN) of the associated KMS key.
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 a copy snapshot operation have an arbitrary volume ID that you should not use 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.
{'Snapshots': {'AssociatedKmsKeys': [{'KmsKeyId': 'string'}]}}
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.
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',
]
},
]
)
integer
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
string
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
list
Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services account IDs, self, and amazon.
(string) --
list
The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.
(string) --
list
The snapshot IDs.
Default: Describes the snapshots for which you have create volume permissions.
(string) --
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
list
The filters.
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).
transfer-type - The type of operation used to create the snapshot ( time-based | 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.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
dict
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',
'AvailabilityZone': 'string',
'TransferType': 'time-based'|'standard',
'CompletionDurationMinutes': 123,
'CompletionTime': datetime(2015, 1, 1),
'FullSnapshotSizeInBytes': 123,
'AssociatedKmsKeys': [
{
'KmsKeyId': 'string'
},
],
'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.
AvailabilityZone (string) --
The Availability Zone or Local Zone of the snapshot. For example, us-west-1a (Availability Zone) or us-west-2-lax-1a (Local Zone).
TransferType (string) --
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) --
The completion duration requested for the time-based snapshot copy operation.
CompletionTime (datetime) --
The time stamp when the snapshot was completed.
FullSnapshotSizeInBytes (integer) --
The full size of the snapshot, in bytes.
AssociatedKmsKeys (list) --
The additional KMS keys that are associated with the snapshot.
(dict) --
Describes an KMS key that is associated with an Amazon EBS snapshot, in addition to the key the snapshot is encrypted under. An associated key provides a second way to access the snapshot's data for cross-account sharing and copying.
KmsKeyId (string) --
The Amazon Resource Name (ARN) of the associated KMS key.
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 a copy snapshot operation have an arbitrary volume ID that you should not use 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.
{'VpcEndpointConnections': {'TransitGatewayAttachmentId': 'string',
'TransitGatewayAttachmentOwner': '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'
)
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
list
The filters.
ip-address-type - The IP address type ( ipv4 | ipv6).
service-id - The ID of the service.
transit-gateway-attachment-id - The ID of the transit gateway attachment.
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.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
integer
The maximum number of results to return 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.
string
The token to retrieve the next page of results.
dict
Response Syntax
{
'VpcEndpointConnections': [
{
'ServiceId': 'string',
'VpcEndpointId': 'string',
'VpcEndpointOwner': 'string',
'VpcEndpointState': 'PendingAcceptance'|'Pending'|'Available'|'Deleting'|'Deleted'|'Rejected'|'Failed'|'Expired'|'Partial',
'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',
'PayerResponsibilities': [
{
'Scope': 'vpc-endpoint-charges'|'resource-gateway-charges',
'PayerResponsibilityType': 'vpc-endpoint-account'|'resource-gateway-account'|'vpc-endpoint-service-account'
},
],
'TransitGatewayAttachmentId': 'string',
'TransitGatewayAttachmentOwner': '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.
PayerResponsibilities (list) --
The payer responsibility settings for the endpoint.
(dict) --
Describes a payer responsibility setting for a VPC endpoint.
Scope (string) --
The scope of usage/charges.
PayerResponsibilityType (string) --
The Amazon Web Services account to which the usage is charged.
TransitGatewayAttachmentId (string) --
The ID of the transit gateway attachment, if the connection is for a transit gateway attachment.
TransitGatewayAttachmentOwner (string) --
The ID of the Amazon Web Services account that owns the transit gateway attachment, if the connection is for a transit gateway attachment.
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.
{'AllowedPrincipals': {'PermissionType': 'vpc-endpoint | '
'transit-gateway-attachment'}}
Describes the principals (service consumers) that are permitted to discover your VPC endpoint service. Principal ARNs with path components aren't supported.
See also: AWS API Documentation
Request Syntax
client.describe_vpc_endpoint_service_permissions(
DryRun=True|False,
ServiceId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
string
[REQUIRED]
The ID of the service.
list
The filters.
permission-type - The permission type ( vpc-endpoint | transit-gateway-attachment).
principal - The ARN of the principal.
principal-type - The principal type ( All | Service | OrganizationUnit | Account | User | Role).
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
integer
The maximum number of results to return 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.
string
The token to retrieve the next page of results.
dict
Response Syntax
{
'AllowedPrincipals': [
{
'PrincipalType': 'All'|'Service'|'OrganizationUnit'|'Account'|'User'|'Role',
'Principal': 'string',
'ServicePermissionId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ServiceId': 'string',
'PermissionType': 'vpc-endpoint'|'transit-gateway-attachment'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AllowedPrincipals (list) --
Information about the allowed principals.
(dict) --
Describes a principal.
PrincipalType (string) --
The type of principal.
Principal (string) --
The Amazon Resource Name (ARN) of the principal.
ServicePermissionId (string) --
The ID of the service permission.
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.
ServiceId (string) --
The ID of the service.
PermissionType (string) --
The type of permission granted to the principal.
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.
{'PermissionType': 'vpc-endpoint | transit-gateway-attachment'}
Response {'AddedPrincipals': {'PermissionType': 'vpc-endpoint | '
'transit-gateway-attachment'}}
Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers (Amazon Web Services accounts, users, and IAM roles) to connect to your endpoint service. Principal ARNs with path components aren't supported.
If you grant permissions to all principals, the service is public. Any users who know the name of a public service can send a request to attach an endpoint. If the service does not require manual approval, attachments are automatically approved.
By default, principals that you grant permissions to can create VPC endpoints that connect to your endpoint service. For Gateway Load Balancer endpoint services, you can instead grant permissions so that principals can create transit gateway attachments that connect to your endpoint service. To do so, specify transit-gateway-attachment for PermissionType. The two permission types are independent. A principal can have either or both.
See also: AWS API Documentation
Request Syntax
client.modify_vpc_endpoint_service_permissions(
DryRun=True|False,
ServiceId='string',
AddAllowedPrincipals=[
'string',
],
RemoveAllowedPrincipals=[
'string',
],
PermissionType='vpc-endpoint'|'transit-gateway-attachment'
)
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
string
[REQUIRED]
The ID of the service.
list
The Amazon Resource Names (ARN) of the principals. Permissions are granted to the principals in this list. To grant permissions to all principals, specify an asterisk (*).
(string) --
list
The Amazon Resource Names (ARN) of the principals. Permissions are revoked for principals in this list.
(string) --
string
The type of permission to add or remove. The permission type applies to all principals in AddAllowedPrincipals and RemoveAllowedPrincipals.
vpc-endpoint - Principals can create VPC endpoints that connect to the endpoint service.
transit-gateway-attachment - Principals can create transit gateway attachments that connect to the endpoint service. This permission type is supported only for Gateway Load Balancer endpoint services. You can grant it only to Amazon Web Services accounts ( arn:aws:iam::account-id:root). You can't grant it to users, IAM roles, organizations, organizational units, or all principals (*).
Default: vpc-endpoint
dict
Response Syntax
{
'AddedPrincipals': [
{
'PrincipalType': 'All'|'Service'|'OrganizationUnit'|'Account'|'User'|'Role',
'Principal': 'string',
'ServicePermissionId': 'string',
'ServiceId': 'string',
'PermissionType': 'vpc-endpoint'|'transit-gateway-attachment'
},
],
'ReturnValue': True|False
}
Response Structure
(dict) --
AddedPrincipals (list) --
Information about the added principals.
(dict) --
Describes a principal.
PrincipalType (string) --
The type of principal.
Principal (string) --
The Amazon Resource Name (ARN) of the principal.
ServicePermissionId (string) --
The ID of the service permission.
ServiceId (string) --
The ID of the service.
PermissionType (string) --
The type of permission granted to the principal.
ReturnValue (boolean) --
Returns true if the request succeeds; otherwise, it returns an error.
{'TransitGatewayAttachmentIds': ['string']}
Rejects VPC endpoint connection requests to your VPC endpoint service.
See also: AWS API Documentation
Request Syntax
client.reject_vpc_endpoint_connections(
DryRun=True|False,
ServiceId='string',
VpcEndpointIds=[
'string',
],
TransitGatewayAttachmentIds=[
'string',
]
)
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
string
[REQUIRED]
The ID of the service.
list
[REQUIRED]
The IDs of the VPC endpoints.
You must specify either VpcEndpointIds or TransitGatewayAttachmentIds, but not both.
(string) --
list
The IDs of the transit gateway attachments to reject. This parameter is supported only for Gateway Load Balancer endpoint services.
You must specify either VpcEndpointIds or TransitGatewayAttachmentIds, but not both.
(string) --
dict
Response Syntax
{
'Unsuccessful': [
{
'Error': {
'Code': 'string',
'Message': 'string'
},
'ResourceId': 'string'
},
]
}
Response Structure
(dict) --
Unsuccessful (list) --
Information about the endpoints that were not rejected, if applicable.
(dict) --
Information about items that were not successfully processed in a batch call.
Error (dict) --
Information about the error.
Code (string) --
The error code.
Message (string) --
The error message accompanying the error code.
ResourceId (string) --
The ID of the resource.