DeadlineCloud / Paginator / ListLicenseEndpoints

ListLicenseEndpoints

class DeadlineCloud.Paginator.ListLicenseEndpoints

paginator = client.get_paginator('list_license_endpoints')

paginate(**kwargs)

Creates an iterator that will paginate through responses from DeadlineCloud.Client.list_license_endpoints().

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

{
    'licenseEndpoints': [
        {
            'licenseEndpointId': 'string',
            'status': 'CREATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'READY'|'NOT_READY',
            'statusMessage': 'string',
            'vpcId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • licenseEndpoints (list) –

    The license endpoints.

    • (dict) –

      The details for a license endpoint.

      • licenseEndpointId (string) –

        The license endpoint ID.

      • status (string) –

        The status of the license endpoint.

      • statusMessage (string) –

        The status message of the license endpoint.

      • vpcId (string) –

        The VCP(virtual private cloud) ID associated with the license endpoint.

  • NextToken (string) –

    A token to resume pagination.