libZSservicesZSamazonka-voice-idZSamazonka-voice-id
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.VoiceId.ListSpeakers

Description

Lists all speakers in a specified domain.

Synopsis

Creating a Request

data ListSpeakers Source #

See: newListSpeakers smart constructor.

Constructors

ListSpeakers' 

Fields

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

  • maxResults :: Maybe Natural

    The maximum number of results that are returned per call. You can use NextToken to obtain further pages of results. The default is 100; the maximum allowed page size is also 100.

  • domainId :: Text

    The identifier of the domain.

Instances

Instances details
Eq ListSpeakers Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakers

Read ListSpeakers Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakers

Show ListSpeakers Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakers

Generic ListSpeakers Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakers

Associated Types

type Rep ListSpeakers :: Type -> Type #

NFData ListSpeakers Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakers

Methods

rnf :: ListSpeakers -> () #

Hashable ListSpeakers Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakers

ToJSON ListSpeakers Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakers

AWSRequest ListSpeakers Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakers

Associated Types

type AWSResponse ListSpeakers #

ToHeaders ListSpeakers Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakers

ToPath ListSpeakers Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakers

ToQuery ListSpeakers Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakers

type Rep ListSpeakers Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakers

type Rep ListSpeakers = D1 ('MetaData "ListSpeakers" "Amazonka.VoiceId.ListSpeakers" "libZSservicesZSamazonka-voice-idZSamazonka-voice-id" 'False) (C1 ('MetaCons "ListSpeakers'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "domainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListSpeakers Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakers

newListSpeakers Source #

Create a value of ListSpeakers 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:nextToken:ListSpeakers', listSpeakers_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:maxResults:ListSpeakers', listSpeakers_maxResults - The maximum number of results that are returned per call. You can use NextToken to obtain further pages of results. The default is 100; the maximum allowed page size is also 100.

$sel:domainId:ListSpeakers', listSpeakers_domainId - The identifier of the domain.

Request Lenses

listSpeakers_nextToken :: Lens' ListSpeakers (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.

listSpeakers_maxResults :: Lens' ListSpeakers (Maybe Natural) Source #

The maximum number of results that are returned per call. You can use NextToken to obtain further pages of results. The default is 100; the maximum allowed page size is also 100.

listSpeakers_domainId :: Lens' ListSpeakers Text Source #

The identifier of the domain.

Destructuring the Response

data ListSpeakersResponse Source #

See: newListSpeakersResponse smart constructor.

Constructors

ListSpeakersResponse' 

Fields

  • speakerSummaries :: Maybe [SpeakerSummary]

    A list containing details about each speaker 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
Eq ListSpeakersResponse Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakers

Show ListSpeakersResponse Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakers

Generic ListSpeakersResponse Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakers

Associated Types

type Rep ListSpeakersResponse :: Type -> Type #

NFData ListSpeakersResponse Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakers

Methods

rnf :: ListSpeakersResponse -> () #

type Rep ListSpeakersResponse Source # 
Instance details

Defined in Amazonka.VoiceId.ListSpeakers

type Rep ListSpeakersResponse = D1 ('MetaData "ListSpeakersResponse" "Amazonka.VoiceId.ListSpeakers" "libZSservicesZSamazonka-voice-idZSamazonka-voice-id" 'False) (C1 ('MetaCons "ListSpeakersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "speakerSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SpeakerSummary])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListSpeakersResponse Source #

Create a value of ListSpeakersResponse 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:speakerSummaries:ListSpeakersResponse', listSpeakersResponse_speakerSummaries - A list containing details about each speaker in the Amazon Web Services account.

$sel:nextToken:ListSpeakers', listSpeakersResponse_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:ListSpeakersResponse', listSpeakersResponse_httpStatus - The response's http status code.

Response Lenses

listSpeakersResponse_speakerSummaries :: Lens' ListSpeakersResponse (Maybe [SpeakerSummary]) Source #

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

listSpeakersResponse_nextToken :: Lens' ListSpeakersResponse (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.