update_flow¶
Operation¶
update_flow
¶
update_flow(request: UpdateFlowInput | UpdateFlowInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateFlowInputDict]) -> UpdateFlowOutput
Modifies a flow. Include both fields that you want to keep and fields that you want to change. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateFlowInput | UpdateFlowInputDict | 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[UpdateFlowInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateFlowOutput
|
An instance of |
update_flow
async
¶
update_flow(request: UpdateFlowInput | UpdateFlowInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateFlowInputDict]) -> UpdateFlowOutput
Modifies a flow. Include both fields that you want to keep and fields that you want to change. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateFlowInput | UpdateFlowInputDict | 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[UpdateFlowInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateFlowOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
UpdateFlowInputDict
¶
Bases: TypedDict
Dictionary form of UpdateFlowInput.
Attributes¶
customer_encryption_key_arn
instance-attribute
¶
customer_encryption_key_arn: str | None
The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.
definition
instance-attribute
¶
definition: FlowDefinition | FlowDefinitionDict | None
A definition of the nodes and the connections between the nodes in the flow.
execution_role_arn
instance-attribute
¶
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.
flow_identifier
instance-attribute
¶
The unique identifier of the flow.
UpdateFlowInput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateFlowInput structure.
Attributes¶
customer_encryption_key_arn
class-attribute
instance-attribute
¶
customer_encryption_key_arn: str | None = ...
The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.
definition
class-attribute
instance-attribute
¶
definition: FlowDefinition | None = ...
A definition of the nodes and the connections between the nodes in the flow.
description
class-attribute
instance-attribute
¶
description: str | None = ...
A description for the flow.
execution_role_arn
class-attribute
instance-attribute
¶
execution_role_arn: str | None = ...
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.
Output¶
UpdateFlowOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateFlowOutput structure.
Attributes¶
customer_encryption_key_arn
class-attribute
instance-attribute
¶
customer_encryption_key_arn: str | None = ...
The Amazon Resource Name (ARN) of the KMS key that the flow was encrypted with.
definition
class-attribute
instance-attribute
¶
definition: FlowDefinition | None = ...
A definition of the nodes and the connections between nodes in the flow.
description
class-attribute
instance-attribute
¶
description: str | None = ...
The description of the flow.
execution_role_arn
instance-attribute
¶
execution_role_arn: str
The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
response_metadata
class-attribute
instance-attribute
¶
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.