VPCLattice / Paginator / ListServiceNetworkServiceAssociations

ListServiceNetworkServiceAssociations#

class VPCLattice.Paginator.ListServiceNetworkServiceAssociations#
paginator = client.get_paginator('list_service_network_service_associations')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    serviceIdentifier='string',
    serviceNetworkIdentifier='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • serviceIdentifier (string) – The ID or Amazon Resource Name (ARN) of the service.

  • serviceNetworkIdentifier (string) – The ID or Amazon Resource Name (ARN) of the service network.

  • 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),
            'createdBy': 'string',
            'customDomainName': 'string',
            'dnsEntry': {
                'domainName': 'string',
                'hostedZoneId': 'string'
            },
            'id': 'string',
            'serviceArn': 'string',
            'serviceId': 'string',
            'serviceName': 'string',
            'serviceNetworkArn': 'string',
            'serviceNetworkId': 'string',
            'serviceNetworkName': 'string',
            'status': 'CREATE_IN_PROGRESS'|'ACTIVE'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      Information about the associations.

      • (dict) –

        Summary information about the association between a service network and a service.

        • arn (string) –

          The Amazon Resource Name (ARN) of the association.

        • createdAt (datetime) –

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

        • createdBy (string) –

          The account that created the association.

        • customDomainName (string) –

          The custom domain name of the service.

        • dnsEntry (dict) –

          DNS information about the service.

          • domainName (string) –

            The domain name of the service.

          • hostedZoneId (string) –

            The ID of the hosted zone.

        • id (string) –

          The ID of the association.

        • serviceArn (string) –

          The Amazon Resource Name (ARN) of the service.

        • serviceId (string) –

          The ID of the service.

        • serviceName (string) –

          The name of the service.

        • serviceNetworkArn (string) –

          The Amazon Resource Name (ARN) of the service network.

        • serviceNetworkId (string) –

          The ID of the service network.

        • serviceNetworkName (string) –

          The name of the service network.

        • status (string) –

          The status. If the deletion fails, try to delete again.

    • NextToken (string) –

      A token to resume pagination.