AgentsforBedrock / Client / get_flow_alias

get_flow_alias#

AgentsforBedrock.Client.get_flow_alias(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.get_flow_alias(
    aliasIdentifier='string',
    flowIdentifier='string'
)
Parameters:

  • aliasIdentifier (string) –

    [REQUIRED]

    The unique identifier of the alias for which to retrieve information.

  • flowIdentifier (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'createdAt': datetime(2015, 1, 1),
    'description': 'string',
    'flowId': 'string',
    'id': 'string',
    'name': 'string',
    'routingConfiguration': [
        {
            'flowVersion': 'string'
        },
    ],
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • arn (string) –

      The Amazon Resource Name (ARN) of the flow.

    • createdAt (datetime) –

      The time at which the flow was created.

    • description (string) –

      The description of the flow.

    • flowId (string) –

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

    • id (string) –

      The unique identifier of the alias of the flow.

    • name (string) –

      The name of the alias.

    • routingConfiguration (list) –

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

      • (dict) –

        Contains information about a version that the alias maps to.

        • flowVersion (string) –

          The version that the alias maps to.

    • updatedAt (datetime) –

      The time at which the alias was last updated.

Exceptions