:doc:`PartnerCentralSellingAPI <../../partnercentral-selling>` / Client / list_resource_snapshots

***********************
list_resource_snapshots
***********************



.. py:method:: PartnerCentralSellingAPI.Client.list_resource_snapshots(**kwargs)

  

  Retrieves a list of resource view snapshots based on specified criteria. This operation supports various use cases, including:

   

  
  * Fetching all snapshots associated with an engagement.
   
  * Retrieving snapshots of a specific resource type within an engagement.
   
  * Obtaining snapshots for a particular resource using a specified template.
   
  * Accessing the latest snapshot of a resource within an engagement.
   
  * Filtering snapshots by resource owner.
  

  

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


  **Request Syntax**
  ::

    response = client.list_resource_snapshots(
        Catalog='string',
        MaxResults=123,
        NextToken='string',
        EngagementIdentifier='string',
        ResourceType='Opportunity',
        ResourceIdentifier='string',
        ResourceSnapshotTemplateIdentifier='string',
        CreatedBy='string'
    )
    
  :type Catalog: string
  :param Catalog: **[REQUIRED]** 

    Specifies the catalog related to the request.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return in a single call.

    

  
  :type NextToken: string
  :param NextToken: 

    The token for the next set of results.

    

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

    

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

    
    ::

      {
          'ResourceSnapshotSummaries': [
              {
                  'Arn': 'string',
                  'Revision': 123,
                  'ResourceType': 'Opportunity',
                  'ResourceId': 'string',
                  'ResourceSnapshotTemplateName': 'string',
                  'CreatedBy': 'string'
              },
          ],
          'NextToken': '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.

            
      
    
      

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

        The token to retrieve the next set of results. If there are no additional results, this value is null.

        
  
  **Exceptions**
  
  *   :py:class:`PartnerCentralSellingAPI.Client.exceptions.ThrottlingException`

  
  *   :py:class:`PartnerCentralSellingAPI.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`PartnerCentralSellingAPI.Client.exceptions.InternalServerException`

  
  *   :py:class:`PartnerCentralSellingAPI.Client.exceptions.ValidationException`

  
  *   :py:class:`PartnerCentralSellingAPI.Client.exceptions.ResourceNotFoundException`

  