Class: Aws::BedrockAgent::Types::GetFlowResponse

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgent::Types::GetFlowResponse

Includes:

Structure

Defined in:

lib/aws-sdk-bedrockagent/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:definition]

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the flow.

• #created_at ⇒ Time

  The time at which the flow was created.

• #customer_encryption_key_arn ⇒ String

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

• #definition ⇒ Types::FlowDefinition

  The definition of the nodes and connections between the nodes in the flow.

• #description ⇒ String

  The description of the flow.

• #execution_role_arn ⇒ String

  The Amazon Resource Name (ARN) of the service role with permissions to create a flow.

• #id ⇒ String

  The unique identifier of the flow.

• #name ⇒ String

  The name of the flow.

• #status ⇒ String

  The status of the flow.

• #updated_at ⇒ Time

  The time at which the flow was last updated.

• #validations ⇒ Array<Types::FlowValidation>

  A list of validation error messages related to the last failed operation on the flow.

• #version ⇒ String

  The version of the flow for which information was retrieved.

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the flow.

Returns:

• (String)

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

class GetFlowResponse < Struct.new(
  :name,
  :description,
  :execution_role_arn,
  :customer_encryption_key_arn,
  :id,
  :arn,
  :status,
  :created_at,
  :updated_at,
  :version,
  :definition,
  :validations)
  SENSITIVE = [:definition]
  include Aws::Structure
end

#created_at ⇒ Time

The time at which the flow was created.

Returns:

• (Time)

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

class GetFlowResponse < Struct.new(
  :name,
  :description,
  :execution_role_arn,
  :customer_encryption_key_arn,
  :id,
  :arn,
  :status,
  :created_at,
  :updated_at,
  :version,
  :definition,
  :validations)
  SENSITIVE = [:definition]
  include Aws::Structure
end

#customer_encryption_key_arn ⇒ String

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

Returns:

• (String)

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

class GetFlowResponse < Struct.new(
  :name,
  :description,
  :execution_role_arn,
  :customer_encryption_key_arn,
  :id,
  :arn,
  :status,
  :created_at,
  :updated_at,
  :version,
  :definition,
  :validations)
  SENSITIVE = [:definition]
  include Aws::Structure
end

#definition ⇒ Types::FlowDefinition

The definition of the nodes and connections between the nodes in the flow.

Returns:

• (Types::FlowDefinition)

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

class GetFlowResponse < Struct.new(
  :name,
  :description,
  :execution_role_arn,
  :customer_encryption_key_arn,
  :id,
  :arn,
  :status,
  :created_at,
  :updated_at,
  :version,
  :definition,
  :validations)
  SENSITIVE = [:definition]
  include Aws::Structure
end

#description ⇒ String

The description of the flow.

Returns:

• (String)

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

class GetFlowResponse < Struct.new(
  :name,
  :description,
  :execution_role_arn,
  :customer_encryption_key_arn,
  :id,
  :arn,
  :status,
  :created_at,
  :updated_at,
  :version,
  :definition,
  :validations)
  SENSITIVE = [:definition]
  include Aws::Structure
end

#execution_role_arn ⇒ String

The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service row for flows in the Amazon Bedrock User Guide.

Returns:

• (String)

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

class GetFlowResponse < Struct.new(
  :name,
  :description,
  :execution_role_arn,
  :customer_encryption_key_arn,
  :id,
  :arn,
  :status,
  :created_at,
  :updated_at,
  :version,
  :definition,
  :validations)
  SENSITIVE = [:definition]
  include Aws::Structure
end

#id ⇒ String

The unique identifier of the flow.

Returns:

• (String)

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

class GetFlowResponse < Struct.new(
  :name,
  :description,
  :execution_role_arn,
  :customer_encryption_key_arn,
  :id,
  :arn,
  :status,
  :created_at,
  :updated_at,
  :version,
  :definition,
  :validations)
  SENSITIVE = [:definition]
  include Aws::Structure
end

#name ⇒ String

The name of the flow.

Returns:

• (String)

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

class GetFlowResponse < Struct.new(
  :name,
  :description,
  :execution_role_arn,
  :customer_encryption_key_arn,
  :id,
  :arn,
  :status,
  :created_at,
  :updated_at,
  :version,
  :definition,
  :validations)
  SENSITIVE = [:definition]
  include Aws::Structure
end

#status ⇒ String

The status of the flow. The following statuses are possible:

• NotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the DRAFT version won't contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT version.

• Preparing – The flow is being prepared so that the DRAFT version contains the latest changes for testing.

• Prepared – The flow is prepared and the DRAFT version contains the latest changes for testing.

• Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations field.

Returns:

• (String)

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

class GetFlowResponse < Struct.new(
  :name,
  :description,
  :execution_role_arn,
  :customer_encryption_key_arn,
  :id,
  :arn,
  :status,
  :created_at,
  :updated_at,
  :version,
  :definition,
  :validations)
  SENSITIVE = [:definition]
  include Aws::Structure
end

#updated_at ⇒ Time

The time at which the flow was last updated.

Returns:

• (Time)

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

class GetFlowResponse < Struct.new(
  :name,
  :description,
  :execution_role_arn,
  :customer_encryption_key_arn,
  :id,
  :arn,
  :status,
  :created_at,
  :updated_at,
  :version,
  :definition,
  :validations)
  SENSITIVE = [:definition]
  include Aws::Structure
end

#validations ⇒ Array<Types::FlowValidation>

A list of validation error messages related to the last failed operation on the flow.

Returns:

• (Array<Types::FlowValidation>)

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

class GetFlowResponse < Struct.new(
  :name,
  :description,
  :execution_role_arn,
  :customer_encryption_key_arn,
  :id,
  :arn,
  :status,
  :created_at,
  :updated_at,
  :version,
  :definition,
  :validations)
  SENSITIVE = [:definition]
  include Aws::Structure
end

#version ⇒ String

The version of the flow for which information was retrieved.

Returns:

• (String)

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

class GetFlowResponse < Struct.new(
  :name,
  :description,
  :execution_role_arn,
  :customer_encryption_key_arn,
  :id,
  :arn,
  :status,
  :created_at,
  :updated_at,
  :version,
  :definition,
  :validations)
  SENSITIVE = [:definition]
  include Aws::Structure
end