EC2 / Client / import_snapshot

import_snapshot#

EC2.Client.import_snapshot(**kwargs)#

Imports a disk into an EBS snapshot.

For more information, see Importing a disk as a snapshot using VM Import/Export in the VM Import/Export User Guide.

Request Syntax

response = client.import_snapshot(
    ClientData={
        'Comment': 'string',
        'UploadEnd': datetime(2015, 1, 1),
        'UploadSize': 123.0,
        'UploadStart': datetime(2015, 1, 1)
    },
    ClientToken='string',
    Description='string',
    DiskContainer={
        'Description': 'string',
        'Format': 'string',
        'Url': 'string',
        'UserBucket': {
            'S3Bucket': 'string',
            'S3Key': 'string'
        }
    },
    DryRun=True|False,
    Encrypted=True|False,
    KmsKeyId='string',
    RoleName='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'
                },
            ]
        },
    ]
)

Parameters:

ClientData (dict) –
The client-specific data.
- Comment (string) –
  
  A user-defined comment about the disk upload.
- UploadEnd (datetime) –
  
  The time that the disk upload ends.
- UploadSize (float) –
  
  The size of the uploaded disk image, in GiB.
- UploadStart (datetime) –
  
  The time that the disk upload starts.
ClientToken (string) – Token to enable idempotency for VM import requests.
Description (string) – The description string for the import snapshot task.
DiskContainer (dict) –
Information about the disk container.
- Description (string) –
  
  The description of the disk image being imported.
- Format (string) –
  
  The format of the disk image being imported.
  
  Valid values: VHD | VMDK | RAW
- Url (string) –
  
  The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon S3 URL (s3://..).
- UserBucket (dict) –
  
  The Amazon S3 bucket for the disk image.
  - S3Bucket (string) –
    
    The name of the Amazon S3 bucket where the disk image is located.
  - S3Key (string) –
    
    The file name of the disk image.
DryRun (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.
Encrypted (boolean) – Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
KmsKeyId (string) –
An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

The KMS key identifier may be provided in any of the following formats:
- Key ID
- Key alias
- ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the key namespace, and then the key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
- ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.

The specified KMS key must exist in the Region that the snapshot is being copied to.

Amazon EBS does not support asymmetric KMS keys.
RoleName (string) – The name of the role to use when not using the default role, ‘vmimport’.
TagSpecifications (list) –
The tags to apply to the import snapshot task 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.

Return type:

dict

Returns:

Response Syntax

{
    'Description': 'string',
    'ImportTaskId': 'string',
    'SnapshotTaskDetail': {
        'Description': 'string',
        'DiskImageSize': 123.0,
        'Encrypted': True|False,
        'Format': 'string',
        'KmsKeyId': 'string',
        'Progress': 'string',
        'SnapshotId': 'string',
        'Status': 'string',
        'StatusMessage': 'string',
        'Url': 'string',
        'UserBucket': {
            'S3Bucket': 'string',
            'S3Key': 'string'
        }
    },
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

(dict) –
- Description (string) –
  
  A description of the import snapshot task.
- ImportTaskId (string) –
  
  The ID of the import snapshot task.
- SnapshotTaskDetail (dict) –
  
  Information about the import snapshot task.
  - Description (string) –
    
    The description of the disk image being imported.
  - DiskImageSize (float) –
    
    The size of the disk in the snapshot, in GiB.
  - Encrypted (boolean) –
    
    Indicates whether the snapshot is encrypted.
  - Format (string) –
    
    The format of the disk image from which the snapshot is created.
  - KmsKeyId (string) –
    
    The identifier for the KMS key that was used to create the encrypted snapshot.
  - Progress (string) –
    
    The percentage of completion for the import snapshot task.
  - SnapshotId (string) –
    
    The snapshot ID of the disk being imported.
  - Status (string) –
    
    A brief status for the import snapshot task.
  - StatusMessage (string) –
    
    A detailed status message for the import snapshot task.
  - Url (string) –
    
    The URL of the disk image from which the snapshot is created.
  - UserBucket (dict) –
    
    The Amazon S3 bucket for the disk image.
    - S3Bucket (string) –
      
      The Amazon S3 bucket from which the disk image was created.
    - S3Key (string) –
      
      The file name of the disk image.
- Tags (list) –
  
  Any tags assigned to the import snapshot task.
  - (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.