:doc:`Inspector2 <../../inspector2>` / Paginator / GetClustersForImage

*******************
GetClustersForImage
*******************



.. py:class:: Inspector2.Paginator.GetClustersForImage

  ::

    
    paginator = client.get_paginator('get_clusters_for_image')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`Inspector2.Client.get_clusters_for_image`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/inspector2-2020-06-08/GetClustersForImage>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          filter={
              'resourceId': 'string'
          },
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type filter: dict
    :param filter: **[REQUIRED]** 

      The resource Id for the Amazon ECR image.

      

    
      - **resourceId** *(string) --* **[REQUIRED]** 

        The resource Id to be used in the filter criteria.

        

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

      
      ::

        {
            'cluster': [
                {
                    'clusterArn': 'string',
                    'clusterDetails': [
                        {
                            'lastInUse': datetime(2015, 1, 1),
                            'runningUnitCount': 123,
                            'stoppedUnitCount': 123,
                            'clusterMetadata': {
                                'awsEcsMetadataDetails': {
                                    'detailsGroup': 'string',
                                    'taskDefinitionArn': 'string'
                                },
                                'awsEksMetadataDetails': {
                                    'namespace': 'string',
                                    'workloadInfoList': [
                                        {
                                            'name': 'string',
                                            'type': 'string'
                                        },
                                    ]
                                }
                            }
                        },
                    ]
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **cluster** *(list) --* 

          A unit of work inside of a cluster, which can include metadata about the cluster.

          
          

          - *(dict) --* 

            Information about the cluster.

            
            

            - **clusterArn** *(string) --* 

              The cluster ARN.

              
            

            - **clusterDetails** *(list) --* 

              Details about the cluster.

              
              

              - *(dict) --* 

                Details about the task or pod in the cluster.

                
                

                - **lastInUse** *(datetime) --* 

                  The last timestamp when Amazon Inspector recorded the image in use in the task or pod in the cluster.

                  
                

                - **runningUnitCount** *(integer) --* 

                  The number of tasks or pods where an image was running on the cluster.

                  
                

                - **stoppedUnitCount** *(integer) --* 

                  The number of tasks or pods where an image was stopped on the cluster in the last 24 hours.

                  
                

                - **clusterMetadata** *(dict) --* 

                  The metadata for a cluster.

                  .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``awsEcsMetadataDetails``, ``awsEksMetadataDetails``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                                    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


                
                  

                  - **awsEcsMetadataDetails** *(dict) --* 

                    The details for an Amazon ECS cluster in the cluster metadata.

                    
                    

                    - **detailsGroup** *(string) --* 

                      The details group information for a task in a cluster.

                      
                    

                    - **taskDefinitionArn** *(string) --* 

                      The task definition ARN.

                      
                
                  

                  - **awsEksMetadataDetails** *(dict) --* 

                    The details for an Amazon EKS cluster in the cluster metadata.

                    
                    

                    - **namespace** *(string) --* 

                      The namespace for an Amazon EKS cluster.

                      
                    

                    - **workloadInfoList** *(list) --* 

                      The list of workloads.

                      
                      

                      - *(dict) --* 

                        Information about the workload.

                        
                        

                        - **name** *(string) --* 

                          The name of the workload.

                          
                        

                        - **type** *(string) --* 

                          The workload type.

                          
                    
                  
                
              
            
          
        
      
        

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

          A token to resume pagination.

          
    