Skip to content

create_flow_alias

create_flow_alias(
    name: Name,
    routing_configuration: FlowAliasRoutingConfiguration,
    flow_identifier: FlowIdentifier,
    *,
    config_overrides: Optional[BedrockAgentClientConfig] = None,
    description: Optional[Description] = None,
    concurrency_configuration: Optional[FlowAliasConcurrencyConfiguration] = None,
    client_token: Optional[ClientToken] = None,
    tags: Optional[TagsMap] = None,
) -> CreateFlowAliasResponse

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 (Name) –

    A name for the alias.

  • description (Optional[Description], default: None ) –

    A description for the alias.

  • routing_configuration (FlowAliasRoutingConfiguration) –

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

  • concurrency_configuration (Optional[FlowAliasConcurrencyConfiguration], default: None ) –

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

  • flow_identifier (FlowIdentifier) –

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

  • client_token (Optional[ClientToken], default: 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.

  • tags (Optional[TagsMap], default: None ) –

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

Raises:

Source code in docs_src/capo_bedrock_agent/_services/bedrock_agent.py
def create_flow_alias(
    self,
    name: "capo_bedrock_agent.types.name.Name",
    routing_configuration: "capo_bedrock_agent.types.flow_alias_routing_configuration.FlowAliasRoutingConfiguration",
    flow_identifier: "capo_bedrock_agent.types.flow_identifier.FlowIdentifier",
    *,
    config_overrides: Optional[BedrockAgentClientConfig] = None,
    description: Optional[
        "capo_bedrock_agent.types.description.Description"
    ] = None,
    concurrency_configuration: Optional[
        "capo_bedrock_agent.types.flow_alias_concurrency_configuration.FlowAliasConcurrencyConfiguration"
    ] = None,
    client_token: Optional[
        "capo_bedrock_agent.types.client_token.ClientToken"
    ] = None,
    tags: Optional["capo_bedrock_agent.types.tags_map.TagsMap"] = None,
) -> "capo_bedrock_agent.types.create_flow_alias_response.CreateFlowAliasResponse":
    """<p>Creates an alias of a flow for deployment. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-deploy.html">Deploy a flow in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p>

    Args:
        name: <p>A name for the alias.</p>
        description: <p>A description for the alias.</p>
        routing_configuration: <p>Contains information about the version to which to map the alias.</p>
        concurrency_configuration: <p>The configuration that specifies how nodes in the flow are executed in parallel.</p>
        flow_identifier: <p>The unique identifier of the flow for which to create an alias.</p>
        client_token: <p>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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
        tags: <p>Any tags that you want to attach to the alias of the flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html">Tagging resources in Amazon Bedrock</a>.</p>

    Raises:
        capo_bedrock_agent.errors.access_denied_exception.AccessDeniedException: <p>The request is denied because of missing access permissions.</p>
        capo_bedrock_agent.errors.conflict_exception.ConflictException: <p>There was a conflict performing an operation.</p>
        capo_bedrock_agent.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Retry your request.</p>
        capo_bedrock_agent.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
        capo_bedrock_agent.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
        capo_bedrock_agent.errors.throttling_exception.ThrottlingException: <p>The number of requests exceeds the limit. Resubmit your request later.</p>
        capo_bedrock_agent.errors.validation_exception.ValidationException: <p>Input validation failed. Check your request parameters and retry the request.</p>
        capo_bedrock_agent.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_bedrock_agent.types.create_flow_alias_request.CreateFlowAliasRequest]",
    ) -> OperationResponse[
        "capo_bedrock_agent.types.create_flow_alias_response.CreateFlowAliasResponse"
    ]:
        import capo_bedrock_agent._operations.amazon_bedrock_agent_build_time_lambda.create_flow_alias

        output, http_response = (
            capo_bedrock_agent._operations.amazon_bedrock_agent_build_time_lambda.create_flow_alias.create_flow_alias(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateFlowAlias")
    )
    input_: capo_bedrock_agent.types.create_flow_alias_request.CreateFlowAliasRequest = {
        "name": name,
        "routing_configuration": routing_configuration,
        "flow_identifier": flow_identifier,
    }
    if description is not None:
        input_["description"] = description
    if concurrency_configuration is not None:
        input_["concurrency_configuration"] = concurrency_configuration
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if tags is not None:
        input_["tags"] = tags

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output