BedrockAgentCoreControlPlaneFrontingLayer / Paginator / ListGateways

ListGateways

class BedrockAgentCoreControlPlaneFrontingLayer.Paginator.ListGateways

paginator = client.get_paginator('list_gateways')

paginate(**kwargs)

Creates an iterator that will paginate through responses from BedrockAgentCoreControlPlaneFrontingLayer.Client.list_gateways().

See also: AWS API Documentation

Request Syntax

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

Parameters:

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

{
    'items': [
        {
            'gatewayId': 'string',
            'name': 'string',
            'status': 'CREATING'|'UPDATING'|'UPDATE_UNSUCCESSFUL'|'DELETING'|'READY'|'FAILED',
            'description': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'authorizerType': 'CUSTOM_JWT',
            'protocolType': 'MCP'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    The list of Gateway summaries.

    • (dict) –

      Contains summary information about a gateway.

      • gatewayId (string) –

        The unique identifier of the gateway.

      • name (string) –

        The name of the gateway.

      • status (string) –

        The current status of the gateway.

      • description (string) –

        The description of the gateway.

      • createdAt (datetime) –

        The timestamp when the gateway was created.

      • updatedAt (datetime) –

        The timestamp when the gateway was last updated.

      • authorizerType (string) –

        The type of authorizer used by the gateway.

      • protocolType (string) –

        The protocol type used by the gateway.

  • NextToken (string) –

    A token to resume pagination.