imagebuilder / Paginator / ListLifecycleExecutions

ListLifecycleExecutions

class imagebuilder.Paginator.ListLifecycleExecutions

paginator = client.get_paginator('list_lifecycle_executions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from imagebuilder.Client.list_lifecycle_executions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    resourceArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• resourceArn (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) of the resource for which to list lifecycle executions. Specify a lifecycle policy ARN to list its executions, or an image build version ARN to list the executions that StartResourceStateUpdate started for that image. Other ARN types aren’t valid for this request.

• 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

{
    'lifecycleExecutions': [
        {
            'lifecycleExecutionId': 'string',
            'lifecyclePolicyArn': 'string',
            'resourcesImpactedSummary': {
                'hasImpactedResources': True|False
            },
            'state': {
                'status': 'IN_PROGRESS'|'CANCELLED'|'CANCELLING'|'FAILED'|'SUCCESS'|'PENDING',
                'reason': 'string'
            },
            'startTime': datetime(2015, 1, 1),
            'endTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • lifecycleExecutions (list) –

    A list of lifecycle runtime instances for the specified resource.

    • (dict) –

      Contains metadata from a runtime instance of a lifecycle policy.

      • lifecycleExecutionId (string) –

        Identifies the lifecycle policy runtime instance.

      • lifecyclePolicyArn (string) –

        The Amazon Resource Name (ARN) of the lifecycle policy that ran.

      • resourcesImpactedSummary (dict) –

        A summary flag that indicates whether the lifecycle execution identified any resources to take lifecycle actions on.

        • hasImpactedResources (boolean) –

          Indicates whether the lifecycle execution identified any resources to take lifecycle actions on.

      • state (dict) –

        Runtime state that reports whether the lifecycle execution is in progress, succeeded, or failed.

        • status (string) –

          The runtime status of the lifecycle execution.

        • reason (string) –

          The reason for the current status.

      • startTime (datetime) –

        The timestamp when the lifecycle runtime instance started.

      • endTime (datetime) –

        The timestamp when the lifecycle runtime instance completed.

  • NextToken (string) –

    A token to resume pagination.