Class: Aws::BedrockAgent::Types::CreatePromptRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:variants]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

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

Returns:

  • (String) 


2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 2645

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

#customer_encryption_key_arn ⇒ String

The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.

Returns:

  • (String) 


2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 2645

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

#default_variant ⇒ String

The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.

Returns:

  • (String) 


2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 2645

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

#description ⇒ String

A description for the prompt.

Returns:

  • (String) 


2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 2645

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

#name ⇒ String

A name for the prompt.

Returns:

  • (String) 


2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 2645

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

#tags ⇒ Hash<String,String>

Any tags that you want to attach to the prompt. For more information, see Tagging resources in Amazon Bedrock.

Returns:

  • (Hash<String,String>) 


2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 2645

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

#variants ⇒ Array<Types::PromptVariant>

A list of objects, each containing details about a variant of the prompt.

Returns:



2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 2645

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