We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.EBS

Inherits:
AWS.Service show all
Identifier:
ebs
API Version:
2019-11-02
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

You can use the Amazon Elastic Block Store (Amazon EBS) direct APIs to create Amazon EBS snapshots, write data directly to your snapshots, read data on your snapshots, and identify the differences or changes between two snapshots. If you’re an independent software vendor (ISV) who offers backup services for Amazon EBS, the EBS direct APIs make it more efficient and cost-effective to track incremental changes on your Amazon EBS volumes through snapshots. This can be done without having to create new volumes from snapshots, and then use Amazon Elastic Compute Cloud (Amazon EC2) instances to compare the differences.

You can create incremental snapshots directly from data on-premises into volumes and the cloud to use for quick disaster recovery. With the ability to write and read snapshots, you can write your on-premises data to an snapshot during a disaster. Then after recovery, you can restore it back to Amazon Web Services or on-premises from the snapshot. You no longer need to build and maintain complex mechanisms to copy data to and from Amazon EBS.

This API reference provides detailed information about the actions, data types, parameters, and errors of the EBS direct APIs. For more information about the elements that make up the EBS direct APIs, and examples of how to use them effectively, see Accessing the Contents of an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas for the EBS direct APIs, see Amazon Elastic Block Store Endpoints and Quotas in the Amazon Web Services General Reference.

Sending a Request Using EBS

