Class: Aws::BedrockAgent::Types::GetPromptResponse

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgent::Types::GetPromptResponse

Includes:

Structure

Defined in:

lib/aws-sdk-bedrockagent/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:variants]

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).

• #created_at ⇒ Time

  The time at which the prompt was created.

• #customer_encryption_key_arn ⇒ String

  The Amazon Resource Name (ARN) of the KMS key that the prompt is encrypted with.

• #default_variant ⇒ String

  The name of the default variant for the prompt.

• #description ⇒ String

  The descriptino of the prompt.

• #id ⇒ String

  The unique identifier of the prompt.

• #name ⇒ String

  The name of the prompt.

• #updated_at ⇒ Time

  The time at which the prompt was last updated.

• #variants ⇒ Array<Types::PromptVariant>

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

• #version ⇒ String

  The version of the prompt.

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).

Returns:

• (String)

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

class GetPromptResponse < Struct.new(
  :arn,
  :created_at,
  :customer_encryption_key_arn,
  :default_variant,
  :description,
  :id,
  :name,
  :updated_at,
  :variants,
  :version)
  SENSITIVE = [:variants]
  include Aws::Structure
end

#created_at ⇒ Time

The time at which the prompt was created.

Returns:

• (Time)

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

class GetPromptResponse < Struct.new(
  :arn,
  :created_at,
  :customer_encryption_key_arn,
  :default_variant,
  :description,
  :id,
  :name,
  :updated_at,
  :variants,
  :version)
  SENSITIVE = [:variants]
  include Aws::Structure
end

#customer_encryption_key_arn ⇒ String

The Amazon Resource Name (ARN) of the KMS key that the prompt is encrypted with.

Returns:

• (String)

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

class GetPromptResponse < Struct.new(
  :arn,
  :created_at,
  :customer_encryption_key_arn,
  :default_variant,
  :description,
  :id,
  :name,
  :updated_at,
  :variants,
  :version)
  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 4085

class GetPromptResponse < Struct.new(
  :arn,
  :created_at,
  :customer_encryption_key_arn,
  :default_variant,
  :description,
  :id,
  :name,
  :updated_at,
  :variants,
  :version)
  SENSITIVE = [:variants]
  include Aws::Structure
end

#description ⇒ String

The descriptino of the prompt.

Returns:

• (String)

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

class GetPromptResponse < Struct.new(
  :arn,
  :created_at,
  :customer_encryption_key_arn,
  :default_variant,
  :description,
  :id,
  :name,
  :updated_at,
  :variants,
  :version)
  SENSITIVE = [:variants]
  include Aws::Structure
end

#id ⇒ String

The unique identifier of the prompt.

Returns:

• (String)

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

class GetPromptResponse < Struct.new(
  :arn,
  :created_at,
  :customer_encryption_key_arn,
  :default_variant,
  :description,
  :id,
  :name,
  :updated_at,
  :variants,
  :version)
  SENSITIVE = [:variants]
  include Aws::Structure
end

#name ⇒ String

The name of the prompt.

Returns:

• (String)

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

class GetPromptResponse < Struct.new(
  :arn,
  :created_at,
  :customer_encryption_key_arn,
  :default_variant,
  :description,
  :id,
  :name,
  :updated_at,
  :variants,
  :version)
  SENSITIVE = [:variants]
  include Aws::Structure
end

#updated_at ⇒ Time

The time at which the prompt was last updated.

Returns:

• (Time)

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

class GetPromptResponse < Struct.new(
  :arn,
  :created_at,
  :customer_encryption_key_arn,
  :default_variant,
  :description,
  :id,
  :name,
  :updated_at,
  :variants,
  :version)
  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 4085

class GetPromptResponse < Struct.new(
  :arn,
  :created_at,
  :customer_encryption_key_arn,
  :default_variant,
  :description,
  :id,
  :name,
  :updated_at,
  :variants,
  :version)
  SENSITIVE = [:variants]
  include Aws::Structure
end

#version ⇒ String

The version of the prompt.

Returns:

• (String)

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

class GetPromptResponse < Struct.new(
  :arn,
  :created_at,
  :customer_encryption_key_arn,
  :default_variant,
  :description,
  :id,
  :name,
  :updated_at,
  :variants,
  :version)
  SENSITIVE = [:variants]
  include Aws::Structure
end