Class: Aws::QBusiness::Types::ListMessagesRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_id ⇒ String

The identifier for the Amazon Q Business application.

Returns:

  • (String) 


4272
4273
4274
4275
4276
4277
4278
4279
4280
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4272

class ListMessagesRequest < Struct.new(
  :conversation_id,
  :application_id,
  :user_id,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#conversation_id ⇒ String

The identifier of the Amazon Q Business web experience conversation.

Returns:

  • (String) 


4272
4273
4274
4275
4276
4277
4278
4279
4280
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4272

class ListMessagesRequest < Struct.new(
  :conversation_id,
  :application_id,
  :user_id,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of messages to return.

Returns:

  • (Integer) 


4272
4273
4274
4275
4276
4277
4278
4279
4280
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4272

class ListMessagesRequest < Struct.new(
  :conversation_id,
  :application_id,
  :user_id,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

If the number of retrievers returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of messages.

Returns:

  • (String) 


4272
4273
4274
4275
4276
4277
4278
4279
4280
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4272

class ListMessagesRequest < Struct.new(
  :conversation_id,
  :application_id,
  :user_id,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#user_id ⇒ String

The identifier of the user involved in the Amazon Q Business web experience conversation.

Returns:

  • (String) 


4272
4273
4274
4275
4276
4277
4278
4279
4280
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4272

class ListMessagesRequest < Struct.new(
  :conversation_id,
  :application_id,
  :user_id,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end