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

Inherits:

Struct

• Object
• Struct
• Aws::ConnectParticipant::Types::GetTranscriptRequest

Includes:

Structure

Defined in:

lib/aws-sdk-connectparticipant/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #connection_token ⇒ 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.

• #max_results ⇒ Integer

  The maximum number of results to return in the page.

• #next_token ⇒ String

  The pagination token.

• #scan_direction ⇒ String

  The direction from StartPosition from which to retrieve message.

• #sort_order ⇒ String

  The sort order for the records.

• #start_position ⇒ Types::StartPosition

  A filtering option for where to start.

Instance Attribute Details

#connection_token ⇒ String

The authentication token associated with the participant’s connection.

Returns:

• (String)

# File 'lib/aws-sdk-connectparticipant/types.rb', line 326

class GetTranscriptRequest < Struct.new(
  :contact_id,
  :max_results,
  :next_token,
  :scan_direction,
  :sort_order,
  :start_position,
  :connection_token)
  SENSITIVE = []
  include Aws::Structure
end

#contact_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-connectparticipant/types.rb', line 326

class GetTranscriptRequest < Struct.new(
  :contact_id,
  :max_results,
  :next_token,
  :scan_direction,
  :sort_order,
  :start_position,
  :connection_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-connectparticipant/types.rb', line 326

class GetTranscriptRequest < Struct.new(
  :contact_id,
  :max_results,
  :next_token,
  :scan_direction,
  :sort_order,
  :start_position,
  :connection_token)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-connectparticipant/types.rb', line 326

class GetTranscriptRequest < Struct.new(
  :contact_id,
  :max_results,
  :next_token,
  :scan_direction,
  :sort_order,
  :start_position,
  :connection_token)
  SENSITIVE = []
  include Aws::Structure
end

#scan_direction ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-connectparticipant/types.rb', line 326

class GetTranscriptRequest < Struct.new(
  :contact_id,
  :max_results,
  :next_token,
  :scan_direction,
  :sort_order,
  :start_position,
  :connection_token)
  SENSITIVE = []
  include Aws::Structure
end

#sort_order ⇒ String

The sort order for the records. Default: DESCENDING.

Returns:

• (String)

# File 'lib/aws-sdk-connectparticipant/types.rb', line 326

class GetTranscriptRequest < Struct.new(
  :contact_id,
  :max_results,
  :next_token,
  :scan_direction,
  :sort_order,
  :start_position,
  :connection_token)
  SENSITIVE = []
  include Aws::Structure
end

#start_position ⇒ Types::StartPosition

A filtering option for where to start.

Returns:

• (Types::StartPosition)

# File 'lib/aws-sdk-connectparticipant/types.rb', line 326

class GetTranscriptRequest < Struct.new(
  :contact_id,
  :max_results,
  :next_token,
  :scan_direction,
  :sort_order,
  :start_position,
  :connection_token)
  SENSITIVE = []
  include Aws::Structure
end