Proton / Paginator / ListServices

ListServices#

class Proton.Paginator.ListServices#

paginator = client.get_paginator('list_services')

paginate(**kwargs)#

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

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

{
    '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'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- 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.
- NextToken (string) –
  
  A token to resume pagination.