Skip to content

SearchJobSummary

Source code in docs_src/capo_backupsearch/types/search_job_summary.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class SearchJobSummary(TypedDict, closed=True):
    search_job_identifier: NotRequired["capo_backupsearch.types.generic_id.GenericId"]
    """<p>The unique string that specifies the search job.</p>"""
    search_job_arn: NotRequired["capo_backupsearch.types.search_job_arn.SearchJobArn"]
    """<p>The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.</p>"""
    name: NotRequired["str"]
    """<p>This is the name of the search job.</p>"""
    status: NotRequired["capo_backupsearch.types.search_job_state.SearchJobState"]
    """<p>This is the status of the search job.</p>"""
    creation_time: NotRequired["datetime.datetime"]
    """<p>This is the creation time of the search job.</p>"""
    completion_time: NotRequired["datetime.datetime"]
    """<p>This is the completion time of the 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>"""
    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>"""

completion_time instance-attribute 

completion_time: NotRequired[datetime]

This is the completion time of the search job.

creation_time instance-attribute 

creation_time: NotRequired[datetime]

This is the creation time of the search job.

name instance-attribute 

name: NotRequired[str]

This is the name of the search job.

search_job_arn instance-attribute 

search_job_arn: NotRequired[SearchJobArn]

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

search_job_identifier instance-attribute 

search_job_identifier: NotRequired[GenericId]

The unique string that specifies the search job.

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 

status: NotRequired[SearchJobState]

This is the status of the search job.

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.