| 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.ConnectParticipant.GetTranscript
Description
Retrieves a transcript of the session, including details about any attachments.
ConnectionToken is used for invoking this API instead of
ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
Synopsis
- data GetTranscript = GetTranscript' {}
- newGetTranscript :: Text -> GetTranscript
- getTranscript_contactId :: Lens' GetTranscript (Maybe Text)
- getTranscript_maxResults :: Lens' GetTranscript (Maybe Natural)
- getTranscript_nextToken :: Lens' GetTranscript (Maybe Text)
- getTranscript_scanDirection :: Lens' GetTranscript (Maybe ScanDirection)
- getTranscript_sortOrder :: Lens' GetTranscript (Maybe SortKey)
- getTranscript_startPosition :: Lens' GetTranscript (Maybe StartPosition)
- getTranscript_connectionToken :: Lens' GetTranscript Text
- data GetTranscriptResponse = GetTranscriptResponse' {
- initialContactId :: Maybe Text
- nextToken :: Maybe Text
- transcript :: Maybe [Item]
- httpStatus :: Int
- newGetTranscriptResponse :: Int -> GetTranscriptResponse
- getTranscriptResponse_initialContactId :: Lens' GetTranscriptResponse (Maybe Text)
- getTranscriptResponse_nextToken :: Lens' GetTranscriptResponse (Maybe Text)
- getTranscriptResponse_transcript :: Lens' GetTranscriptResponse (Maybe [Item])
- getTranscriptResponse_httpStatus :: Lens' GetTranscriptResponse Int
Creating a Request
data GetTranscript Source #
See: newGetTranscript smart constructor.
Constructors
| GetTranscript' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> GetTranscript |
Create a value of GetTranscript 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:contactId:GetTranscript', getTranscript_contactId - The contactId from the current contact chain for which transcript is
needed.
$sel:maxResults:GetTranscript', getTranscript_maxResults - The maximum number of results to return in the page. Default: 10.
GetTranscript, getTranscript_nextToken - The pagination token. Use the value returned previously in the next
subsequent request to retrieve the next set of results.
$sel:scanDirection:GetTranscript', getTranscript_scanDirection - The direction from StartPosition from which to retrieve message.
Default: BACKWARD when no StartPosition is provided, FORWARD with
StartPosition.
$sel:sortOrder:GetTranscript', getTranscript_sortOrder - The sort order for the records. Default: DESCENDING.
$sel:startPosition:GetTranscript', getTranscript_startPosition - A filtering option for where to start.
GetTranscript, getTranscript_connectionToken - The authentication token associated with the participant's connection.
Request Lenses
getTranscript_contactId :: Lens' GetTranscript (Maybe Text) Source #
The contactId from the current contact chain for which transcript is needed.
getTranscript_maxResults :: Lens' GetTranscript (Maybe Natural) Source #
The maximum number of results to return in the page. Default: 10.
getTranscript_nextToken :: Lens' GetTranscript (Maybe Text) Source #
The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.
getTranscript_scanDirection :: Lens' GetTranscript (Maybe ScanDirection) Source #
The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.
getTranscript_sortOrder :: Lens' GetTranscript (Maybe SortKey) Source #
The sort order for the records. Default: DESCENDING.
getTranscript_startPosition :: Lens' GetTranscript (Maybe StartPosition) Source #
A filtering option for where to start.
getTranscript_connectionToken :: Lens' GetTranscript Text Source #
The authentication token associated with the participant's connection.
Destructuring the Response
data GetTranscriptResponse Source #
See: newGetTranscriptResponse smart constructor.
Constructors
| GetTranscriptResponse' | |
Fields
| |
Instances
newGetTranscriptResponse Source #
Create a value of GetTranscriptResponse 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:initialContactId:GetTranscriptResponse', getTranscriptResponse_initialContactId - The initial contact ID for the contact.
GetTranscript, getTranscriptResponse_nextToken - The pagination token. Use the value returned previously in the next
subsequent request to retrieve the next set of results.
$sel:transcript:GetTranscriptResponse', getTranscriptResponse_transcript - The list of messages in the session.
$sel:httpStatus:GetTranscriptResponse', getTranscriptResponse_httpStatus - The response's http status code.
Response Lenses
getTranscriptResponse_initialContactId :: Lens' GetTranscriptResponse (Maybe Text) Source #
The initial contact ID for the contact.
getTranscriptResponse_nextToken :: Lens' GetTranscriptResponse (Maybe Text) Source #
The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.
getTranscriptResponse_transcript :: Lens' GetTranscriptResponse (Maybe [Item]) Source #
The list of messages in the session.
getTranscriptResponse_httpStatus :: Lens' GetTranscriptResponse Int Source #
The response's http status code.