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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#connection_token ⇒ String

The authentication token associated with the participant's connection.

Returns:

  • (String) 


454
455
456
457
458
459
460
461
462
463
464
 
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/types.rb', line 454

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) 


454
455
456
457
458
459
460
461
462
463
464
 
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/types.rb', line 454

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) 


454
455
456
457
458
459
460
461
462
463
464
 
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/types.rb', line 454

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) 


454
455
456
457
458
459
460
461
462
463
464
 
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/types.rb', line 454

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) 


454
455
456
457
458
459
460
461
462
463
464
 
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/types.rb', line 454

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) 


454
455
456
457
458
459
460
461
462
463
464
 
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/types.rb', line 454

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:



454
455
456
457
458
459
460
461
462
463
464
 
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/types.rb', line 454

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