Skip to content

Type definitions#

Index > BackupSearch > Type definitions

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

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

BackupCreationTimeFilterUnionTypeDef#

# BackupCreationTimeFilterUnionTypeDef definition

BackupCreationTimeFilterUnionTypeDef = Union[
    BackupCreationTimeFilterTypeDef,  # (1)
    BackupCreationTimeFilterOutputTypeDef,  # (2)
]
  1. See BackupCreationTimeFilterTypeDef
  2. See BackupCreationTimeFilterOutputTypeDef

TimeConditionUnionTypeDef#

# TimeConditionUnionTypeDef definition

TimeConditionUnionTypeDef = Union[
    TimeConditionTypeDef,  # (1)
    TimeConditionOutputTypeDef,  # (2)
]
  1. See TimeConditionTypeDef
  2. See TimeConditionOutputTypeDef

S3ItemFilterUnionTypeDef#

# S3ItemFilterUnionTypeDef definition

S3ItemFilterUnionTypeDef = Union[
    S3ItemFilterTypeDef,  # (1)
    S3ItemFilterOutputTypeDef,  # (2)
]
  1. See S3ItemFilterTypeDef
  2. See S3ItemFilterOutputTypeDef

EBSItemFilterUnionTypeDef#

# EBSItemFilterUnionTypeDef definition

EBSItemFilterUnionTypeDef = Union[
    EBSItemFilterTypeDef,  # (1)
    EBSItemFilterOutputTypeDef,  # (2)
]
  1. See EBSItemFilterTypeDef
  2. See EBSItemFilterOutputTypeDef

BackupCreationTimeFilterOutputTypeDef#

# BackupCreationTimeFilterOutputTypeDef definition

class BackupCreationTimeFilterOutputTypeDef(TypedDict):
    CreatedAfter: NotRequired[datetime],
    CreatedBefore: NotRequired[datetime],

CurrentSearchProgressTypeDef#

# CurrentSearchProgressTypeDef definition

class CurrentSearchProgressTypeDef(TypedDict):
    RecoveryPointsScannedCount: NotRequired[int],
    ItemsScannedCount: NotRequired[int],
    ItemsMatchedCount: NotRequired[int],

LongConditionTypeDef#

# LongConditionTypeDef definition

class LongConditionTypeDef(TypedDict):
    Value: int,
    Operator: NotRequired[LongConditionOperatorType],  # (1)
  1. See LongConditionOperatorType

StringConditionTypeDef#

# StringConditionTypeDef definition

class StringConditionTypeDef(TypedDict):
    Value: str,
    Operator: NotRequired[StringConditionOperatorType],  # (1)
  1. See StringConditionOperatorType

TimeConditionOutputTypeDef#

# TimeConditionOutputTypeDef definition

class TimeConditionOutputTypeDef(TypedDict):
    Value: datetime,
    Operator: NotRequired[TimeConditionOperatorType],  # (1)
  1. See TimeConditionOperatorType

EBSResultItemTypeDef#

# EBSResultItemTypeDef definition

class EBSResultItemTypeDef(TypedDict):
    BackupResourceArn: NotRequired[str],
    SourceResourceArn: NotRequired[str],
    BackupVaultName: NotRequired[str],
    FileSystemIdentifier: NotRequired[str],
    FilePath: NotRequired[str],
    FileSize: NotRequired[int],
    CreationTime: NotRequired[datetime],
    LastModifiedTime: NotRequired[datetime],

ExportJobSummaryTypeDef#

# ExportJobSummaryTypeDef definition

class ExportJobSummaryTypeDef(TypedDict):
    ExportJobIdentifier: str,
    ExportJobArn: NotRequired[str],
    Status: NotRequired[ExportJobStatusType],  # (1)
    CreationTime: NotRequired[datetime],
    CompletionTime: NotRequired[datetime],
    StatusMessage: NotRequired[str],
    SearchJobArn: NotRequired[str],
  1. See ExportJobStatusType

