pending state after the request completes.
After creating the snapshot, use PutSnapshotBlock to write blocks of data to the snapshot.
External DocumentationTo learn more, visit the AWS documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| AWS Region(s) | Enter the desired AWS Region(s). To execute the action in multiple regions, provide a comma-separated list. For example: us-east-1,eu-west-2.If you wish to run the action in all available regions, use the asterisk symbol ( *) instead. |
| Volume Size | The size of the volume, in GiB. The maximum size is 65536 GiB (64 TiB). |
Advanced Parameters
| Parameter | Description |
|---|---|
| Client Token | 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. |
| Description | A description for the snapshot. |
| Disable XML To JSON Auto Convert | When checked, XML responses are not automatically converted into JSON format. |
| Encrypted | Indicates whether to encrypt the snapshot. To create an encrypted snapshot, specify true. To create an unencrypted snapshot, omit this parameter.If you specify a value for ParentSnapshotId, omit this parameter. If you specify true, the snapshot is encrypted using the KMS key specified using the KmsKeyArn parameter. If no value is specified for KmsKeyArn, the default KMS key for your account is used. If no default KMS key has been specified for your account, the Amazon Web Services managed KMS key is used. To set a default KMS key for your account, use ModifyEbsDefaultKmsKeyId.If your account is enabled for encryption by default, you cannot set this parameter to false. In this case, you can omit this parameter.For more information, see Using encryption in the Amazon Elastic Compute Cloud User Guide. |
| KMS Key ARN | The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to be used to encrypt the snapshot. If you do not specify a KMS key, the default Amazon Web Services managed KMS key is used. If you specify a ParentSnapshotId, omit this parameter; the snapshot will be encrypted using the same KMS key that was used to encrypt the parent snapshot. If Encrypted is set to true, you must specify a KMS key ARN. |
| Parent Snapshot ID | 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. If your account is enabled for encryption by default, you cannot use an unencrypted snapshot as a parent snapshot. You must first create an encrypted copy of the parent snapshot using CopySnapshot. |
| Tags | The tags to apply to the snapshot. |
| Timeout | 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. |
Example Output
{
"BlockSize": 0,
"Description": "^[\\S\\s]+$",
"KmsKeyArn": "password",
"OwnerId": "\\S+",
"ParentSnapshotId": "^snap-[0-9a-f]+$",
"SnapshotId": "^snap-[0-9a-f]+$",
"StartTime": "date-time",
"Status": "string",
"Tags": [
{
"Key": "^[\\S\\s]+$",
"Value": "^[\\S\\s]+$"
}
],
"VolumeSize": 0
}