| 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 |
Amazonka.EBS
Description
Derived from API version 2019-11-02 of the AWS service descriptions, licensed under Apache 2.0.
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.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConcurrentLimitExceededException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _RequestThrottledException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data CompleteSnapshot = CompleteSnapshot' (Maybe Text) (Maybe ChecksumAggregationMethod) (Maybe ChecksumAlgorithm) Text Natural
- newCompleteSnapshot :: Text -> Natural -> CompleteSnapshot
- data CompleteSnapshotResponse = CompleteSnapshotResponse' (Maybe Status) Int
- newCompleteSnapshotResponse :: Int -> CompleteSnapshotResponse
- data GetSnapshotBlock = GetSnapshotBlock' Text Natural Text
- newGetSnapshotBlock :: Text -> Natural -> Text -> GetSnapshotBlock
- data GetSnapshotBlockResponse = GetSnapshotBlockResponse' (Maybe Text) (Maybe ChecksumAlgorithm) (Maybe Int) Int ResponseBody
- newGetSnapshotBlockResponse :: Int -> ResponseBody -> GetSnapshotBlockResponse
- data ListChangedBlocks = ListChangedBlocks' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Natural) Text
- newListChangedBlocks :: Text -> ListChangedBlocks
- data ListChangedBlocksResponse = ListChangedBlocksResponse' (Maybe Int) (Maybe [Sensitive ChangedBlock]) (Maybe POSIX) (Maybe Text) (Maybe Natural) Int
- newListChangedBlocksResponse :: Int -> ListChangedBlocksResponse
- data ListSnapshotBlocks = ListSnapshotBlocks' (Maybe Natural) (Maybe Text) (Maybe Natural) Text
- newListSnapshotBlocks :: Text -> ListSnapshotBlocks
- data ListSnapshotBlocksResponse = ListSnapshotBlocksResponse' (Maybe Int) (Maybe (Sensitive [Block])) (Maybe POSIX) (Maybe Text) (Maybe Natural) Int
- newListSnapshotBlocksResponse :: Int -> ListSnapshotBlocksResponse
- data PutSnapshotBlock = PutSnapshotBlock' (Maybe Natural) Text Natural Int Text ChecksumAlgorithm HashedBody
- newPutSnapshotBlock :: Text -> Natural -> Int -> Text -> ChecksumAlgorithm -> HashedBody -> PutSnapshotBlock
- data PutSnapshotBlockResponse = PutSnapshotBlockResponse' (Maybe Text) (Maybe ChecksumAlgorithm) Int
- newPutSnapshotBlockResponse :: Int -> PutSnapshotBlockResponse
- data StartSnapshot = StartSnapshot' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe (Sensitive Text)) (Maybe Text) (Maybe [Tag]) (Maybe Natural) Natural
- newStartSnapshot :: Natural -> StartSnapshot
- data StartSnapshotResponse = StartSnapshotResponse' (Maybe Int) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Status) (Maybe [Tag]) (Maybe Natural) Int
- newStartSnapshotResponse :: Int -> StartSnapshotResponse
- newtype ChecksumAggregationMethod where
- newtype ChecksumAlgorithm where
- ChecksumAlgorithm' { }
- pattern ChecksumAlgorithm_SHA256 :: ChecksumAlgorithm
- newtype Status where
- Status' {
- fromStatus :: Text
- pattern Status_Completed :: Status
- pattern Status_Error :: Status
- pattern Status_Pending :: Status
- Status' {
- data Block = Block' (Maybe Natural) (Maybe Text)
- newBlock :: Block
- data ChangedBlock = ChangedBlock' (Maybe Natural) (Maybe Text) (Maybe Text)
- newChangedBlock :: ChangedBlock
- data Tag = Tag' (Maybe Text) (Maybe Text)
- newTag :: Tag
Service Configuration
defaultService :: Service Source #
API version 2019-11-02 of the Amazon Elastic Block Store SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by EBS.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You do not have sufficient access to perform this action.
ConcurrentLimitExceededException
_ConcurrentLimitExceededException :: AsError a => Fold a ServiceError Source #
You have reached the limit for concurrent API requests. For more information, see Optimizing performance of the EBS direct APIs in the Amazon Elastic Compute Cloud User Guide.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
The request uses the same client token as a previous, but non-identical request.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
An internal error has occurred.
RequestThrottledException
_RequestThrottledException :: AsError a => Fold a ServiceError Source #
The number of API requests has exceed the maximum allowed API request throttling limit.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The specified resource does not exist.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
Your current service quotas do not allow you to perform this action.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
The input fails to satisfy the constraints of the EBS direct APIs.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CompleteSnapshot
data CompleteSnapshot Source #
See: newCompleteSnapshot smart constructor.
Constructors
| CompleteSnapshot' (Maybe Text) (Maybe ChecksumAggregationMethod) (Maybe ChecksumAlgorithm) Text Natural |
Instances
Arguments
| :: Text | |
| -> Natural | |
| -> CompleteSnapshot |
Create a value of CompleteSnapshot with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:checksum:CompleteSnapshot', completeSnapshot_checksum - 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.
$sel:checksumAggregationMethod:CompleteSnapshot', completeSnapshot_checksumAggregationMethod - The aggregation method used to generate the checksum. Currently, the
only supported aggregation method is LINEAR.
$sel:checksumAlgorithm:CompleteSnapshot', completeSnapshot_checksumAlgorithm - The algorithm used to generate the checksum. Currently, the only
supported algorithm is SHA256.
$sel:snapshotId:CompleteSnapshot', completeSnapshot_snapshotId - The ID of the snapshot.
$sel:changedBlocksCount:CompleteSnapshot', completeSnapshot_changedBlocksCount - The number of blocks that were written to the snapshot.
data CompleteSnapshotResponse Source #
See: newCompleteSnapshotResponse smart constructor.
Constructors
| CompleteSnapshotResponse' (Maybe Status) Int |
Instances
newCompleteSnapshotResponse Source #
Create a value of CompleteSnapshotResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:CompleteSnapshotResponse', completeSnapshotResponse_status - The status of the snapshot.
$sel:httpStatus:CompleteSnapshotResponse', completeSnapshotResponse_httpStatus - The response's http status code.
GetSnapshotBlock
data GetSnapshotBlock Source #
See: newGetSnapshotBlock smart constructor.
Constructors
| GetSnapshotBlock' Text Natural Text |
Instances
Arguments
| :: Text | |
| -> Natural | |
| -> Text | |
| -> GetSnapshotBlock |
Create a value of GetSnapshotBlock with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:snapshotId:GetSnapshotBlock', getSnapshotBlock_snapshotId - 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, getSnapshotBlock_blockIndex - 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, getSnapshotBlock_blockToken - The block token of the block from which to get data. You can obtain the
BlockToken by running the ListChangedBlocks or ListSnapshotBlocks
operations.
data GetSnapshotBlockResponse Source #
See: newGetSnapshotBlockResponse smart constructor.
Constructors
| GetSnapshotBlockResponse' (Maybe Text) (Maybe ChecksumAlgorithm) (Maybe Int) Int ResponseBody |
Instances
newGetSnapshotBlockResponse Source #
Arguments
| :: Int | |
| -> ResponseBody | |
| -> GetSnapshotBlockResponse |
Create a value of GetSnapshotBlockResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:checksum:GetSnapshotBlockResponse', getSnapshotBlockResponse_checksum - The checksum generated for the block, which is Base64 encoded.
$sel:checksumAlgorithm:GetSnapshotBlockResponse', getSnapshotBlockResponse_checksumAlgorithm - The algorithm used to generate the checksum for the block, such as
SHA256.
$sel:dataLength:GetSnapshotBlockResponse', getSnapshotBlockResponse_dataLength - The size of the data in the block.
$sel:httpStatus:GetSnapshotBlockResponse', getSnapshotBlockResponse_httpStatus - The response's http status code.
$sel:blockData:GetSnapshotBlockResponse', getSnapshotBlockResponse_blockData - The data content of the block.
ListChangedBlocks
data ListChangedBlocks Source #
See: newListChangedBlocks smart constructor.
Instances
Create a value of ListChangedBlocks with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:firstSnapshotId:ListChangedBlocks', listChangedBlocks_firstSnapshotId - 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.
$sel:maxResults:ListChangedBlocks', listChangedBlocks_maxResults - 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, listChangedBlocks_nextToken - The token to request the next page of results.
If you specify NextToken, then StartingBlockIndex is ignored.
$sel:startingBlockIndex:ListChangedBlocks', listChangedBlocks_startingBlockIndex - 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.
$sel:secondSnapshotId:ListChangedBlocks', listChangedBlocks_secondSnapshotId - 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.
data ListChangedBlocksResponse Source #
See: newListChangedBlocksResponse smart constructor.
Constructors
| ListChangedBlocksResponse' (Maybe Int) (Maybe [Sensitive ChangedBlock]) (Maybe POSIX) (Maybe Text) (Maybe Natural) Int |
Instances
newListChangedBlocksResponse Source #
Create a value of ListChangedBlocksResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:blockSize:ListChangedBlocksResponse', listChangedBlocksResponse_blockSize - The size of the blocks in the snapshot, in bytes.
$sel:changedBlocks:ListChangedBlocksResponse', listChangedBlocksResponse_changedBlocks - An array of objects containing information about the changed blocks.
$sel:expiryTime:ListChangedBlocksResponse', listChangedBlocksResponse_expiryTime - The time when the BlockToken expires.
ListChangedBlocks, listChangedBlocksResponse_nextToken - The token to use to retrieve the next page of results. This value is
null when there are no more results to return.
$sel:volumeSize:ListChangedBlocksResponse', listChangedBlocksResponse_volumeSize - The size of the volume in GB.
$sel:httpStatus:ListChangedBlocksResponse', listChangedBlocksResponse_httpStatus - The response's http status code.
ListSnapshotBlocks
data ListSnapshotBlocks Source #
See: newListSnapshotBlocks smart constructor.
Instances
newListSnapshotBlocks Source #
Arguments
| :: Text | |
| -> ListSnapshotBlocks |
Create a value of ListSnapshotBlocks with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListSnapshotBlocks', listSnapshotBlocks_maxResults - 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, listSnapshotBlocks_nextToken - The token to request the next page of results.
If you specify NextToken, then StartingBlockIndex is ignored.
$sel:startingBlockIndex:ListSnapshotBlocks', listSnapshotBlocks_startingBlockIndex - 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.
$sel:snapshotId:ListSnapshotBlocks', listSnapshotBlocks_snapshotId - The ID of the snapshot from which to get block indexes and block tokens.
data ListSnapshotBlocksResponse Source #
See: newListSnapshotBlocksResponse smart constructor.
Constructors
| ListSnapshotBlocksResponse' (Maybe Int) (Maybe (Sensitive [Block])) (Maybe POSIX) (Maybe Text) (Maybe Natural) Int |
Instances
newListSnapshotBlocksResponse Source #
Create a value of ListSnapshotBlocksResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:blockSize:ListSnapshotBlocksResponse', listSnapshotBlocksResponse_blockSize - The size of the blocks in the snapshot, in bytes.
$sel:blocks:ListSnapshotBlocksResponse', listSnapshotBlocksResponse_blocks - An array of objects containing information about the blocks.
$sel:expiryTime:ListSnapshotBlocksResponse', listSnapshotBlocksResponse_expiryTime - The time when the BlockToken expires.
ListSnapshotBlocks, listSnapshotBlocksResponse_nextToken - The token to use to retrieve the next page of results. This value is
null when there are no more results to return.
$sel:volumeSize:ListSnapshotBlocksResponse', listSnapshotBlocksResponse_volumeSize - The size of the volume in GB.
$sel:httpStatus:ListSnapshotBlocksResponse', listSnapshotBlocksResponse_httpStatus - The response's http status code.
PutSnapshotBlock
data PutSnapshotBlock Source #
See: newPutSnapshotBlock smart constructor.
Constructors
| PutSnapshotBlock' (Maybe Natural) Text Natural Int Text ChecksumAlgorithm HashedBody |
Instances
Arguments
| :: Text | |
| -> Natural | |
| -> Int | |
| -> Text | |
| -> ChecksumAlgorithm | |
| -> HashedBody | |
| -> PutSnapshotBlock |
Create a value of PutSnapshotBlock with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:progress:PutSnapshotBlock', putSnapshotBlock_progress - The progress of the write process, as a percentage.
$sel:snapshotId:PutSnapshotBlock', putSnapshotBlock_snapshotId - 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, putSnapshotBlock_blockIndex - 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.
$sel:dataLength:PutSnapshotBlock', putSnapshotBlock_dataLength - The size of the data to write to the block, in bytes. Currently, the
only supported size is 524288 bytes.
Valid values: 524288
PutSnapshotBlock, putSnapshotBlock_checksum - A Base64-encoded SHA256 checksum of the data. Only SHA256 checksums are
supported.
PutSnapshotBlock, putSnapshotBlock_checksumAlgorithm - The algorithm used to generate the checksum. Currently, the only
supported algorithm is SHA256.
$sel:blockData:PutSnapshotBlock', putSnapshotBlock_blockData - 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.
data PutSnapshotBlockResponse Source #
See: newPutSnapshotBlockResponse smart constructor.
Constructors
| PutSnapshotBlockResponse' (Maybe Text) (Maybe ChecksumAlgorithm) Int |
Instances
newPutSnapshotBlockResponse Source #
Create a value of PutSnapshotBlockResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutSnapshotBlock, putSnapshotBlockResponse_checksum - The SHA256 checksum generated for the block data by Amazon EBS.
PutSnapshotBlock, putSnapshotBlockResponse_checksumAlgorithm - The algorithm used by Amazon EBS to generate the checksum.
$sel:httpStatus:PutSnapshotBlockResponse', putSnapshotBlockResponse_httpStatus - The response's http status code.
StartSnapshot
data StartSnapshot Source #
See: newStartSnapshot smart constructor.
Constructors
| StartSnapshot' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe (Sensitive Text)) (Maybe Text) (Maybe [Tag]) (Maybe Natural) Natural |
Instances
Arguments
| :: Natural | |
| -> StartSnapshot |
Create a value of StartSnapshot with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:StartSnapshot', startSnapshot_clientToken - 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, startSnapshot_description - A description for the snapshot.
$sel:encrypted:StartSnapshot', startSnapshot_encrypted - 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, startSnapshot_kmsKeyArn - 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, startSnapshot_parentSnapshotId - 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, startSnapshot_tags - The tags to apply to the snapshot.
$sel:timeout:StartSnapshot', startSnapshot_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.
StartSnapshot, startSnapshot_volumeSize - The size of the volume, in GiB. The maximum size is 65536 GiB (64
TiB).
data StartSnapshotResponse Source #
See: newStartSnapshotResponse smart constructor.
Constructors
| StartSnapshotResponse' (Maybe Int) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Status) (Maybe [Tag]) (Maybe Natural) Int |
Instances
newStartSnapshotResponse Source #
Create a value of StartSnapshotResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:blockSize:StartSnapshotResponse', startSnapshotResponse_blockSize - The size of the blocks in the snapshot, in bytes.
StartSnapshot, startSnapshotResponse_description - The description of the snapshot.
StartSnapshot, startSnapshotResponse_kmsKeyArn - The Amazon Resource Name (ARN) of the Key Management Service (KMS) key
used to encrypt the snapshot.
$sel:ownerId:StartSnapshotResponse', startSnapshotResponse_ownerId - The Amazon Web Services account ID of the snapshot owner.
StartSnapshot, startSnapshotResponse_parentSnapshotId - The ID of the parent snapshot.
$sel:snapshotId:StartSnapshotResponse', startSnapshotResponse_snapshotId - The ID of the snapshot.
$sel:startTime:StartSnapshotResponse', startSnapshotResponse_startTime - The timestamp when the snapshot was created.
$sel:status:StartSnapshotResponse', startSnapshotResponse_status - The status of the snapshot.
StartSnapshot, startSnapshotResponse_tags - 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.
StartSnapshot, startSnapshotResponse_volumeSize - The size of the volume, in GiB.
$sel:httpStatus:StartSnapshotResponse', startSnapshotResponse_httpStatus - The response's http status code.
Types
ChecksumAggregationMethod
newtype ChecksumAggregationMethod Source #
Constructors
| ChecksumAggregationMethod' | |
Fields | |
Bundled Patterns
| pattern ChecksumAggregationMethod_LINEAR :: ChecksumAggregationMethod |
Instances
ChecksumAlgorithm
newtype ChecksumAlgorithm Source #
Constructors
| ChecksumAlgorithm' | |
Fields | |
Bundled Patterns
| pattern ChecksumAlgorithm_SHA256 :: ChecksumAlgorithm |
Instances
Status
Constructors
| Status' | |
Fields
| |
Bundled Patterns
| pattern Status_Completed :: Status | |
| pattern Status_Error :: Status | |
| pattern Status_Pending :: Status |
Instances
Block
A block of data in an Amazon Elastic Block Store snapshot.
See: newBlock smart constructor.
Instances
| FromJSON Block Source # | |
| Generic Block Source # | |
| Read Block Source # | |
| Show Block Source # | |
| NFData Block Source # | |
Defined in Amazonka.EBS.Types.Block | |
| Eq Block Source # | |
| Hashable Block Source # | |
Defined in Amazonka.EBS.Types.Block | |
| type Rep Block Source # | |
Defined in Amazonka.EBS.Types.Block type Rep Block = D1 ('MetaData "Block" "Amazonka.EBS.Types.Block" "amazonka-ebs-2.0-64shgDr10jT2ab25iSOcZ1" 'False) (C1 ('MetaCons "Block'" 'PrefixI 'True) (S1 ('MetaSel ('Just "blockIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "blockToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
Create a value of Block with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:blockIndex:Block', block_blockIndex - The block index.
$sel:blockToken:Block', block_blockToken - The block token for the block index.
ChangedBlock
data ChangedBlock Source #
A block of data in an Amazon Elastic Block Store snapshot that is different from another snapshot of the same volume/snapshot lineage.
See: newChangedBlock smart constructor.
Instances
newChangedBlock :: ChangedBlock Source #
Create a value of ChangedBlock with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:blockIndex:ChangedBlock', changedBlock_blockIndex - The block index.
$sel:firstBlockToken:ChangedBlock', changedBlock_firstBlockToken - 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.
$sel:secondBlockToken:ChangedBlock', changedBlock_secondBlockToken - The block token for the block index of the SecondSnapshotId specified
in the ListChangedBlocks operation.
Tag
Describes a tag.
See: newTag smart constructor.
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.EBS.Types.Tag | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.EBS.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.EBS.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.EBS.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.EBS.Types.Tag" "amazonka-ebs-2.0-64shgDr10jT2ab25iSOcZ1" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
Create a value of Tag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag', tag_key - The key of the tag.
$sel:value:Tag', tag_value - The value of the tag.