Skip to content

GetSearchJobOutput

Source code in docs_src/capo_backupsearch/types/get_search_job_output.py
class GetSearchJobOutput(TypedDict, closed=True):
    name: NotRequired["str"]
    """<p>Returned name of the specified search job.</p>"""
    search_scope_summary: NotRequired[
        "capo_backupsearch.types.search_scope_summary.SearchScopeSummary"
    ]
    """<p>Returned summary of the specified search job scope, including: </p> <ul> <li> <p>TotalBackupsToScanCount, the number of recovery points returned by the search.</p> </li> <li> <p>TotalItemsToScanCount, the number of items returned by the search.</p> </li> </ul>"""
    current_search_progress: NotRequired[
        "capo_backupsearch.types.current_search_progress.CurrentSearchProgress"
    ]
    """<p>Returns numbers representing BackupsScannedCount, ItemsScanned, and ItemsMatched.</p>"""
    status_message: NotRequired["str"]
    """<p>A status message will be returned for either a earch job with a status of <code>ERRORED</code> or a status of <code>COMPLETED</code> jobs with issues.</p> <p>For example, a message may say that a search contained recovery points unable to be scanned because of a permissions issue.</p>"""
    encryption_key_arn: NotRequired[
        "capo_backupsearch.types.encryption_key_arn.EncryptionKeyArn"
    ]
    """<p>The encryption key for the specified search job.</p> <p>Example: <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>"""
    completion_time: NotRequired["datetime.datetime"]
    """<p>The date and time that a search job completed, in Unix format and Coordinated Universal Time (UTC). The value of <code>CompletionTime</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"""
    status: "capo_backupsearch.types.search_job_state.SearchJobState"
    """<p>The current status of the specified search job.</p> <p>A search job may have one of the following statuses: <code>RUNNING</code>; <code>COMPLETED</code>; <code>STOPPED</code>; <code>FAILED</code>; <code>TIMED_OUT</code>; or <code>EXPIRED</code> .</p>"""
    search_scope: "capo_backupsearch.types.search_scope.SearchScope"
    """<p>The search scope is all backup properties input into a search.</p>"""
    item_filters: "capo_backupsearch.types.item_filters.ItemFilters"
    """<p>Item Filters represent all input item properties specified when the search was created.</p>"""
    creation_time: "datetime.datetime"
    """<p>The date and time that a search job was created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CompletionTime</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"""
    search_job_identifier: "capo_backupsearch.types.generic_id.GenericId"
    """<p>The unique string that identifies the specified search job.</p>"""
    search_job_arn: "capo_backupsearch.types.search_job_arn.SearchJobArn"
    """<p>The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.</p>"""

completion_time instance-attribute

completion_time: NotRequired[datetime]

The date and time that a search job completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

creation_time instance-attribute

creation_time: datetime

The date and time that a search job was created, in Unix format and Coordinated Universal Time (UTC). The value of CompletionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

current_search_progress instance-attribute

current_search_progress: NotRequired[CurrentSearchProgress]

Returns numbers representing BackupsScannedCount, ItemsScanned, and ItemsMatched.

encryption_key_arn instance-attribute

encryption_key_arn: NotRequired[EncryptionKeyArn]

The encryption key for the specified search job.

Example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

item_filters instance-attribute

item_filters: ItemFilters

Item Filters represent all input item properties specified when the search was created.

name instance-attribute

name: NotRequired[str]

Returned name of the specified search job.

search_job_arn instance-attribute

search_job_arn: SearchJobArn

The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.

search_job_identifier instance-attribute

search_job_identifier: GenericId

The unique string that identifies the specified search job.

search_scope instance-attribute

search_scope: SearchScope

The search scope is all backup properties input into a search.

search_scope_summary instance-attribute

search_scope_summary: NotRequired[SearchScopeSummary]

Returned summary of the specified search job scope, including:

  • TotalBackupsToScanCount, the number of recovery points returned by the search.

  • TotalItemsToScanCount, the number of items returned by the search.

status instance-attribute

The current status of the specified search job.

A search job may have one of the following statuses: RUNNING; COMPLETED; STOPPED; FAILED; TIMED_OUT; or EXPIRED .

status_message instance-attribute

status_message: NotRequired[str]

A status message will be returned for either a earch job with a status of ERRORED or a status of COMPLETED jobs with issues.

For example, a message may say that a search contained recovery points unable to be scanned because of a permissions issue.