Amazonka.VoiceId.ListSpeakers

Lists all speakers in a specified domain.

This operation returns paginated results.

Creating a Request

data ListSpeakers

See: newListSpeakers smart constructor.

Constructors

ListSpeakers'

Fields

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

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

• domainId :: Text

  The identifier of the domain.

Instances

ToJSON ListSpeakers

Defined in Amazonka.VoiceId.ListSpeakers

Methods

toJSON :: ListSpeakers -> Value

toEncoding :: ListSpeakers -> Encoding

toJSONList :: [ListSpeakers] -> Value

toEncodingList :: [ListSpeakers] -> Encoding

ToHeaders ListSpeakers

Defined in Amazonka.VoiceId.ListSpeakers

Methods

toHeaders :: ListSpeakers -> [Header]

ToPath ListSpeakers

Defined in Amazonka.VoiceId.ListSpeakers

Methods

toPath :: ListSpeakers -> ByteString

ToQuery ListSpeakers

Defined in Amazonka.VoiceId.ListSpeakers

Methods

toQuery :: ListSpeakers -> QueryString

AWSPager ListSpeakers

Defined in Amazonka.VoiceId.ListSpeakers

Methods

page :: ListSpeakers -> AWSResponse ListSpeakers -> Maybe ListSpeakers

AWSRequest ListSpeakers

Defined in Amazonka.VoiceId.ListSpeakers

Associated Types

type AWSResponse ListSpeakers

Methods

request :: (Service -> Service) -> ListSpeakers -> Request ListSpeakers

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListSpeakers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListSpeakers)))

Generic ListSpeakers

Defined in Amazonka.VoiceId.ListSpeakers

Associated Types

type Rep ListSpeakers :: Type -> Type

Methods

from :: ListSpeakers -> Rep ListSpeakers x

to :: Rep ListSpeakers x -> ListSpeakers

Read ListSpeakers

Defined in Amazonka.VoiceId.ListSpeakers

Methods

readsPrec :: Int -> ReadS ListSpeakers

readList :: ReadS [ListSpeakers]

readPrec :: ReadPrec ListSpeakers

readListPrec :: ReadPrec [ListSpeakers]

Show ListSpeakers

Defined in Amazonka.VoiceId.ListSpeakers

Methods

showsPrec :: Int -> ListSpeakers -> ShowS

show :: ListSpeakers -> String

showList :: [ListSpeakers] -> ShowS

NFData ListSpeakers

Defined in Amazonka.VoiceId.ListSpeakers

Methods

rnf :: ListSpeakers -> ()

Eq ListSpeakers

Defined in Amazonka.VoiceId.ListSpeakers

Methods

(==) :: ListSpeakers -> ListSpeakers -> Bool

(/=) :: ListSpeakers -> ListSpeakers -> Bool

Hashable ListSpeakers

Defined in Amazonka.VoiceId.ListSpeakers

Methods

hashWithSalt :: Int -> ListSpeakers -> Int

hash :: ListSpeakers -> Int

type AWSResponse ListSpeakers

Defined in Amazonka.VoiceId.ListSpeakers

type AWSResponse ListSpeakers = ListSpeakersResponse

type Rep ListSpeakers

Defined in Amazonka.VoiceId.ListSpeakers

type Rep ListSpeakers = D1 ('MetaData "ListSpeakers" "Amazonka.VoiceId.ListSpeakers" "amazonka-voice-id-2.0-E9fR3xKghdA6rj9Pl7P2NC" 'False) (C1 ('MetaCons "ListSpeakers'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "domainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListSpeakers

Arguments

:: Text

ListSpeakers

-> ListSpeakers

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

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.

ListSpeakers, listSpeakers_domainId - The identifier of the domain.

Request Lenses

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

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

listSpeakers_domainId :: Lens' ListSpeakers Text

The identifier of the domain.

Destructuring the Response

data ListSpeakersResponse

See: newListSpeakersResponse smart constructor.

Constructors

ListSpeakersResponse'

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.

• speakerSummaries :: Maybe [SpeakerSummary]

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListSpeakersResponse

Defined in Amazonka.VoiceId.ListSpeakers

Associated Types

type Rep ListSpeakersResponse :: Type -> Type

Methods

from :: ListSpeakersResponse -> Rep ListSpeakersResponse x

to :: Rep ListSpeakersResponse x -> ListSpeakersResponse

Show ListSpeakersResponse

Defined in Amazonka.VoiceId.ListSpeakers

Methods

showsPrec :: Int -> ListSpeakersResponse -> ShowS

show :: ListSpeakersResponse -> String

showList :: [ListSpeakersResponse] -> ShowS

NFData ListSpeakersResponse

Defined in Amazonka.VoiceId.ListSpeakers

Methods

rnf :: ListSpeakersResponse -> ()

Eq ListSpeakersResponse

Defined in Amazonka.VoiceId.ListSpeakers

Methods

(==) :: ListSpeakersResponse -> ListSpeakersResponse -> Bool

(/=) :: ListSpeakersResponse -> ListSpeakersResponse -> Bool

type Rep ListSpeakersResponse

Defined in Amazonka.VoiceId.ListSpeakers

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

newListSpeakersResponse

Arguments

:: Int

$sel:httpStatus:ListSpeakersResponse'

-> ListSpeakersResponse

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:

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

$sel:httpStatus:ListSpeakersResponse', listSpeakersResponse_httpStatus - The response's http status code.

Response Lenses

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

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

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

listSpeakersResponse_httpStatus :: Lens' ListSpeakersResponse Int

The response's http status code.