Skip to content

BackupSearchClient#

Index > BackupSearch > BackupSearchClient

Auto-generated documentation for BackupSearch type annotations stubs module types-boto3-backupsearch.

BackupSearchClient#

Type annotations and code completion for boto3.client("backupsearch"). boto3 documentation

# BackupSearchClient usage example

from boto3.session import Session
from types_boto3_backupsearch.client import BackupSearchClient

def get_backupsearch_client() -> BackupSearchClient:
    return Session().client("backupsearch")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("backupsearch").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("backupsearch")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from types_boto3_backupsearch.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("backupsearch").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("backupsearch").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_search_job#

This operation retrieves metadata of a search job, including its progress.

Type annotations and code completion for boto3.client("backupsearch").get_search_job method. boto3 documentation

# get_search_job method definition

def get_search_job(
    self,
    *,
    SearchJobIdentifier: str,
) -> GetSearchJobOutputTypeDef:  # (1)
    ...
  1. See GetSearchJobOutputTypeDef 
# get_search_job method usage example with argument unpacking

kwargs: GetSearchJobInputRequestTypeDef = {  # (1)
    "SearchJobIdentifier": ...,
}

parent.get_search_job(**kwargs)
  1. See GetSearchJobInputRequestTypeDef

get_search_result_export_job#

This operation retrieves the metadata of an export job.

Type annotations and code completion for boto3.client("backupsearch").get_search_result_export_job method. boto3 documentation

# get_search_result_export_job method definition

def get_search_result_export_job(
    self,
    *,
    ExportJobIdentifier: str,
) -> GetSearchResultExportJobOutputTypeDef:  # (1)
    ...
  1. See GetSearchResultExportJobOutputTypeDef 
# get_search_result_export_job method usage example with argument unpacking

kwargs: GetSearchResultExportJobInputRequestTypeDef = {  # (1)
    "ExportJobIdentifier": ...,
}

parent.get_search_result_export_job(**kwargs)
  1. See GetSearchResultExportJobInputRequestTypeDef

list_search_job_backups#

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

Type annotations and code completion for boto3.client("backupsearch").list_search_job_backups method. boto3 documentation

# list_search_job_backups method definition

