ECR / Paginator / GetLifecyclePolicyPreview

GetLifecyclePolicyPreview

class ECR.Paginator.GetLifecyclePolicyPreview

paginator = client.get_paginator('get_lifecycle_policy_preview')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ECR.Client.get_lifecycle_policy_preview().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    registryId='string',
    repositoryName='string',
    imageIds=[
        {
            'imageDigest': 'string',
            'imageTag': 'string'
        },
    ],
    filter={
        'tagStatus': 'TAGGED'|'UNTAGGED'|'ANY'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• registryId (string) – The Amazon Web Services account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.

• repositoryName (string) –

  [REQUIRED]

  The name of the repository.

• imageIds (list) –

  The list of imageIDs to be included.

  • (dict) –

    An object with identifying information for an image in an Amazon ECR repository.

    • imageDigest (string) –

      The sha256 digest of the image manifest.

    • imageTag (string) –

      The tag used for the image.

• filter (dict) –

  An optional parameter that filters results based on image tag status and all tags, if tagged.

  • tagStatus (string) –

    The tag status of the image.

• 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

{
    'registryId': 'string',
    'repositoryName': 'string',
    'lifecyclePolicyText': 'string',
    'status': 'IN_PROGRESS'|'COMPLETE'|'EXPIRED'|'FAILED',
    'previewResults': [
        {
            'imageTags': [
                'string',
            ],
            'imageDigest': 'string',
            'imagePushedAt': datetime(2015, 1, 1),
            'action': {
                'type': 'EXPIRE'
            },
            'appliedRulePriority': 123
        },
    ],
    'summary': {
        'expiringImageTotalCount': 123
    },
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • registryId (string) –

    The registry ID associated with the request.

  • repositoryName (string) –

    The repository name associated with the request.

  • lifecyclePolicyText (string) –

    The JSON lifecycle policy text.

  • status (string) –

    The status of the lifecycle policy preview request.

  • previewResults (list) –

    The results of the lifecycle policy preview request.

    • (dict) –

      The result of the lifecycle policy preview.

      • imageTags (list) –

        The list of tags associated with this image.

        • (string) –

      • imageDigest (string) –

        The sha256 digest of the image manifest.

      • imagePushedAt (datetime) –

        The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository.

      • action (dict) –

        The type of action to be taken.

        • type (string) –

          The type of action to be taken.

      • appliedRulePriority (integer) –

        The priority of the applied rule.

  • summary (dict) –

    The list of images that is returned as a result of the action.

    • expiringImageTotalCount (integer) –

      The number of expiring images.

  • NextToken (string) –

    A token to resume pagination.