AWS Cloud Control v1.9.0, Nov 18 24

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.bedrock.getFlow

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

Using getFlow

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getFlow(args: GetFlowArgs, opts?: InvokeOptions): Promise<GetFlowResult>
function getFlowOutput(args: GetFlowOutputArgs, opts?: InvokeOptions): Output<GetFlowResult>

def get_flow(arn: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetFlowResult
def get_flow_output(arn: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetFlowResult]

func LookupFlow(ctx *Context, args *LookupFlowArgs, opts ...InvokeOption) (*LookupFlowResult, error)
func LookupFlowOutput(ctx *Context, args *LookupFlowOutputArgs, opts ...InvokeOption) LookupFlowResultOutput

> Note: This function is named LookupFlow in the Go SDK.

public static class GetFlow 
{
    public static Task<GetFlowResult> InvokeAsync(GetFlowArgs args, InvokeOptions? opts = null)
    public static Output<GetFlowResult> Invoke(GetFlowInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetFlowResult> getFlow(GetFlowArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:bedrock:getFlow
  arguments:
    # arguments dictionary

The following arguments are supported:

Arn string: Arn representation of the Flow

Arn string: Arn representation of the Flow

arn String: Arn representation of the Flow

arn string: Arn representation of the Flow

arn str: Arn representation of the Flow

arn String: Arn representation of the Flow

getFlow Result

The following output properties are available:

Arn string

Arn representation of the Flow

CreatedAt string

Time Stamp.

CustomerEncryptionKeyArn string

A KMS key ARN

Definition Pulumi.AwsNative.Bedrock.Outputs.FlowDefinition

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

Description string

Description of the flow

ExecutionRoleArn string

ARN of a IAM role

Id string

Identifier for a Flow

Name string

Name for the flow

Status Pulumi.AwsNative.Bedrock.FlowStatus

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.

Tags Dictionary<string, string>

Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

TestAliasTags Dictionary<string, string>

UpdatedAt string

Time Stamp.

Validations List<Pulumi.AwsNative.Bedrock.Outputs.FlowValidation>

Version string

Draft Version.

Arn string

Arn representation of the Flow

CreatedAt string

Time Stamp.

CustomerEncryptionKeyArn string

A KMS key ARN

Definition FlowDefinition

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

Description string

Description of the flow

ExecutionRoleArn string

ARN of a IAM role

Id string

Identifier for a Flow

Name string

Name for the flow

Status FlowStatus

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.

Tags map[string]string

Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

TestAliasTags map[string]string

UpdatedAt string

Time Stamp.

Validations []FlowValidation

Version string

Draft Version.

arn String

Arn representation of the Flow

createdAt String

Time Stamp.

customerEncryptionKeyArn String

A KMS key ARN

definition FlowDefinition

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

description String

Description of the flow

executionRoleArn String

ARN of a IAM role

id String

Identifier for a Flow

name String

Name for the flow

status FlowStatus

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.

tags Map<String,String>

Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

testAliasTags Map<String,String>

updatedAt String

Time Stamp.

validations List<FlowValidation>

version String

Draft Version.

arn string

Arn representation of the Flow

createdAt string

Time Stamp.

customerEncryptionKeyArn string

A KMS key ARN

definition FlowDefinition

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

description string

Description of the flow

executionRoleArn string

ARN of a IAM role

id string

Identifier for a Flow

name string

Name for the flow

status FlowStatus

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.

tags {[key: string]: string}

Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

testAliasTags {[key: string]: string}

updatedAt string

Time Stamp.

validations FlowValidation[]

version string

Draft Version.

arn str

Arn representation of the Flow

created_at str

Time Stamp.

customer_encryption_key_arn str

A KMS key ARN

definition FlowDefinition

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

description str

Description of the flow

execution_role_arn str

ARN of a IAM role

id str

Identifier for a Flow

name str

Name for the flow

status FlowStatus

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.

tags Mapping[str, str]

Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

test_alias_tags Mapping[str, str]

updated_at str

Time Stamp.

validations Sequence[FlowValidation]

version str

Draft Version.

arn String

Arn representation of the Flow

createdAt String

Time Stamp.

customerEncryptionKeyArn String

A KMS key ARN

definition Property Map

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

description String

Description of the flow

executionRoleArn String

ARN of a IAM role

id String

Identifier for a Flow

name String

Name for the flow

status "Failed" | "Prepared" | "Preparing" | "NotPrepared"

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.

tags Map<String>

Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

testAliasTags Map<String>

updatedAt String

Time Stamp.

validations List<Property Map>

version String

Draft Version.

Supporting Types

FlowAgentFlowNodeConfiguration

AgentAliasArn string: Arn representation of the Agent Alias.

AgentAliasArn string: Arn representation of the Agent Alias.

agentAliasArn String: Arn representation of the Agent Alias.

agentAliasArn string: Arn representation of the Agent Alias.

agent_alias_arn str: Arn representation of the Agent Alias.

agentAliasArn String: Arn representation of the Agent Alias.

FlowCondition

Name string: Name of a condition in a flow
Expression string: Expression for a condition in a flow

Name string: Name of a condition in a flow
Expression string: Expression for a condition in a flow

name String: Name of a condition in a flow
expression String: Expression for a condition in a flow

name string: Name of a condition in a flow
expression string: Expression for a condition in a flow

name str: Name of a condition in a flow
expression str: Expression for a condition in a flow

name String: Name of a condition in a flow
expression String: Expression for a condition in a flow

FlowConditionFlowNodeConfiguration

Conditions List<Pulumi.AwsNative.Bedrock.Inputs.FlowCondition>: List of conditions in a condition node

Conditions []FlowCondition: List of conditions in a condition node

conditions List<FlowCondition>: List of conditions in a condition node

conditions FlowCondition[]: List of conditions in a condition node

conditions Sequence[FlowCondition]: List of conditions in a condition node

conditions List<Property Map>: List of conditions in a condition node

FlowConditionalConnectionConfiguration

Condition string: Name of a condition in a flow

Condition string: Name of a condition in a flow

condition String: Name of a condition in a flow

condition string: Name of a condition in a flow

condition str: Name of a condition in a flow

condition String: Name of a condition in a flow

FlowConnection

Name string: Name of a connection in a flow
Source string: Name of a node in a flow
Target string: Name of a node in a flow
Type Pulumi.AwsNative.Bedrock.FlowConnectionType: Whether the source node that the connection begins from is a condition node ( Conditional ) or not ( Data ).
Configuration Pulumi.AwsNative.Bedrock.Inputs.FlowConnectionConfiguration0Properties | Pulumi.AwsNative.Bedrock.Inputs.FlowConnectionConfiguration1Properties: The configuration of the connection.

Name string: Name of a connection in a flow
Source string: Name of a node in a flow
Target string: Name of a node in a flow
Type FlowConnectionType: Whether the source node that the connection begins from is a condition node ( Conditional ) or not ( Data ).
Configuration FlowConnectionConfiguration0Properties | FlowConnectionConfiguration1Properties: The configuration of the connection.

name String: Name of a connection in a flow
source String: Name of a node in a flow
target String: Name of a node in a flow
type FlowConnectionType: Whether the source node that the connection begins from is a condition node ( Conditional ) or not ( Data ).
configuration FlowConnectionConfiguration0Properties | FlowConnectionConfiguration1Properties: The configuration of the connection.

name string: Name of a connection in a flow
source string: Name of a node in a flow
target string: Name of a node in a flow
type FlowConnectionType: Whether the source node that the connection begins from is a condition node ( Conditional ) or not ( Data ).
configuration FlowConnectionConfiguration0Properties | FlowConnectionConfiguration1Properties: The configuration of the connection.

name str: Name of a connection in a flow
source str: Name of a node in a flow
target str: Name of a node in a flow
type FlowConnectionType: Whether the source node that the connection begins from is a condition node ( Conditional ) or not ( Data ).
configuration FlowConnectionConfiguration0Properties | FlowConnectionConfiguration1Properties: The configuration of the connection.

name String: Name of a connection in a flow
source String: Name of a node in a flow
target String: Name of a node in a flow
type "Data" | "Conditional": Whether the source node that the connection begins from is a condition node ( Conditional ) or not ( Data ).
configuration Property Map | Property Map: The configuration of the connection.

FlowConnectionConfiguration0Properties

Data Pulumi.AwsNative.Bedrock.Inputs.FlowDataConnectionConfiguration

Data FlowDataConnectionConfiguration

data FlowDataConnectionConfiguration

data FlowDataConnectionConfiguration

data FlowDataConnectionConfiguration

data Property Map

FlowConnectionConfiguration1Properties

Conditional Pulumi.AwsNative.Bedrock.Inputs.FlowConditionalConnectionConfiguration

Conditional FlowConditionalConnectionConfiguration

conditional FlowConditionalConnectionConfiguration

conditional FlowConditionalConnectionConfiguration

conditional FlowConditionalConnectionConfiguration

conditional Property Map

FlowConnectionType

FlowDataConnectionConfiguration

SourceOutput string: Name of a node output in a flow
TargetInput string: Name of a node input in a flow

SourceOutput string: Name of a node output in a flow
TargetInput string: Name of a node input in a flow

sourceOutput String: Name of a node output in a flow
targetInput String: Name of a node input in a flow

sourceOutput string: Name of a node output in a flow
targetInput string: Name of a node input in a flow

source_output str: Name of a node output in a flow
target_input str: Name of a node input in a flow

sourceOutput String: Name of a node output in a flow
targetInput String: Name of a node input in a flow

FlowDefinition

Connections List<Pulumi.AwsNative.Bedrock.Inputs.FlowConnection>: List of connections
Nodes List<Pulumi.AwsNative.Bedrock.Inputs.FlowNode>: List of nodes in a flow

Connections []FlowConnection: List of connections
Nodes []FlowNode: List of nodes in a flow

connections List<FlowConnection>: List of connections
nodes List<FlowNode>: List of nodes in a flow

connections FlowConnection[]: List of connections
nodes FlowNode[]: List of nodes in a flow

connections Sequence[FlowConnection]: List of connections
nodes Sequence[FlowNode]: List of nodes in a flow

connections List<Property Map>: List of connections
nodes List<Property Map>: List of nodes in a flow

FlowGuardrailConfiguration

GuardrailIdentifier string: Identifier for the guardrail, could be the id or the arn
GuardrailVersion string: Version of the guardrail

GuardrailIdentifier string: Identifier for the guardrail, could be the id or the arn
GuardrailVersion string: Version of the guardrail

guardrailIdentifier String: Identifier for the guardrail, could be the id or the arn
guardrailVersion String: Version of the guardrail

guardrailIdentifier string: Identifier for the guardrail, could be the id or the arn
guardrailVersion string: Version of the guardrail

guardrail_identifier str: Identifier for the guardrail, could be the id or the arn
guardrail_version str: Version of the guardrail

guardrailIdentifier String: Identifier for the guardrail, could be the id or the arn
guardrailVersion String: Version of the guardrail

FlowKnowledgeBaseFlowNodeConfiguration

KnowledgeBaseId string: Identifier of the KnowledgeBase
GuardrailConfiguration Pulumi.AwsNative.Bedrock.Inputs.FlowGuardrailConfiguration
ModelId string: ARN or Id of a Bedrock Foundational Model or Inference Profile, or the ARN of a imported model, or a provisioned throughput ARN for custom models.

KnowledgeBaseId string: Identifier of the KnowledgeBase
GuardrailConfiguration FlowGuardrailConfiguration
ModelId string: ARN or Id of a Bedrock Foundational Model or Inference Profile, or the ARN of a imported model, or a provisioned throughput ARN for custom models.

knowledgeBaseId String: Identifier of the KnowledgeBase
guardrailConfiguration FlowGuardrailConfiguration
modelId String: ARN or Id of a Bedrock Foundational Model or Inference Profile, or the ARN of a imported model, or a provisioned throughput ARN for custom models.

knowledgeBaseId string: Identifier of the KnowledgeBase
guardrailConfiguration FlowGuardrailConfiguration
modelId string: ARN or Id of a Bedrock Foundational Model or Inference Profile, or the ARN of a imported model, or a provisioned throughput ARN for custom models.

knowledge_base_id str: Identifier of the KnowledgeBase
guardrail_configuration FlowGuardrailConfiguration
model_id str: ARN or Id of a Bedrock Foundational Model or Inference Profile, or the ARN of a imported model, or a provisioned throughput ARN for custom models.

knowledgeBaseId String: Identifier of the KnowledgeBase
guardrailConfiguration Property Map
modelId String: ARN or Id of a Bedrock Foundational Model or Inference Profile, or the ARN of a imported model, or a provisioned throughput ARN for custom models.

FlowLambdaFunctionFlowNodeConfiguration

LambdaArn string: ARN of a Lambda.

LambdaArn string: ARN of a Lambda.

lambdaArn String: ARN of a Lambda.

lambdaArn string: ARN of a Lambda.

lambda_arn str: ARN of a Lambda.

lambdaArn String: ARN of a Lambda.

FlowLexFlowNodeConfiguration

BotAliasArn string: ARN of a Lex bot alias
LocaleId string: Lex bot locale id

BotAliasArn string: ARN of a Lex bot alias
LocaleId string: Lex bot locale id

botAliasArn String: ARN of a Lex bot alias
localeId String: Lex bot locale id

botAliasArn string: ARN of a Lex bot alias
localeId string: Lex bot locale id

bot_alias_arn str: ARN of a Lex bot alias
locale_id str: Lex bot locale id

botAliasArn String: ARN of a Lex bot alias
localeId String: Lex bot locale id

FlowNodeInput

Expression string: Expression for a node input in a flow
Name string: Name of a node input in a flow
Type Pulumi.AwsNative.Bedrock.FlowNodeIoDataType: The data type of the input. If the input doesn't match this type at runtime, a validation error will be thrown.

Expression string: Expression for a node input in a flow
Name string: Name of a node input in a flow
Type FlowNodeIoDataType: The data type of the input. If the input doesn't match this type at runtime, a validation error will be thrown.

expression String: Expression for a node input in a flow
name String: Name of a node input in a flow
type FlowNodeIoDataType: The data type of the input. If the input doesn't match this type at runtime, a validation error will be thrown.

expression string: Expression for a node input in a flow
name string: Name of a node input in a flow
type FlowNodeIoDataType: The data type of the input. If the input doesn't match this type at runtime, a validation error will be thrown.

expression str: Expression for a node input in a flow
name str: Name of a node input in a flow
type FlowNodeIoDataType: The data type of the input. If the input doesn't match this type at runtime, a validation error will be thrown.

expression String: Expression for a node input in a flow
name String: Name of a node input in a flow
type "String" | "Number" | "Boolean" | "Object" | "Array": The data type of the input. If the input doesn't match this type at runtime, a validation error will be thrown.

FlowNodeIoDataType

FlowNodeOutput

Name string: Name of a node output in a flow
Type Pulumi.AwsNative.Bedrock.FlowNodeIoDataType: The data type of the output. If the output doesn't match this type at runtime, a validation error will be thrown.

Name string: Name of a node output in a flow
Type FlowNodeIoDataType: The data type of the output. If the output doesn't match this type at runtime, a validation error will be thrown.

name String: Name of a node output in a flow
type FlowNodeIoDataType: The data type of the output. If the output doesn't match this type at runtime, a validation error will be thrown.

name string: Name of a node output in a flow
type FlowNodeIoDataType: The data type of the output. If the output doesn't match this type at runtime, a validation error will be thrown.

name str: Name of a node output in a flow
type FlowNodeIoDataType: The data type of the output. If the output doesn't match this type at runtime, a validation error will be thrown.

name String: Name of a node output in a flow
type "String" | "Number" | "Boolean" | "Object" | "Array": The data type of the output. If the output doesn't match this type at runtime, a validation error will be thrown.

FlowNodeType

FlowPromptFlowNodeConfiguration

SourceConfiguration Pulumi.AwsNative.Bedrock.Inputs.FlowPromptFlowNodeSourceConfiguration0Properties | Pulumi.AwsNative.Bedrock.Inputs.FlowPromptFlowNodeSourceConfiguration1Properties
GuardrailConfiguration Pulumi.AwsNative.Bedrock.Inputs.FlowGuardrailConfiguration

SourceConfiguration FlowPromptFlowNodeSourceConfiguration0Properties | FlowPromptFlowNodeSourceConfiguration1Properties
GuardrailConfiguration FlowGuardrailConfiguration

sourceConfiguration FlowPromptFlowNodeSourceConfiguration0Properties | FlowPromptFlowNodeSourceConfiguration1Properties
guardrailConfiguration FlowGuardrailConfiguration

sourceConfiguration FlowPromptFlowNodeSourceConfiguration0Properties | FlowPromptFlowNodeSourceConfiguration1Properties
guardrailConfiguration FlowGuardrailConfiguration

source_configuration FlowPromptFlowNodeSourceConfiguration0Properties | FlowPromptFlowNodeSourceConfiguration1Properties
guardrail_configuration FlowGuardrailConfiguration

sourceConfiguration Property Map | Property Map
guardrailConfiguration Property Map

FlowPromptFlowNodeInlineConfiguration

ModelId string: ARN or Id of a Bedrock Foundational Model or Inference Profile, or the ARN of a imported model, or a provisioned throughput ARN for custom models.
TemplateConfiguration Pulumi.AwsNative.Bedrock.Inputs.FlowPromptTemplateConfigurationProperties
TemplateType Pulumi.AwsNative.Bedrock.FlowPromptTemplateType
InferenceConfiguration Pulumi.AwsNative.Bedrock.Inputs.FlowPromptInferenceConfigurationProperties

ModelId string: ARN or Id of a Bedrock Foundational Model or Inference Profile, or the ARN of a imported model, or a provisioned throughput ARN for custom models.
TemplateConfiguration FlowPromptTemplateConfigurationProperties
TemplateType FlowPromptTemplateType
InferenceConfiguration FlowPromptInferenceConfigurationProperties

modelId String: ARN or Id of a Bedrock Foundational Model or Inference Profile, or the ARN of a imported model, or a provisioned throughput ARN for custom models.
templateConfiguration FlowPromptTemplateConfigurationProperties
templateType FlowPromptTemplateType
inferenceConfiguration FlowPromptInferenceConfigurationProperties

modelId string: ARN or Id of a Bedrock Foundational Model or Inference Profile, or the ARN of a imported model, or a provisioned throughput ARN for custom models.
templateConfiguration FlowPromptTemplateConfigurationProperties
templateType FlowPromptTemplateType
inferenceConfiguration FlowPromptInferenceConfigurationProperties

model_id str: ARN or Id of a Bedrock Foundational Model or Inference Profile, or the ARN of a imported model, or a provisioned throughput ARN for custom models.
template_configuration FlowPromptTemplateConfigurationProperties
template_type FlowPromptTemplateType
inference_configuration FlowPromptInferenceConfigurationProperties

modelId String: ARN or Id of a Bedrock Foundational Model or Inference Profile, or the ARN of a imported model, or a provisioned throughput ARN for custom models.
templateConfiguration Property Map
templateType "TEXT"
inferenceConfiguration Property Map