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 |
Returns information about the blocks that are different between two Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.
Synopsis
- data ListChangedBlocks = ListChangedBlocks' {}
- newListChangedBlocks :: Text -> ListChangedBlocks
- 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
- data ListChangedBlocksResponse = ListChangedBlocksResponse' {}
- newListChangedBlocksResponse :: Int -> ListChangedBlocksResponse
- 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
Creating a Request
data ListChangedBlocks Source #
See: newListChangedBlocks
smart constructor.
ListChangedBlocks' | |
|
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.
Request Lenses
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.
Destructuring the Response
data ListChangedBlocksResponse Source #
See: newListChangedBlocksResponse
smart constructor.
ListChangedBlocksResponse' | |
|
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.
Response Lenses
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.