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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_idString

The identifier for the Amazon Q Business application.

Returns:

  • (String)


5488
5489
5490
5491
5492
5493
5494
5495
5496
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5488

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

#conversation_idString

The identifier of the Amazon Q Business web experience conversation.

Returns:

  • (String)


5488
5489
5490
5491
5492
5493
5494
5495
5496
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5488

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

#max_resultsInteger

The maximum number of messages to return.

Returns:

  • (Integer)


5488
5489
5490
5491
5492
5493
5494
5495
5496
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5488

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

#next_tokenString

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

Returns:

  • (String)


5488
5489
5490
5491
5492
5493
5494
5495
5496
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5488

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

#user_idString

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

Returns:

  • (String)


5488
5489
5490
5491
5492
5493
5494
5495
5496
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5488

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