:doc:`ECR <../../ecr>` / Waiter / LifecyclePolicyPreviewComplete

******************************
LifecyclePolicyPreviewComplete
******************************



.. py:class:: ECR.Waiter.LifecyclePolicyPreviewComplete

  ::

    
    waiter = client.get_waiter('lifecycle_policy_preview_complete')

  
  

  .. py:method:: wait(**kwargs)

    Polls :py:meth:`ECR.Client.get_lifecycle_policy_preview` every 5 seconds until a successful state is reached. An error is raised after 20 failed checks.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/GetLifecyclePolicyPreview>`_    


    **Request Syntax**
    ::

      waiter.wait(
          registryId='string',
          repositoryName='string',
          imageIds=[
              {
                  'imageDigest': 'string',
                  'imageTag': 'string'
              },
          ],
          nextToken='string',
          maxResults=123,
          filter={
              'tagStatus': 'TAGGED'|'UNTAGGED'|'ANY'
          },
          WaiterConfig={
              'Delay': 123,
              'MaxAttempts': 123
          }
      )
      
    :type registryId: string
    :param registryId: 

      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.

      

    
    :type repositoryName: string
    :param repositoryName: **[REQUIRED]** 

      The name of the repository.

      

    
    :type imageIds: list
    :param imageIds: 

      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.

          

        
      
  
    :type nextToken: string
    :param nextToken: 

      The ``nextToken`` value returned from a previous paginated  ``GetLifecyclePolicyPreviewRequest`` 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. This option cannot be used when you specify images with ``imageIds``.

      

    
    :type maxResults: integer
    :param maxResults: 

      The maximum number of repository results returned by ``GetLifecyclePolicyPreviewRequest`` in paginated output. When this parameter is used, ``GetLifecyclePolicyPreviewRequest`` 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 ``GetLifecyclePolicyPreviewRequest`` request with the returned ``nextToken``  value. This value can be between 1 and 100. If this parameter is not used, then ``GetLifecyclePolicyPreviewRequest`` returns up to 100 results and a ``nextToken`` value, if applicable. This option cannot be used when you specify images with ``imageIds``.

      

    
    :type filter: dict
    :param filter: 

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

      

    
      - **tagStatus** *(string) --* 

        The tag status of the image.

        

      
    
    :type WaiterConfig: dict
    :param WaiterConfig: 

      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: 20

        

      
    
    
    :returns: None