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.ConnectContactLens.ListRealtimeContactAnalysisSegments

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides a list of analysis segments for a real-time analysis session.

Synopsis

Creating a Request

data ListRealtimeContactAnalysisSegments Source #

See: newListRealtimeContactAnalysisSegments smart constructor.

Constructors

ListRealtimeContactAnalysisSegments'
Fields maxResults :: Maybe Natural The maximimum number of results to return per page. nextToken :: Maybe Text The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. instanceId :: Text The identifier of the Amazon Connect instance. contactId :: Text The identifier of the contact.

Instances

Instances details

ToJSON ListRealtimeContactAnalysisSegments Source #
Instance details Defined in Amazonka.ConnectContactLens.ListRealtimeContactAnalysisSegments Methods toJSON :: ListRealtimeContactAnalysisSegments -> Value # toEncoding :: ListRealtimeContactAnalysisSegments -> Encoding # toJSONList :: [ListRealtimeContactAnalysisSegments] -> Value # toEncodingList :: [ListRealtimeContactAnalysisSegments] -> Encoding #
ToHeaders ListRealtimeContactAnalysisSegments Source #
Instance details Defined in Amazonka.ConnectContactLens.ListRealtimeContactAnalysisSegments Methods toHeaders :: ListRealtimeContactAnalysisSegments -> [Header] #
ToPath ListRealtimeContactAnalysisSegments Source #
Instance details Defined in Amazonka.ConnectContactLens.ListRealtimeContactAnalysisSegments Methods toPath :: ListRealtimeContactAnalysisSegments -> ByteString #
ToQuery ListRealtimeContactAnalysisSegments Source #
Instance details Defined in Amazonka.ConnectContactLens.ListRealtimeContactAnalysisSegments Methods toQuery :: ListRealtimeContactAnalysisSegments -> QueryString #
AWSRequest ListRealtimeContactAnalysisSegments Source #
Instance details Defined in Amazonka.ConnectContactLens.ListRealtimeContactAnalysisSegments Associated Types type AWSResponse ListRealtimeContactAnalysisSegments # Methods request :: (Service -> Service) -> ListRealtimeContactAnalysisSegments -> Request ListRealtimeContactAnalysisSegments # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListRealtimeContactAnalysisSegments -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListRealtimeContactAnalysisSegments))) #
Generic ListRealtimeContactAnalysisSegments Source #
Instance details Defined in Amazonka.ConnectContactLens.ListRealtimeContactAnalysisSegments Associated Types type Rep ListRealtimeContactAnalysisSegments :: Type -> Type # Methods from :: ListRealtimeContactAnalysisSegments -> Rep ListRealtimeContactAnalysisSegments x # to :: Rep ListRealtimeContactAnalysisSegments x -> ListRealtimeContactAnalysisSegments #
Read ListRealtimeContactAnalysisSegments Source #
Instance details Defined in Amazonka.ConnectContactLens.ListRealtimeContactAnalysisSegments Methods readsPrec :: Int -> ReadS ListRealtimeContactAnalysisSegments # readList :: ReadS [ListRealtimeContactAnalysisSegments] # readPrec :: ReadPrec ListRealtimeContactAnalysisSegments # readListPrec :: ReadPrec [ListRealtimeContactAnalysisSegments] #
Show ListRealtimeContactAnalysisSegments Source #
Instance details Defined in Amazonka.ConnectContactLens.ListRealtimeContactAnalysisSegments Methods showsPrec :: Int -> ListRealtimeContactAnalysisSegments -> ShowS # show :: ListRealtimeContactAnalysisSegments -> String # showList :: [ListRealtimeContactAnalysisSegments] -> ShowS #
NFData ListRealtimeContactAnalysisSegments Source #
Instance details Defined in Amazonka.ConnectContactLens.ListRealtimeContactAnalysisSegments Methods rnf :: ListRealtimeContactAnalysisSegments -> () #
Eq ListRealtimeContactAnalysisSegments Source #
Instance details Defined in Amazonka.ConnectContactLens.ListRealtimeContactAnalysisSegments Methods (==) :: ListRealtimeContactAnalysisSegments -> ListRealtimeContactAnalysisSegments -> Bool # (/=) :: ListRealtimeContactAnalysisSegments -> ListRealtimeContactAnalysisSegments -> Bool #
Hashable ListRealtimeContactAnalysisSegments Source #
Instance details Defined in Amazonka.ConnectContactLens.ListRealtimeContactAnalysisSegments Methods hashWithSalt :: Int -> ListRealtimeContactAnalysisSegments -> Int # hash :: ListRealtimeContactAnalysisSegments -> Int #
type AWSResponse ListRealtimeContactAnalysisSegments Source #
Instance details Defined in Amazonka.ConnectContactLens.ListRealtimeContactAnalysisSegments type AWSResponse ListRealtimeContactAnalysisSegments = ListRealtimeContactAnalysisSegmentsResponse
type Rep ListRealtimeContactAnalysisSegments Source #
Instance details Defined in Amazonka.ConnectContactLens.ListRealtimeContactAnalysisSegments type Rep ListRealtimeContactAnalysisSegments = D1 ('MetaData "ListRealtimeContactAnalysisSegments" "Amazonka.ConnectContactLens.ListRealtimeContactAnalysisSegments" "amazonka-connect-contact-lens-2.0-9Vo58J4YA8CG5QImOmbpc2" 'False) (C1 ('MetaCons "ListRealtimeContactAnalysisSegments'" '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 "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "contactId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListRealtimeContactAnalysisSegments Source #

Arguments

:: Text	`$sel:instanceId:ListRealtimeContactAnalysisSegments'`
-> Text	`$sel:contactId:ListRealtimeContactAnalysisSegments'`
-> ListRealtimeContactAnalysisSegments

Create a value of ListRealtimeContactAnalysisSegments 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:ListRealtimeContactAnalysisSegments', listRealtimeContactAnalysisSegments_maxResults - The maximimum number of results to return per page.

ListRealtimeContactAnalysisSegments, listRealtimeContactAnalysisSegments_nextToken - The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

$sel:instanceId:ListRealtimeContactAnalysisSegments', listRealtimeContactAnalysisSegments_instanceId - The identifier of the Amazon Connect instance.

$sel:contactId:ListRealtimeContactAnalysisSegments', listRealtimeContactAnalysisSegments_contactId - The identifier of the contact.

Request Lenses

listRealtimeContactAnalysisSegments_maxResults :: Lens' ListRealtimeContactAnalysisSegments (Maybe Natural) Source #

The maximimum number of results to return per page.

listRealtimeContactAnalysisSegments_nextToken :: Lens' ListRealtimeContactAnalysisSegments (Maybe Text) Source #

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

listRealtimeContactAnalysisSegments_instanceId :: Lens' ListRealtimeContactAnalysisSegments Text Source #

The identifier of the Amazon Connect instance.

listRealtimeContactAnalysisSegments_contactId :: Lens' ListRealtimeContactAnalysisSegments Text Source #

The identifier of the contact.

Destructuring the Response

data ListRealtimeContactAnalysisSegmentsResponse Source #

See: newListRealtimeContactAnalysisSegmentsResponse smart constructor.

Constructors

ListRealtimeContactAnalysisSegmentsResponse'

Fields

nextToken :: Maybe Text
If there are additional results, this is the token for the next set of results. If response includes nextToken there are two possible scenarios:
- There are more segments so another call is required to get them.
- There are no more segments at this time, but more may be available later (real-time analysis is in progress) so the client should call the operation again to get new segments.
If response does not include nextToken, the analysis is completed (successfully or failed) and there are no more segments to retrieve.
httpStatus :: Int
The response's http status code.
segments :: [RealtimeContactAnalysisSegment]
An analyzed transcript or category.

Instances

Instances details

Generic ListRealtimeContactAnalysisSegmentsResponse Source #
Instance details Defined in Amazonka.ConnectContactLens.ListRealtimeContactAnalysisSegments Associated Types type Rep ListRealtimeContactAnalysisSegmentsResponse :: Type -> Type # Methods from :: ListRealtimeContactAnalysisSegmentsResponse -> Rep ListRealtimeContactAnalysisSegmentsResponse x # to :: Rep ListRealtimeContactAnalysisSegmentsResponse x -> ListRealtimeContactAnalysisSegmentsResponse #
Read ListRealtimeContactAnalysisSegmentsResponse Source #
Instance details Defined in Amazonka.ConnectContactLens.ListRealtimeContactAnalysisSegments Methods readsPrec :: Int -> ReadS ListRealtimeContactAnalysisSegmentsResponse # readList :: ReadS [ListRealtimeContactAnalysisSegmentsResponse] # readPrec :: ReadPrec ListRealtimeContactAnalysisSegmentsResponse # readListPrec :: ReadPrec [ListRealtimeContactAnalysisSegmentsResponse] #
Show ListRealtimeContactAnalysisSegmentsResponse Source #
Instance details Defined in Amazonka.ConnectContactLens.ListRealtimeContactAnalysisSegments Methods showsPrec :: Int -> ListRealtimeContactAnalysisSegmentsResponse -> ShowS # show :: ListRealtimeContactAnalysisSegmentsResponse -> String # showList :: [ListRealtimeContactAnalysisSegmentsResponse] -> ShowS #
NFData ListRealtimeContactAnalysisSegmentsResponse Source #
Instance details Defined in Amazonka.ConnectContactLens.ListRealtimeContactAnalysisSegments Methods rnf :: ListRealtimeContactAnalysisSegmentsResponse -> () #
Eq ListRealtimeContactAnalysisSegmentsResponse Source #
Instance details Defined in Amazonka.ConnectContactLens.ListRealtimeContactAnalysisSegments Methods (==) :: ListRealtimeContactAnalysisSegmentsResponse -> ListRealtimeContactAnalysisSegmentsResponse -> Bool # (/=) :: ListRealtimeContactAnalysisSegmentsResponse -> ListRealtimeContactAnalysisSegmentsResponse -> Bool #
type Rep ListRealtimeContactAnalysisSegmentsResponse Source #
Instance details Defined in Amazonka.ConnectContactLens.ListRealtimeContactAnalysisSegments type Rep ListRealtimeContactAnalysisSegmentsResponse = D1 ('MetaData "ListRealtimeContactAnalysisSegmentsResponse" "Amazonka.ConnectContactLens.ListRealtimeContactAnalysisSegments" "amazonka-connect-contact-lens-2.0-9Vo58J4YA8CG5QImOmbpc2" 'False) (C1 ('MetaCons "ListRealtimeContactAnalysisSegmentsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "segments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [RealtimeContactAnalysisSegment]))))

newListRealtimeContactAnalysisSegmentsResponse Source #

Arguments

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

Create a value of ListRealtimeContactAnalysisSegmentsResponse 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:

ListRealtimeContactAnalysisSegments, listRealtimeContactAnalysisSegmentsResponse_nextToken - If there are additional results, this is the token for the next set of results. If response includes nextToken there are two possible scenarios:

There are more segments so another call is required to get them.
There are no more segments at this time, but more may be available later (real-time analysis is in progress) so the client should call the operation again to get new segments.

If response does not include nextToken, the analysis is completed (successfully or failed) and there are no more segments to retrieve.

$sel:httpStatus:ListRealtimeContactAnalysisSegmentsResponse', listRealtimeContactAnalysisSegmentsResponse_httpStatus - The response's http status code.

$sel:segments:ListRealtimeContactAnalysisSegmentsResponse', listRealtimeContactAnalysisSegmentsResponse_segments - An analyzed transcript or category.

Response Lenses

listRealtimeContactAnalysisSegmentsResponse_nextToken :: Lens' ListRealtimeContactAnalysisSegmentsResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results. If response includes nextToken there are two possible scenarios:

There are more segments so another call is required to get them.
There are no more segments at this time, but more may be available later (real-time analysis is in progress) so the client should call the operation again to get new segments.

If response does not include nextToken, the analysis is completed (successfully or failed) and there are no more segments to retrieve.

listRealtimeContactAnalysisSegmentsResponse_httpStatus :: Lens' ListRealtimeContactAnalysisSegmentsResponse Int Source #

The response's http status code.

listRealtimeContactAnalysisSegmentsResponse_segments :: Lens' ListRealtimeContactAnalysisSegmentsResponse [RealtimeContactAnalysisSegment] Source #

An analyzed transcript or category.