ECR / Waiter / ImageScanComplete

ImageScanComplete#

class ECR.Waiter.ImageScanComplete#
waiter = client.get_waiter('image_scan_complete')
wait(**kwargs)#

Polls ECR.Client.describe_image_scan_findings() every 5 seconds until a successful state is reached. An error is returned after 60 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    registryId='string',
    repositoryName='string',
    imageId={
        'imageDigest': 'string',
        'imageTag': 'string'
    },
    nextToken='string',
    maxResults=123,
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters:

  • registryId (string) – The Amazon Web Services account ID associated with the registry that contains the repository in which to describe the image scan findings for. If you do not specify a registry, the default registry is assumed.

  • repositoryName (string) –

    [REQUIRED]

    The repository for the image for which to describe the scan findings.

  • imageId (dict) –

    [REQUIRED]

    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.

  • nextToken (string) – The nextToken value returned from a previous paginated DescribeImageScanFindings request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

  • maxResults (integer) – The maximum number of image scan results returned by DescribeImageScanFindings in paginated output. When this parameter is used, DescribeImageScanFindings only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeImageScanFindings request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeImageScanFindings returns up to 100 results and a nextToken value, if applicable.

  • WaiterConfig (dict) –

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) –

      The amount of time in seconds to wait between attempts. Default: 5

    • MaxAttempts (integer) –

      The maximum number of attempts to be made. Default: 60

Returns:

None