VPCLattice / Client / list_services

list_services#

VPCLattice.Client.list_services(**kwargs)#

Lists the services owned by the caller account or shared with the caller account.

See also: AWS API Documentation

Request Syntax

response = client.list_services(
    maxResults=123,
    nextToken='string'
)
Parameters:
  • maxResults (integer) – The maximum number of results to return.

  • nextToken (string) – A pagination token for the next page of results.

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, 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, in ISO-8601 format.

        • name (string) –

          The name of the service.

        • status (string) –

          The status.

    • nextToken (string) –

      If there are additional results, a pagination token for the next page of results.

Exceptions

  • VPCLattice.Client.exceptions.ValidationException

  • VPCLattice.Client.exceptions.AccessDeniedException

  • VPCLattice.Client.exceptions.ThrottlingException

  • VPCLattice.Client.exceptions.InternalServerException