EBS / Client / start_snapshot

start_snapshot#

EBS.Client.start_snapshot(**kwargs)#

Creates a new Amazon EBS snapshot. The new snapshot enters the pending state after the request completes.

After creating the snapshot, use PutSnapshotBlock to write blocks of data to the snapshot.

Note

You should always retry requests that receive server ( 5xx) error responses, and ThrottlingException and RequestThrottledException client error responses. For more information see Error retries in the Amazon Elastic Compute Cloud User Guide.

See also: AWS API Documentation

Request Syntax

response = client.start_snapshot(
    VolumeSize=123,
    ParentSnapshotId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    Description='string',
    ClientToken='string',
    Encrypted=True|False,
    KmsKeyArn='string',
    Timeout=123
)
Parameters:

  • VolumeSize (integer) –

    [REQUIRED]

    The size of the volume, in GiB. The maximum size is 65536 GiB (64 TiB).

  • ParentSnapshotId (string) –

    The ID of the parent snapshot. If there is no parent snapshot, or if you are creating the first snapshot for an on-premises volume, omit this parameter.

    You can’t specify ParentSnapshotId and Encrypted in the same request. If you specify both parameters, the request fails with ValidationException.

    The encryption status of the snapshot depends on the values that you specify for Encrypted, KmsKeyArn, and ParentSnapshotId, and whether your Amazon Web Services account is enabled for encryption by default. For more information, see Using encryption in the Amazon Elastic Compute Cloud User Guide.

    Warning

    If you specify an encrypted parent snapshot, you must have permission to use the KMS key that was used to encrypt the parent snapshot. For more information, see Permissions to use Key Management Service keys in the Amazon Elastic Compute Cloud User Guide.

  • Tags (list) –

    The tags to apply to the snapshot.

    • (dict) –

      Describes a tag.

      • Key (string) –

        The key of the tag.

      • Value (string) –

        The value of the tag.

  • Description (string) – A description for the snapshot.

  • ClientToken (string) –

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

    For more information, see Idempotency for StartSnapshot API in the Amazon Elastic Compute Cloud User Guide.

    This field is autopopulated if not provided.

  • Encrypted (boolean) –

    Indicates whether to encrypt the snapshot.

    You can’t specify Encrypted and ParentSnapshotId in the same request. If you specify both parameters, the request fails with ValidationException.

    The encryption status of the snapshot depends on the values that you specify for Encrypted, KmsKeyArn, and ParentSnapshotId, and whether your Amazon Web Services account is enabled for encryption by default. For more information, see Using encryption in the Amazon Elastic Compute Cloud User Guide.

    Warning

    To create an encrypted snapshot, you must have permission to use the KMS key. For more information, see Permissions to use Key Management Service keys in the Amazon Elastic Compute Cloud User Guide.

  • KmsKeyArn (string) –

    The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to be used to encrypt the snapshot.

    The encryption status of the snapshot depends on the values that you specify for Encrypted, KmsKeyArn, and ParentSnapshotId, and whether your Amazon Web Services account is enabled for encryption by default. For more information, see Using encryption in the Amazon Elastic Compute Cloud User Guide.

    Warning

    To create an encrypted snapshot, you must have permission to use the KMS key. For more information, see Permissions to use Key Management Service keys in the Amazon Elastic Compute Cloud User Guide.

  • Timeout (integer) –

    The amount of time (in minutes) after which the snapshot is automatically cancelled if:

    • No blocks are written to the snapshot.

    • The snapshot is not completed after writing the last block of data.

    If no value is specified, the timeout defaults to 60 minutes.

Return type:

dict

Returns:

Response Syntax

{
    'Description': 'string',
    'SnapshotId': 'string',
    'OwnerId': 'string',
    'Status': 'completed'|'pending'|'error',
    'StartTime': datetime(2015, 1, 1),
    'VolumeSize': 123,
    'BlockSize': 123,
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'ParentSnapshotId': 'string',
    'KmsKeyArn': 'string',
    'SseType': 'sse-ebs'|'sse-kms'|'none'
}

Response Structure

  • (dict) –

    • Description (string) –

      The description of the snapshot.

    • SnapshotId (string) –

      The ID of the snapshot.

    • OwnerId (string) –

      The Amazon Web Services account ID of the snapshot owner.

    • Status (string) –

      The status of the snapshot.

    • StartTime (datetime) –

      The timestamp when the snapshot was created.

    • VolumeSize (integer) –

      The size of the volume, in GiB.

    • BlockSize (integer) –

      The size of the blocks in the snapshot, in bytes.

    • Tags (list) –

      The tags applied to the snapshot. You can specify up to 50 tags per snapshot. For more information, see Tagging your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.

      • (dict) –

        Describes a tag.

        • Key (string) –

          The key of the tag.

        • Value (string) –

          The value of the tag.

    • ParentSnapshotId (string) –

      The ID of the parent snapshot.

    • KmsKeyArn (string) –

      The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the snapshot.

    • SseType (string) –

      Reserved for future use.

Exceptions