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

Inherits:

Struct

• Object
• Struct
• Aws::QConnect::Types::GetRecommendationsRequest

Defined in:

gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #assistant_id ⇒ String

  The identifier of the Amazon Q in Connect assistant.

• #max_results ⇒ Integer

  The maximum number of results to return per page.

• #next_chunk_token ⇒ String

  The token for the next set of chunks.

• #recommendation_type ⇒ String

  The type of recommendation being requested.

• #session_id ⇒ String

  The identifier of the session.

• #wait_time_seconds ⇒ Integer

  The duration (in seconds) for which the call waits for a recommendation to be made available before returning.

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)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 5308

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

#max_results ⇒ Integer

The maximum number of results to return per page.

Returns:

• (Integer)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 5308

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

#next_chunk_token ⇒ String

The token for the next set of chunks. Use the value returned in the previous response in the next request to retrieve the next set of chunks.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 5308

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

#recommendation_type ⇒ String

The type of recommendation being requested.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 5308

class GetRecommendationsRequest < Struct.new(
  :assistant_id,
  :session_id,
  :max_results,
  :wait_time_seconds,
  :next_chunk_token,
  :recommendation_type)
  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)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 5308

class GetRecommendationsRequest < Struct.new(
  :assistant_id,
  :session_id,
  :max_results,
  :wait_time_seconds,
  :next_chunk_token,
  :recommendation_type)
  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)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 5308

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