Skip to content

StartSearchJobInput

Source code in docs_src/capo_backupsearch/types/start_search_job_input.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class StartSearchJobInput(TypedDict, closed=True):
    tags: NotRequired["capo_backupsearch.types.tag_map.TagMap"]
    """<p>List of tags returned by the operation.</p>"""
    name: NotRequired["str"]
    """<p>Include alphanumeric characters to create a name for this search job.</p>"""
    encryption_key_arn: NotRequired[
        "capo_backupsearch.types.encryption_key_arn.EncryptionKeyArn"
    ]
    """<p>The encryption key for the specified search job.</p>"""
    client_token: NotRequired["str"]
    """<p>Include this parameter to allow multiple identical calls for idempotency.</p> <p>A client token is valid for 8 hours after the first request that uses it is completed. After this time, any request with the same token is treated as a new request.</p>"""
    search_scope: "capo_backupsearch.types.search_scope.SearchScope"
    """<p>This object can contain BackupResourceTypes, BackupResourceArns, BackupResourceCreationTime, BackupResourceTags, and SourceResourceArns to filter the recovery points returned by the search job.</p>"""
    item_filters: NotRequired["capo_backupsearch.types.item_filters.ItemFilters"]
    """<p>Item Filters represent all input item properties specified when the search was created.</p> <p>Contains either EBSItemFilters or S3ItemFilters</p>"""

client_token instance-attribute 

client_token: NotRequired[str]

Include this parameter to allow multiple identical calls for idempotency.

A client token is valid for 8 hours after the first request that uses it is completed. After this time, any request with the same token is treated as a new request.

encryption_key_arn instance-attribute 

encryption_key_arn: NotRequired[EncryptionKeyArn]

The encryption key for the specified search job.

item_filters instance-attribute 

item_filters: NotRequired[ItemFilters]

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

Contains either EBSItemFilters or S3ItemFilters

name instance-attribute 

name: NotRequired[str]

Include alphanumeric characters to create a name for this search job.

search_scope instance-attribute 

search_scope: SearchScope

This object can contain BackupResourceTypes, BackupResourceArns, BackupResourceCreationTime, BackupResourceTags, and SourceResourceArns to filter the recovery points returned by the search job.

tags instance-attribute 

tags: NotRequired[TagMap]

List of tags returned by the operation.