var ebs = new AWS.EBS();
ebs.completeSnapshot(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the EBS object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var ebs = new AWS.EBS({apiVersion: '2019-11-02'});

You can also set the API version globally in AWS.config.apiVersions using the ebs service identifier:

AWS.config.apiVersions = {
  ebs: '2019-11-02',
  // other service API versions
};

var ebs = new AWS.EBS();

Version:

  • 2019-11-02

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.EBS(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a EBS object

var ebs = new AWS.EBS({apiVersion: '2019-11-02'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.EBS.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.EBS.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.EBS.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean) —

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean) —

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

completeSnapshot(params = {}, callback) ⇒ AWS.Request

Seals and completes the snapshot after all of the required blocks of data have been written to it. Completing the snapshot changes the status to completed. You cannot write new blocks to a snapshot after it has been completed.

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.

Service Reference:

Examples:

Calling the completeSnapshot operation

var params = {
  ChangedBlocksCount: 'NUMBER_VALUE', /* required */
  SnapshotId: 'STRING_VALUE', /* required */
  Checksum: 'STRING_VALUE',
  ChecksumAggregationMethod: LINEAR,
  ChecksumAlgorithm: SHA256
};
ebs.completeSnapshot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • SnapshotId — (String)

      The ID of the snapshot.

    • ChangedBlocksCount — (Integer)

      The number of blocks that were written to the snapshot.

    • Checksum — (String)

      An aggregated Base-64 SHA256 checksum based on the checksums of each written block.

      To generate the aggregated checksum using the linear aggregation method, arrange the checksums for each written block in ascending order of their block index, concatenate them to form a single string, and then generate the checksum on the entire string using the SHA256 algorithm.

    • ChecksumAlgorithm — (String)

      The algorithm used to generate the checksum. Currently, the only supported algorithm is SHA256.

      Possible values include:
      • "SHA256"
    • ChecksumAggregationMethod — (String)

      The aggregation method used to generate the checksum. Currently, the only supported aggregation method is LINEAR.

      Possible values include:
      • "LINEAR"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Status — (String)

        The status of the snapshot.

        Possible values include:
        • "completed"
        • "pending"
        • "error"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getSnapshotBlock(params = {}, callback) ⇒ AWS.Request

Returns the data in a block in an Amazon Elastic Block Store 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.

Service Reference:

Examples:

Calling the getSnapshotBlock operation

var params = {
  BlockIndex: 'NUMBER_VALUE', /* required */
  BlockToken: 'STRING_VALUE', /* required */
  SnapshotId: 'STRING_VALUE' /* required */
};
ebs.getSnapshotBlock(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • SnapshotId — (String)

      The ID of the snapshot containing the block from which to get data.

      If the specified snapshot is encrypted, you must have permission to use the KMS key that was used to encrypt the snapshot. For more information, see Using encryption in the Amazon Elastic Compute Cloud User Guide.

    • BlockIndex — (Integer)

      The block index of the block in which to read the data. A block index is a logical index in units of 512 KiB blocks. To identify the block index, divide the logical offset of the data in the logical volume by the block size (logical offset of data/524288). The logical offset of the data must be 512 KiB aligned.

    • BlockToken — (String)

      The block token of the block from which to get data. You can obtain the BlockToken by running the ListChangedBlocks or ListSnapshotBlocks operations.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DataLength — (Integer)

        The size of the data in the block.

      • BlockData — (Buffer(Node.js), Typed Array(Browser), ReadableStream)

        The data content of the block.

      • Checksum — (String)

        The checksum generated for the block, which is Base64 encoded.

      • ChecksumAlgorithm — (String)

        The algorithm used to generate the checksum for the block, such as SHA256.

        Possible values include:
        • "SHA256"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listChangedBlocks(params = {}, callback) ⇒ AWS.Request

Returns information about the blocks that are different between two Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.

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.

Service Reference:

Examples:

Calling the listChangedBlocks operation

var params = {
  SecondSnapshotId: 'STRING_VALUE', /* required */
  FirstSnapshotId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  StartingBlockIndex: 'NUMBER_VALUE'
};
ebs.listChangedBlocks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • FirstSnapshotId — (String)

      The ID of the first snapshot to use for the comparison.

      The FirstSnapshotID parameter must be specified with a SecondSnapshotId parameter; otherwise, an error occurs.

    • SecondSnapshotId — (String)

      The ID of the second snapshot to use for the comparison.

      The SecondSnapshotId parameter must be specified with a FirstSnapshotID parameter; otherwise, an error occurs.

    • NextToken — (String)

      The token to request the next page of results.

      If you specify NextToken, then StartingBlockIndex is ignored.

    • MaxResults — (Integer)

      The maximum number of blocks to be returned by the request.

      Even if additional blocks can be retrieved from the snapshot, the request can return less blocks than MaxResults or an empty array of blocks.

      To retrieve the next set of blocks from the snapshot, make another request with the returned NextToken value. The value of NextToken is null when there are no more blocks to return.

    • StartingBlockIndex — (Integer)

      The block index from which the comparison should start.

      The list in the response will start from this block index or the next valid block index in the snapshots.

      If you specify NextToken, then StartingBlockIndex is ignored.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ChangedBlocks — (Array<map>)

        An array of objects containing information about the changed blocks.

        • BlockIndex — (Integer)

          The block index.

        • FirstBlockToken — (String)

          The block token for the block index of the FirstSnapshotId specified in the ListChangedBlocks operation. This value is absent if the first snapshot does not have the changed block that is on the second snapshot.

        • SecondBlockToken — (String)

          The block token for the block index of the SecondSnapshotId specified in the ListChangedBlocks operation.

      • ExpiryTime — (Date)

        The time when the BlockToken expires.

      • VolumeSize — (Integer)

        The size of the volume in GB.

      • BlockSize — (Integer)

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

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listSnapshotBlocks(params = {}, callback) ⇒ AWS.Request

Returns information about the blocks in an Amazon Elastic Block Store 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.

Service Reference:

Examples:

Calling the listSnapshotBlocks operation

var params = {
  SnapshotId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  StartingBlockIndex: 'NUMBER_VALUE'
};
ebs.listSnapshotBlocks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • SnapshotId — (String)

      The ID of the snapshot from which to get block indexes and block tokens.

    • NextToken — (String)

      The token to request the next page of results.

      If you specify NextToken, then StartingBlockIndex is ignored.

    • MaxResults — (Integer)

      The maximum number of blocks to be returned by the request.

      Even if additional blocks can be retrieved from the snapshot, the request can return less blocks than MaxResults or an empty array of blocks.

      To retrieve the next set of blocks from the snapshot, make another request with the returned NextToken value. The value of NextToken is null when there are no more blocks to return.

    • StartingBlockIndex — (Integer)

      The block index from which the list should start. The list in the response will start from this block index or the next valid block index in the snapshot.

      If you specify NextToken, then StartingBlockIndex is ignored.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Blocks — (Array<map>)

        An array of objects containing information about the blocks.

        • BlockIndex — (Integer)

          The block index.

        • BlockToken — (String)

          The block token for the block index.

      • ExpiryTime — (Date)

        The time when the BlockToken expires.

      • VolumeSize — (Integer)

        The size of the volume in GB.

      • BlockSize — (Integer)

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

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putSnapshotBlock(params = {}, callback) ⇒ AWS.Request

Writes a block of data to a snapshot. If the specified block contains data, the existing data is overwritten. The target snapshot must be in the pending state.

Data written to a snapshot must be aligned with 512-KiB sectors.

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.

Service Reference:

Examples:

Calling the putSnapshotBlock operation

var params = {
  BlockData: Buffer.from('...') || 'STRING_VALUE' || streamObject, /* required */
  BlockIndex: 'NUMBER_VALUE', /* required */
  Checksum: 'STRING_VALUE', /* required */
  ChecksumAlgorithm: SHA256, /* required */
  DataLength: 'NUMBER_VALUE', /* required */
  SnapshotId: 'STRING_VALUE', /* required */
  Progress: 'NUMBER_VALUE'
};
ebs.putSnapshotBlock(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • SnapshotId — (String)

      The ID of the snapshot.

      If the specified snapshot is encrypted, you must have permission to use the KMS key that was used to encrypt the snapshot. For more information, see Using encryption in the Amazon Elastic Compute Cloud User Guide..

    • BlockIndex — (Integer)

      The block index of the block in which to write the data. A block index is a logical index in units of 512 KiB blocks. To identify the block index, divide the logical offset of the data in the logical volume by the block size (logical offset of data/524288). The logical offset of the data must be 512 KiB aligned.

    • BlockData — (Buffer, Typed Array, Blob, String, ReadableStream)

      The data to write to the block.

      The block data is not signed as part of the Signature Version 4 signing process. As a result, you must generate and provide a Base64-encoded SHA256 checksum for the block data using the x-amz-Checksum header. Also, you must specify the checksum algorithm using the x-amz-Checksum-Algorithm header. The checksum that you provide is part of the Signature Version 4 signing process. It is validated against a checksum generated by Amazon EBS to ensure the validity and authenticity of the data. If the checksums do not correspond, the request fails. For more information, see Using checksums with the EBS direct APIs in the Amazon Elastic Compute Cloud User Guide.

    • DataLength — (Integer)

      The size of the data to write to the block, in bytes. Currently, the only supported size is 524288 bytes.

      Valid values: 524288

    • Progress — (Integer)

      The progress of the write process, as a percentage.

    • Checksum — (String)

      A Base64-encoded SHA256 checksum of the data. Only SHA256 checksums are supported.

    • ChecksumAlgorithm — (String)

      The algorithm used to generate the checksum. Currently, the only supported algorithm is SHA256.

      Possible values include:
      • "SHA256"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Checksum — (String)

        The SHA256 checksum generated for the block data by Amazon EBS.

      • ChecksumAlgorithm — (String)

        The algorithm used by Amazon EBS to generate the checksum.

        Possible values include:
        • "SHA256"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

startSnapshot(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the startSnapshot operation

var params = {
  VolumeSize: 'NUMBER_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Encrypted: true || false,
  KmsKeyArn: 'STRING_VALUE',
  ParentSnapshotId: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  Timeout: 'NUMBER_VALUE'
};
ebs.startSnapshot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • VolumeSize — (Integer)

      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.

      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 — (Array<map>)

      The tags to apply to the snapshot.

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

      If a token is not provided, the SDK will use a version 4 UUID.
    • 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.

      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.

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

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

        Possible values include:
        • "completed"
        • "pending"
        • "error"
      • StartTime — (Date)

        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 — (Array<map>)

        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.

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

        Possible values include:
        • "sse-ebs"
        • "sse-kms"
        • "none"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.