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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides a list of Call Analytics jobs that match the specified criteria. If no criteria are specified, all Call Analytics jobs are returned.

To get detailed information about a specific Call Analytics job, use the operation.

Synopsis

Creating a Request

data ListCallAnalyticsJobs Source #

See: newListCallAnalyticsJobs smart constructor.

Constructors

ListCallAnalyticsJobs'

Fields

jobNameContains :: Maybe Text
Returns only the Call Analytics jobs that contain the specified string. The search is not case sensitive.
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 that you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.
nextToken :: Maybe Text
If your ListCallAnalyticsJobs request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.
status :: Maybe CallAnalyticsJobStatus
Returns only Call Analytics jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you don't include Status, all Call Analytics jobs are returned.

Instances

Instances details

ToJSON ListCallAnalyticsJobs Source #
Instance details Defined in Amazonka.Transcribe.ListCallAnalyticsJobs Methods toJSON :: ListCallAnalyticsJobs -> Value # toEncoding :: ListCallAnalyticsJobs -> Encoding # toJSONList :: [ListCallAnalyticsJobs] -> Value # toEncodingList :: [ListCallAnalyticsJobs] -> Encoding #
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 #
AWSRequest ListCallAnalyticsJobs Source #
Instance details Defined in Amazonka.Transcribe.ListCallAnalyticsJobs Associated Types type AWSResponse ListCallAnalyticsJobs # Methods request :: (Service -> Service) -> ListCallAnalyticsJobs -> Request ListCallAnalyticsJobs # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListCallAnalyticsJobs -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListCallAnalyticsJobs))) #
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 #
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 #
NFData ListCallAnalyticsJobs Source #
Instance details Defined in Amazonka.Transcribe.ListCallAnalyticsJobs Methods rnf :: ListCallAnalyticsJobs -> () #
Eq ListCallAnalyticsJobs Source #
Instance details Defined in Amazonka.Transcribe.ListCallAnalyticsJobs Methods (==) :: ListCallAnalyticsJobs -> ListCallAnalyticsJobs -> Bool # (/=) :: ListCallAnalyticsJobs -> ListCallAnalyticsJobs -> Bool #
Hashable ListCallAnalyticsJobs Source #
Instance details Defined in Amazonka.Transcribe.ListCallAnalyticsJobs Methods hashWithSalt :: Int -> ListCallAnalyticsJobs -> Int # hash :: ListCallAnalyticsJobs -> Int #
type AWSResponse ListCallAnalyticsJobs Source #
Instance details Defined in Amazonka.Transcribe.ListCallAnalyticsJobs type AWSResponse ListCallAnalyticsJobs = ListCallAnalyticsJobsResponse
type Rep ListCallAnalyticsJobs Source #
Instance details Defined in Amazonka.Transcribe.ListCallAnalyticsJobs type Rep ListCallAnalyticsJobs = D1 ('MetaData "ListCallAnalyticsJobs" "Amazonka.Transcribe.ListCallAnalyticsJobs" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "ListCallAnalyticsJobs'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "jobNameContains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CallAnalyticsJobStatus)))))

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:jobNameContains:ListCallAnalyticsJobs', listCallAnalyticsJobs_jobNameContains - Returns only the Call Analytics jobs that contain the specified string. The search is not case sensitive.

$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 that you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.

ListCallAnalyticsJobs, listCallAnalyticsJobs_nextToken - If your ListCallAnalyticsJobs request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

ListCallAnalyticsJobs, listCallAnalyticsJobs_status - Returns only Call Analytics jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you don't include Status, all Call Analytics jobs are returned.

Request Lenses

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

Returns only the Call Analytics jobs that contain the specified string. The search is not case sensitive.

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 that you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.

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

If your ListCallAnalyticsJobs request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

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

Returns only Call Analytics jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you don't include Status, all Call Analytics jobs are returned.

Destructuring the Response

data ListCallAnalyticsJobsResponse Source #

See: newListCallAnalyticsJobsResponse smart constructor.

Constructors

ListCallAnalyticsJobsResponse'

Fields

callAnalyticsJobSummaries :: Maybe [CallAnalyticsJobSummary]
Provides a summary of information about each result.
nextToken :: Maybe Text
If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.
status :: Maybe CallAnalyticsJobStatus
Lists all Call Analytics jobs that have the status specified in your request. Jobs are ordered by creation date, with the newest job first.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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 #
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 #
NFData ListCallAnalyticsJobsResponse Source #
Instance details Defined in Amazonka.Transcribe.ListCallAnalyticsJobs Methods rnf :: ListCallAnalyticsJobsResponse -> () #
Eq ListCallAnalyticsJobsResponse Source #
Instance details Defined in Amazonka.Transcribe.ListCallAnalyticsJobs Methods (==) :: ListCallAnalyticsJobsResponse -> ListCallAnalyticsJobsResponse -> Bool # (/=) :: ListCallAnalyticsJobsResponse -> ListCallAnalyticsJobsResponse -> Bool #
type Rep ListCallAnalyticsJobsResponse Source #
Instance details Defined in Amazonka.Transcribe.ListCallAnalyticsJobs type Rep ListCallAnalyticsJobsResponse = D1 ('MetaData "ListCallAnalyticsJobsResponse" "Amazonka.Transcribe.ListCallAnalyticsJobs" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "ListCallAnalyticsJobsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "callAnalyticsJobSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CallAnalyticsJobSummary])) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CallAnalyticsJobStatus)) :*: 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:callAnalyticsJobSummaries:ListCallAnalyticsJobsResponse', listCallAnalyticsJobsResponse_callAnalyticsJobSummaries - Provides a summary of information about each result.

ListCallAnalyticsJobs, listCallAnalyticsJobsResponse_nextToken - If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

ListCallAnalyticsJobs, listCallAnalyticsJobsResponse_status - Lists all Call Analytics jobs that have the status specified in your request. Jobs are ordered by creation date, with the newest job first.

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

Response Lenses

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

Provides a summary of information about each result.

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

If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

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

Lists all Call Analytics jobs that have the status specified in your request. Jobs are ordered by creation date, with the newest job first.

listCallAnalyticsJobsResponse_httpStatus :: Lens' ListCallAnalyticsJobsResponse Int Source #

The response's http status code.