LaunchWizard / Paginator / ListDeploymentEvents

ListDeploymentEvents#

class LaunchWizard.Paginator.ListDeploymentEvents#
paginator = client.get_paginator('list_deployment_events')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    deploymentId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • deploymentId (string) –

    [REQUIRED]

    The ID of the deployment.

  • 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

{
    'deploymentEvents': [
        {
            'description': 'string',
            'name': 'string',
            'status': 'CANCELED'|'CANCELING'|'COMPLETED'|'CREATED'|'FAILED'|'IN_PROGRESS'|'PENDING'|'TIMED_OUT',
            'statusReason': 'string',
            'timestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • deploymentEvents (list) –

      Lists the deployment events.

      • (dict) –

        A summary of the deployment event data.

        • description (string) –

          The description of the deployment event.

        • name (string) –

          The name of the deployment event.

        • status (string) –

          The status of the deployment event.

        • statusReason (string) –

          The reason of the deployment event status.

        • timestamp (datetime) –

          The timestamp of the deployment event.

    • NextToken (string) –

      A token to resume pagination.