:doc:`BackupSearch <../../backupsearch>` / Client / list_search_job_results

***********************
list_search_job_results
***********************



.. py:method:: BackupSearch.Client.list_search_job_results(**kwargs)

  

  This operation returns a list of a specified search job.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/backupsearch-2018-05-10/ListSearchJobResults>`_  


  **Request Syntax**
  ::

    response = client.list_search_job_results(
        SearchJobIdentifier='string',
        NextToken='string',
        MaxResults=123
    )
    
  :type SearchJobIdentifier: string
  :param SearchJobIdentifier: **[REQUIRED]** 

    The unique string that specifies the search job.

    

  
  :type NextToken: string
  :param NextToken: 

    The next item following a partial list of returned search job results.

     

    For example, if a request is made to return ``MaxResults`` number of search job results, ``NextToken`` allows you to return more items in your list starting at the location pointed to by the next token.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of resource list items to be returned.

    

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

    
    ::

      {
          'Results': [
              {
                  'S3ResultItem': {
                      'BackupResourceArn': 'string',
                      'SourceResourceArn': 'string',
                      'BackupVaultName': 'string',
                      'ObjectKey': 'string',
                      'ObjectSize': 123,
                      'CreationTime': datetime(2015, 1, 1),
                      'ETag': 'string',
                      'VersionId': 'string'
                  },
                  'EBSResultItem': {
                      'BackupResourceArn': 'string',
                      'SourceResourceArn': 'string',
                      'BackupVaultName': 'string',
                      'FileSystemIdentifier': 'string',
                      'FilePath': 'string',
                      'FileSize': 123,
                      'CreationTime': datetime(2015, 1, 1),
                      'LastModifiedTime': datetime(2015, 1, 1)
                  }
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Results** *(list) --* 

        The results consist of either EBSResultItem or S3ResultItem.

        
        

        - *(dict) --* 

          This is an object representing the item returned in the results of a search for a specific resource type.

          .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``S3ResultItem``, ``EBSResultItem``.     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'}


        
          

          - **S3ResultItem** *(dict) --* 

            These are items returned in the search results of an Amazon S3 search.

            
            

            - **BackupResourceArn** *(string) --* 

              These are items in the returned results that match recovery point Amazon Resource Names (ARN) input during a search of Amazon S3 backup metadata.

              
            

            - **SourceResourceArn** *(string) --* 

              These are items in the returned results that match source Amazon Resource Names (ARN) input during a search of Amazon S3 backup metadata.

              
            

            - **BackupVaultName** *(string) --* 

              The name of the backup vault.

              
            

            - **ObjectKey** *(string) --* 

              This is one or more items returned in the results of a search of Amazon S3 backup metadata that match the values input for object key.

              
            

            - **ObjectSize** *(integer) --* 

              These are items in the returned results that match values for object size(s) input during a search of Amazon S3 backup metadata.

              
            

            - **CreationTime** *(datetime) --* 

              These are one or more items in the returned results that match values for item creation time input during a search of Amazon S3 backup metadata.

              
            

            - **ETag** *(string) --* 

              These are one or more items in the returned results that match values for ETags input during a search of Amazon S3 backup metadata.

              
            

            - **VersionId** *(string) --* 

              These are one or more items in the returned results that match values for version IDs input during a search of Amazon S3 backup metadata.

              
        
          

          - **EBSResultItem** *(dict) --* 

            These are items returned in the search results of an Amazon EBS search.

            
            

            - **BackupResourceArn** *(string) --* 

              These are one or more items in the results that match values for the Amazon Resource Name (ARN) of recovery points returned in a search of Amazon EBS backup metadata.

              
            

            - **SourceResourceArn** *(string) --* 

              These are one or more items in the results that match values for the Amazon Resource Name (ARN) of source resources returned in a search of Amazon EBS backup metadata.

              
            

            - **BackupVaultName** *(string) --* 

              The name of the backup vault.

              
            

            - **FileSystemIdentifier** *(string) --* 

              These are one or more items in the results that match values for file systems returned in a search of Amazon EBS backup metadata.

              
            

            - **FilePath** *(string) --* 

              These are one or more items in the results that match values for file paths returned in a search of Amazon EBS backup metadata.

              
            

            - **FileSize** *(integer) --* 

              These are one or more items in the results that match values for file sizes returned in a search of Amazon EBS backup metadata.

              
            

            - **CreationTime** *(datetime) --* 

              These are one or more items in the results that match values for creation times returned in a search of Amazon EBS backup metadata.

              
            

            - **LastModifiedTime** *(datetime) --* 

              These are one or more items in the results that match values for Last Modified Time returned in a search of Amazon EBS backup metadata.

              
        
      
    
      

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

        The next item following a partial list of search job results.

         

        For example, if a request is made to return ``MaxResults`` number of backups, ``NextToken`` allows you to return more items in your list starting at the location pointed to by the next token.

        
  
  **Exceptions**
  
  *   :py:class:`BackupSearch.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`BackupSearch.Client.exceptions.ThrottlingException`

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

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

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

  