AWS CLI Command Reference

[ aws . bedrock-agent ]

get-flow

Description

Retrieves information about a flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

See also: AWS API Documentation

get-flow uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type document must be provided as JSON. Shorthand syntax does not support document types.

Synopsis

  get-flow
--flow-identifier <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--flow-identifier (string)

The unique identifier of the flow.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

arn -> (string)

The Amazon Resource Name (ARN) of the flow.

createdAt -> (timestamp)

The time at which the flow was created.

customerEncryptionKeyArn -> (string)

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

definition -> (structure)

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

connections -> (list)

An array of connection definitions in the flow.

(structure)

Contains information about a connection between two nodes in the flow.

configuration -> (tagged union structure)

The configuration of the connection.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: conditional, data.

conditional -> (structure)

The configuration of a connection originating from a Condition node.

condition -> (string)

The condition that triggers this connection. For more information about how to write conditions, see the Condition node type in the Node types topic in the Amazon Bedrock User Guide.

data -> (structure)

The configuration of a connection originating from a node that isn’t a Condition node.

sourceOutput -> (string)

The name of the output in the source node that the connection begins from.

targetInput -> (string)

The name of the input in the target node that the connection ends at.

name -> (string)

A name for the connection that you can reference.

source -> (string)

The node that the connection starts at.

target -> (string)

The node that the connection ends at.

type -> (string)

Whether the source node that the connection begins from is a condition node (Conditional ) or not (Data ).

nodes -> (list)

An array of node definitions in the flow.

(structure)

Contains configurations about a node in the flow.

configuration -> (tagged union structure)

Contains configurations for the node.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: agent, collector, condition, input, iterator, knowledgeBase, lambdaFunction, lex, output, prompt, retrieval, storage.

agent -> (structure)

Contains configurations for an agent node in your flow. Invokes an alias of an agent and returns the response.

agentAliasArn -> (string)

The Amazon Resource Name (ARN) of the alias of the agent to invoke.

collector -> (structure)

Contains configurations for a collector node in your flow. Collects an iteration of inputs and consolidates them into an array of outputs.

condition -> (structure)

Contains configurations for a Condition node in your flow. Defines conditions that lead to different branches of the flow.

conditions -> (list)

An array of conditions. Each member contains the name of a condition and an expression that defines the condition.

(structure)

Defines a condition in the condition node.

expression -> (string)

Defines the condition. You must refer to at least one of the inputs in the condition. For more information, expand the Condition node section in Node types in prompt flows .

name -> (string)

A name for the condition that you can reference.

input -> (structure)

Contains configurations for an input flow node in your flow. The first node in the flow. inputs can’t be specified for this node.

iterator -> (structure)

Contains configurations for an iterator node in your flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output.

The output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node.

knowledgeBase -> (structure)

Contains configurations for a knowledge base node in your flow. Queries a knowledge base and returns the retrieved results or generated response.

guardrailConfiguration -> (structure)

Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.

guardrailIdentifier -> (string)

The unique identifier of the guardrail.

guardrailVersion -> (string)

The version of the guardrail.

knowledgeBaseId -> (string)

The unique identifier of the knowledge base to query.

modelId -> (string)

The unique identifier of the model or inference profile to use to generate a response from the query results. Omit this field if you want to return the retrieved results as an array.

lambdaFunction -> (structure)

Contains configurations for a Lambda function node in your flow. Invokes an Lambda function.

lambdaArn -> (string)

The Amazon Resource Name (ARN) of the Lambda function to invoke.

lex -> (structure)

Contains configurations for a Lex node in your flow. Invokes an Amazon Lex bot to identify the intent of the input and return the intent as the output.

botAliasArn -> (string)

The Amazon Resource Name (ARN) of the Amazon Lex bot alias to invoke.

localeId -> (string)

The Region to invoke the Amazon Lex bot in.

output -> (structure)

Contains configurations for an output flow node in your flow. The last node in the flow. outputs can’t be specified for this node.

prompt -> (structure)

Contains configurations for a prompt node in your flow. Runs a prompt and generates the model response as the output. You can use a prompt from Prompt management or you can configure one in this node.

guardrailConfiguration -> (structure)

Contains configurations for a guardrail to apply to the prompt in this node and the response generated from it.

guardrailIdentifier -> (string)

The unique identifier of the guardrail.

guardrailVersion -> (string)

The version of the guardrail.

sourceConfiguration -> (tagged union structure)

Specifies whether the prompt is from Prompt management or defined inline.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: inline, resource.

inline -> (structure)

Contains configurations for a prompt that is defined inline

additionalModelRequestFields -> (document)

Additional fields to be included in the model request for the Prompt node.

inferenceConfiguration -> (tagged union structure)

Contains inference configurations for the prompt.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: text.

text -> (structure)

Contains inference configurations for a text prompt.

maxTokens -> (integer)

The maximum number of tokens to return in the response.

stopSequences -> (list)

