LaunchWizard / Paginator / ListDeployments

ListDeployments

class LaunchWizard.Paginator.ListDeployments

paginator = client.get_paginator('list_deployments')

paginate(**kwargs)

Creates an iterator that will paginate through responses from LaunchWizard.Client.list_deployments().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filters=[
        {
            'name': 'WORKLOAD_NAME'|'DEPLOYMENT_STATUS',
            'values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• filters (list) –

  Filters to scope the results. The following filters are supported:

  • WORKLOAD_NAME - The name used in deployments.

  • DEPLOYMENT_STATUS - COMPLETED | CREATING | DELETE_IN_PROGRESS | DELETE_INITIATING | DELETE_FAILED | DELETED | FAILED | IN_PROGRESS | VALIDATING

  • (dict) –

    A filter name and value pair that is used to return more specific results from a describe operation. Filters can be used to match a set of resources by specific criteria.

    • name (string) –

      The name of the filter. Filter names are case-sensitive.

    • values (list) –

      The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

      • (string) –

• 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

{
    'deployments': [
        {
            'createdAt': datetime(2015, 1, 1),
            'id': 'string',
            'name': 'string',
            'patternName': 'string',
            'status': 'COMPLETED'|'CREATING'|'DELETE_IN_PROGRESS'|'DELETE_INITIATING'|'DELETE_FAILED'|'DELETED'|'FAILED'|'IN_PROGRESS'|'VALIDATING',
            'workloadName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • deployments (list) –

    Lists the deployments.

    • (dict) –

      A summary of the deployment data.

      • createdAt (datetime) –

        The time the deployment was created.

      • id (string) –

        The ID of the deployment.

      • name (string) –

        The name of the deployment

      • patternName (string) –

        The name of the workload deployment pattern.

      • status (string) –

        The status of the deployment.

      • workloadName (string) –

        The name of the workload.

  • NextToken (string) –

    A token to resume pagination.