You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ConnectParticipant::Types::GetTranscriptRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetTranscriptRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  contact_id: "ContactId",
  max_results: 1,
  next_token: "NextToken",
  scan_direction: "FORWARD", # accepts FORWARD, BACKWARD
  sort_order: "DESCENDING", # accepts DESCENDING, ASCENDING
  start_position: {
    id: "ChatItemId",
    absolute_time: "Instant",
    most_recent: 1,
  },
  connection_token: "ParticipantToken", # required
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#connection_token ⇒ String

The authentication token associated with the participant\'s connection.

Returns:

  • (String) —

    The authentication token associated with the participant\'s connection.

#contact_id ⇒ String

The contactId from the current contact chain for which transcript is needed.

Returns:

  • (String) —

    The contactId from the current contact chain for which transcript is needed.

#max_results ⇒ Integer

The maximum number of results to return in the page. Default: 10.

Returns:

  • (Integer) —

    The maximum number of results to return in the page.

#next_token ⇒ String

The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.

Returns:

  • (String) —

    The pagination token.

#scan_direction ⇒ String

The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.

Possible values:

  • FORWARD
  • BACKWARD

Returns:

  • (String) —

    The direction from StartPosition from which to retrieve message.

#sort_order ⇒ String

The sort order for the records. Default: DESCENDING.

Possible values:

  • DESCENDING
  • ASCENDING

Returns:

  • (String) —

    The sort order for the records.

#start_position ⇒ Types::StartPosition

A filtering option for where to start.

Returns: