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.Lightsail.GetDisks

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about all block storage disks in your AWS account and region.

This operation returns paginated results.

Synopsis

data GetDisks = GetDisks' {
- pageToken :: Maybe Text
}
newGetDisks :: GetDisks
getDisks_pageToken :: Lens' GetDisks (Maybe Text)
data GetDisksResponse = GetDisksResponse' {
- disks :: Maybe [Disk]
- nextPageToken :: Maybe Text
- httpStatus :: Int
}
newGetDisksResponse :: Int -> GetDisksResponse
getDisksResponse_disks :: Lens' GetDisksResponse (Maybe [Disk])
getDisksResponse_nextPageToken :: Lens' GetDisksResponse (Maybe Text)
getDisksResponse_httpStatus :: Lens' GetDisksResponse Int

Creating a Request

data GetDisks Source #

See: newGetDisks smart constructor.

Constructors

GetDisks'
Fields pageToken :: Maybe Text The token to advance to the next page of results from your request. To get a page token, perform an initial `GetDisks` request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

Instances

Instances details

ToJSON GetDisks Source #
Instance details Defined in Amazonka.Lightsail.GetDisks Methods toJSON :: GetDisks -> Value # toEncoding :: GetDisks -> Encoding # toJSONList :: [GetDisks] -> Value # toEncodingList :: [GetDisks] -> Encoding #
ToHeaders GetDisks Source #
Instance details Defined in Amazonka.Lightsail.GetDisks Methods toHeaders :: GetDisks -> [Header] #
ToPath GetDisks Source #
Instance details Defined in Amazonka.Lightsail.GetDisks Methods toPath :: GetDisks -> ByteString #
ToQuery GetDisks Source #
Instance details Defined in Amazonka.Lightsail.GetDisks Methods toQuery :: GetDisks -> QueryString #
AWSPager GetDisks Source #
Instance details Defined in Amazonka.Lightsail.GetDisks Methods page :: GetDisks -> AWSResponse GetDisks -> Maybe GetDisks #
AWSRequest GetDisks Source #
Instance details Defined in Amazonka.Lightsail.GetDisks Associated Types type AWSResponse GetDisks # Methods request :: (Service -> Service) -> GetDisks -> Request GetDisks # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetDisks -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetDisks))) #
Generic GetDisks Source #
Instance details Defined in Amazonka.Lightsail.GetDisks Associated Types type Rep GetDisks :: Type -> Type # Methods from :: GetDisks -> Rep GetDisks x # to :: Rep GetDisks x -> GetDisks #
Read GetDisks Source #
Instance details Defined in Amazonka.Lightsail.GetDisks Methods readsPrec :: Int -> ReadS GetDisks # readList :: ReadS [GetDisks] # readPrec :: ReadPrec GetDisks # readListPrec :: ReadPrec [GetDisks] #
Show GetDisks Source #
Instance details Defined in Amazonka.Lightsail.GetDisks Methods showsPrec :: Int -> GetDisks -> ShowS # show :: GetDisks -> String # showList :: [GetDisks] -> ShowS #
NFData GetDisks Source #
Instance details Defined in Amazonka.Lightsail.GetDisks Methods rnf :: GetDisks -> () #
Eq GetDisks Source #
Instance details Defined in Amazonka.Lightsail.GetDisks Methods (==) :: GetDisks -> GetDisks -> Bool # (/=) :: GetDisks -> GetDisks -> Bool #
Hashable GetDisks Source #
Instance details Defined in Amazonka.Lightsail.GetDisks Methods hashWithSalt :: Int -> GetDisks -> Int # hash :: GetDisks -> Int #
type AWSResponse GetDisks Source #
Instance details Defined in Amazonka.Lightsail.GetDisks type AWSResponse GetDisks = GetDisksResponse
type Rep GetDisks Source #
Instance details Defined in Amazonka.Lightsail.GetDisks type Rep GetDisks = D1 ('MetaData "GetDisks" "Amazonka.Lightsail.GetDisks" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "GetDisks'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newGetDisks :: GetDisks Source #

Create a value of GetDisks 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:pageToken:GetDisks', getDisks_pageToken - The token to advance to the next page of results from your request.

To get a page token, perform an initial GetDisks request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

Request Lenses

getDisks_pageToken :: Lens' GetDisks (Maybe Text) Source #

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetDisks request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

Destructuring the Response

data GetDisksResponse Source #

See: newGetDisksResponse smart constructor.

Constructors

GetDisksResponse'

Fields

disks :: Maybe [Disk]
An array of objects containing information about all block storage disks.
nextPageToken :: Maybe Text
The token to advance to the next page of results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetDisks request and specify the next page token using the pageToken parameter.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetDisksResponse Source #
Instance details Defined in Amazonka.Lightsail.GetDisks Associated Types type Rep GetDisksResponse :: Type -> Type # Methods from :: GetDisksResponse -> Rep GetDisksResponse x # to :: Rep GetDisksResponse x -> GetDisksResponse #
Read GetDisksResponse Source #
Instance details Defined in Amazonka.Lightsail.GetDisks Methods readsPrec :: Int -> ReadS GetDisksResponse # readList :: ReadS [GetDisksResponse] # readPrec :: ReadPrec GetDisksResponse # readListPrec :: ReadPrec [GetDisksResponse] #
Show GetDisksResponse Source #
Instance details Defined in Amazonka.Lightsail.GetDisks Methods showsPrec :: Int -> GetDisksResponse -> ShowS # show :: GetDisksResponse -> String # showList :: [GetDisksResponse] -> ShowS #
NFData GetDisksResponse Source #
Instance details Defined in Amazonka.Lightsail.GetDisks Methods rnf :: GetDisksResponse -> () #
Eq GetDisksResponse Source #
Instance details Defined in Amazonka.Lightsail.GetDisks Methods (==) :: GetDisksResponse -> GetDisksResponse -> Bool # (/=) :: GetDisksResponse -> GetDisksResponse -> Bool #
type Rep GetDisksResponse Source #
Instance details Defined in Amazonka.Lightsail.GetDisks type Rep GetDisksResponse = D1 ('MetaData "GetDisksResponse" "Amazonka.Lightsail.GetDisks" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "GetDisksResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "disks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Disk])) :: (S1 ('MetaSel ('Just "nextPageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetDisksResponse Source #

Arguments

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

Create a value of GetDisksResponse 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:

GetDisksResponse, getDisksResponse_disks - An array of objects containing information about all block storage disks.

$sel:nextPageToken:GetDisksResponse', getDisksResponse_nextPageToken - The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetDisks request and specify the next page token using the pageToken parameter.

$sel:httpStatus:GetDisksResponse', getDisksResponse_httpStatus - The response's http status code.

Response Lenses

getDisksResponse_disks :: Lens' GetDisksResponse (Maybe [Disk]) Source #

An array of objects containing information about all block storage disks.

getDisksResponse_nextPageToken :: Lens' GetDisksResponse (Maybe Text) Source #

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetDisks request and specify the next page token using the pageToken parameter.

getDisksResponse_httpStatus :: Lens' GetDisksResponse Int Source #

The response's http status code.