Skip to content

create_flow_alias

Operation

create_flow_alias

create_flow_alias(request: CreateFlowAliasInput | CreateFlowAliasInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateFlowAliasInputDict]) -> CreateFlowAliasOutput

Creates an alias of a flow for deployment. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Parameters:

Name Type Description Default
request CreateFlowAliasInput | CreateFlowAliasInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[CreateFlowAliasInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateFlowAliasOutput

An instance of CreateFlowAliasOutput.

create_flow_alias async

create_flow_alias(request: CreateFlowAliasInput | CreateFlowAliasInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateFlowAliasInputDict]) -> CreateFlowAliasOutput

Creates an alias of a flow for deployment. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Parameters:

Name Type Description Default
request CreateFlowAliasInput | CreateFlowAliasInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[CreateFlowAliasInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateFlowAliasOutput

An instance of CreateFlowAliasOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

CreateFlowAliasInputDict

Bases: TypedDict

Dictionary form of CreateFlowAliasInput.

Attributes

client_token instance-attribute
client_token: str | None

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.

This field is autopopulated if not provided.

concurrency_configuration instance-attribute

The configuration that specifies how nodes in the flow are executed in parallel.

description instance-attribute
description: str | None

A description for the alias.

flow_identifier instance-attribute
flow_identifier: Required[str]

The unique identifier of the flow for which to create an alias.

name instance-attribute
name: Required[str]

A name for the alias.

routing_configuration instance-attribute

Contains information about the version to which to map the alias.

tags instance-attribute
tags: Mapping[str, str] | None

Any tags that you want to attach to the alias of the flow. For more information, see Tagging resources in Amazon Bedrock.

CreateFlowAliasInput dataclass

Bases: _SerdeShape

Dataclass for CreateFlowAliasInput structure.

Attributes

client_token class-attribute instance-attribute
client_token: str | None = ...

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.

This field is autopopulated if not provided.

concurrency_configuration class-attribute instance-attribute
concurrency_configuration: FlowAliasConcurrencyConfiguration | None = ...

The configuration that specifies how nodes in the flow are executed in parallel.

description class-attribute instance-attribute
description: str | None = ...

A description for the alias.

flow_identifier class-attribute instance-attribute
flow_identifier: str | None = ...

The unique identifier of the flow for which to create an alias.

name class-attribute instance-attribute
name: str | None = ...

A name for the alias.

routing_configuration class-attribute instance-attribute
routing_configuration: list[FlowAliasRoutingConfigurationListItem] | None = ...

Contains information about the version to which to map the alias.

tags class-attribute instance-attribute
tags: dict[str, str] | None = ...

Any tags that you want to attach to the alias of the flow. For more information, see Tagging resources in Amazon Bedrock.

Output

CreateFlowAliasOutput dataclass

Bases: _SerdeShape

Dataclass for CreateFlowAliasOutput structure.

Attributes

arn instance-attribute
arn: str

The Amazon Resource Name (ARN) of the alias.

concurrency_configuration class-attribute instance-attribute
concurrency_configuration: FlowAliasConcurrencyConfiguration | None = ...

The configuration that specifies how nodes in the flow are executed in parallel.

created_at instance-attribute
created_at: datetime

The time at which the alias was created.

description class-attribute instance-attribute
description: str | None = ...

The description of the alias.

flow_id instance-attribute
flow_id: str

The unique identifier of the flow that the alias belongs to.

id instance-attribute
id: str

The unique identifier of the alias.

name instance-attribute
name: str

The name of the alias.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

routing_configuration instance-attribute

Contains information about the version that the alias is mapped to.

updated_at instance-attribute
updated_at: datetime

The time at which the alias of the flow was last updated.