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.SDB.ListDomains

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

ToHeaders ListDomains Source #
Instance details Defined in Amazonka.SDB.ListDomains Methods toHeaders :: ListDomains -> [Header] #
ToPath ListDomains Source #
Instance details Defined in Amazonka.SDB.ListDomains Methods toPath :: ListDomains -> ByteString #
ToQuery ListDomains Source #
Instance details Defined in Amazonka.SDB.ListDomains Methods toQuery :: ListDomains -> QueryString #
AWSPager ListDomains Source #
Instance details Defined in Amazonka.SDB.ListDomains Methods page :: ListDomains -> AWSResponse ListDomains -> Maybe ListDomains #
AWSRequest ListDomains Source #
Instance details Defined in Amazonka.SDB.ListDomains Associated Types type AWSResponse ListDomains # Methods request :: (Service -> Service) -> ListDomains -> Request ListDomains # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListDomains -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListDomains))) #
Generic ListDomains Source #
Instance details Defined in Amazonka.SDB.ListDomains Associated Types type Rep ListDomains :: Type -> Type # Methods from :: ListDomains -> Rep ListDomains x # to :: Rep ListDomains x -> ListDomains #
Read ListDomains Source #
Instance details Defined in Amazonka.SDB.ListDomains Methods readsPrec :: Int -> ReadS ListDomains # readList :: ReadS [ListDomains] # readPrec :: ReadPrec ListDomains # readListPrec :: ReadPrec [ListDomains] #
Show ListDomains Source #
Instance details Defined in Amazonka.SDB.ListDomains Methods showsPrec :: Int -> ListDomains -> ShowS # show :: ListDomains -> String # showList :: [ListDomains] -> ShowS #
NFData ListDomains Source #
Instance details Defined in Amazonka.SDB.ListDomains Methods rnf :: ListDomains -> () #
Eq ListDomains Source #
Instance details Defined in Amazonka.SDB.ListDomains Methods (==) :: ListDomains -> ListDomains -> Bool # (/=) :: ListDomains -> ListDomains -> Bool #
Hashable ListDomains Source #
Instance details Defined in Amazonka.SDB.ListDomains Methods hashWithSalt :: Int -> ListDomains -> Int # hash :: ListDomains -> Int #
type AWSResponse ListDomains Source #
Instance details Defined in Amazonka.SDB.ListDomains type AWSResponse ListDomains = ListDomainsResponse
type Rep ListDomains Source #
Instance details Defined in Amazonka.SDB.ListDomains type Rep ListDomains = D1 ('MetaData "ListDomains" "Amazonka.SDB.ListDomains" "amazonka-sdb-2.0-7a0e7nVPNy1GutfrhcqnW8" '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))))

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.

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

Generic ListDomainsResponse Source #
Instance details Defined in Amazonka.SDB.ListDomains Associated Types type Rep ListDomainsResponse :: Type -> Type # Methods from :: ListDomainsResponse -> Rep ListDomainsResponse x # to :: Rep ListDomainsResponse x -> ListDomainsResponse #
Read ListDomainsResponse Source #
Instance details Defined in Amazonka.SDB.ListDomains Methods readsPrec :: Int -> ReadS ListDomainsResponse # readList :: ReadS [ListDomainsResponse] # readPrec :: ReadPrec ListDomainsResponse # readListPrec :: ReadPrec [ListDomainsResponse] #
Show ListDomainsResponse Source #
Instance details Defined in Amazonka.SDB.ListDomains Methods showsPrec :: Int -> ListDomainsResponse -> ShowS # show :: ListDomainsResponse -> String # showList :: [ListDomainsResponse] -> ShowS #
NFData ListDomainsResponse Source #
Instance details Defined in Amazonka.SDB.ListDomains Methods rnf :: ListDomainsResponse -> () #
Eq ListDomainsResponse Source #
Instance details Defined in Amazonka.SDB.ListDomains Methods (==) :: ListDomainsResponse -> ListDomainsResponse -> Bool # (/=) :: ListDomainsResponse -> ListDomainsResponse -> Bool #
type Rep ListDomainsResponse Source #
Instance details Defined in Amazonka.SDB.ListDomains type Rep ListDomainsResponse = D1 ('MetaData "ListDomainsResponse" "Amazonka.SDB.ListDomains" "amazonka-sdb-2.0-7a0e7nVPNy1GutfrhcqnW8" '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 #

Arguments

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

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.

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.

listDomainsResponse_httpStatus :: Lens' ListDomainsResponse Int Source #

The response's http status code.