amazonka-lightsail-2.0: Amazon Lightsail SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Lightsail.GetDisks

Description

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

This operation returns paginated results.

Synopsis

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

ToHeaders GetDisks Source # 
Instance details

Defined in Amazonka.Lightsail.GetDisks

Methods

toHeaders :: GetDisks -> [Header] #

ToPath GetDisks Source # 
Instance details

Defined in Amazonka.Lightsail.GetDisks

ToQuery GetDisks Source # 
Instance details

Defined in Amazonka.Lightsail.GetDisks

AWSPager GetDisks Source # 
Instance details

Defined in Amazonka.Lightsail.GetDisks

AWSRequest GetDisks Source # 
Instance details

Defined in Amazonka.Lightsail.GetDisks

Associated Types

type 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

Show GetDisks Source # 
Instance details

Defined in Amazonka.Lightsail.GetDisks

NFData GetDisks Source # 
Instance details

Defined in Amazonka.Lightsail.GetDisks

Methods

rnf :: GetDisks -> () #

Eq GetDisks Source # 
Instance details

Defined in Amazonka.Lightsail.GetDisks

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 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 #

Read GetDisksResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetDisks

Show GetDisksResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetDisks

NFData GetDisksResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetDisks

Methods

rnf :: GetDisksResponse -> () #

Eq GetDisksResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetDisks

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 #

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.