def list_search_job_backups(
    self,
    *,
    SearchJobIdentifier: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListSearchJobBackupsOutputTypeDef:  # (1)
    ...
  1. See ListSearchJobBackupsOutputTypeDef 
# list_search_job_backups method usage example with argument unpacking

kwargs: ListSearchJobBackupsInputRequestTypeDef = {  # (1)
    "SearchJobIdentifier": ...,
}

parent.list_search_job_backups(**kwargs)
  1. See ListSearchJobBackupsInputRequestTypeDef

list_search_job_results#

This operation returns a list of a specified search job.

Type annotations and code completion for boto3.client("backupsearch").list_search_job_results method. boto3 documentation

# list_search_job_results method definition

def list_search_job_results(
    self,
    *,
    SearchJobIdentifier: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListSearchJobResultsOutputTypeDef:  # (1)
    ...
  1. See ListSearchJobResultsOutputTypeDef 
# list_search_job_results method usage example with argument unpacking

kwargs: ListSearchJobResultsInputRequestTypeDef = {  # (1)
    "SearchJobIdentifier": ...,
}

parent.list_search_job_results(**kwargs)
  1. See ListSearchJobResultsInputRequestTypeDef

list_search_jobs#

This operation returns a list of search jobs belonging to an account.

Type annotations and code completion for boto3.client("backupsearch").list_search_jobs method. boto3 documentation

# list_search_jobs method definition

def list_search_jobs(
    self,
    *,
    ByStatus: SearchJobStateType = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListSearchJobsOutputTypeDef:  # (2)
    ...
  1. See SearchJobStateType
  2. See ListSearchJobsOutputTypeDef 
# list_search_jobs method usage example with argument unpacking

kwargs: ListSearchJobsInputRequestTypeDef = {  # (1)
    "ByStatus": ...,
}

parent.list_search_jobs(**kwargs)
  1. See ListSearchJobsInputRequestTypeDef

list_search_result_export_jobs#

This operation exports search results of a search job to a specified destination S3 bucket.

Type annotations and code completion for boto3.client("backupsearch").list_search_result_export_jobs method. boto3 documentation

# list_search_result_export_jobs method definition

def list_search_result_export_jobs(
    self,
    *,
    Status: ExportJobStatusType = ...,  # (1)
    SearchJobIdentifier: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListSearchResultExportJobsOutputTypeDef:  # (2)
    ...
  1. See ExportJobStatusType
  2. See ListSearchResultExportJobsOutputTypeDef 
# list_search_result_export_jobs method usage example with argument unpacking

kwargs: ListSearchResultExportJobsInputRequestTypeDef = {  # (1)
    "Status": ...,
}

parent.list_search_result_export_jobs(**kwargs)
  1. See ListSearchResultExportJobsInputRequestTypeDef

list_tags_for_resource#

This operation returns the tags for a resource type.

Type annotations and code completion for boto3.client("backupsearch").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

start_search_job#

This operation creates a search job which returns recovery points filtered by SearchScope and items filtered by ItemFilters.

Type annotations and code completion for boto3.client("backupsearch").start_search_job method. boto3 documentation

# start_search_job method definition

def start_search_job(
    self,
    *,
    SearchScope: SearchScopeTypeDef,  # (1)
    Tags: Mapping[str, str] = ...,
    Name: str = ...,
    EncryptionKeyArn: str = ...,
    ClientToken: str = ...,
    ItemFilters: ItemFiltersTypeDef = ...,  # (2)
) -> StartSearchJobOutputTypeDef:  # (3)
    ...
  1. See SearchScopeTypeDef
  2. See ItemFiltersTypeDef
  3. See StartSearchJobOutputTypeDef 
# start_search_job method usage example with argument unpacking

kwargs: StartSearchJobInputRequestTypeDef = {  # (1)
    "SearchScope": ...,
}

parent.start_search_job(**kwargs)
  1. See StartSearchJobInputRequestTypeDef

start_search_result_export_job#

This operations starts a job to export the results of search job to a designated S3 bucket.

Type annotations and code completion for boto3.client("backupsearch").start_search_result_export_job method. boto3 documentation

# start_search_result_export_job method definition

def start_search_result_export_job(
    self,
    *,
    SearchJobIdentifier: str,
    ExportSpecification: ExportSpecificationTypeDef,  # (1)
    ClientToken: str = ...,
    Tags: Mapping[str, str] = ...,
    RoleArn: str = ...,
) -> StartSearchResultExportJobOutputTypeDef:  # (2)
    ...
  1. See ExportSpecificationTypeDef
  2. See StartSearchResultExportJobOutputTypeDef 
# start_search_result_export_job method usage example with argument unpacking

kwargs: StartSearchResultExportJobInputRequestTypeDef = {  # (1)
    "SearchJobIdentifier": ...,
    "ExportSpecification": ...,
}

parent.start_search_result_export_job(**kwargs)
  1. See StartSearchResultExportJobInputRequestTypeDef

stop_search_job#

This operations ends a search job.

Type annotations and code completion for boto3.client("backupsearch").stop_search_job method. boto3 documentation

# stop_search_job method definition

def stop_search_job(
    self,
    *,
    SearchJobIdentifier: str,
) -> dict[str, Any]:
    ...
# stop_search_job method usage example with argument unpacking

kwargs: StopSearchJobInputRequestTypeDef = {  # (1)
    "SearchJobIdentifier": ...,
}

parent.stop_search_job(**kwargs)
  1. See StopSearchJobInputRequestTypeDef

tag_resource#

This operation puts tags on the resource you indicate.

Type annotations and code completion for boto3.client("backupsearch").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource#

This operation removes tags from the specified resource.

Type annotations and code completion for boto3.client("backupsearch").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("backupsearch").get_paginator method with overloads.