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

Description

Returns the names of all active (not deleted) resources.

This operation returns paginated results.

Synopsis

Creating a Request

data GetActiveNames Source #

See: newGetActiveNames smart constructor.

Constructors

GetActiveNames' 

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 GetActiveNames 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 GetActiveNames Source # 
Instance details

Defined in Amazonka.Lightsail.GetActiveNames

ToHeaders GetActiveNames Source # 
Instance details

Defined in Amazonka.Lightsail.GetActiveNames

ToPath GetActiveNames Source # 
Instance details

Defined in Amazonka.Lightsail.GetActiveNames

ToQuery GetActiveNames Source # 
Instance details

Defined in Amazonka.Lightsail.GetActiveNames

AWSPager GetActiveNames Source # 
Instance details

Defined in Amazonka.Lightsail.GetActiveNames

AWSRequest GetActiveNames Source # 
Instance details

Defined in Amazonka.Lightsail.GetActiveNames

Associated Types

type AWSResponse GetActiveNames #

Generic GetActiveNames Source # 
Instance details

Defined in Amazonka.Lightsail.GetActiveNames

Associated Types

type Rep GetActiveNames :: Type -> Type #

Read GetActiveNames Source # 
Instance details

Defined in Amazonka.Lightsail.GetActiveNames

Show GetActiveNames Source # 
Instance details

Defined in Amazonka.Lightsail.GetActiveNames

NFData GetActiveNames Source # 
Instance details

Defined in Amazonka.Lightsail.GetActiveNames

Methods

rnf :: GetActiveNames -> () #

Eq GetActiveNames Source # 
Instance details

Defined in Amazonka.Lightsail.GetActiveNames

Hashable GetActiveNames Source # 
Instance details

Defined in Amazonka.Lightsail.GetActiveNames

type AWSResponse GetActiveNames Source # 
Instance details

Defined in Amazonka.Lightsail.GetActiveNames

type Rep GetActiveNames Source # 
Instance details

Defined in Amazonka.Lightsail.GetActiveNames

type Rep GetActiveNames = D1 ('MetaData "GetActiveNames" "Amazonka.Lightsail.GetActiveNames" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "GetActiveNames'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newGetActiveNames :: GetActiveNames Source #

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

To get a page token, perform an initial GetActiveNames 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

getActiveNames_pageToken :: Lens' GetActiveNames (Maybe Text) Source #

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

To get a page token, perform an initial GetActiveNames 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 GetActiveNamesResponse Source #

See: newGetActiveNamesResponse smart constructor.

Constructors

GetActiveNamesResponse' 

Fields

  • activeNames :: Maybe [Text]

    The list of active names returned by the get active names request.

  • 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 GetActiveNames request and specify the next page token using the pageToken parameter.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic GetActiveNamesResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetActiveNames

Associated Types

type Rep GetActiveNamesResponse :: Type -> Type #

Read GetActiveNamesResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetActiveNames

Show GetActiveNamesResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetActiveNames

NFData GetActiveNamesResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetActiveNames

Methods

rnf :: GetActiveNamesResponse -> () #

Eq GetActiveNamesResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetActiveNames

type Rep GetActiveNamesResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetActiveNames

type Rep GetActiveNamesResponse = D1 ('MetaData "GetActiveNamesResponse" "Amazonka.Lightsail.GetActiveNames" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "GetActiveNamesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "activeNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "nextPageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetActiveNamesResponse Source #

Create a value of GetActiveNamesResponse 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:activeNames:GetActiveNamesResponse', getActiveNamesResponse_activeNames - The list of active names returned by the get active names request.

$sel:nextPageToken:GetActiveNamesResponse', getActiveNamesResponse_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 GetActiveNames request and specify the next page token using the pageToken parameter.

$sel:httpStatus:GetActiveNamesResponse', getActiveNamesResponse_httpStatus - The response's http status code.

Response Lenses

getActiveNamesResponse_activeNames :: Lens' GetActiveNamesResponse (Maybe [Text]) Source #

The list of active names returned by the get active names request.

getActiveNamesResponse_nextPageToken :: Lens' GetActiveNamesResponse (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 GetActiveNames request and specify the next page token using the pageToken parameter.