Class: Aws::QBusiness::Types::CreateRetrieverRequest

Inherits:

Struct

• Object
• Struct
• Aws::QBusiness::Types::CreateRetrieverRequest

Includes:

Structure

Defined in:

lib/aws-sdk-qbusiness/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #application_id ⇒ String

  The identifier of your Amazon Q Business application.

• #client_token ⇒ String

  A token that you provide to identify the request to create your Amazon Q Business application retriever.

• #configuration ⇒ Types::RetrieverConfiguration

  Provides information on how the retriever used for your Amazon Q Business application is configured.

• #display_name ⇒ String

  The name of your retriever.

• #role_arn ⇒ String

  The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.

• #tags ⇒ Array<Types::Tag>

  A list of key-value pairs that identify or categorize the retriever.

• #type ⇒ String

  The type of retriever you are using.

Instance Attribute Details

#application_id ⇒ String

The identifier of your Amazon Q Business application.

Returns:

• (String)

# File 'lib/aws-sdk-qbusiness/types.rb', line 2084

class CreateRetrieverRequest < Struct.new(
  :application_id,
  :type,
  :display_name,
  :configuration,
  :role_arn,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

A token that you provide to identify the request to create your Amazon Q Business application retriever.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

• (String)

# File 'lib/aws-sdk-qbusiness/types.rb', line 2084

class CreateRetrieverRequest < Struct.new(
  :application_id,
  :type,
  :display_name,
  :configuration,
  :role_arn,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#configuration ⇒ Types::RetrieverConfiguration

Provides information on how the retriever used for your Amazon Q Business application is configured.

Returns:

• (Types::RetrieverConfiguration)

# File 'lib/aws-sdk-qbusiness/types.rb', line 2084

class CreateRetrieverRequest < Struct.new(
  :application_id,
  :type,
  :display_name,
  :configuration,
  :role_arn,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#display_name ⇒ String

The name of your retriever.

Returns:

• (String)

# File 'lib/aws-sdk-qbusiness/types.rb', line 2084

class CreateRetrieverRequest < Struct.new(
  :application_id,
  :type,
  :display_name,
  :configuration,
  :role_arn,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.

Returns:

• (String)

# File 'lib/aws-sdk-qbusiness/types.rb', line 2084

class CreateRetrieverRequest < Struct.new(
  :application_id,
  :type,
  :display_name,
  :configuration,
  :role_arn,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-qbusiness/types.rb', line 2084

class CreateRetrieverRequest < Struct.new(
  :application_id,
  :type,
  :display_name,
  :configuration,
  :role_arn,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of retriever you are using.

Returns:

• (String)

# File 'lib/aws-sdk-qbusiness/types.rb', line 2084

class CreateRetrieverRequest < Struct.new(
  :application_id,
  :type,
  :display_name,
  :configuration,
  :role_arn,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end