Class: Aws::QConnect::Types::GetRecommendationsRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#assistant_id ⇒ String

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

  • (String) 


1754
1755
1756
1757
1758
1759
1760
1761
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 1754

class GetRecommendationsRequest < Struct.new(
  :assistant_id,
  :max_results,
  :session_id,
  :wait_time_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to return per page.

Returns:

  • (Integer) 


1754
1755
1756
1757
1758
1759
1760
1761
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 1754

class GetRecommendationsRequest < Struct.new(
  :assistant_id,
  :max_results,
  :session_id,
  :wait_time_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#session_id ⇒ String

The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

  • (String) 


1754
1755
1756
1757
1758
1759
1760
1761
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 1754

class GetRecommendationsRequest < Struct.new(
  :assistant_id,
  :max_results,
  :session_id,
  :wait_time_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#wait_time_seconds ⇒ Integer

The duration (in seconds) for which the call waits for a recommendation to be made available before returning. If a recommendation is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list.

Returns:

  • (Integer) 


1754
1755
1756
1757
1758
1759
1760
1761
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 1754

class GetRecommendationsRequest < Struct.new(
  :assistant_id,
  :max_results,
  :session_id,
  :wait_time_seconds)
  SENSITIVE = []
  include Aws::Structure
end