APIGateway / Paginator / GetSdkTypes

GetSdkTypes

class APIGateway.Paginator.GetSdkTypes

paginator = client.get_paginator('get_sdk_types')

paginate(**kwargs)

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

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': [
        {
            'id': 'string',
            'friendlyName': 'string',
            'description': 'string',
            'configurationProperties': [
                {
                    'name': 'string',
                    'friendlyName': 'string',
                    'description': 'string',
                    'required': True|False,
                    'defaultValue': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  The collection of SdkType instances.

  • items (list) –

    The current page of elements from this collection.

    • (dict) –

      A type of SDK that API Gateway can generate.

      • id (string) –

        The identifier of an SdkType instance.

      • friendlyName (string) –

        The user-friendly name of an SdkType instance.

      • description (string) –

        The description of an SdkType.

      • configurationProperties (list) –

        A list of configuration properties of an SdkType.

        • (dict) –

          A configuration property of an SDK type.

          • name (string) –

            The name of a an SdkType configuration property.

          • friendlyName (string) –

            The user-friendly name of an SdkType configuration property.

          • description (string) –

            The description of an SdkType configuration property.

          • required (boolean) –

            A boolean flag of an SdkType configuration property to indicate if the associated SDK configuration property is required ( true) or not ( false).

          • defaultValue (string) –

            The default value of an SdkType configuration property.

  • NextToken (string) –

    A token to resume pagination.