imagebuilder / Paginator / ListLifecycleExecutionResources

ListLifecycleExecutionResources

class imagebuilder.Paginator.ListLifecycleExecutionResources

paginator = client.get_paginator('list_lifecycle_execution_resources')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• lifecycleExecutionId (string) –

  [REQUIRED]

  The unique identifier for a runtime instance of the lifecycle policy.

• parentResourceId (string) – The Amazon Resource Name (ARN) of an image build version to get the output resources for, such as AMIs or container images in Amazon ECR. You can get this value from the resourceId in the top-level response. If you leave this property empty, the response lists the Image Builder resources that the lifecycle execution identified for lifecycle actions. If the image build version that you specify in parentResourceId wasn’t part of this lifecycle execution, the response contains an empty list.

• 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

{
    'lifecycleExecutionId': 'string',
    'lifecycleExecutionState': {
        'status': 'IN_PROGRESS'|'CANCELLED'|'CANCELLING'|'FAILED'|'SUCCESS'|'PENDING',
        'reason': 'string'
    },
    'resources': [
        {
            'accountId': 'string',
            'resourceId': 'string',
            'state': {
                'status': 'FAILED'|'IN_PROGRESS'|'SKIPPED'|'SUCCESS',
                'reason': 'string'
            },
            'action': {
                'name': 'AVAILABLE'|'DELETE'|'DEPRECATE'|'DISABLE',
                'reason': 'string'
            },
            'region': 'string',
            'snapshots': [
                {
                    'snapshotId': 'string',
                    'state': {
                        'status': 'FAILED'|'IN_PROGRESS'|'SKIPPED'|'SUCCESS',
                        'reason': 'string'
                    }
                },
            ],
            'imageUris': [
                'string',
            ],
            'startTime': datetime(2015, 1, 1),
            'endTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • lifecycleExecutionId (string) –

    The unique identifier for the runtime instance of the lifecycle policy.

  • lifecycleExecutionState (dict) –

    The current state of the lifecycle runtime instance.

    • status (string) –

      The runtime status of the lifecycle execution.

    • reason (string) –

      The reason for the current status.

  • resources (list) –

    A list of resources that were identified for lifecycle actions.

    • (dict) –

      Contains details for a resource that the runtime instance of the lifecycle policy identified for action.

      • accountId (string) –

        The account that owns the impacted resource.

      • resourceId (string) –

        Identifies the impacted resource. The resource ID depends on the type of resource, as follows.

        • Image Builder image resources: Amazon Resource Name (ARN)

        • Distributed AMIs: AMI ID

        • Container images distributed to an ECR repository: image URI or SHA Digest

      • state (dict) –

        The runtime state of the lifecycle action for this resource.

        • status (string) –

          The runtime status of the lifecycle action taken for the impacted resource.

        • reason (string) –

          Messaging that clarifies the reason for the assigned status.

      • action (dict) –

        The action to take for the identified resource.

        • name (string) –

          The name of the lifecycle action that was identified for the resource.

        • reason (string) –

          The reason why the lifecycle policy action is taken.

      • region (string) –

        The Amazon Web Services Region where the lifecycle execution resource is stored.

      • snapshots (list) –

        A list of associated resource snapshots for the impacted resource if it’s an AMI.

        • (dict) –

          Contains the state of an impacted snapshot resource that the runtime instance of the lifecycle policy identified for action.

          • snapshotId (string) –

            Identifies the impacted snapshot resource.

          • state (dict) –

            The runtime status of the lifecycle action taken for the snapshot.

            • status (string) –

              The runtime status of the lifecycle action taken for the impacted resource.

            • reason (string) –

              Messaging that clarifies the reason for the assigned status.

      • imageUris (list) –

        For an impacted container image, this identifies a list of URIs for associated container images distributed to ECR repositories.

        • (string) –

      • startTime (datetime) –

        The starting timestamp from the lifecycle action that was applied to the resource.

      • endTime (datetime) –

        The ending timestamp from the lifecycle action that was applied to the resource.

  • NextToken (string) –

    A token to resume pagination.