BackupSearch / Client / list_search_job_backups

list_search_job_backups#

BackupSearch.Client.list_search_job_backups(**kwargs)#

This operation returns a list of all backups (recovery points) in a paginated format that were included in the search job.

If a search does not display an expected backup in the results, you can call this operation to display each backup included in the search. Any backups that were not included because they have a FAILED status from a permissions issue will be displayed, along with a status message.

Only recovery points with a backup index that has a status of ACTIVE will be included in search results. If the index has any other status, its status will be displayed along with a status message.

See also: AWS API Documentation

Request Syntax

response = client.list_search_job_backups(
    SearchJobIdentifier='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • SearchJobIdentifier (string) –

    [REQUIRED]

    The unique string that specifies the search job.

  • NextToken (string) –

    The next item following a partial list of returned backups included in a search job.

    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.

  • MaxResults (integer) – The maximum number of resource list items to be returned.

Return type:

dict

Returns:

Response Syntax

{
    'Results': [
        {
            'Status': 'RUNNING'|'COMPLETED'|'STOPPING'|'STOPPED'|'FAILED',
            'StatusMessage': 'string',
            'ResourceType': 'S3'|'EBS',
            'BackupResourceArn': 'string',
            'SourceResourceArn': 'string',
            'IndexCreationTime': datetime(2015, 1, 1),
            'BackupCreationTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Results (list) –

      The recovery points returned the results of a search job

      • (dict) –

        This contains the information about recovery points returned in results of a search job.

        • Status (string) –

          This is the status of the search job backup result.

        • StatusMessage (string) –

          This is the status message included with the results.

        • ResourceType (string) –

          This is the resource type of the search.

        • BackupResourceArn (string) –

          The Amazon Resource Name (ARN) that uniquely identifies the backup resources.

        • SourceResourceArn (string) –

          The Amazon Resource Name (ARN) that uniquely identifies the source resources.

        • IndexCreationTime (datetime) –

          This is the creation time of the backup index.

        • BackupCreationTime (datetime) –

          This is the creation time of the backup (recovery point).

    • NextToken (string) –

      The next item following a partial list of returned backups included in a search job.

      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