:doc:`ECR <../../ecr>` / Paginator / DescribePullThroughCacheRules

*****************************
DescribePullThroughCacheRules
*****************************



.. py:class:: ECR.Paginator.DescribePullThroughCacheRules

  ::

    
    paginator = client.get_paginator('describe_pull_through_cache_rules')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`ECR.Client.describe_pull_through_cache_rules`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          registryId='string',
          ecrRepositoryPrefixes=[
              'string',
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type registryId: string
    :param registryId: 

      The Amazon Web Services account ID associated with the registry to return the pull through cache rules for. If you do not specify a registry, the default registry is assumed.

      

    
    :type ecrRepositoryPrefixes: list
    :param ecrRepositoryPrefixes: 

      The Amazon ECR repository prefixes associated with the pull through cache rules to return. If no repository prefix value is specified, all pull through cache rules are returned.

      

    
      - *(string) --* 

      
  
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'pullThroughCacheRules': [
                {
                    'ecrRepositoryPrefix': 'string',
                    'upstreamRegistryUrl': 'string',
                    'createdAt': datetime(2015, 1, 1),
                    'registryId': 'string',
                    'credentialArn': 'string',
                    'customRoleArn': 'string',
                    'upstreamRepositoryPrefix': 'string',
                    'upstreamRegistry': 'ecr'|'ecr-public'|'quay'|'k8s'|'docker-hub'|'github-container-registry'|'azure-container-registry'|'gitlab-container-registry',
                    'updatedAt': datetime(2015, 1, 1)
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **pullThroughCacheRules** *(list) --* 

          The details of the pull through cache rules.

          
          

          - *(dict) --* 

            The details of a pull through cache rule.

            
            

            - **ecrRepositoryPrefix** *(string) --* 

              The Amazon ECR repository prefix associated with the pull through cache rule.

              
            

            - **upstreamRegistryUrl** *(string) --* 

              The upstream registry URL associated with the pull through cache rule.

              
            

            - **createdAt** *(datetime) --* 

              The date and time the pull through cache was created.

              
            

            - **registryId** *(string) --* 

              The Amazon Web Services account ID associated with the registry the pull through cache rule is associated with.

              
            

            - **credentialArn** *(string) --* 

              The ARN of the Secrets Manager secret associated with the pull through cache rule.

              
            

            - **customRoleArn** *(string) --* 

              The ARN of the IAM role associated with the pull through cache rule.

              
            

            - **upstreamRepositoryPrefix** *(string) --* 

              The upstream repository prefix associated with the pull through cache rule.

              
            

            - **upstreamRegistry** *(string) --* 

              The name of the upstream source registry associated with the pull through cache rule.

              
            

            - **updatedAt** *(datetime) --* 

              The date and time, in JavaScript date format, when the pull through cache rule was last updated.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    