libZSservicesZSamazonka-sdbZSamazonka-sdb
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.SDB.ListDomains

Description

The ListDomains operation lists all domains associated with the Access Key ID. It returns domain names up to the limit set by MaxNumberOfDomains. A NextToken is returned if there are more than MaxNumberOfDomains domains. Calling ListDomains successive times with the NextToken provided by the operation returns up to MaxNumberOfDomains more domain names with each successive operation call.

This operation returns paginated results.

Synopsis

Creating a Request

data ListDomains Source #

See: newListDomains smart constructor.

Constructors

ListDomains' 

Fields

  • maxNumberOfDomains :: Maybe Int

    The maximum number of domain names you want returned. The range is 1 to 100. The default setting is 100.

  • nextToken :: Maybe Text

    A string informing Amazon SimpleDB where to start the next list of domain names.

Instances

Instances details
Eq ListDomains Source # 
Instance details

Defined in Amazonka.SDB.ListDomains

Read ListDomains Source # 
Instance details

Defined in Amazonka.SDB.ListDomains

Show ListDomains Source # 
Instance details

Defined in Amazonka.SDB.ListDomains

Generic ListDomains Source # 
Instance details

Defined in Amazonka.SDB.ListDomains

Associated Types

type Rep ListDomains :: Type -> Type #

NFData ListDomains Source # 
Instance details

Defined in Amazonka.SDB.ListDomains

Methods

rnf :: ListDomains -> () #

Hashable ListDomains Source # 
Instance details

Defined in Amazonka.SDB.ListDomains

AWSPager ListDomains Source # 
Instance details

Defined in Amazonka.SDB.ListDomains

AWSRequest ListDomains Source # 
Instance details

Defined in Amazonka.SDB.ListDomains

Associated Types

type AWSResponse ListDomains #

ToHeaders ListDomains Source # 
Instance details

Defined in Amazonka.SDB.ListDomains

Methods

toHeaders :: ListDomains -> [Header] #

ToPath ListDomains Source # 
Instance details

Defined in Amazonka.SDB.ListDomains

ToQuery ListDomains Source # 
Instance details

Defined in Amazonka.SDB.ListDomains

type Rep ListDomains Source # 
Instance details

Defined in Amazonka.SDB.ListDomains

type Rep ListDomains = D1 ('MetaData "ListDomains" "Amazonka.SDB.ListDomains" "libZSservicesZSamazonka-sdbZSamazonka-sdb" 'False) (C1 ('MetaCons "ListDomains'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxNumberOfDomains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))
type AWSResponse ListDomains Source # 
Instance details

Defined in Amazonka.SDB.ListDomains

newListDomains :: ListDomains Source #

Create a value of ListDomains 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:maxNumberOfDomains:ListDomains', listDomains_maxNumberOfDomains - The maximum number of domain names you want returned. The range is 1 to 100. The default setting is 100.

$sel:nextToken:ListDomains', listDomains_nextToken - A string informing Amazon SimpleDB where to start the next list of domain names.

Request Lenses

listDomains_maxNumberOfDomains :: Lens' ListDomains (Maybe Int) Source #

The maximum number of domain names you want returned. The range is 1 to 100. The default setting is 100.

listDomains_nextToken :: Lens' ListDomains (Maybe Text) Source #

A string informing Amazon SimpleDB where to start the next list of domain names.

Destructuring the Response

data ListDomainsResponse Source #

See: newListDomainsResponse smart constructor.

Constructors

ListDomainsResponse' 

Fields

  • domainNames :: Maybe [Text]

    A list of domain names that match the expression.

  • nextToken :: Maybe Text

    An opaque token indicating that there are more domains than the specified MaxNumberOfDomains still available.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListDomainsResponse Source # 
Instance details

Defined in Amazonka.SDB.ListDomains

Read ListDomainsResponse Source # 
Instance details

Defined in Amazonka.SDB.ListDomains

Show ListDomainsResponse Source # 
Instance details

Defined in Amazonka.SDB.ListDomains

Generic ListDomainsResponse Source # 
Instance details

Defined in Amazonka.SDB.ListDomains

Associated Types

type Rep ListDomainsResponse :: Type -> Type #

NFData ListDomainsResponse Source # 
Instance details

Defined in Amazonka.SDB.ListDomains

Methods

rnf :: ListDomainsResponse -> () #

type Rep ListDomainsResponse Source # 
Instance details

Defined in Amazonka.SDB.ListDomains

type Rep ListDomainsResponse = D1 ('MetaData "ListDomainsResponse" "Amazonka.SDB.ListDomains" "libZSservicesZSamazonka-sdbZSamazonka-sdb" 'False) (C1 ('MetaCons "ListDomainsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domainNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListDomainsResponse Source #

Create a value of ListDomainsResponse 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:domainNames:ListDomainsResponse', listDomainsResponse_domainNames - A list of domain names that match the expression.

$sel:nextToken:ListDomains', listDomainsResponse_nextToken - An opaque token indicating that there are more domains than the specified MaxNumberOfDomains still available.

$sel:httpStatus:ListDomainsResponse', listDomainsResponse_httpStatus - The response's http status code.

Response Lenses

listDomainsResponse_domainNames :: Lens' ListDomainsResponse (Maybe [Text]) Source #

A list of domain names that match the expression.

listDomainsResponse_nextToken :: Lens' ListDomainsResponse (Maybe Text) Source #

An opaque token indicating that there are more domains than the specified MaxNumberOfDomains still available.