AgentsforBedrock / Paginator / ListFlowAliases

ListFlowAliases

class AgentsforBedrock.Paginator.ListFlowAliases

paginator = client.get_paginator('list_flow_aliases')

paginate(**kwargs)

Creates an iterator that will paginate through responses from AgentsforBedrock.Client.list_flow_aliases().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    flowIdentifier='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• flowIdentifier (string) –

  [REQUIRED]

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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:

      • ListFlowAliases response

      • 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) –

    A token to resume pagination.