Class: Aws::BedrockAgent::Types::GetRetrievalInstructionResponse

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgent::Types::GetRetrievalInstructionResponse

Defined in:

gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:name, :instruction, :description]

Instance Attribute Summary

• #created_at ⇒ Time

  When the retrieval instruction was created.

• #customer_encryption_key_arn ⇒ String

  The ARN of the customer managed KMS key protecting this content, when one was supplied at create.

• #description ⇒ String

  A description of the retrieval instruction.

• #instruction ⇒ Types::RetrievalInstructionContent

  The reviewed content this instruction serves — what AgenticRetrieveStream resolves while status is ACTIVE.

• #last_transition_status ⇒ String

  The outcome or in-progress state of the most recent create or update.

• #last_transition_status_reasons ⇒ Array<Types::RetrievalInstructionFailureReason>

  Why the most recent create or update was rejected.

• #latest_version ⇒ String

  The largest version number that currently exists for this retrieval instruction, that is, the newest version you can retrieve.

• #name ⇒ String

  The name of the retrieval instruction.

• #retrieval_instruction_arn ⇒ String

  The ARN of the retrieval instruction.

• #retrieval_instruction_id ⇒ String

  The identifier of the retrieval instruction.

• #status ⇒ String

  Specifies whether you can use the instruction.

• #updated_at ⇒ Time

  When the retrieval instruction was last updated.

• #version ⇒ String

  The version this response describes: a version number, or DRAFT.

Instance Attribute Details

#created_at ⇒ Time

When the retrieval instruction was created. On a numbered version, when that version was created.

Returns:

• (Time)

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

class GetRetrievalInstructionResponse < Struct.new(
  :retrieval_instruction_id,
  :retrieval_instruction_arn,
  :name,
  :status,
  :last_transition_status,
  :instruction,
  :created_at,
  :updated_at,
  :description,
  :customer_encryption_key_arn,
  :last_transition_status_reasons,
  :version,
  :latest_version)
  SENSITIVE = [:name, :instruction, :description]
  include Aws::Structure
end

#customer_encryption_key_arn ⇒ String

The ARN of the customer managed KMS key protecting this content, when one was supplied at create.

Returns:

• (String)

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

class GetRetrievalInstructionResponse < Struct.new(
  :retrieval_instruction_id,
  :retrieval_instruction_arn,
  :name,
  :status,
  :last_transition_status,
  :instruction,
  :created_at,
  :updated_at,
  :description,
  :customer_encryption_key_arn,
  :last_transition_status_reasons,
  :version,
  :latest_version)
  SENSITIVE = [:name, :instruction, :description]
  include Aws::Structure
end

#description ⇒ String

A description of the retrieval instruction. On a numbered version, the description of that version.

Returns:

• (String)

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

class GetRetrievalInstructionResponse < Struct.new(
  :retrieval_instruction_id,
  :retrieval_instruction_arn,
  :name,
  :status,
  :last_transition_status,
  :instruction,
  :created_at,
  :updated_at,
  :description,
  :customer_encryption_key_arn,
  :last_transition_status_reasons,
  :version,
  :latest_version)
  SENSITIVE = [:name, :instruction, :description]
  include Aws::Structure
end

#instruction ⇒ Types::RetrievalInstructionContent

The reviewed content this instruction serves — what AgenticRetrieveStream resolves while status is ACTIVE. Absent until the first create review passes. Always present on a numbered version.

Returns:

• (Types::RetrievalInstructionContent)

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

class GetRetrievalInstructionResponse < Struct.new(
  :retrieval_instruction_id,
  :retrieval_instruction_arn,
  :name,
  :status,
  :last_transition_status,
  :instruction,
  :created_at,
  :updated_at,
  :description,
  :customer_encryption_key_arn,
  :last_transition_status_reasons,
  :version,
  :latest_version)
  SENSITIVE = [:name, :instruction, :description]
  include Aws::Structure
end

#last_transition_status ⇒ String

The outcome or in-progress state of the most recent create or update. CREATING or UPDATING means the operation is still running. Independent of status. Always has a value from the create 202 onward. On a numbered version this is always CREATE_SUCCESSFUL: a version is created once, from reviewed content, and is immutable.

Returns:

• (String)

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

class GetRetrievalInstructionResponse < Struct.new(
  :retrieval_instruction_id,
  :retrieval_instruction_arn,
  :name,
  :status,
  :last_transition_status,
  :instruction,
  :created_at,
  :updated_at,
  :description,
  :customer_encryption_key_arn,
  :last_transition_status_reasons,
  :version,
  :latest_version)
  SENSITIVE = [:name, :instruction, :description]
  include Aws::Structure
end

#last_transition_status_reasons ⇒ Array<Types::RetrievalInstructionFailureReason>

