| 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.VoiceId.ListSpeakers
Description
Lists all speakers in a specified domain.
This operation returns paginated results.
Synopsis
- data ListSpeakers = ListSpeakers' {}
- newListSpeakers :: Text -> ListSpeakers
- listSpeakers_maxResults :: Lens' ListSpeakers (Maybe Natural)
- listSpeakers_nextToken :: Lens' ListSpeakers (Maybe Text)
- listSpeakers_domainId :: Lens' ListSpeakers Text
- data ListSpeakersResponse = ListSpeakersResponse' {}
- newListSpeakersResponse :: Int -> ListSpeakersResponse
- listSpeakersResponse_nextToken :: Lens' ListSpeakersResponse (Maybe Text)
- listSpeakersResponse_speakerSummaries :: Lens' ListSpeakersResponse (Maybe [SpeakerSummary])
- listSpeakersResponse_httpStatus :: Lens' ListSpeakersResponse Int
Creating a Request
data ListSpeakers Source #
See: newListSpeakers smart constructor.
Constructors
| ListSpeakers' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> 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) 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_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_domainId :: Lens' ListSpeakers Text Source #
The identifier of the domain.
Destructuring the Response
data ListSpeakersResponse Source #
See: newListSpeakersResponse smart constructor.
Constructors
| ListSpeakersResponse' | |
Fields
| |
Instances
newListSpeakersResponse Source #
Arguments
| :: Int | |
| -> 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) 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.
listSpeakersResponse_speakerSummaries :: Lens' ListSpeakersResponse (Maybe [SpeakerSummary]) Source #
A list containing details about each speaker in the Amazon Web Services account.
listSpeakersResponse_httpStatus :: Lens' ListSpeakersResponse Int Source #
The response's http status code.