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

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgent::Types::CreatePromptRequest

Includes:

Structure

Defined in:

lib/aws-sdk-bedrockagent/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:variants]

Instance Attribute Summary

• #client_token ⇒ String

  A unique, case-sensitive identifier to ensure that the API request completes no more than one time.

• #customer_encryption_key_arn ⇒ String

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

• #default_variant ⇒ String

  The name of the default variant for the prompt.

• #description ⇒ String

  A description for the prompt.

• #name ⇒ String

  A name for the prompt.

• #tags ⇒ Hash<String,String>

  Any tags that you want to attach to the prompt.

• #variants ⇒ Array<Types::PromptVariant>

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

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.

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

Returns:

• (String)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 2019

class CreatePromptRequest < Struct.new(
  :client_token,
  :customer_encryption_key_arn,
  :default_variant,
  :description,
  :name,
  :tags,
  :variants)
  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)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 2019

class CreatePromptRequest < Struct.new(
  :client_token,
  :customer_encryption_key_arn,
  :default_variant,
  :description,
  :name,
  :tags,
  :variants)
  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.

[1]: docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html

Returns:

• (String)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 2019

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

#description ⇒ String

A description for the prompt.

Returns:

• (String)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 2019

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

#name ⇒ String

A name for the prompt.

Returns:

• (String)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 2019

class CreatePromptRequest < Struct.new(
  :client_token,
  :customer_encryption_key_arn,
  :default_variant,
  :description,
  :name,
  :tags,
  :variants)
  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].

[1]: docs.aws.amazon.com/bedrock/latest/userguide/tagging.html

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 2019

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

#variants ⇒ Array<Types::PromptVariant>

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

Returns:

• (Array<Types::PromptVariant>)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 2019

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