VPCLattice / Paginator / ListServices

ListServices#

class VPCLattice.Paginator.ListServices#
paginator = client.get_paginator('list_services')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from VPCLattice.Client.list_services().

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': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'customDomainName': 'string',
            'dnsEntry': {
                'domainName': 'string',
                'hostedZoneId': 'string'
            },
            'id': 'string',
            'lastUpdatedAt': datetime(2015, 1, 1),
            'name': 'string',
            'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      Information about the services.

      • (dict) –

        Summary information about a service.

        • arn (string) –

          The Amazon Resource Name (ARN) of the service.

        • createdAt (datetime) –

          The date and time that the service was created, specified in ISO-8601 format.

        • customDomainName (string) –

          The custom domain name of the service.

        • dnsEntry (dict) –

          The DNS information.

          • domainName (string) –

            The domain name of the service.

          • hostedZoneId (string) –

            The ID of the hosted zone.

        • id (string) –

          The ID of the service.

        • lastUpdatedAt (datetime) –

          The date and time that the service was last updated. The format is ISO-8601.

        • name (string) –

          The name of the service.

        • status (string) –

          The status.

    • NextToken (string) –

      A token to resume pagination.