:doc:`PartnerCentralSellingAPI <../../partnercentral-selling>` / Paginator / ListResourceSnapshots

*********************
ListResourceSnapshots
*********************



.. py:class:: PartnerCentralSellingAPI.Paginator.ListResourceSnapshots

  ::

    
    paginator = client.get_paginator('list_resource_snapshots')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`PartnerCentralSellingAPI.Client.list_resource_snapshots`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListResourceSnapshots>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          Catalog='string',
          EngagementIdentifier='string',
          ResourceType='Opportunity',
          ResourceIdentifier='string',
          ResourceSnapshotTemplateIdentifier='string',
          CreatedBy='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type Catalog: string
    :param Catalog: **[REQUIRED]** 

      Specifies the catalog related to the request.

      

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

      The unique identifier of the engagement associated with the snapshots.

      

    
    :type ResourceType: string
    :param ResourceType: 

      Filters the response to include only snapshots of the specified resource type.

      

    
    :type ResourceIdentifier: string
    :param ResourceIdentifier: 

      Filters the response to include only snapshots of the specified resource.

      

    
    :type ResourceSnapshotTemplateIdentifier: string
    :param ResourceSnapshotTemplateIdentifier: 

      Filters the response to include only snapshots created using the specified template.

      

    
    :type CreatedBy: string
    :param CreatedBy: 

      Filters the response to include only snapshots of resources owned by the specified AWS account.

      

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

      
      ::

        {
            'ResourceSnapshotSummaries': [
                {
                    'Arn': 'string',
                    'Revision': 123,
                    'ResourceType': 'Opportunity',
                    'ResourceId': 'string',
                    'ResourceSnapshotTemplateName': 'string',
                    'CreatedBy': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **ResourceSnapshotSummaries** *(list) --* 

          An array of resource snapshot summary objects.

          
          

          - *(dict) --* 

            Provides a concise summary of a resource snapshot, including its unique identifier and version information. This structure is used to quickly reference and identify specific versions of resource snapshots.

            
            

            - **Arn** *(string) --* 

              The Amazon Resource Name (ARN) of the snapshot. This globally unique identifier can be used for cross-service references and in IAM policies.

              
            

            - **Revision** *(integer) --* 

              The revision number of the snapshot. This integer value is incremented each time the snapshot is updated, allowing for version tracking of the resource snapshot.

              
            

            - **ResourceType** *(string) --* 

              The type of resource snapshotted.

              
            

            - **ResourceId** *(string) --* 

              The identifier of the specific resource snapshotted. The format might vary depending on the ResourceType.

              
            

            - **ResourceSnapshotTemplateName** *(string) --* 

              The name of the template used to create the snapshot.

              
            

            - **CreatedBy** *(string) --* 

              The AWS account ID of the entity that owns the resource from which the snapshot was created.

              
        
      
    