AgentsforBedrock / Paginator / ListAgentAliases


class AgentsforBedrock.Paginator.ListAgentAliases#
paginator = client.get_paginator('list_agent_aliases')

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • agentId (string) –


    The unique identifier of the agent.

  • 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:



Response Syntax

    'agentAliasSummaries': [
            'agentAliasId': 'string',
            'agentAliasName': 'string',
            'agentAliasStatus': 'CREATING'|'PREPARED'|'FAILED'|'UPDATING'|'DELETING',
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'routingConfiguration': [
                    'agentVersion': 'string',
                    'provisionedThroughput': 'string'
            'updatedAt': datetime(2015, 1, 1)
    'NextToken': 'string'

Response Structure

  • (dict) –

    • agentAliasSummaries (list) –

      A list of objects, each of which contains information about an alias of the agent.

      • (dict) –

        Contains details about an alias of an agent.

        • agentAliasId (string) –

          Contains details about

        • agentAliasName (string) –

          The name of the alias.

        • agentAliasStatus (string) –

          The status of the alias.

        • createdAt (datetime) –

          The time at which the alias of the agent was created.

        • description (string) –

          The description of the alias.

        • routingConfiguration (list) –

          Contains details about the version of the agent with which the alias is associated.

          • (dict) –

            Contains details about the routing configuration of the alias.

            • agentVersion (string) –

              The version of the agent with which the alias is associated.

            • provisionedThroughput (string) –

              Information on the Provisioned Throughput assigned to an agent alias.

        • updatedAt (datetime) –

          The time at which the alias was last updated.

    • NextToken (string) –

      A token to resume pagination.