Class: Aws::BedrockAgent::Types::CreateFlowRequest

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgent::Types::CreateFlowRequest

Includes:

Structure

Defined in:

lib/aws-sdk-bedrockagent/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

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 flow.

• #definition ⇒ Types::FlowDefinition

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

• #description ⇒ String

  A description for the flow.

• #execution_role_arn ⇒ String

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

• #name ⇒ String

  A name for the flow.

• #tags ⇒ Hash<String,String>

  Any tags that you want to attach to the flow.

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 1719

class CreateFlowRequest < Struct.new(
  :client_token,
  :customer_encryption_key_arn,
  :definition,
  :description,
  :execution_role_arn,
  :name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#customer_encryption_key_arn ⇒ String

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

Returns:

• (String)

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

class CreateFlowRequest < Struct.new(
  :client_token,
  :customer_encryption_key_arn,
  :definition,
  :description,
  :execution_role_arn,
  :name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#definition ⇒ Types::FlowDefinition

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

Returns:

• (Types::FlowDefinition)

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

class CreateFlowRequest < Struct.new(
  :client_token,
  :customer_encryption_key_arn,
  :definition,
  :description,
  :execution_role_arn,
  :name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description for the flow.

Returns:

• (String)

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

class CreateFlowRequest < Struct.new(
  :client_token,
  :customer_encryption_key_arn,
  :definition,
  :description,
  :execution_role_arn,
  :name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#execution_role_arn ⇒ String

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

[1]: docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html

Returns:

• (String)

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

class CreateFlowRequest < Struct.new(
  :client_token,
  :customer_encryption_key_arn,
  :definition,
  :description,
  :execution_role_arn,
  :name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

A name for the flow.

Returns:

• (String)

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

class CreateFlowRequest < Struct.new(
  :client_token,
  :customer_encryption_key_arn,
  :definition,
  :description,
  :execution_role_arn,
  :name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Any tags that you want to attach to the flow. 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 1719

class CreateFlowRequest < Struct.new(
  :client_token,
  :customer_encryption_key_arn,
  :definition,
  :description,
  :execution_role_arn,
  :name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end