Class: Aws::BedrockAgent::Types::CreateRetrievalInstructionRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:name, :instruction, :description]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

A caller-supplied token that makes a retried create return the existing resource rather than a second one. The window is 8 hours.

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

Returns:

  • (String) 


2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 2903

class CreateRetrievalInstructionRequest < Struct.new(
  :client_token,
  :name,
  :instruction,
  :description,
  :customer_encryption_key_arn,
  :tags)
  SENSITIVE = [:name, :instruction, :description]
  include Aws::Structure
end

#customer_encryption_key_arn ⇒ String

The Amazon Resource Name (ARN) of a customer managed AWS Key Management Service (AWS KMS) key used to encrypt the instruction content at rest. If you omit it, the service uses an AWS owned key. You fix the key at create and cannot change it later.

Returns:

  • (String) 


2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 2903

class CreateRetrievalInstructionRequest < Struct.new(
  :client_token,
  :name,
  :instruction,
  :description,
  :customer_encryption_key_arn,
  :tags)
  SENSITIVE = [:name, :instruction, :description]
  include Aws::Structure
end

#description ⇒ String

Specifies a description of the retrieval instruction.

Returns:

  • (String) 


2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 2903

class CreateRetrievalInstructionRequest < Struct.new(
  :client_token,
  :name,
  :instruction,
  :description,
  :customer_encryption_key_arn,
  :tags)
  SENSITIVE = [:name, :instruction, :description]
  include Aws::Structure
end

#instruction ⇒ Types::RetrievalInstructionContent

The instruction content, as a set of named fields. Get does not return this field until the create review passes.

Returns:



2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 2903

class CreateRetrievalInstructionRequest < Struct.new(
  :client_token,
  :name,
  :instruction,
  :description,
  :customer_encryption_key_arn,
  :tags)
  SENSITIVE = [:name, :instruction, :description]
  include Aws::Structure
end

#name ⇒ String

Specifies the name of the retrieval instruction.

Returns:

  • (String) 


2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 2903

class CreateRetrievalInstructionRequest < Struct.new(
  :client_token,
  :name,
  :instruction,
  :description,
  :customer_encryption_key_arn,
  :tags)
  SENSITIVE = [:name, :instruction, :description]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Tags for the retrieval instruction.

Returns:

  • (Hash<String,String>) 


2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 2903

class CreateRetrievalInstructionRequest < Struct.new(
  :client_token,
  :name,
  :instruction,
  :description,
  :customer_encryption_key_arn,
  :tags)
  SENSITIVE = [:name, :instruction, :description]
  include Aws::Structure
end