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.Transcribe.ListCallAnalyticsJobs

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

List call analytics jobs with a specified status or substring that matches their names.

Synopsis

Creating a Request

data ListCallAnalyticsJobs Source #

See: newListCallAnalyticsJobs smart constructor.

Constructors

ListCallAnalyticsJobs'

Fields

status :: Maybe CallAnalyticsJobStatus
When specified, returns only call analytics jobs with the specified status. Jobs are ordered by creation date, with the most recent jobs returned first. If you don't specify a status, Amazon Transcribe returns all analytics jobs ordered by creation date.
nextToken :: Maybe Text
If you receive a truncated result in the previous request of , include NextToken to fetch the next set of jobs.
jobNameContains :: Maybe Text
When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.
maxResults :: Maybe Natural
The maximum number of call analytics jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.

Instances

Instances details

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

newListCallAnalyticsJobs :: ListCallAnalyticsJobs Source #

Create a value of ListCallAnalyticsJobs 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:ListCallAnalyticsJobs', listCallAnalyticsJobs_status - When specified, returns only call analytics jobs with the specified status. Jobs are ordered by creation date, with the most recent jobs returned first. If you don't specify a status, Amazon Transcribe returns all analytics jobs ordered by creation date.

$sel:nextToken:ListCallAnalyticsJobs', listCallAnalyticsJobs_nextToken - If you receive a truncated result in the previous request of , include NextToken to fetch the next set of jobs.

$sel:jobNameContains:ListCallAnalyticsJobs', listCallAnalyticsJobs_jobNameContains - When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.

$sel:maxResults:ListCallAnalyticsJobs', listCallAnalyticsJobs_maxResults - The maximum number of call analytics jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.

Request Lenses

listCallAnalyticsJobs_status :: Lens' ListCallAnalyticsJobs (Maybe CallAnalyticsJobStatus) Source #

When specified, returns only call analytics jobs with the specified status. Jobs are ordered by creation date, with the most recent jobs returned first. If you don't specify a status, Amazon Transcribe returns all analytics jobs ordered by creation date.

listCallAnalyticsJobs_nextToken :: Lens' ListCallAnalyticsJobs (Maybe Text) Source #

If you receive a truncated result in the previous request of , include NextToken to fetch the next set of jobs.

listCallAnalyticsJobs_jobNameContains :: Lens' ListCallAnalyticsJobs (Maybe Text) Source #

When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.

listCallAnalyticsJobs_maxResults :: Lens' ListCallAnalyticsJobs (Maybe Natural) Source #

The maximum number of call analytics jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.

Destructuring the Response

data ListCallAnalyticsJobsResponse Source #

See: newListCallAnalyticsJobsResponse smart constructor.

Constructors

ListCallAnalyticsJobsResponse'

Fields

status :: Maybe CallAnalyticsJobStatus
When specified, returns only call analytics jobs with that status. Jobs are ordered by creation date, with the most recent jobs returned first. If you don't specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.
callAnalyticsJobSummaries :: Maybe [CallAnalyticsJobSummary]
A list of objects containing summary information for a transcription job.
nextToken :: Maybe Text
The operation returns a page of jobs at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in your next request to the operation to return next page of jobs.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq ListCallAnalyticsJobsResponse Source #
Instance details Defined in Amazonka.Transcribe.ListCallAnalyticsJobs Methods (==) :: ListCallAnalyticsJobsResponse -> ListCallAnalyticsJobsResponse -> Bool # (/=) :: ListCallAnalyticsJobsResponse -> ListCallAnalyticsJobsResponse -> Bool #
Read ListCallAnalyticsJobsResponse Source #
Instance details Defined in Amazonka.Transcribe.ListCallAnalyticsJobs Methods readsPrec :: Int -> ReadS ListCallAnalyticsJobsResponse # readList :: ReadS [ListCallAnalyticsJobsResponse] # readPrec :: ReadPrec ListCallAnalyticsJobsResponse # readListPrec :: ReadPrec [ListCallAnalyticsJobsResponse] #
Show ListCallAnalyticsJobsResponse Source #
Instance details Defined in Amazonka.Transcribe.ListCallAnalyticsJobs Methods showsPrec :: Int -> ListCallAnalyticsJobsResponse -> ShowS # show :: ListCallAnalyticsJobsResponse -> String # showList :: [ListCallAnalyticsJobsResponse] -> ShowS #
Generic ListCallAnalyticsJobsResponse Source #
Instance details Defined in Amazonka.Transcribe.ListCallAnalyticsJobs Associated Types type Rep ListCallAnalyticsJobsResponse :: Type -> Type # Methods from :: ListCallAnalyticsJobsResponse -> Rep ListCallAnalyticsJobsResponse x # to :: Rep ListCallAnalyticsJobsResponse x -> ListCallAnalyticsJobsResponse #
NFData ListCallAnalyticsJobsResponse Source #
Instance details Defined in Amazonka.Transcribe.ListCallAnalyticsJobs Methods rnf :: ListCallAnalyticsJobsResponse -> () #
type Rep ListCallAnalyticsJobsResponse Source #
Instance details Defined in Amazonka.Transcribe.ListCallAnalyticsJobs type Rep ListCallAnalyticsJobsResponse = D1 ('MetaData "ListCallAnalyticsJobsResponse" "Amazonka.Transcribe.ListCallAnalyticsJobs" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" 'False) (C1 ('MetaCons "ListCallAnalyticsJobsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CallAnalyticsJobStatus)) :: S1 ('MetaSel ('Just "callAnalyticsJobSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CallAnalyticsJobSummary]))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListCallAnalyticsJobsResponse Source #

Arguments

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

Create a value of ListCallAnalyticsJobsResponse 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:ListCallAnalyticsJobs', listCallAnalyticsJobsResponse_status - When specified, returns only call analytics jobs with that status. Jobs are ordered by creation date, with the most recent jobs returned first. If you don't specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.

$sel:callAnalyticsJobSummaries:ListCallAnalyticsJobsResponse', listCallAnalyticsJobsResponse_callAnalyticsJobSummaries - A list of objects containing summary information for a transcription job.

$sel:nextToken:ListCallAnalyticsJobs', listCallAnalyticsJobsResponse_nextToken - The operation returns a page of jobs at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in your next request to the operation to return next page of jobs.

$sel:httpStatus:ListCallAnalyticsJobsResponse', listCallAnalyticsJobsResponse_httpStatus - The response's http status code.

Response Lenses

listCallAnalyticsJobsResponse_status :: Lens' ListCallAnalyticsJobsResponse (Maybe CallAnalyticsJobStatus) Source #

When specified, returns only call analytics jobs with that status. Jobs are ordered by creation date, with the most recent jobs returned first. If you don't specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.

listCallAnalyticsJobsResponse_callAnalyticsJobSummaries :: Lens' ListCallAnalyticsJobsResponse (Maybe [CallAnalyticsJobSummary]) Source #

A list of objects containing summary information for a transcription job.

listCallAnalyticsJobsResponse_nextToken :: Lens' ListCallAnalyticsJobsResponse (Maybe Text) Source #

The operation returns a page of jobs at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in your next request to the operation to return next page of jobs.

listCallAnalyticsJobsResponse_httpStatus :: Lens' ListCallAnalyticsJobsResponse Int Source #

The response's http status code.