Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Polly.ListSpeechSynthesisTasks

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of SpeechSynthesisTask objects ordered by their creation date. This operation can filter the tasks by their status, for example, allowing users to list only tasks that are completed.

This operation returns paginated results.

Synopsis

Creating a Request

data ListSpeechSynthesisTasks Source #

See: newListSpeechSynthesisTasks smart constructor.

Constructors

ListSpeechSynthesisTasks'
Fields status :: Maybe TaskStatus Status of the speech synthesis tasks returned in a List operation nextToken :: Maybe Text The pagination token to use in the next request to continue the listing of speech synthesis tasks. maxResults :: Maybe Natural Maximum number of speech synthesis tasks returned in a List operation.

Instances

Instances details

Eq ListSpeechSynthesisTasks Source #
Instance details Defined in Amazonka.Polly.ListSpeechSynthesisTasks Methods (==) :: ListSpeechSynthesisTasks -> ListSpeechSynthesisTasks -> Bool # (/=) :: ListSpeechSynthesisTasks -> ListSpeechSynthesisTasks -> Bool #
Read ListSpeechSynthesisTasks Source #
Instance details Defined in Amazonka.Polly.ListSpeechSynthesisTasks Methods readsPrec :: Int -> ReadS ListSpeechSynthesisTasks # readList :: ReadS [ListSpeechSynthesisTasks] # readPrec :: ReadPrec ListSpeechSynthesisTasks # readListPrec :: ReadPrec [ListSpeechSynthesisTasks] #
Show ListSpeechSynthesisTasks Source #
Instance details Defined in Amazonka.Polly.ListSpeechSynthesisTasks Methods showsPrec :: Int -> ListSpeechSynthesisTasks -> ShowS # show :: ListSpeechSynthesisTasks -> String # showList :: [ListSpeechSynthesisTasks] -> ShowS #
Generic ListSpeechSynthesisTasks Source #
Instance details Defined in Amazonka.Polly.ListSpeechSynthesisTasks Associated Types type Rep ListSpeechSynthesisTasks :: Type -> Type # Methods from :: ListSpeechSynthesisTasks -> Rep ListSpeechSynthesisTasks x # to :: Rep ListSpeechSynthesisTasks x -> ListSpeechSynthesisTasks #
NFData ListSpeechSynthesisTasks Source #
Instance details Defined in Amazonka.Polly.ListSpeechSynthesisTasks Methods rnf :: ListSpeechSynthesisTasks -> () #
Hashable ListSpeechSynthesisTasks Source #
Instance details Defined in Amazonka.Polly.ListSpeechSynthesisTasks Methods hashWithSalt :: Int -> ListSpeechSynthesisTasks -> Int # hash :: ListSpeechSynthesisTasks -> Int #
AWSPager ListSpeechSynthesisTasks Source #
Instance details Defined in Amazonka.Polly.ListSpeechSynthesisTasks Methods page :: ListSpeechSynthesisTasks -> AWSResponse ListSpeechSynthesisTasks -> Maybe ListSpeechSynthesisTasks #
AWSRequest ListSpeechSynthesisTasks Source #
Instance details Defined in Amazonka.Polly.ListSpeechSynthesisTasks Associated Types type AWSResponse ListSpeechSynthesisTasks # Methods request :: ListSpeechSynthesisTasks -> Request ListSpeechSynthesisTasks # response :: MonadResource m => Logger -> Service -> Proxy ListSpeechSynthesisTasks -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListSpeechSynthesisTasks))) #
ToHeaders ListSpeechSynthesisTasks Source #
Instance details Defined in Amazonka.Polly.ListSpeechSynthesisTasks Methods toHeaders :: ListSpeechSynthesisTasks -> [Header] #
ToPath ListSpeechSynthesisTasks Source #
Instance details Defined in Amazonka.Polly.ListSpeechSynthesisTasks Methods toPath :: ListSpeechSynthesisTasks -> ByteString #
ToQuery ListSpeechSynthesisTasks Source #
Instance details Defined in Amazonka.Polly.ListSpeechSynthesisTasks Methods toQuery :: ListSpeechSynthesisTasks -> QueryString #
type Rep ListSpeechSynthesisTasks Source #
Instance details Defined in Amazonka.Polly.ListSpeechSynthesisTasks type Rep ListSpeechSynthesisTasks = D1 ('MetaData "ListSpeechSynthesisTasks" "Amazonka.Polly.ListSpeechSynthesisTasks" "libZSservicesZSamazonka-pollyZSamazonka-polly" 'False) (C1 ('MetaCons "ListSpeechSynthesisTasks'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaskStatus)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListSpeechSynthesisTasks Source #
Instance details Defined in Amazonka.Polly.ListSpeechSynthesisTasks type AWSResponse ListSpeechSynthesisTasks = ListSpeechSynthesisTasksResponse

newListSpeechSynthesisTasks :: ListSpeechSynthesisTasks Source #

Create a value of ListSpeechSynthesisTasks 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:status:ListSpeechSynthesisTasks', listSpeechSynthesisTasks_status - Status of the speech synthesis tasks returned in a List operation

$sel:nextToken:ListSpeechSynthesisTasks', listSpeechSynthesisTasks_nextToken - The pagination token to use in the next request to continue the listing of speech synthesis tasks.

$sel:maxResults:ListSpeechSynthesisTasks', listSpeechSynthesisTasks_maxResults - Maximum number of speech synthesis tasks returned in a List operation.

Request Lenses

listSpeechSynthesisTasks_status :: Lens' ListSpeechSynthesisTasks (Maybe TaskStatus) Source #

Status of the speech synthesis tasks returned in a List operation

listSpeechSynthesisTasks_nextToken :: Lens' ListSpeechSynthesisTasks (Maybe Text) Source #

The pagination token to use in the next request to continue the listing of speech synthesis tasks.

listSpeechSynthesisTasks_maxResults :: Lens' ListSpeechSynthesisTasks (Maybe Natural) Source #

Maximum number of speech synthesis tasks returned in a List operation.

Destructuring the Response

data ListSpeechSynthesisTasksResponse Source #

See: newListSpeechSynthesisTasksResponse smart constructor.

Constructors

ListSpeechSynthesisTasksResponse'

Fields

nextToken :: Maybe Text
An opaque pagination token returned from the previous List operation in this request. If present, this indicates where to continue the listing.
synthesisTasks :: Maybe [SynthesisTask]
List of SynthesisTask objects that provides information from the specified task in the list request, including output format, creation time, task status, and so on.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq ListSpeechSynthesisTasksResponse Source #
Instance details Defined in Amazonka.Polly.ListSpeechSynthesisTasks Methods (==) :: ListSpeechSynthesisTasksResponse -> ListSpeechSynthesisTasksResponse -> Bool # (/=) :: ListSpeechSynthesisTasksResponse -> ListSpeechSynthesisTasksResponse -> Bool #
Read ListSpeechSynthesisTasksResponse Source #
Instance details Defined in Amazonka.Polly.ListSpeechSynthesisTasks Methods readsPrec :: Int -> ReadS ListSpeechSynthesisTasksResponse # readList :: ReadS [ListSpeechSynthesisTasksResponse] # readPrec :: ReadPrec ListSpeechSynthesisTasksResponse # readListPrec :: ReadPrec [ListSpeechSynthesisTasksResponse] #
Show ListSpeechSynthesisTasksResponse Source #
Instance details Defined in Amazonka.Polly.ListSpeechSynthesisTasks Methods showsPrec :: Int -> ListSpeechSynthesisTasksResponse -> ShowS # show :: ListSpeechSynthesisTasksResponse -> String # showList :: [ListSpeechSynthesisTasksResponse] -> ShowS #
Generic ListSpeechSynthesisTasksResponse Source #
Instance details Defined in Amazonka.Polly.ListSpeechSynthesisTasks Associated Types type Rep ListSpeechSynthesisTasksResponse :: Type -> Type # Methods from :: ListSpeechSynthesisTasksResponse -> Rep ListSpeechSynthesisTasksResponse x # to :: Rep ListSpeechSynthesisTasksResponse x -> ListSpeechSynthesisTasksResponse #
NFData ListSpeechSynthesisTasksResponse Source #
Instance details Defined in Amazonka.Polly.ListSpeechSynthesisTasks Methods rnf :: ListSpeechSynthesisTasksResponse -> () #
type Rep ListSpeechSynthesisTasksResponse Source #
Instance details Defined in Amazonka.Polly.ListSpeechSynthesisTasks type Rep ListSpeechSynthesisTasksResponse = D1 ('MetaData "ListSpeechSynthesisTasksResponse" "Amazonka.Polly.ListSpeechSynthesisTasks" "libZSservicesZSamazonka-pollyZSamazonka-polly" 'False) (C1 ('MetaCons "ListSpeechSynthesisTasksResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "synthesisTasks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SynthesisTask])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListSpeechSynthesisTasksResponse Source #

Arguments

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

Create a value of ListSpeechSynthesisTasksResponse 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:ListSpeechSynthesisTasks', listSpeechSynthesisTasksResponse_nextToken - An opaque pagination token returned from the previous List operation in this request. If present, this indicates where to continue the listing.

$sel:synthesisTasks:ListSpeechSynthesisTasksResponse', listSpeechSynthesisTasksResponse_synthesisTasks - List of SynthesisTask objects that provides information from the specified task in the list request, including output format, creation time, task status, and so on.

$sel:httpStatus:ListSpeechSynthesisTasksResponse', listSpeechSynthesisTasksResponse_httpStatus - The response's http status code.

Response Lenses

listSpeechSynthesisTasksResponse_nextToken :: Lens' ListSpeechSynthesisTasksResponse (Maybe Text) Source #

An opaque pagination token returned from the previous List operation in this request. If present, this indicates where to continue the listing.

listSpeechSynthesisTasksResponse_synthesisTasks :: Lens' ListSpeechSynthesisTasksResponse (Maybe [SynthesisTask]) Source #

List of SynthesisTask objects that provides information from the specified task in the list request, including output format, creation time, task status, and so on.

listSpeechSynthesisTasksResponse_httpStatus :: Lens' ListSpeechSynthesisTasksResponse Int Source #

The response's http status code.