A list of strings that define sequences after which the model will stop generating.

(string)

temperature -> (float)

Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.

topP -> (float)

The percentage of most-likely candidates that the model considers for the next token.

modelId -> (string)

The unique identifier of the model or inference profile to run inference with.

templateConfiguration -> (tagged union structure)

Contains a prompt and variables in the prompt that can be replaced with values at runtime.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: chat, text.

chat -> (structure)

Contains configurations to use the prompt in a conversational format.

inputVariables -> (list)

An array of the variables in the prompt template.

(structure)

Contains information about a variable in the prompt.

name -> (string)

The name of the variable.

messages -> (list)

Contains messages in the chat for the prompt.

(structure)

A message input or response from a model. For more information, see Create a prompt using Prompt management .

content -> (list)

The content in the message.

(tagged union structure)

Contains the content for the message you pass to, or receive from a model. For more information, see Create a prompt using Prompt management .

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: text.

text -> (string)

The text in the message.

role -> (string)

The role that the message belongs to.

system -> (list)

Contains system prompts to provide context to the model or to describe how it should behave.

(tagged union structure)

Contains a system prompt to provide context to the model or to describe how it should behave. For more information, see Create a prompt using Prompt management .

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: text.

text -> (string)

The text in the system prompt.

toolConfiguration -> (structure)

Configuration information for the tools that the model can use when generating a response.

toolChoice -> (tagged union structure)

Defines which tools the model should request when invoked.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: any, auto, tool.

any -> (structure)

Defines tools, at least one of which must be requested by the model. No text is generated but the results of tool use are sent back to the model to help generate a response.

auto -> (structure)

Defines tools. The model automatically decides whether to call a tool or to generate text instead.

tool -> (structure)

Defines a specific tool that the model must request. No text is generated but the results of tool use are sent back to the model to help generate a response.

name -> (string)

The name of the tool.

tools -> (list)

An array of tools to pass to a model.

(tagged union structure)

Contains configurations for a tool that a model can use when generating a response. For more information, see Use a tool to complete an Amazon Bedrock model response .

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: toolSpec.

toolSpec -> (structure)

The specification for the tool.

description -> (string)

The description of the tool.

inputSchema -> (tagged union structure)

The input schema for the tool.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: json.

json -> (document)

A JSON object defining the input schema for the tool.

name -> (string)

The name of the tool.

text -> (structure)

Contains configurations for the text in a message for a prompt.

inputVariables -> (list)

An array of the variables in the prompt template.

(structure)

Contains information about a variable in the prompt.

name -> (string)

The name of the variable.

text -> (string)

The message for the prompt.

templateType -> (string)

The type of prompt template.

resource -> (structure)

Contains configurations for a prompt from Prompt management.

promptArn -> (string)

The Amazon Resource Name (ARN) of the prompt from Prompt management.

retrieval -> (structure)

Contains configurations for a Retrieval node in your flow. Retrieves data from an Amazon S3 location and returns it as the output.

serviceConfiguration -> (tagged union structure)

Contains configurations for the service to use for retrieving data to return as the output from the node.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: s3.

s3 -> (structure)

Contains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node.

bucketName -> (string)

The name of the Amazon S3 bucket from which to retrieve data.

storage -> (structure)

Contains configurations for a Storage node in your flow. Stores an input in an Amazon S3 location.

serviceConfiguration -> (tagged union structure)

Contains configurations for the service to use for storing the input into the node.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: s3.

s3 -> (structure)

Contains configurations for the Amazon S3 location in which to store the input into the node.

bucketName -> (string)

The name of the Amazon S3 bucket in which to store the input into the node.

inputs -> (list)

An array of objects, each of which contains information about an input into the node.

(structure)

Contains configurations for an input to a node.

expression -> (string)

An expression that formats the input for the node. For an explanation of how to create expressions, see Expressions in Prompt flows in Amazon Bedrock .

name -> (string)

A name for the input that you can reference.

type -> (string)

The data type of the input. If the input doesn’t match this type at runtime, a validation error will be thrown.

name -> (string)

A name for the node.

outputs -> (list)

A list of objects, each of which contains information about an output from the node.

(structure)

Contains configurations for an output from a node.

name -> (string)

A name for the output that you can reference.

type -> (string)

The data type of the output. If the output doesn’t match this type at runtime, a validation error will be thrown.

type -> (string)

The type of node. This value must match the name of the key that you provide in the configuration you provide in the FlowNodeConfiguration field.

description -> (string)

The description of the flow.

