Class: Aws::BedrockAgent::Types::FlowSummary

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgent::Types::FlowSummary

Includes:

Structure

Defined in:

lib/aws-sdk-bedrockagent/types.rb

Overview

Contains the definition of a flow.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the flow.

• #created_at ⇒ Time

  The time at which the flow was created.

• #description ⇒ String

  A description of the 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.

• #version ⇒ String

  The latest version of the flow.

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the flow.

Returns:

• (String)

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

class FlowSummary < Struct.new(
  :arn,
  :created_at,
  :description,
  :id,
  :name,
  :status,
  :updated_at,
  :version)
  SENSITIVE = []
  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 3318

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

#description ⇒ String

A description of the flow.

Returns:

• (String)

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

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

#id ⇒ String

The unique identifier of the flow.

Returns:

• (String)

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

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

#name ⇒ String

The name of the flow.

Returns:

• (String)

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

class FlowSummary < Struct.new(
  :arn,
  :created_at,
  :description,
  :id,
  :name,
  :status,
  :updated_at,
  :version)
  SENSITIVE = []
  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.

[1]: docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PrepareFlow.html [2]: docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlow.html

Returns:

• (String)

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

class FlowSummary < Struct.new(
  :arn,
  :created_at,
  :description,
  :id,
  :name,
  :status,
  :updated_at,
  :version)
  SENSITIVE = []
  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 3318

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

#version ⇒ String

The latest version of the flow.

Returns:

• (String)

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

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