amazonka-voice-id-2.0: Amazon Voice ID 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.VoiceId.ListDomains

Description

Lists all the domains in the Amazon Web Services account.

This operation returns paginated results.

Synopsis

Creating a Request

data ListDomains Source #

See: newListDomains smart constructor.

Constructors

ListDomains' 

Fields

  • maxResults :: Maybe Natural

    The maximum number of domains to list per API call.

  • nextToken :: Maybe Text

    If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

Instances

Instances details
ToJSON ListDomains Source # 
Instance details

Defined in Amazonka.VoiceId.ListDomains

Methods

toJSON :: ListDomains -> Value #

toEncoding :: ListDomains -> Encoding #

toJSONList :: [ListDomains] -> Value #

toEncodingList :: [ListDomains] -> Encoding #

ToHeaders ListDomains Source # 
Instance details

Defined in Amazonka.VoiceId.ListDomains

Methods

toHeaders :: ListDomains -> [Header] #

ToPath ListDomains Source # 
Instance details

Defined in Amazonka.VoiceId.ListDomains

Methods

toPath :: ListDomains -> ByteString #

ToQuery ListDomains Source # 
Instance details

Defined in Amazonka.VoiceId.ListDomains

Methods

toQuery :: ListDomains -> QueryString #

AWSPager ListDomains Source # 
Instance details

Defined in Amazonka.VoiceId.ListDomains

Methods

page :: ListDomains -> AWSResponse ListDomains -> Maybe ListDomains #

AWSRequest ListDomains Source # 
Instance details

Defined in Amazonka.VoiceId.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.VoiceId.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.VoiceId.ListDomains

Methods

readsPrec :: Int -> ReadS ListDomains #

readList :: ReadS [ListDomains] #

readPrec :: ReadPrec ListDomains #

readListPrec :: ReadPrec [ListDomains] #

Show ListDomains Source # 
Instance details

Defined in Amazonka.VoiceId.ListDomains

Methods

showsPrec :: Int -> ListDomains -> ShowS #

show :: ListDomains -> String #

showList :: [ListDomains] -> ShowS #

NFData ListDomains Source # 
Instance details

Defined in Amazonka.VoiceId.ListDomains

Methods

rnf :: ListDomains -> () #

Eq ListDomains Source # 
Instance details

Defined in Amazonka.VoiceId.ListDomains

Methods

(==) :: ListDomains -> ListDomains -> Bool #

(/=) :: ListDomains -> ListDomains -> Bool #

Hashable ListDomains Source # 
Instance details

Defined in Amazonka.VoiceId.ListDomains

Methods

hashWithSalt :: Int -> ListDomains -> Int #

hash :: ListDomains -> Int #

type AWSResponse ListDomains Source # 
Instance details

Defined in Amazonka.VoiceId.ListDomains

type AWSResponse ListDomains = ListDomainsResponse
type Rep ListDomains Source # 
Instance details

Defined in Amazonka.VoiceId.ListDomains

type Rep ListDomains = D1 ('MetaData "ListDomains" "Amazonka.VoiceId.ListDomains" "amazonka-voice-id-2.0-E9fR3xKghdA6rj9Pl7P2NC" 'False) (C1 ('MetaCons "ListDomains'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: 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:maxResults:ListDomains', listDomains_maxResults - The maximum number of domains to list per API call.

ListDomains, listDomains_nextToken - If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

Request Lenses

listDomains_maxResults :: Lens' ListDomains (Maybe Natural) Source #

The maximum number of domains to list per API call.

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

If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

Destructuring the Response

data ListDomainsResponse Source #

See: newListDomainsResponse smart constructor.

Constructors

ListDomainsResponse' 

Fields

  • domainSummaries :: Maybe [DomainSummary]

    A list containing details about each domain in the Amazon Web Services account.

  • nextToken :: Maybe Text

    If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListDomainsResponse Source # 
Instance details

Defined in Amazonka.VoiceId.ListDomains

Associated Types

type Rep ListDomainsResponse :: Type -> Type #

Methods

from :: ListDomainsResponse -> Rep ListDomainsResponse x #

to :: Rep ListDomainsResponse x -> ListDomainsResponse #

Show ListDomainsResponse Source # 
Instance details

Defined in Amazonka.VoiceId.ListDomains

Methods

showsPrec :: Int -> ListDomainsResponse -> ShowS #

show :: ListDomainsResponse -> String #

showList :: [ListDomainsResponse] -> ShowS #

NFData ListDomainsResponse Source # 
Instance details

Defined in Amazonka.VoiceId.ListDomains

Methods

rnf :: ListDomainsResponse -> () #

Eq ListDomainsResponse Source # 
Instance details

Defined in Amazonka.VoiceId.ListDomains

Methods

(==) :: ListDomainsResponse -> ListDomainsResponse -> Bool #

(/=) :: ListDomainsResponse -> ListDomainsResponse -> Bool #

type Rep ListDomainsResponse Source # 
Instance details

Defined in Amazonka.VoiceId.ListDomains

type Rep ListDomainsResponse = D1 ('MetaData "ListDomainsResponse" "Amazonka.VoiceId.ListDomains" "amazonka-voice-id-2.0-E9fR3xKghdA6rj9Pl7P2NC" 'False) (C1 ('MetaCons "ListDomainsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domainSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DomainSummary])) :*: (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:domainSummaries:ListDomainsResponse', listDomainsResponse_domainSummaries - A list containing details about each domain in the Amazon Web Services account.

ListDomains, listDomainsResponse_nextToken - If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

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

Response Lenses

listDomainsResponse_domainSummaries :: Lens' ListDomainsResponse (Maybe [DomainSummary]) Source #

A list containing details about each domain in the Amazon Web Services account.

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

If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

listDomainsResponse_httpStatus :: Lens' ListDomainsResponse Int Source #

The response's http status code.