APIGateway / Paginator / GetDeployments


class APIGateway.Paginator.GetDeployments#
paginator = client.get_paginator('get_deployments')

Creates an iterator that will paginate through responses from APIGateway.Client.get_deployments().

See also: AWS API Documentation

Request Syntax

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


    The string identifier of the associated RestApi.

  • 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

    'items': [
            'id': 'string',
            'description': 'string',
            'createdDate': datetime(2015, 1, 1),
            'apiSummary': {
                'string': {
                    'string': {
                        'authorizationType': 'string',
                        'apiKeyRequired': True|False
    'NextToken': 'string'

Response Structure

  • (dict) –

    Represents a collection resource that contains zero or more references to your existing deployments, and links that guide you on how to interact with your collection. The collection offers a paginated view of the contained deployments.

    • items (list) –

      The current page of elements from this collection.

      • (dict) –

        An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.

        • id (string) –

          The identifier for the deployment resource.

        • description (string) –

          The description for the deployment resource.

        • createdDate (datetime) –

          The date and time that the deployment resource was created.

        • apiSummary (dict) –

          A summary of the RestApi at the date and time that the deployment resource was created.

          • (string) –

            • (dict) –

              • (string) –

                • (dict) –

                  Represents a summary of a Method resource, given a particular date and time.

                  • authorizationType (string) –

                    The method’s authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

                  • apiKeyRequired (boolean) –

                    Specifies whether the method requires a valid ApiKey.

    • NextToken (string) –

      A token to resume pagination.