S3ExportSpecificationTypeDef#

# S3ExportSpecificationTypeDef definition

class S3ExportSpecificationTypeDef(TypedDict):
    DestinationBucket: str,
    DestinationPrefix: NotRequired[str],

GetSearchJobInputRequestTypeDef#

# GetSearchJobInputRequestTypeDef definition

class GetSearchJobInputRequestTypeDef(TypedDict):
    SearchJobIdentifier: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

SearchScopeSummaryTypeDef#

# SearchScopeSummaryTypeDef definition

class SearchScopeSummaryTypeDef(TypedDict):
    TotalRecoveryPointsToScanCount: NotRequired[int],
    TotalItemsToScanCount: NotRequired[int],

GetSearchResultExportJobInputRequestTypeDef#

# GetSearchResultExportJobInputRequestTypeDef definition

class GetSearchResultExportJobInputRequestTypeDef(TypedDict):
    ExportJobIdentifier: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListSearchJobBackupsInputRequestTypeDef#

# ListSearchJobBackupsInputRequestTypeDef definition

class ListSearchJobBackupsInputRequestTypeDef(TypedDict):
    SearchJobIdentifier: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

SearchJobBackupsResultTypeDef#

# SearchJobBackupsResultTypeDef definition

class SearchJobBackupsResultTypeDef(TypedDict):
    Status: NotRequired[SearchJobStateType],  # (1)
    StatusMessage: NotRequired[str],
    ResourceType: NotRequired[ResourceTypeType],  # (2)
    BackupResourceArn: NotRequired[str],
    SourceResourceArn: NotRequired[str],
    IndexCreationTime: NotRequired[datetime],
    BackupCreationTime: NotRequired[datetime],
  1. See SearchJobStateType
  2. See ResourceTypeType

ListSearchJobResultsInputRequestTypeDef#

# ListSearchJobResultsInputRequestTypeDef definition

class ListSearchJobResultsInputRequestTypeDef(TypedDict):
    SearchJobIdentifier: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListSearchJobsInputRequestTypeDef#

# ListSearchJobsInputRequestTypeDef definition

class ListSearchJobsInputRequestTypeDef(TypedDict):
    ByStatus: NotRequired[SearchJobStateType],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See SearchJobStateType

ListSearchResultExportJobsInputRequestTypeDef#

# ListSearchResultExportJobsInputRequestTypeDef definition

class ListSearchResultExportJobsInputRequestTypeDef(TypedDict):
    Status: NotRequired[ExportJobStatusType],  # (1)
    SearchJobIdentifier: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See ExportJobStatusType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

S3ResultItemTypeDef#

# S3ResultItemTypeDef definition

class S3ResultItemTypeDef(TypedDict):
    BackupResourceArn: NotRequired[str],
    SourceResourceArn: NotRequired[str],
    BackupVaultName: NotRequired[str],
    ObjectKey: NotRequired[str],
    ObjectSize: NotRequired[int],
    CreationTime: NotRequired[datetime],
    ETag: NotRequired[str],
    VersionId: NotRequired[str],

StopSearchJobInputRequestTypeDef#

# StopSearchJobInputRequestTypeDef definition

class StopSearchJobInputRequestTypeDef(TypedDict):
    SearchJobIdentifier: str,

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

SearchScopeOutputTypeDef#

# SearchScopeOutputTypeDef definition

class SearchScopeOutputTypeDef(TypedDict):
    BackupResourceTypes: list[ResourceTypeType],  # (1)
    BackupResourceCreationTime: NotRequired[BackupCreationTimeFilterOutputTypeDef],  # (2)
    SourceResourceArns: NotRequired[list[str]],
    BackupResourceArns: NotRequired[list[str]],
    BackupResourceTags: NotRequired[dict[str, str]],
  1. See ResourceTypeType
  2. See BackupCreationTimeFilterOutputTypeDef

BackupCreationTimeFilterTypeDef#

