Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- completeSnapshot_checksum :: Lens' CompleteSnapshot (Maybe Text)
- completeSnapshot_checksumAggregationMethod :: Lens' CompleteSnapshot (Maybe ChecksumAggregationMethod)
- completeSnapshot_checksumAlgorithm :: Lens' CompleteSnapshot (Maybe ChecksumAlgorithm)
- completeSnapshot_snapshotId :: Lens' CompleteSnapshot Text
- completeSnapshot_changedBlocksCount :: Lens' CompleteSnapshot Natural
- completeSnapshotResponse_status :: Lens' CompleteSnapshotResponse (Maybe Status)
- completeSnapshotResponse_httpStatus :: Lens' CompleteSnapshotResponse Int
- getSnapshotBlock_snapshotId :: Lens' GetSnapshotBlock Text
- getSnapshotBlock_blockIndex :: Lens' GetSnapshotBlock Natural
- getSnapshotBlock_blockToken :: Lens' GetSnapshotBlock Text
- getSnapshotBlockResponse_checksum :: Lens' GetSnapshotBlockResponse (Maybe Text)
- getSnapshotBlockResponse_checksumAlgorithm :: Lens' GetSnapshotBlockResponse (Maybe ChecksumAlgorithm)
- getSnapshotBlockResponse_dataLength :: Lens' GetSnapshotBlockResponse (Maybe Int)
- getSnapshotBlockResponse_httpStatus :: Lens' GetSnapshotBlockResponse Int
- getSnapshotBlockResponse_blockData :: Lens' GetSnapshotBlockResponse ResponseBody
- listChangedBlocks_firstSnapshotId :: Lens' ListChangedBlocks (Maybe Text)
- listChangedBlocks_maxResults :: Lens' ListChangedBlocks (Maybe Natural)
- listChangedBlocks_nextToken :: Lens' ListChangedBlocks (Maybe Text)
- listChangedBlocks_startingBlockIndex :: Lens' ListChangedBlocks (Maybe Natural)
- listChangedBlocks_secondSnapshotId :: Lens' ListChangedBlocks Text
- listChangedBlocksResponse_blockSize :: Lens' ListChangedBlocksResponse (Maybe Int)
- listChangedBlocksResponse_changedBlocks :: Lens' ListChangedBlocksResponse (Maybe [ChangedBlock])
- listChangedBlocksResponse_expiryTime :: Lens' ListChangedBlocksResponse (Maybe UTCTime)
- listChangedBlocksResponse_nextToken :: Lens' ListChangedBlocksResponse (Maybe Text)
- listChangedBlocksResponse_volumeSize :: Lens' ListChangedBlocksResponse (Maybe Natural)
- listChangedBlocksResponse_httpStatus :: Lens' ListChangedBlocksResponse Int
- listSnapshotBlocks_maxResults :: Lens' ListSnapshotBlocks (Maybe Natural)
- listSnapshotBlocks_nextToken :: Lens' ListSnapshotBlocks (Maybe Text)
- listSnapshotBlocks_startingBlockIndex :: Lens' ListSnapshotBlocks (Maybe Natural)
- listSnapshotBlocks_snapshotId :: Lens' ListSnapshotBlocks Text
- listSnapshotBlocksResponse_blockSize :: Lens' ListSnapshotBlocksResponse (Maybe Int)
- listSnapshotBlocksResponse_blocks :: Lens' ListSnapshotBlocksResponse (Maybe [Block])
- listSnapshotBlocksResponse_expiryTime :: Lens' ListSnapshotBlocksResponse (Maybe UTCTime)
- listSnapshotBlocksResponse_nextToken :: Lens' ListSnapshotBlocksResponse (Maybe Text)
- listSnapshotBlocksResponse_volumeSize :: Lens' ListSnapshotBlocksResponse (Maybe Natural)
- listSnapshotBlocksResponse_httpStatus :: Lens' ListSnapshotBlocksResponse Int
- putSnapshotBlock_progress :: Lens' PutSnapshotBlock (Maybe Natural)
- putSnapshotBlock_snapshotId :: Lens' PutSnapshotBlock Text
- putSnapshotBlock_blockIndex :: Lens' PutSnapshotBlock Natural
- putSnapshotBlock_dataLength :: Lens' PutSnapshotBlock Int
- putSnapshotBlock_checksum :: Lens' PutSnapshotBlock Text
- putSnapshotBlock_checksumAlgorithm :: Lens' PutSnapshotBlock ChecksumAlgorithm
- putSnapshotBlock_blockData :: Lens' PutSnapshotBlock HashedBody
- putSnapshotBlockResponse_checksum :: Lens' PutSnapshotBlockResponse (Maybe Text)
- putSnapshotBlockResponse_checksumAlgorithm :: Lens' PutSnapshotBlockResponse (Maybe ChecksumAlgorithm)
- putSnapshotBlockResponse_httpStatus :: Lens' PutSnapshotBlockResponse Int
- startSnapshot_clientToken :: Lens' StartSnapshot (Maybe Text)
- startSnapshot_description :: Lens' StartSnapshot (Maybe Text)
- startSnapshot_encrypted :: Lens' StartSnapshot (Maybe Bool)
- startSnapshot_kmsKeyArn :: Lens' StartSnapshot (Maybe Text)
- startSnapshot_parentSnapshotId :: Lens' StartSnapshot (Maybe Text)
- startSnapshot_tags :: Lens' StartSnapshot (Maybe [Tag])
- startSnapshot_timeout :: Lens' StartSnapshot (Maybe Natural)
- startSnapshot_volumeSize :: Lens' StartSnapshot Natural
- startSnapshotResponse_blockSize :: Lens' StartSnapshotResponse (Maybe Int)
- startSnapshotResponse_description :: Lens' StartSnapshotResponse (Maybe Text)
- startSnapshotResponse_kmsKeyArn :: Lens' StartSnapshotResponse (Maybe Text)
- startSnapshotResponse_ownerId :: Lens' StartSnapshotResponse (Maybe Text)
- startSnapshotResponse_parentSnapshotId :: Lens' StartSnapshotResponse (Maybe Text)
- startSnapshotResponse_snapshotId :: Lens' StartSnapshotResponse (Maybe Text)
- startSnapshotResponse_startTime :: Lens' StartSnapshotResponse (Maybe UTCTime)
- startSnapshotResponse_status :: Lens' StartSnapshotResponse (Maybe Status)
- startSnapshotResponse_tags :: Lens' StartSnapshotResponse (Maybe [Tag])
- startSnapshotResponse_volumeSize :: Lens' StartSnapshotResponse (Maybe Natural)
- startSnapshotResponse_httpStatus :: Lens' StartSnapshotResponse Int
- block_blockIndex :: Lens' Block (Maybe Natural)
- block_blockToken :: Lens' Block (Maybe Text)
- changedBlock_blockIndex :: Lens' ChangedBlock (Maybe Natural)
- changedBlock_firstBlockToken :: Lens' ChangedBlock (Maybe Text)
- changedBlock_secondBlockToken :: Lens' ChangedBlock (Maybe Text)
- tag_key :: Lens' Tag (Maybe Text)
- tag_value :: Lens' Tag (Maybe Text)
Operations
CompleteSnapshot
completeSnapshot_checksum :: Lens' CompleteSnapshot (Maybe Text) Source #
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.
completeSnapshot_checksumAggregationMethod :: Lens' CompleteSnapshot (Maybe ChecksumAggregationMethod) Source #
The aggregation method used to generate the checksum. Currently, the
only supported aggregation method is LINEAR
.
completeSnapshot_checksumAlgorithm :: Lens' CompleteSnapshot (Maybe ChecksumAlgorithm) Source #
The algorithm used to generate the checksum. Currently, the only
supported algorithm is SHA256
.
completeSnapshot_snapshotId :: Lens' CompleteSnapshot Text Source #
The ID of the snapshot.
completeSnapshot_changedBlocksCount :: Lens' CompleteSnapshot Natural Source #
The number of blocks that were written to the snapshot.
completeSnapshotResponse_status :: Lens' CompleteSnapshotResponse (Maybe Status) Source #
The status of the snapshot.
completeSnapshotResponse_httpStatus :: Lens' CompleteSnapshotResponse Int Source #
The response's http status code.
GetSnapshotBlock
getSnapshotBlock_snapshotId :: Lens' GetSnapshotBlock Text Source #
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.
getSnapshotBlock_blockIndex :: Lens' GetSnapshotBlock Natural Source #
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.
getSnapshotBlock_blockToken :: Lens' GetSnapshotBlock Text Source #
The block token of the block from which to get data. You can obtain the
BlockToken
by running the ListChangedBlocks
or ListSnapshotBlocks
operations.
getSnapshotBlockResponse_checksum :: Lens' GetSnapshotBlockResponse (Maybe Text) Source #
The checksum generated for the block, which is Base64 encoded.
getSnapshotBlockResponse_checksumAlgorithm :: Lens' GetSnapshotBlockResponse (Maybe ChecksumAlgorithm) Source #
The algorithm used to generate the checksum for the block, such as SHA256.
getSnapshotBlockResponse_dataLength :: Lens' GetSnapshotBlockResponse (Maybe Int) Source #
The size of the data in the block.
getSnapshotBlockResponse_httpStatus :: Lens' GetSnapshotBlockResponse Int Source #
The response's http status code.
getSnapshotBlockResponse_blockData :: Lens' GetSnapshotBlockResponse ResponseBody Source #
The data content of the block.
ListChangedBlocks
listChangedBlocks_firstSnapshotId :: Lens' ListChangedBlocks (Maybe Text) Source #
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.
listChangedBlocks_maxResults :: Lens' ListChangedBlocks (Maybe Natural) Source #
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.
listChangedBlocks_nextToken :: Lens' ListChangedBlocks (Maybe Text) Source #
The token to request the next page of results.
If you specify NextToken, then StartingBlockIndex is ignored.
listChangedBlocks_startingBlockIndex :: Lens' ListChangedBlocks (Maybe Natural) Source #
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.
listChangedBlocks_secondSnapshotId :: Lens' ListChangedBlocks Text Source #
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.
listChangedBlocksResponse_blockSize :: Lens' ListChangedBlocksResponse (Maybe Int) Source #
The size of the blocks in the snapshot, in bytes.
listChangedBlocksResponse_changedBlocks :: Lens' ListChangedBlocksResponse (Maybe [ChangedBlock]) Source #
An array of objects containing information about the changed blocks.
listChangedBlocksResponse_expiryTime :: Lens' ListChangedBlocksResponse (Maybe UTCTime) Source #
The time when the BlockToken
expires.
listChangedBlocksResponse_nextToken :: Lens' ListChangedBlocksResponse (Maybe Text) Source #
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
listChangedBlocksResponse_volumeSize :: Lens' ListChangedBlocksResponse (Maybe Natural) Source #
The size of the volume in GB.
listChangedBlocksResponse_httpStatus :: Lens' ListChangedBlocksResponse Int Source #
The response's http status code.
ListSnapshotBlocks
listSnapshotBlocks_maxResults :: Lens' ListSnapshotBlocks (Maybe Natural) Source #
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.
listSnapshotBlocks_nextToken :: Lens' ListSnapshotBlocks (Maybe Text) Source #
The token to request the next page of results.
If you specify NextToken, then StartingBlockIndex is ignored.
listSnapshotBlocks_startingBlockIndex :: Lens' ListSnapshotBlocks (Maybe Natural) Source #
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.
listSnapshotBlocks_snapshotId :: Lens' ListSnapshotBlocks Text Source #
The ID of the snapshot from which to get block indexes and block tokens.
listSnapshotBlocksResponse_blockSize :: Lens' ListSnapshotBlocksResponse (Maybe Int) Source #
The size of the blocks in the snapshot, in bytes.
listSnapshotBlocksResponse_blocks :: Lens' ListSnapshotBlocksResponse (Maybe [Block]) Source #
An array of objects containing information about the blocks.
listSnapshotBlocksResponse_expiryTime :: Lens' ListSnapshotBlocksResponse (Maybe UTCTime) Source #
The time when the BlockToken
expires.
listSnapshotBlocksResponse_nextToken :: Lens' ListSnapshotBlocksResponse (Maybe Text) Source #
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
listSnapshotBlocksResponse_volumeSize :: Lens' ListSnapshotBlocksResponse (Maybe Natural) Source #
The size of the volume in GB.
listSnapshotBlocksResponse_httpStatus :: Lens' ListSnapshotBlocksResponse Int Source #
The response's http status code.
PutSnapshotBlock
putSnapshotBlock_progress :: Lens' PutSnapshotBlock (Maybe Natural) Source #
The progress of the write process, as a percentage.
putSnapshotBlock_snapshotId :: Lens' PutSnapshotBlock Text Source #
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..
putSnapshotBlock_blockIndex :: Lens' PutSnapshotBlock Natural Source #
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.
putSnapshotBlock_dataLength :: Lens' PutSnapshotBlock Int Source #
The size of the data to write to the block, in bytes. Currently, the
only supported size is 524288
bytes.
Valid values: 524288
putSnapshotBlock_checksum :: Lens' PutSnapshotBlock Text Source #
A Base64-encoded SHA256 checksum of the data. Only SHA256 checksums are supported.
putSnapshotBlock_checksumAlgorithm :: Lens' PutSnapshotBlock ChecksumAlgorithm Source #
The algorithm used to generate the checksum. Currently, the only
supported algorithm is SHA256
.
putSnapshotBlock_blockData :: Lens' PutSnapshotBlock HashedBody Source #
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.
putSnapshotBlockResponse_checksum :: Lens' PutSnapshotBlockResponse (Maybe Text) Source #
The SHA256 checksum generated for the block data by Amazon EBS.
putSnapshotBlockResponse_checksumAlgorithm :: Lens' PutSnapshotBlockResponse (Maybe ChecksumAlgorithm) Source #
The algorithm used by Amazon EBS to generate the checksum.
putSnapshotBlockResponse_httpStatus :: Lens' PutSnapshotBlockResponse Int Source #
The response's http status code.
StartSnapshot
startSnapshot_clientToken :: Lens' StartSnapshot (Maybe Text) Source #
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.
startSnapshot_description :: Lens' StartSnapshot (Maybe Text) Source #
A description for the snapshot.
startSnapshot_encrypted :: Lens' StartSnapshot (Maybe Bool) Source #
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.
startSnapshot_kmsKeyArn :: Lens' StartSnapshot (Maybe Text) Source #
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.
startSnapshot_parentSnapshotId :: Lens' StartSnapshot (Maybe Text) Source #
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.
startSnapshot_tags :: Lens' StartSnapshot (Maybe [Tag]) Source #
The tags to apply to the snapshot.
startSnapshot_timeout :: Lens' StartSnapshot (Maybe Natural) Source #
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.
startSnapshot_volumeSize :: Lens' StartSnapshot Natural Source #
The size of the volume, in GiB. The maximum size is 65536
GiB (64
TiB).
startSnapshotResponse_blockSize :: Lens' StartSnapshotResponse (Maybe Int) Source #
The size of the blocks in the snapshot, in bytes.
startSnapshotResponse_description :: Lens' StartSnapshotResponse (Maybe Text) Source #
The description of the snapshot.
startSnapshotResponse_kmsKeyArn :: Lens' StartSnapshotResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the snapshot.
startSnapshotResponse_ownerId :: Lens' StartSnapshotResponse (Maybe Text) Source #
The Amazon Web Services account ID of the snapshot owner.
startSnapshotResponse_parentSnapshotId :: Lens' StartSnapshotResponse (Maybe Text) Source #
The ID of the parent snapshot.
startSnapshotResponse_snapshotId :: Lens' StartSnapshotResponse (Maybe Text) Source #
The ID of the snapshot.
startSnapshotResponse_startTime :: Lens' StartSnapshotResponse (Maybe UTCTime) Source #
The timestamp when the snapshot was created.
startSnapshotResponse_status :: Lens' StartSnapshotResponse (Maybe Status) Source #
The status of the snapshot.
startSnapshotResponse_tags :: Lens' StartSnapshotResponse (Maybe [Tag]) Source #
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.
startSnapshotResponse_volumeSize :: Lens' StartSnapshotResponse (Maybe Natural) Source #
The size of the volume, in GiB.
startSnapshotResponse_httpStatus :: Lens' StartSnapshotResponse Int Source #
The response's http status code.
Types
Block
ChangedBlock
changedBlock_blockIndex :: Lens' ChangedBlock (Maybe Natural) Source #
The block index.
changedBlock_firstBlockToken :: Lens' ChangedBlock (Maybe Text) Source #
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.
changedBlock_secondBlockToken :: Lens' ChangedBlock (Maybe Text) Source #
The block token for the block index of the SecondSnapshotId
specified
in the ListChangedBlocks
operation.