@datafire/amazonaws_ebs

Client library for Amazon Elastic Block Store

Installation and Usage

npm install --save @datafire/amazonaws_ebs

let amazonaws_ebs = require('@datafire/amazonaws_ebs').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

Actions

StartSnapshot

amazonaws_ebs.StartSnapshot({
  "VolumeSize": 0
}, context)

Input

• input object
  • 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 AWS SDK. For more information, see Idempotency for StartSnapshot API in the Amazon Elastic Compute Cloud User Guide.
  • Description string: A description for the snapshot.
  • Encrypted boolean: 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 CMK specified using the KmsKeyArn parameter. If no value is specified for KmsKeyArn, the default CMK for your account is used. If no default CMK has been specified for your account, the AWS managed CMK is used. To set a default CMK 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.
  • KmsKeyArn string: The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) to be used to encrypt the snapshot. If you do not specify a CMK, the default AWS managed CMK is used. If you specify a ParentSnapshotId, omit this parameter; the snapshot will be encrypted using the same CMK that was used to encrypt the parent snapshot. If Encrypted is set to true, you must specify a CMK ARN.
  • 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. 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 array: The tags to apply to the snapshot.
    • items Tag
  • 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.
  • VolumeSize required integer: The size of the volume, in GiB. The maximum size is 16384 GiB (16 TiB).

Output

Output schema unknown

CompleteSnapshot

amazonaws_ebs.CompleteSnapshot({
  "snapshotId": "",
  "x-amz-ChangedBlocksCount": 0
}, context)

Input

• input object
  • snapshotId required string
  • x-amz-ChangedBlocksCount required integer
  • x-amz-Checksum string
  • x-amz-Checksum-Algorithm string
  • x-amz-Checksum-Aggregation-Method string

Output

Output schema unknown

ListChangedBlocks

amazonaws_ebs.ListChangedBlocks({
  "secondSnapshotId": ""
}, context)

Input

• input object
  • firstSnapshotId string
  • secondSnapshotId required string
  • pageToken string
  • maxResults integer
  • startingBlockIndex integer
  • MaxResults string
  • NextToken string

Output

• output ListChangedBlocksResponse

ListSnapshotBlocks

amazonaws_ebs.ListSnapshotBlocks({
  "snapshotId": ""
}, context)

Input

• input object
  • snapshotId required string
  • pageToken string
  • maxResults integer
  • startingBlockIndex integer
  • MaxResults string
  • NextToken string

Output

• output ListSnapshotBlocksResponse

GetSnapshotBlock

amazonaws_ebs.GetSnapshotBlock({
  "snapshotId": "",
  "blockIndex": 0,
  "blockToken": ""
}, context)

Input

• input object
  • snapshotId required string
  • blockIndex required integer
  • blockToken required string

Output

• output GetSnapshotBlockResponse

PutSnapshotBlock

amazonaws_ebs.PutSnapshotBlock({
  "snapshotId": "",
  "blockIndex": 0,
  "x-amz-Data-Length": 0,
  "x-amz-Checksum": "",
  "x-amz-Checksum-Algorithm": "",
  "BlockData": ""
}, context)

Input

• input object
  • snapshotId required string
  • blockIndex required integer
  • x-amz-Data-Length required integer
  • x-amz-Progress integer
  • x-amz-Checksum required string
  • x-amz-Checksum-Algorithm required string
  • BlockData required string: 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.

Output

Output schema unknown

Definitions

AccessDeniedException

Block

• Block object: A block of data in an Amazon Elastic Block Store snapshot.
  • BlockIndex
  • BlockToken

BlockData

• BlockData string

BlockIndex

• BlockIndex integer

BlockSize

• BlockSize integer

BlockToken

• BlockToken string

Blocks

• Blocks array
  • items Block

Boolean

• Boolean boolean

ChangedBlock

• ChangedBlock object: A block of data in an Amazon Elastic Block Store snapshot that is different from another snapshot of the same volume/snapshot lineage.
  • BlockIndex
  • FirstBlockToken
  • SecondBlockToken

ChangedBlocks

• ChangedBlocks array
  • items ChangedBlock

ChangedBlocksCount

• ChangedBlocksCount integer

Checksum

• Checksum string

ChecksumAggregationMethod

• ChecksumAggregationMethod string (values: LINEAR)

ChecksumAlgorithm

• ChecksumAlgorithm string (values: SHA256)

CompleteSnapshotRequest

• CompleteSnapshotRequest object

CompleteSnapshotResponse

• CompleteSnapshotResponse object
  • Status

ConcurrentLimitExceededException

ConflictException

DataLength

• DataLength integer

Description

• Description string

GetSnapshotBlockRequest

• GetSnapshotBlockRequest object

GetSnapshotBlockResponse

• GetSnapshotBlockResponse object
  • BlockData

IdempotencyToken

• IdempotencyToken string

InternalServerException

KmsKeyArn

• KmsKeyArn string

ListChangedBlocksRequest

• ListChangedBlocksRequest object

ListChangedBlocksResponse

• ListChangedBlocksResponse object
  • BlockSize
  • ChangedBlocks
    • items ChangedBlock
  • ExpiryTime
  • NextToken
  • VolumeSize

ListSnapshotBlocksRequest

• ListSnapshotBlocksRequest object

ListSnapshotBlocksResponse

• ListSnapshotBlocksResponse object
  • BlockSize
  • Blocks
    • items Block
  • ExpiryTime
  • NextToken
  • VolumeSize

MaxResults

• MaxResults integer

OwnerId

• OwnerId string

PageToken

• PageToken string

Progress

• Progress integer

PutSnapshotBlockRequest

• PutSnapshotBlockRequest object
  • BlockData required

PutSnapshotBlockResponse

• PutSnapshotBlockResponse object

RequestThrottledException

ResourceNotFoundException

ServiceQuotaExceededException

SnapshotId

• SnapshotId string

StartSnapshotRequest

• StartSnapshotRequest object
  • ClientToken
  • Description
  • Encrypted
  • KmsKeyArn
  • ParentSnapshotId
  • Tags
    • items Tag
  • Timeout
  • VolumeSize required

StartSnapshotResponse

• StartSnapshotResponse object
  • BlockSize
  • Description
  • KmsKeyArn
  • OwnerId
  • ParentSnapshotId
  • SnapshotId
  • StartTime
  • Status
  • Tags
    • items Tag
  • VolumeSize

Status

• Status string (values: completed, pending, error)

Tag

• Tag object: Describes a tag.
  • Key
  • Value

TagKey

• TagKey string

TagValue

• TagValue string

Tags

• Tags array
  • items Tag

TimeStamp

• TimeStamp string

Timeout

• Timeout integer

ValidationException

VolumeSize

• VolumeSize integer