# BackupCreationTimeFilterTypeDef definition

class BackupCreationTimeFilterTypeDef(TypedDict):
    CreatedAfter: NotRequired[TimestampTypeDef],
    CreatedBefore: NotRequired[TimestampTypeDef],

TimeConditionTypeDef#

# TimeConditionTypeDef definition

class TimeConditionTypeDef(TypedDict):
    Value: TimestampTypeDef,
    Operator: NotRequired[TimeConditionOperatorType],  # (1)
  1. See TimeConditionOperatorType

EBSItemFilterOutputTypeDef#

# EBSItemFilterOutputTypeDef definition

class EBSItemFilterOutputTypeDef(TypedDict):
    FilePaths: NotRequired[list[StringConditionTypeDef]],  # (1)
    Sizes: NotRequired[list[LongConditionTypeDef]],  # (2)
    CreationTimes: NotRequired[list[TimeConditionOutputTypeDef]],  # (3)
    LastModificationTimes: NotRequired[list[TimeConditionOutputTypeDef]],  # (3)
  1. See StringConditionTypeDef
  2. See LongConditionTypeDef
  3. See TimeConditionOutputTypeDef
  4. See TimeConditionOutputTypeDef

S3ItemFilterOutputTypeDef#

# S3ItemFilterOutputTypeDef definition

class S3ItemFilterOutputTypeDef(TypedDict):
    ObjectKeys: NotRequired[list[StringConditionTypeDef]],  # (1)
    Sizes: NotRequired[list[LongConditionTypeDef]],  # (2)
    CreationTimes: NotRequired[list[TimeConditionOutputTypeDef]],  # (3)
    VersionIds: NotRequired[list[StringConditionTypeDef]],  # (1)
    ETags: NotRequired[list[StringConditionTypeDef]],  # (1)
  1. See StringConditionTypeDef
  2. See LongConditionTypeDef
  3. See TimeConditionOutputTypeDef
  4. See StringConditionTypeDef
  5. See StringConditionTypeDef

ExportSpecificationTypeDef#

# ExportSpecificationTypeDef definition

class ExportSpecificationTypeDef(TypedDict):
    s3ExportSpecification: NotRequired[S3ExportSpecificationTypeDef],  # (1)
  1. See S3ExportSpecificationTypeDef

ListSearchResultExportJobsOutputTypeDef#

# ListSearchResultExportJobsOutputTypeDef definition