Why the most recent create or update was rejected. One entry for each rejected field, or a single entry when the review itself failed. Each entry has a machine-readable code and a message, and names the field when it applies to one. The service includes this field only when lastTransitionStatus is CREATE_FAILED or UPDATE_FAILED. Never present on a numbered version.

Returns:

• (Array<Types::RetrievalInstructionFailureReason>)

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

class GetRetrievalInstructionResponse < Struct.new(
  :retrieval_instruction_id,
  :retrieval_instruction_arn,
  :name,
  :status,
  :last_transition_status,
  :instruction,
  :created_at,
  :updated_at,
  :description,
  :customer_encryption_key_arn,
  :last_transition_status_reasons,
  :version,
  :latest_version)
  SENSITIVE = [:name, :instruction, :description]
  include Aws::Structure
end

#latest_version ⇒ String

The largest version number that currently exists for this retrieval instruction, that is, the newest version you can retrieve. Present only on a DRAFT read, and only when at least one version exists. Because version numbers are never reused, deleting versions can leave gaps: this is the newest existing version, not a count and not the highest number ever created.

Returns:

• (String)

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

class GetRetrievalInstructionResponse < Struct.new(
  :retrieval_instruction_id,
  :retrieval_instruction_arn,
  :name,
  :status,
  :last_transition_status,
  :instruction,
  :created_at,
  :updated_at,
  :description,
  :customer_encryption_key_arn,
  :last_transition_status_reasons,
  :version,
  :latest_version)
  SENSITIVE = [:name, :instruction, :description]
  include Aws::Structure
end

#name ⇒ String

The name of the retrieval instruction.

Returns:

• (String)

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

class GetRetrievalInstructionResponse < Struct.new(
  :retrieval_instruction_id,
  :retrieval_instruction_arn,
  :name,
  :status,
  :last_transition_status,
  :instruction,
  :created_at,
  :updated_at,
  :description,
  :customer_encryption_key_arn,
  :last_transition_status_reasons,
  :version,
  :latest_version)
  SENSITIVE = [:name, :instruction, :description]
  include Aws::Structure
end

#retrieval_instruction_arn ⇒ String

The ARN of the retrieval instruction.

Returns:

• (String)

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

class GetRetrievalInstructionResponse < Struct.new(
  :retrieval_instruction_id,
  :retrieval_instruction_arn,
  :name,
  :status,
  :last_transition_status,
  :instruction,
  :created_at,
  :updated_at,
  :description,
  :customer_encryption_key_arn,
  :last_transition_status_reasons,
  :version,
  :latest_version)
  SENSITIVE = [:name, :instruction, :description]
  include Aws::Structure
end

#retrieval_instruction_id ⇒ String

The identifier of the retrieval instruction.

Returns:

• (String)

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

class GetRetrievalInstructionResponse < Struct.new(
  :retrieval_instruction_id,
  :retrieval_instruction_arn,
  :name,
  :status,
  :last_transition_status,
  :instruction,
  :created_at,
  :updated_at,
  :description,
  :customer_encryption_key_arn,
  :last_transition_status_reasons,
  :version,
  :latest_version)
  SENSITIVE = [:name, :instruction, :description]
  include Aws::Structure
end

#status ⇒ String

Specifies whether you can use the instruction. You can resolve only an ACTIVE instruction at retrieval time. Monotone: INACTIVE to ACTIVE once, never back. Numbered versions are always ACTIVE.

Returns:

• (String)

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

class GetRetrievalInstructionResponse < Struct.new(
  :retrieval_instruction_id,
  :retrieval_instruction_arn,
  :name,
  :status,
  :last_transition_status,
  :instruction,
  :created_at,
  :updated_at,
  :description,
  :customer_encryption_key_arn,
  :last_transition_status_reasons,
  :version,
  :latest_version)
  SENSITIVE = [:name, :instruction, :description]
  include Aws::Structure
end

#updated_at ⇒ Time

When the retrieval instruction was last updated. Equal to createdAt on a numbered version, which is immutable.

Returns:

• (Time)

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

class GetRetrievalInstructionResponse < Struct.new(
  :retrieval_instruction_id,
  :retrieval_instruction_arn,
  :name,
  :status,
  :last_transition_status,
  :instruction,
  :created_at,
  :updated_at,
  :description,
  :customer_encryption_key_arn,
  :last_transition_status_reasons,
  :version,
  :latest_version)
  SENSITIVE = [:name, :instruction, :description]
  include Aws::Structure
end

#version ⇒ String

The version this response describes: a version number, or DRAFT.

Returns:

• (String)

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

class GetRetrievalInstructionResponse < Struct.new(
  :retrieval_instruction_id,
  :retrieval_instruction_arn,
  :name,
  :status,
  :last_transition_status,
  :instruction,
  :created_at,
  :updated_at,
  :description,
  :customer_encryption_key_arn,
  :last_transition_status_reasons,
  :version,
  :latest_version)
  SENSITIVE = [:name, :instruction, :description]
  include Aws::Structure
end