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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about the blocks in an Amazon Elastic Block Store snapshot.

Synopsis

data ListSnapshotBlocks = ListSnapshotBlocks' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- startingBlockIndex :: Maybe Natural
- snapshotId :: Text
}
newListSnapshotBlocks :: Text -> ListSnapshotBlocks
listSnapshotBlocks_maxResults :: Lens' ListSnapshotBlocks (Maybe Natural)
listSnapshotBlocks_nextToken :: Lens' ListSnapshotBlocks (Maybe Text)
listSnapshotBlocks_startingBlockIndex :: Lens' ListSnapshotBlocks (Maybe Natural)
listSnapshotBlocks_snapshotId :: Lens' ListSnapshotBlocks Text
data ListSnapshotBlocksResponse = ListSnapshotBlocksResponse' {
- blockSize :: Maybe Int
- blocks :: Maybe (Sensitive [Block])
- expiryTime :: Maybe POSIX
- nextToken :: Maybe Text
- volumeSize :: Maybe Natural
- httpStatus :: Int
}
newListSnapshotBlocksResponse :: Int -> ListSnapshotBlocksResponse
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

Creating a Request

data ListSnapshotBlocks Source #

See: newListSnapshotBlocks smart constructor.

Constructors

ListSnapshotBlocks'

Fields

maxResults :: Maybe Natural
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.
nextToken :: Maybe Text
The token to request the next page of results.
If you specify NextToken, then StartingBlockIndex is ignored.
startingBlockIndex :: Maybe Natural
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.
snapshotId :: Text
The ID of the snapshot from which to get block indexes and block tokens.

Instances

Instances details

ToHeaders ListSnapshotBlocks Source #
Instance details Defined in Amazonka.EBS.ListSnapshotBlocks Methods toHeaders :: ListSnapshotBlocks -> [Header] #
ToPath ListSnapshotBlocks Source #
Instance details Defined in Amazonka.EBS.ListSnapshotBlocks Methods toPath :: ListSnapshotBlocks -> ByteString #
ToQuery ListSnapshotBlocks Source #
Instance details Defined in Amazonka.EBS.ListSnapshotBlocks Methods toQuery :: ListSnapshotBlocks -> QueryString #
AWSRequest ListSnapshotBlocks Source #
Instance details Defined in Amazonka.EBS.ListSnapshotBlocks Associated Types type AWSResponse ListSnapshotBlocks # Methods request :: (Service -> Service) -> ListSnapshotBlocks -> Request ListSnapshotBlocks # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListSnapshotBlocks -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListSnapshotBlocks))) #
Generic ListSnapshotBlocks Source #
Instance details Defined in Amazonka.EBS.ListSnapshotBlocks Associated Types type Rep ListSnapshotBlocks :: Type -> Type # Methods from :: ListSnapshotBlocks -> Rep ListSnapshotBlocks x # to :: Rep ListSnapshotBlocks x -> ListSnapshotBlocks #
Read ListSnapshotBlocks Source #
Instance details Defined in Amazonka.EBS.ListSnapshotBlocks Methods readsPrec :: Int -> ReadS ListSnapshotBlocks # readList :: ReadS [ListSnapshotBlocks] # readPrec :: ReadPrec ListSnapshotBlocks # readListPrec :: ReadPrec [ListSnapshotBlocks] #
Show ListSnapshotBlocks Source #
Instance details Defined in Amazonka.EBS.ListSnapshotBlocks Methods showsPrec :: Int -> ListSnapshotBlocks -> ShowS # show :: ListSnapshotBlocks -> String # showList :: [ListSnapshotBlocks] -> ShowS #
NFData ListSnapshotBlocks Source #
Instance details Defined in Amazonka.EBS.ListSnapshotBlocks Methods rnf :: ListSnapshotBlocks -> () #
Eq ListSnapshotBlocks Source #
Instance details Defined in Amazonka.EBS.ListSnapshotBlocks Methods (==) :: ListSnapshotBlocks -> ListSnapshotBlocks -> Bool # (/=) :: ListSnapshotBlocks -> ListSnapshotBlocks -> Bool #
Hashable ListSnapshotBlocks Source #
Instance details Defined in Amazonka.EBS.ListSnapshotBlocks Methods hashWithSalt :: Int -> ListSnapshotBlocks -> Int # hash :: ListSnapshotBlocks -> Int #
type AWSResponse ListSnapshotBlocks Source #
Instance details Defined in Amazonka.EBS.ListSnapshotBlocks type AWSResponse ListSnapshotBlocks = ListSnapshotBlocksResponse
type Rep ListSnapshotBlocks Source #
Instance details Defined in Amazonka.EBS.ListSnapshotBlocks type Rep ListSnapshotBlocks = D1 ('MetaData "ListSnapshotBlocks" "Amazonka.EBS.ListSnapshotBlocks" "amazonka-ebs-2.0-64shgDr10jT2ab25iSOcZ1" 'False) (C1 ('MetaCons "ListSnapshotBlocks'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "startingBlockIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "snapshotId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListSnapshotBlocks Source #

Arguments

:: Text	`$sel:snapshotId:ListSnapshotBlocks'`
-> 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.

Request Lenses

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.

Destructuring the Response

data ListSnapshotBlocksResponse Source #

See: newListSnapshotBlocksResponse smart constructor.

Constructors

ListSnapshotBlocksResponse'

Fields

blockSize :: Maybe Int
The size of the blocks in the snapshot, in bytes.
blocks :: Maybe (Sensitive [Block])
An array of objects containing information about the blocks.
expiryTime :: Maybe POSIX
The time when the BlockToken expires.
nextToken :: Maybe Text
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
volumeSize :: Maybe Natural
The size of the volume in GB.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ListSnapshotBlocksResponse Source #
Instance details Defined in Amazonka.EBS.ListSnapshotBlocks Associated Types type Rep ListSnapshotBlocksResponse :: Type -> Type # Methods from :: ListSnapshotBlocksResponse -> Rep ListSnapshotBlocksResponse x # to :: Rep ListSnapshotBlocksResponse x -> ListSnapshotBlocksResponse #
Show ListSnapshotBlocksResponse Source #
Instance details Defined in Amazonka.EBS.ListSnapshotBlocks Methods showsPrec :: Int -> ListSnapshotBlocksResponse -> ShowS # show :: ListSnapshotBlocksResponse -> String # showList :: [ListSnapshotBlocksResponse] -> ShowS #
NFData ListSnapshotBlocksResponse Source #
Instance details Defined in Amazonka.EBS.ListSnapshotBlocks Methods rnf :: ListSnapshotBlocksResponse -> () #
Eq ListSnapshotBlocksResponse Source #
Instance details Defined in Amazonka.EBS.ListSnapshotBlocks Methods (==) :: ListSnapshotBlocksResponse -> ListSnapshotBlocksResponse -> Bool # (/=) :: ListSnapshotBlocksResponse -> ListSnapshotBlocksResponse -> Bool #
type Rep ListSnapshotBlocksResponse Source #
Instance details Defined in Amazonka.EBS.ListSnapshotBlocks type Rep ListSnapshotBlocksResponse = D1 ('MetaData "ListSnapshotBlocksResponse" "Amazonka.EBS.ListSnapshotBlocks" "amazonka-ebs-2.0-64shgDr10jT2ab25iSOcZ1" 'False) (C1 ('MetaCons "ListSnapshotBlocksResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "blockSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "blocks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive [Block]))) :: S1 ('MetaSel ('Just "expiryTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "volumeSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newListSnapshotBlocksResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListSnapshotBlocksResponse'`
-> ListSnapshotBlocksResponse

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.

Response Lenses

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.