AgentsforBedrock / Client / list_flow_aliases

list_flow_aliases#

AgentsforBedrock.Client.list_flow_aliases(**kwargs)#

Returns a list of aliases for a flow.

See also: AWS API Documentation

Request Syntax

response = client.list_flow_aliases(
    flowIdentifier='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • flowIdentifier (string) –

    [REQUIRED]

    The unique identifier of the flow for which aliases are being returned.

  • maxResults (integer) – The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

  • nextToken (string) – If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • flowAliasSummaries (list) –

      A list, each member of which contains information about an alias.

      • (dict) –

        Contains information about an alias of a flow.

        This data type is used in the following API operations:

        • arn (string) –

          The Amazon Resource Name (ARN) of the alias.

        • createdAt (datetime) –

          The time at which the alias was created.

        • description (string) –

          A description of the alias.

        • flowId (string) –

          The unique identifier of the flow.

        • id (string) –

          The unique identifier of the alias of the flow.

        • name (string) –

          The name of the alias.

        • routingConfiguration (list) –

          A list of configurations about the versions that the alias maps to. Currently, you can only specify one.

          • (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.

    • nextToken (string) –

      If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

Exceptions