Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

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

Creating a Request

data ListSnapshotBlocks Source #

See: newListSnapshotBlocks smart constructor.

Constructors

ListSnapshotBlocks'

Fields

nextToken :: Maybe Text
The token to request the next page of results.
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.
maxResults :: Maybe Natural
The number of results to return.
snapshotId :: Text
The ID of the snapshot from which to get block indexes and block tokens.

Instances

Instances details

Eq ListSnapshotBlocks Source #
Instance details Defined in Amazonka.EBS.ListSnapshotBlocks Methods (==) :: ListSnapshotBlocks -> ListSnapshotBlocks -> Bool # (/=) :: ListSnapshotBlocks -> ListSnapshotBlocks -> Bool #
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 #
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 #
NFData ListSnapshotBlocks Source #
Instance details Defined in Amazonka.EBS.ListSnapshotBlocks Methods rnf :: ListSnapshotBlocks -> () #
Hashable ListSnapshotBlocks Source #
Instance details Defined in Amazonka.EBS.ListSnapshotBlocks Methods hashWithSalt :: Int -> ListSnapshotBlocks -> Int # hash :: ListSnapshotBlocks -> Int #
AWSRequest ListSnapshotBlocks Source #
Instance details Defined in Amazonka.EBS.ListSnapshotBlocks Associated Types type AWSResponse ListSnapshotBlocks # Methods request :: ListSnapshotBlocks -> Request ListSnapshotBlocks # response :: MonadResource m => Logger -> Service -> Proxy ListSnapshotBlocks -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListSnapshotBlocks))) #
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 #
type Rep ListSnapshotBlocks Source #
Instance details Defined in Amazonka.EBS.ListSnapshotBlocks type Rep ListSnapshotBlocks = D1 ('MetaData "ListSnapshotBlocks" "Amazonka.EBS.ListSnapshotBlocks" "libZSservicesZSamazonka-ebsZSamazonka-ebs" 'False) (C1 ('MetaCons "ListSnapshotBlocks'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "startingBlockIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "snapshotId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListSnapshotBlocks Source #
Instance details Defined in Amazonka.EBS.ListSnapshotBlocks type AWSResponse ListSnapshotBlocks = ListSnapshotBlocksResponse

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:nextToken:ListSnapshotBlocks', listSnapshotBlocks_nextToken - The token to request the next page of results.

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

$sel:maxResults:ListSnapshotBlocks', listSnapshotBlocks_maxResults - The number of results to return.

$sel:snapshotId:ListSnapshotBlocks', listSnapshotBlocks_snapshotId - The ID of the snapshot from which to get block indexes and block tokens.

Request Lenses

listSnapshotBlocks_nextToken :: Lens' ListSnapshotBlocks (Maybe Text) Source #

The token to request the next page of results.

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.

listSnapshotBlocks_maxResults :: Lens' ListSnapshotBlocks (Maybe Natural) Source #

The number of results to return.

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.
volumeSize :: Maybe Natural
The size of the volume in GB.
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq ListSnapshotBlocksResponse Source #
Instance details Defined in Amazonka.EBS.ListSnapshotBlocks Methods (==) :: ListSnapshotBlocksResponse -> ListSnapshotBlocksResponse -> Bool # (/=) :: ListSnapshotBlocksResponse -> ListSnapshotBlocksResponse -> Bool #
Show ListSnapshotBlocksResponse Source #
Instance details Defined in Amazonka.EBS.ListSnapshotBlocks Methods showsPrec :: Int -> ListSnapshotBlocksResponse -> ShowS # show :: ListSnapshotBlocksResponse -> String # showList :: [ListSnapshotBlocksResponse] -> ShowS #
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 #
NFData ListSnapshotBlocksResponse Source #
Instance details Defined in Amazonka.EBS.ListSnapshotBlocks Methods rnf :: ListSnapshotBlocksResponse -> () #
type Rep ListSnapshotBlocksResponse Source #
Instance details Defined in Amazonka.EBS.ListSnapshotBlocks type Rep ListSnapshotBlocksResponse = D1 ('MetaData "ListSnapshotBlocksResponse" "Amazonka.EBS.ListSnapshotBlocks" "libZSservicesZSamazonka-ebsZSamazonka-ebs" '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 "volumeSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: 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.

$sel:volumeSize:ListSnapshotBlocksResponse', listSnapshotBlocksResponse_volumeSize - The size of the volume in GB.

$sel:nextToken: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: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_volumeSize :: Lens' ListSnapshotBlocksResponse (Maybe Natural) Source #

The size of the volume in GB.

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_httpStatus :: Lens' ListSnapshotBlocksResponse Int Source #

The response's http status code.