Proton / Client / list_services

list_services#

Proton.Client.list_services(**kwargs)#

List services with summaries of detail data.

See also: AWS API Documentation

Request Syntax

response = client.list_services(
    maxResults=123,
    nextToken='string'
)
Parameters:

  • maxResults (integer) – The maximum number of services to list.

  • nextToken (string) – A token that indicates the location of the next service in the array of services, after the list of services that was previously requested.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'services': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'lastModifiedAt': datetime(2015, 1, 1),
            'name': 'string',
            'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED_CLEANUP_IN_PROGRESS'|'CREATE_FAILED_CLEANUP_COMPLETE'|'CREATE_FAILED_CLEANUP_FAILED'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED_CLEANUP_IN_PROGRESS'|'UPDATE_FAILED_CLEANUP_COMPLETE'|'UPDATE_FAILED_CLEANUP_FAILED'|'UPDATE_FAILED'|'UPDATE_COMPLETE_CLEANUP_FAILED',
            'statusMessage': 'string',
            'templateName': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      A token that indicates the location of the next service in the array of services, after the current requested list of services.

    • services (list) –

      An array of services with summaries of detail data.

      • (dict) –

        Summary data of an Proton service resource.

        • arn (string) –

          The Amazon Resource Name (ARN) of the service.

        • createdAt (datetime) –

          The time when the service was created.

        • description (string) –

          A description of the service.

        • lastModifiedAt (datetime) –

          The time when the service was last modified.

        • name (string) –

          The name of the service.

        • status (string) –

          The status of the service.

        • statusMessage (string) –

          A service status message.

        • templateName (string) –

          The name of the service template.

Exceptions