executionRoleArn -> (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.

id -> (string)

The unique identifier of the flow.

name -> (string)

The name of the flow.

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.

updatedAt -> (timestamp)

The time at which the flow was last updated.

validations -> (list)

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

(structure)

Contains information about validation of the flow.

This data type is used in the following API operations:

details -> (tagged union structure)

Specific details about the validation issue encountered in the flow.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: cyclicConnection, duplicateConditionExpression, duplicateConnections, incompatibleConnectionDataType, malformedConditionExpression, malformedNodeInputExpression, mismatchedNodeInputType, mismatchedNodeOutputType, missingConnectionConfiguration, missingDefaultCondition, missingEndingNodes, missingNodeConfiguration, missingNodeInput, missingNodeOutput, missingStartingNodes, multipleNodeInputConnections, unfulfilledNodeInput, unknownConnectionCondition, unknownConnectionSource, unknownConnectionSourceOutput, unknownConnectionTarget, unknownConnectionTargetInput, unreachableNode, unsatisfiedConnectionConditions, unspecified.

cyclicConnection -> (structure)

Details about a cyclic connection in the flow.

connection -> (string)

The name of the connection that causes the cycle in the flow.

duplicateConditionExpression -> (structure)

Details about duplicate condition expressions in a node.

expression -> (string)

The duplicated condition expression.

node -> (string)

The name of the node containing the duplicate condition expressions.

duplicateConnections -> (structure)

Details about duplicate connections between nodes.

source -> (string)

The name of the source node where the duplicate connection starts.

target -> (string)

The name of the target node where the duplicate connection ends.

incompatibleConnectionDataType -> (structure)

Details about incompatible data types in a connection.

connection -> (string)

The name of the connection with incompatible data types.

malformedConditionExpression -> (structure)

Details about a malformed condition expression in a node.

cause -> (string)

The error message describing why the condition expression is malformed.

condition -> (string)

The name of the malformed condition.

node -> (string)

The name of the node containing the malformed condition expression.

malformedNodeInputExpression -> (structure)

Details about a malformed input expression in a node.

cause -> (string)

The error message describing why the input expression is malformed.

input -> (string)

The name of the input with the malformed expression.

node -> (string)

The name of the node containing the malformed input expression.

mismatchedNodeInputType -> (structure)

Details about mismatched input data types in a node.

expectedType -> (string)

The expected data type for the node input.

input -> (string)

The name of the input with the mismatched data type.

node -> (string)

The name of the node containing the input with the mismatched data type.

mismatchedNodeOutputType -> (structure)

Details about mismatched output data types in a node.

expectedType -> (string)

The expected data type for the node output.

node -> (string)

The name of the node containing the output with the mismatched data type.

output -> (string)

The name of the output with the mismatched data type.

missingConnectionConfiguration -> (structure)

Details about missing configuration for a connection.

connection -> (string)

The name of the connection missing configuration.

missingDefaultCondition -> (structure)

Details about a missing default condition in a conditional node.

node -> (string)

The name of the node missing the default condition.

missingEndingNodes -> (structure)

Details about missing ending nodes in the flow.

missingNodeConfiguration -> (structure)

Details about missing configuration for a node.

node -> (string)

The name of the node missing configuration.

missingNodeInput -> (structure)

Details about a missing required input in a node.

input -> (string)

The name of the missing input.

node -> (string)

The name of the node missing the required input.

missingNodeOutput -> (structure)

Details about a missing required output in a node.

node -> (string)

The name of the node missing the required output.

output -> (string)

The name of the missing output.

missingStartingNodes -> (structure)

Details about missing starting nodes in the flow.

multipleNodeInputConnections -> (structure)

Details about multiple connections to a single node input.

input -> (string)

The name of the input with multiple connections to it.

node -> (string)

The name of the node containing the input with multiple connections.

unfulfilledNodeInput -> (structure)

Details about an unfulfilled node input with no valid connections.

input -> (string)

The name of the unfulfilled input. An input is unfulfilled if there are no data connections to it.

node -> (string)

The name of the node containing the unfulfilled input.

unknownConnectionCondition -> (structure)

Details about an unknown condition for a connection.

connection -> (string)

The name of the connection with the unknown condition.

unknownConnectionSource -> (structure)

Details about an unknown source node for a connection.

connection -> (string)

The name of the connection with the unknown source.

unknownConnectionSourceOutput -> (structure)

Details about an unknown source output for a connection.

connection -> (string)

The name of the connection with the unknown source output.

unknownConnectionTarget -> (structure)

Details about an unknown target node for a connection.

connection -> (string)

The name of the connection with the unknown target.

unknownConnectionTargetInput -> (structure)

Details about an unknown target input for a connection.

connection -> (string)

The name of the connection with the unknown target input.

unreachableNode -> (structure)

Details about an unreachable node in the flow.

node -> (string)

The name of the unreachable node.

unsatisfiedConnectionConditions -> (structure)

Details about unsatisfied conditions for a connection.

connection -> (string)

The name of the connection with unsatisfied conditions.

unspecified -> (structure)

Details about an unspecified validation.

message -> (string)

A message describing the validation error.

severity -> (string)

The severity of the issue described in the message.

type -> (string)

The type of validation issue encountered in the flow.

version -> (string)

The version of the flow for which information was retrieved.
© Copyright 2018, Amazon Web Services. Created using Sphinx.