class ListSearchResultExportJobsOutputTypeDef(TypedDict):
    ExportJobs: list[ExportJobSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ExportJobSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartSearchJobOutputTypeDef#

# StartSearchJobOutputTypeDef definition

class StartSearchJobOutputTypeDef(TypedDict):
    SearchJobArn: str,
    CreationTime: datetime,
    SearchJobIdentifier: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartSearchResultExportJobOutputTypeDef#

# StartSearchResultExportJobOutputTypeDef definition

class StartSearchResultExportJobOutputTypeDef(TypedDict):
    ExportJobArn: str,
    ExportJobIdentifier: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

SearchJobSummaryTypeDef#

# SearchJobSummaryTypeDef definition

class SearchJobSummaryTypeDef(TypedDict):
    SearchJobIdentifier: NotRequired[str],
    SearchJobArn: NotRequired[str],
    Name: NotRequired[str],
    Status: NotRequired[SearchJobStateType],  # (1)
    CreationTime: NotRequired[datetime],
    CompletionTime: NotRequired[datetime],
    SearchScopeSummary: NotRequired[SearchScopeSummaryTypeDef],  # (2)
    StatusMessage: NotRequired[str],
  1. See SearchJobStateType
  2. See SearchScopeSummaryTypeDef

ListSearchJobBackupsInputPaginateTypeDef#

# ListSearchJobBackupsInputPaginateTypeDef definition

class ListSearchJobBackupsInputPaginateTypeDef(TypedDict):
    SearchJobIdentifier: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListSearchJobResultsInputPaginateTypeDef#

# ListSearchJobResultsInputPaginateTypeDef definition

class ListSearchJobResultsInputPaginateTypeDef(TypedDict):
    SearchJobIdentifier: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListSearchJobsInputPaginateTypeDef#

# ListSearchJobsInputPaginateTypeDef definition

class ListSearchJobsInputPaginateTypeDef(TypedDict):
    ByStatus: NotRequired[SearchJobStateType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See SearchJobStateType
  2. See PaginatorConfigTypeDef

ListSearchResultExportJobsInputPaginateTypeDef#

# ListSearchResultExportJobsInputPaginateTypeDef definition

class ListSearchResultExportJobsInputPaginateTypeDef(TypedDict):
    Status: NotRequired[ExportJobStatusType],  # (1)
    SearchJobIdentifier: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ExportJobStatusType
  2. See PaginatorConfigTypeDef

ListSearchJobBackupsOutputTypeDef#

# ListSearchJobBackupsOutputTypeDef definition

class ListSearchJobBackupsOutputTypeDef(TypedDict):
    Results: list[SearchJobBackupsResultTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See SearchJobBackupsResultTypeDef
  2. See ResponseMetadataTypeDef

ResultItemTypeDef#

# ResultItemTypeDef definition

class ResultItemTypeDef(TypedDict):
    S3ResultItem: NotRequired[S3ResultItemTypeDef],  # (1)
    EBSResultItem: NotRequired[EBSResultItemTypeDef],  # (2)
  1. See S3ResultItemTypeDef
  2. See EBSResultItemTypeDef

S3ItemFilterTypeDef#

# S3ItemFilterTypeDef definition

class S3ItemFilterTypeDef(TypedDict):
    ObjectKeys: NotRequired[Sequence[StringConditionTypeDef]],  # (1)
    Sizes: NotRequired[Sequence[LongConditionTypeDef]],  # (2)
    CreationTimes: NotRequired[Sequence[TimeConditionTypeDef]],  # (3)
    VersionIds: NotRequired[Sequence[StringConditionTypeDef]],  # (1)
    ETags: NotRequired[Sequence[StringConditionTypeDef]],  # (1)
  1. See StringConditionTypeDef
  2. See LongConditionTypeDef
  3. See TimeConditionTypeDef
  4. See StringConditionTypeDef
  5. See StringConditionTypeDef

ItemFiltersOutputTypeDef#

# ItemFiltersOutputTypeDef definition

class ItemFiltersOutputTypeDef(TypedDict):
    S3ItemFilters: NotRequired[list[S3ItemFilterOutputTypeDef]],  # (1)
    EBSItemFilters: NotRequired[list[EBSItemFilterOutputTypeDef]],  # (2)
  1. See S3ItemFilterOutputTypeDef
  2. See EBSItemFilterOutputTypeDef

GetSearchResultExportJobOutputTypeDef#

# GetSearchResultExportJobOutputTypeDef definition

class GetSearchResultExportJobOutputTypeDef(TypedDict):
    ExportJobIdentifier: str,
    ExportJobArn: str,
    Status: ExportJobStatusType,  # (1)
    CreationTime: datetime,
    CompletionTime: datetime,
    StatusMessage: str,
    ExportSpecification: ExportSpecificationTypeDef,  # (2)
    SearchJobArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ExportJobStatusType
  2. See ExportSpecificationTypeDef
  3. See ResponseMetadataTypeDef

StartSearchResultExportJobInputRequestTypeDef#

# StartSearchResultExportJobInputRequestTypeDef definition

class StartSearchResultExportJobInputRequestTypeDef(TypedDict):
    SearchJobIdentifier: str,
    ExportSpecification: ExportSpecificationTypeDef,  # (1)
    ClientToken: NotRequired[str],
    Tags: NotRequired[Mapping[str, str]],
    RoleArn: NotRequired[str],
  1. See ExportSpecificationTypeDef

ListSearchJobsOutputTypeDef#

# ListSearchJobsOutputTypeDef definition

class ListSearchJobsOutputTypeDef(TypedDict):
    SearchJobs: list[SearchJobSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See SearchJobSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListSearchJobResultsOutputTypeDef#

# ListSearchJobResultsOutputTypeDef definition

class ListSearchJobResultsOutputTypeDef(TypedDict):
    Results: list[ResultItemTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ResultItemTypeDef
  2. See ResponseMetadataTypeDef

SearchScopeTypeDef#

# SearchScopeTypeDef definition

class SearchScopeTypeDef(TypedDict):
    BackupResourceTypes: Sequence[ResourceTypeType],  # (1)
    BackupResourceCreationTime: NotRequired[BackupCreationTimeFilterUnionTypeDef],  # (2)
    SourceResourceArns: NotRequired[Sequence[str]],
    BackupResourceArns: NotRequired[Sequence[str]],
    BackupResourceTags: NotRequired[Mapping[str, str]],
  1. See ResourceTypeType
  2. See BackupCreationTimeFilterTypeDef BackupCreationTimeFilterOutputTypeDef

EBSItemFilterTypeDef#

# EBSItemFilterTypeDef definition

class EBSItemFilterTypeDef(TypedDict):
    FilePaths: NotRequired[Sequence[StringConditionTypeDef]],  # (1)
    Sizes: NotRequired[Sequence[LongConditionTypeDef]],  # (2)
    CreationTimes: NotRequired[Sequence[TimeConditionUnionTypeDef]],  # (3)
    LastModificationTimes: NotRequired[Sequence[TimeConditionTypeDef]],  # (4)
  1. See StringConditionTypeDef
  2. See LongConditionTypeDef
  3. See TimeConditionTypeDef TimeConditionOutputTypeDef
  4. See TimeConditionTypeDef

GetSearchJobOutputTypeDef#

# GetSearchJobOutputTypeDef definition

class GetSearchJobOutputTypeDef(TypedDict):
    Name: str,
    SearchScopeSummary: SearchScopeSummaryTypeDef,  # (1)
    CurrentSearchProgress: CurrentSearchProgressTypeDef,  # (2)
    StatusMessage: str,
    EncryptionKeyArn: str,
    CompletionTime: datetime,
    Status: SearchJobStateType,  # (3)
    SearchScope: SearchScopeOutputTypeDef,  # (4)
    ItemFilters: ItemFiltersOutputTypeDef,  # (5)
    CreationTime: datetime,
    SearchJobIdentifier: str,
    SearchJobArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See SearchScopeSummaryTypeDef
  2. See CurrentSearchProgressTypeDef
  3. See SearchJobStateType
  4. See SearchScopeOutputTypeDef
  5. See ItemFiltersOutputTypeDef
  6. See ResponseMetadataTypeDef

ItemFiltersTypeDef#

# ItemFiltersTypeDef definition

class ItemFiltersTypeDef(TypedDict):
    S3ItemFilters: NotRequired[Sequence[S3ItemFilterUnionTypeDef]],  # (1)
    EBSItemFilters: NotRequired[Sequence[EBSItemFilterUnionTypeDef]],  # (2)
  1. See S3ItemFilterTypeDef S3ItemFilterOutputTypeDef
  2. See EBSItemFilterTypeDef EBSItemFilterOutputTypeDef

StartSearchJobInputRequestTypeDef#

# StartSearchJobInputRequestTypeDef definition

class StartSearchJobInputRequestTypeDef(TypedDict):
    SearchScope: SearchScopeTypeDef,  # (1)
    Tags: NotRequired[Mapping[str, str]],
    Name: NotRequired[str],
    EncryptionKeyArn: NotRequired[str],
    ClientToken: NotRequired[str],
    ItemFilters: NotRequired[ItemFiltersTypeDef],  # (2)
  1. See SearchScopeTypeDef
  2. See ItemFiltersTypeDef