BackupSearch / Paginator / ListSearchJobResults

ListSearchJobResults

class BackupSearch.Paginator.ListSearchJobResults

paginator = client.get_paginator('list_search_job_results')

paginate(**kwargs)

Creates an iterator that will paginate through responses from BackupSearch.Client.list_search_job_results().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    SearchJobIdentifier='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• SearchJobIdentifier (string) –

  [REQUIRED]

  The unique string that specifies the search job.

• PaginationConfig (dict) –

  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.

Return type:

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)
            }
        },
    ],

}

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.