Proton / Paginator / ListServiceInstances

ListServiceInstances

class Proton.Paginator.ListServiceInstances

paginator = client.get_paginator('list_service_instances')

paginate(**kwargs)

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

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filters=[
        {
            'key': 'name'|'deploymentStatus'|'templateName'|'serviceName'|'deployedTemplateVersionStatus'|'environmentName'|'lastDeploymentAttemptedAtBefore'|'lastDeploymentAttemptedAtAfter'|'createdAtBefore'|'createdAtAfter',
            'value': 'string'
        },
    ],
    serviceName='string',
    sortBy='name'|'deploymentStatus'|'templateName'|'serviceName'|'environmentName'|'lastDeploymentAttemptedAt'|'createdAt',
    sortOrder='ASCENDING'|'DESCENDING',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• filters (list) –

  An array of filtering criteria that scope down the result list. By default, all service instances in the Amazon Web Services account are returned.

  • (dict) –

    A filtering criterion to scope down the result list of the ListServiceInstances action.

    • key (string) –

      The name of a filtering criterion.

    • value (string) –

      A value to filter by.

      With the date/time keys ( *At{Before,After}), the value is a valid RFC 3339 string with no UTC offset and with an optional fractional precision (for example, 1985-04-12T23:20:50.52Z).

• serviceName (string) – The name of the service that the service instance belongs to.

• sortBy (string) –

  The field that the result list is sorted by.

  When you choose to sort by serviceName, service instances within each service are sorted by service instance name.

  Default: serviceName

• sortOrder (string) –

  Result list sort order.

  Default: ASCENDING

• 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

{
    'serviceInstances': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
            'deploymentStatusMessage': 'string',
            'environmentName': 'string',
            'lastAttemptedDeploymentId': 'string',
            'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
            'lastDeploymentSucceededAt': datetime(2015, 1, 1),
            'lastSucceededDeploymentId': 'string',
            'name': 'string',
            'serviceName': 'string',
            'templateMajorVersion': 'string',
            'templateMinorVersion': 'string',
            'templateName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • serviceInstances (list) –

    An array of service instances with summary data.

    • (dict) –

      Summary data of an Proton service instance resource.

      • arn (string) –

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

      • createdAt (datetime) –

        The time when the service instance was created.

      • deploymentStatus (string) –

        The service instance deployment status.

      • deploymentStatusMessage (string) –

        A service instance deployment status message.

      • environmentName (string) –

        The name of the environment that the service instance was deployed into.

      • lastAttemptedDeploymentId (string) –

        The ID of the last attempted deployment of this service instance.

      • lastDeploymentAttemptedAt (datetime) –

        The time when a deployment of the service was last attempted.

      • lastDeploymentSucceededAt (datetime) –

        The time when the service was last deployed successfully.

      • lastSucceededDeploymentId (string) –

        The ID of the last successful deployment of this service instance.

      • name (string) –

        The name of the service instance.

      • serviceName (string) –

        The name of the service that the service instance belongs to.

      • templateMajorVersion (string) –

        The service instance template major version.

      • templateMinorVersion (string) –

        The service instance template minor version.

      • templateName (string) –

        The name of the service template.

  • NextToken (string) –

    A token to resume pagination.