libZSservicesZSamazonka-lightsailZSamazonka-lightsail
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Lightsail.GetDomains

Description

Returns a list of all domains in the user's account.

This operation returns paginated results.

Synopsis

Creating a Request

data GetDomains Source #

See: newGetDomains smart constructor.

Constructors

GetDomains' 

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

Defined in Amazonka.Lightsail.GetDomains

Read GetDomains Source # 
Instance details

Defined in Amazonka.Lightsail.GetDomains

Show GetDomains Source # 
Instance details

Defined in Amazonka.Lightsail.GetDomains

Generic GetDomains Source # 
Instance details

Defined in Amazonka.Lightsail.GetDomains

Associated Types

type Rep GetDomains :: Type -> Type #

NFData GetDomains Source # 
Instance details

Defined in Amazonka.Lightsail.GetDomains

Methods

rnf :: GetDomains -> () #

Hashable GetDomains Source # 
Instance details

Defined in Amazonka.Lightsail.GetDomains

ToJSON GetDomains Source # 
Instance details

Defined in Amazonka.Lightsail.GetDomains

AWSPager GetDomains Source # 
Instance details

Defined in Amazonka.Lightsail.GetDomains

AWSRequest GetDomains Source # 
Instance details

Defined in Amazonka.Lightsail.GetDomains

Associated Types

type AWSResponse GetDomains #

ToHeaders GetDomains Source # 
Instance details

Defined in Amazonka.Lightsail.GetDomains

Methods

toHeaders :: GetDomains -> [Header] #

ToPath GetDomains Source # 
Instance details

Defined in Amazonka.Lightsail.GetDomains

ToQuery GetDomains Source # 
Instance details

Defined in Amazonka.Lightsail.GetDomains

type Rep GetDomains Source # 
Instance details

Defined in Amazonka.Lightsail.GetDomains

type Rep GetDomains = D1 ('MetaData "GetDomains" "Amazonka.Lightsail.GetDomains" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" 'False) (C1 ('MetaCons "GetDomains'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))
type AWSResponse GetDomains Source # 
Instance details

Defined in Amazonka.Lightsail.GetDomains

newGetDomains :: GetDomains Source #

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

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

getDomains_pageToken :: Lens' GetDomains (Maybe Text) Source #

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

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

See: newGetDomainsResponse smart constructor.

Constructors

GetDomainsResponse' 

Fields

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

  • domains :: Maybe [Domain]

    An array of key-value pairs containing information about each of the domain entries in the user's account.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq GetDomainsResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetDomains

Read GetDomainsResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetDomains

Show GetDomainsResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetDomains

Generic GetDomainsResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetDomains

Associated Types

type Rep GetDomainsResponse :: Type -> Type #

NFData GetDomainsResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetDomains

Methods

rnf :: GetDomainsResponse -> () #

type Rep GetDomainsResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetDomains

type Rep GetDomainsResponse = D1 ('MetaData "GetDomainsResponse" "Amazonka.Lightsail.GetDomains" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" 'False) (C1 ('MetaCons "GetDomainsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextPageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "domains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Domain])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetDomainsResponse Source #

Create a value of GetDomainsResponse 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:nextPageToken:GetDomainsResponse', getDomainsResponse_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 GetDomains request and specify the next page token using the pageToken parameter.

$sel:domains:GetDomainsResponse', getDomainsResponse_domains - An array of key-value pairs containing information about each of the domain entries in the user's account.

$sel:httpStatus:GetDomainsResponse', getDomainsResponse_httpStatus - The response's http status code.

Response Lenses

getDomainsResponse_nextPageToken :: Lens' GetDomainsResponse (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 GetDomains request and specify the next page token using the pageToken parameter.

getDomainsResponse_domains :: Lens' GetDomainsResponse (Maybe [Domain]) Source #

An array of key-value pairs containing information about each of the domain entries in the user's account.