2024/12/17 - AWS Backup Search - 12 new api methods
Changes Add support for searching backups
This operation retrieves the metadata of an export job.
An export job is an operation that transmits the results of a search job to a specified S3 bucket in a .csv file.
An export job allows you to retain results of a search beyond the search job's scheduled retention of 7 days.
See also: AWS API Documentation
Request Syntax
client.get_search_result_export_job(
ExportJobIdentifier='string'
)
string
[REQUIRED]
This is the unique string that identifies a specific export job.
Required for this operation.
dict
Response Syntax
{
'ExportJobIdentifier': 'string',
'ExportJobArn': 'string',
'Status': 'RUNNING'|'FAILED'|'COMPLETED',
'CreationTime': datetime(2015, 1, 1),
'CompletionTime': datetime(2015, 1, 1),
'StatusMessage': 'string',
'ExportSpecification': {
's3ExportSpecification': {
'DestinationBucket': 'string',
'DestinationPrefix': 'string'
}
},
'SearchJobArn': 'string'
}
Response Structure
(dict) --
ExportJobIdentifier (string) --
This is the unique string that identifies the specified export job.
ExportJobArn (string) --
The unique Amazon Resource Name (ARN) that uniquely identifies the export job.
Status (string) --
This is the current status of the export job.
CreationTime (datetime) --
The date and time that an export job was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
CompletionTime (datetime) --
The date and time that an export job completed, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
StatusMessage (string) --
A status message is a string that is returned for search job with a status of FAILED, along with steps to remedy and retry the operation.
ExportSpecification (dict) --
The export specification consists of the destination S3 bucket to which the search results were exported, along with the destination prefix.
s3ExportSpecification (dict) --
This specifies the destination Amazon S3 bucket for the export job. And, if included, it also specifies the destination prefix.
DestinationBucket (string) --
This specifies the destination Amazon S3 bucket for the export job.
DestinationPrefix (string) --
This specifies the prefix for the destination Amazon S3 bucket for the export job.
SearchJobArn (string) --
The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.
This operation puts tags on the resource you indicate.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
ResourceArn='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies the resource.
This is the resource that will have the indicated tags.
dict
[REQUIRED]
Required tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.
(string) --
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
This operation retrieves metadata of a search job, including its progress.
See also: AWS API Documentation
Request Syntax
client.get_search_job(
SearchJobIdentifier='string'
)
string
[REQUIRED]
Required unique string that specifies the search job.
dict
Response Syntax
{
'Name': 'string',
'SearchScopeSummary': {
'TotalRecoveryPointsToScanCount': 123,
'TotalItemsToScanCount': 123
},
'CurrentSearchProgress': {
'RecoveryPointsScannedCount': 123,
'ItemsScannedCount': 123,
'ItemsMatchedCount': 123
},
'StatusMessage': 'string',
'EncryptionKeyArn': 'string',
'CompletionTime': datetime(2015, 1, 1),
'Status': 'RUNNING'|'COMPLETED'|'STOPPING'|'STOPPED'|'FAILED',
'SearchScope': {
'BackupResourceTypes': [
'S3'|'EBS',
],
'BackupResourceCreationTime': {
'CreatedAfter': datetime(2015, 1, 1),
'CreatedBefore': datetime(2015, 1, 1)
},
'SourceResourceArns': [
'string',
],
'BackupResourceArns': [
'string',
],
'BackupResourceTags': {
'string': 'string'
}
},
'ItemFilters': {
'S3ItemFilters': [
{
'ObjectKeys': [
{
'Value': 'string',
'Operator': 'EQUALS_TO'|'NOT_EQUALS_TO'|'CONTAINS'|'DOES_NOT_CONTAIN'|'BEGINS_WITH'|'ENDS_WITH'|'DOES_NOT_BEGIN_WITH'|'DOES_NOT_END_WITH'
},
],
'Sizes': [
{
'Value': 123,
'Operator': 'EQUALS_TO'|'NOT_EQUALS_TO'|'LESS_THAN_EQUAL_TO'|'GREATER_THAN_EQUAL_TO'
},
],
'CreationTimes': [
{
'Value': datetime(2015, 1, 1),
'Operator': 'EQUALS_TO'|'NOT_EQUALS_TO'|'LESS_THAN_EQUAL_TO'|'GREATER_THAN_EQUAL_TO'
},
],
'VersionIds': [
{
'Value': 'string',
'Operator': 'EQUALS_TO'|'NOT_EQUALS_TO'|'CONTAINS'|'DOES_NOT_CONTAIN'|'BEGINS_WITH'|'ENDS_WITH'|'DOES_NOT_BEGIN_WITH'|'DOES_NOT_END_WITH'
},
],
'ETags': [
{
'Value': 'string',
'Operator': 'EQUALS_TO'|'NOT_EQUALS_TO'|'CONTAINS'|'DOES_NOT_CONTAIN'|'BEGINS_WITH'|'ENDS_WITH'|'DOES_NOT_BEGIN_WITH'|'DOES_NOT_END_WITH'
},
]
},
],
'EBSItemFilters': [
{
'FilePaths': [
{
'Value': 'string',
'Operator': 'EQUALS_TO'|'NOT_EQUALS_TO'|'CONTAINS'|'DOES_NOT_CONTAIN'|'BEGINS_WITH'|'ENDS_WITH'|'DOES_NOT_BEGIN_WITH'|'DOES_NOT_END_WITH'
},
],
'Sizes': [
{
'Value': 123,
'Operator': 'EQUALS_TO'|'NOT_EQUALS_TO'|'LESS_THAN_EQUAL_TO'|'GREATER_THAN_EQUAL_TO'
},
],
'CreationTimes': [
{
'Value': datetime(2015, 1, 1),
'Operator': 'EQUALS_TO'|'NOT_EQUALS_TO'|'LESS_THAN_EQUAL_TO'|'GREATER_THAN_EQUAL_TO'
},
],
'LastModificationTimes': [
{
'Value': datetime(2015, 1, 1),
'Operator': 'EQUALS_TO'|'NOT_EQUALS_TO'|'LESS_THAN_EQUAL_TO'|'GREATER_THAN_EQUAL_TO'
},
]
},
]
},
'CreationTime': datetime(2015, 1, 1),
'SearchJobIdentifier': 'string',
'SearchJobArn': 'string'
}
Response Structure
(dict) --
Name (string) --
Returned name of the specified search job.
SearchScopeSummary (dict) --
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.
TotalRecoveryPointsToScanCount (integer) --
This is the count of the total number of backups that will be scanned in a search.
TotalItemsToScanCount (integer) --
This is the count of the total number of items that will be scanned in a search.
CurrentSearchProgress (dict) --
Returns numbers representing BackupsScannedCount, ItemsScanned, and ItemsMatched.
RecoveryPointsScannedCount (integer) --
This number is the sum of all backups that have been scanned so far during a search job.
ItemsScannedCount (integer) --
This number is the sum of all items that have been scanned so far during a search job.
ItemsMatchedCount (integer) --
This number is the sum of all items that match the item filters in a search job in progress.
StatusMessage (string) --
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.
EncryptionKeyArn (string) --
The encryption key for the specified search job.
Example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
CompletionTime (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.
Status (string) --
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 .
SearchScope (dict) --
The search scope is all backup properties input into a search.
BackupResourceTypes (list) --
The resource types included in a search.
Eligible resource types include S3 and EBS.
(string) --
BackupResourceCreationTime (dict) --
This is the time a backup resource was created.
CreatedAfter (datetime) --
This timestamp includes recovery points only created after the specified time.
CreatedBefore (datetime) --
This timestamp includes recovery points only created before the specified time.
SourceResourceArns (list) --
The Amazon Resource Name (ARN) that uniquely identifies the source resources.
(string) --
BackupResourceArns (list) --
The Amazon Resource Name (ARN) that uniquely identifies the backup resources.
(string) --
BackupResourceTags (dict) --
These are one or more tags on the backup (recovery point).
(string) --
(string) --
ItemFilters (dict) --
Item Filters represent all input item properties specified when the search was created.
S3ItemFilters (list) --
This array can contain CreationTimes, ETags, ObjectKeys, Sizes, or VersionIds objects.
(dict) --
This contains arrays of objects, which may include ObjectKeys, Sizes, CreationTimes, VersionIds, and/or Etags.
ObjectKeys (list) --
You can include 1 to 10 values.
If one value is included, the results will return only items that match the value.
If more than one value is included, the results will return all items that match any of the values.
(dict) --
This contains the value of the string and can contain one or more operators.
Value (string) --
The value of the string.
Operator (string) --
A string that defines what values will be returned.
If this is included, avoid combinations of operators that will return all possible values. For example, including both EQUALS_TO and NOT_EQUALS_TO with a value of 4 will return all values.
Sizes (list) --
You can include 1 to 10 values.
If one value is included, the results will return only items that match the value.
If more than one value is included, the results will return all items that match any of the values.
(dict) --
The long condition contains a Value and can optionally contain an Operator.
Value (integer) --
The value of an item included in one of the search item filters.
Operator (string) --
A string that defines what values will be returned.
If this is included, avoid combinations of operators that will return all possible values. For example, including both EQUALS_TO and NOT_EQUALS_TO with a value of 4 will return all values.
CreationTimes (list) --
You can include 1 to 10 values.
If one value is included, the results will return only items that match the value.
If more than one value is included, the results will return all items that match any of the values.
(dict) --
A time condition denotes a creation time, last modification time, or other time.
Value (datetime) --
This is the timestamp value of the time condition.
Operator (string) --
A string that defines what values will be returned.
If this is included, avoid combinations of operators that will return all possible values. For example, including both EQUALS_TO and NOT_EQUALS_TO with a value of 4 will return all values.
VersionIds (list) --
You can include 1 to 10 values.
If one value is included, the results will return only items that match the value.
If more than one value is included, the results will return all items that match any of the values.
(dict) --
This contains the value of the string and can contain one or more operators.
Value (string) --
The value of the string.
Operator (string) --
A string that defines what values will be returned.
If this is included, avoid combinations of operators that will return all possible values. For example, including both EQUALS_TO and NOT_EQUALS_TO with a value of 4 will return all values.
ETags (list) --
You can include 1 to 10 values.
If one value is included, the results will return only items that match the value.
If more than one value is included, the results will return all items that match any of the values.
(dict) --
This contains the value of the string and can contain one or more operators.
Value (string) --
The value of the string.
Operator (string) --
A string that defines what values will be returned.
If this is included, avoid combinations of operators that will return all possible values. For example, including both EQUALS_TO and NOT_EQUALS_TO with a value of 4 will return all values.
EBSItemFilters (list) --
This array can contain CreationTimes, FilePaths, LastModificationTimes, or Sizes objects.
(dict) --
This contains arrays of objects, which may include CreationTimes time condition objects, FilePaths string objects, LastModificationTimes time condition objects,
FilePaths (list) --
You can include 1 to 10 values.
If one file path is included, the results will return only items that match the file path.
If more than one file path is included, the results will return all items that match any of the file paths.
(dict) --
This contains the value of the string and can contain one or more operators.
Value (string) --
The value of the string.
Operator (string) --
A string that defines what values will be returned.
If this is included, avoid combinations of operators that will return all possible values. For example, including both EQUALS_TO and NOT_EQUALS_TO with a value of 4 will return all values.
Sizes (list) --
You can include 1 to 10 values.
If one is included, the results will return only items that match.
If more than one is included, the results will return all items that match any of the included values.
(dict) --
The long condition contains a Value and can optionally contain an Operator.
Value (integer) --
The value of an item included in one of the search item filters.
Operator (string) --
A string that defines what values will be returned.
If this is included, avoid combinations of operators that will return all possible values. For example, including both EQUALS_TO and NOT_EQUALS_TO with a value of 4 will return all values.
CreationTimes (list) --
You can include 1 to 10 values.
If one is included, the results will return only items that match.
If more than one is included, the results will return all items that match any of the included values.
(dict) --
A time condition denotes a creation time, last modification time, or other time.
Value (datetime) --
This is the timestamp value of the time condition.
Operator (string) --
A string that defines what values will be returned.
If this is included, avoid combinations of operators that will return all possible values. For example, including both EQUALS_TO and NOT_EQUALS_TO with a value of 4 will return all values.
LastModificationTimes (list) --
You can include 1 to 10 values.
If one is included, the results will return only items that match.
If more than one is included, the results will return all items that match any of the included values.
(dict) --
A time condition denotes a creation time, last modification time, or other time.
Value (datetime) --
This is the timestamp value of the time condition.
Operator (string) --
A string that defines what values will be returned.
If this is included, avoid combinations of operators that will return all possible values. For example, including both EQUALS_TO and NOT_EQUALS_TO with a value of 4 will return all values.
CreationTime (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.
SearchJobIdentifier (string) --
The unique string that identifies the specified search job.
SearchJobArn (string) --
The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.
This operation returns a list of a specified search job.
See also: AWS API Documentation
Request Syntax
client.list_search_job_results(
SearchJobIdentifier='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The unique string that specifies the search job.
string
The next item following a partial list of returned search job results.
For example, if a request is made to return MaxResults number of search job results, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
integer
The maximum number of resource list items to be returned.
dict
Response Syntax
{
'Results': [
{
'S3ResultItem': {
'BackupResourceArn': 'string',
'SourceResourceArn': 'string',
'BackupVaultName': 'string',
'ObjectKey': 'string',
'ObjectSize': 123,
'CreationTime': datetime(2015, 1, 1),
'ETag': 'string',
'VersionId': 'string'
},
'EBSResultItem': {
'BackupResourceArn': 'string',
'SourceResourceArn': 'string',
'BackupVaultName': 'string',
'FileSystemIdentifier': 'string',
'FilePath': 'string',
'FileSize': 123,
'CreationTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1)
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Results (list) --
The results consist of either EBSResultItem or S3ResultItem.
(dict) --
This is an object representing the item returned in the results of a search for a specific resource type.
S3ResultItem (dict) --
These are items returned in the search results of an Amazon S3 search.
BackupResourceArn (string) --
These are items in the returned results that match recovery point Amazon Resource Names (ARN) input during a search of Amazon S3 backup metadata.
SourceResourceArn (string) --
These are items in the returned results that match source Amazon Resource Names (ARN) input during a search of Amazon S3 backup metadata.
BackupVaultName (string) --
The name of the backup vault.
ObjectKey (string) --
This is one or more items returned in the results of a search of Amazon S3 backup metadata that match the values input for object key.
ObjectSize (integer) --
These are items in the returned results that match values for object size(s) input during a search of Amazon S3 backup metadata.
CreationTime (datetime) --
These are one or more items in the returned results that match values for item creation time input during a search of Amazon S3 backup metadata.
ETag (string) --
These are one or more items in the returned results that match values for ETags input during a search of Amazon S3 backup metadata.
VersionId (string) --
These are one or more items in the returned results that match values for version IDs input during a search of Amazon S3 backup metadata.
EBSResultItem (dict) --
These are items returned in the search results of an Amazon EBS search.
BackupResourceArn (string) --
These are one or more items in the results that match values for the Amazon Resource Name (ARN) of recovery points returned in a search of Amazon EBS backup metadata.
SourceResourceArn (string) --
These are one or more items in the results that match values for the Amazon Resource Name (ARN) of source resources returned in a search of Amazon EBS backup metadata.
BackupVaultName (string) --
The name of the backup vault.
FileSystemIdentifier (string) --
These are one or more items in the results that match values for file systems returned in a search of Amazon EBS backup metadata.
FilePath (string) --
These are one or more items in the results that match values for file paths returned in a search of Amazon EBS backup metadata.
FileSize (integer) --
These are one or more items in the results that match values for file sizes returned in a search of Amazon EBS backup metadata.
CreationTime (datetime) --
These are one or more items in the results that match values for creation times returned in a search of Amazon EBS backup metadata.
LastModifiedTime (datetime) --
These are one or more items in the results that match values for Last Modified Time returned in a search of Amazon EBS backup metadata.
NextToken (string) --
The next item following a partial list of search job results.
For example, if a request is made to return MaxResults number of backups, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
This operation creates a search job which returns recovery points filtered by SearchScope and items filtered by ItemFilters.
You can optionally include ClientToken, EncryptionKeyArn, Name, and/or Tags.
See also: AWS API Documentation
Request Syntax
client.start_search_job(
Tags={
'string': 'string'
},
Name='string',
EncryptionKeyArn='string',
ClientToken='string',
SearchScope={
'BackupResourceTypes': [
'S3'|'EBS',
],
'BackupResourceCreationTime': {
'CreatedAfter': datetime(2015, 1, 1),
'CreatedBefore': datetime(2015, 1, 1)
},
'SourceResourceArns': [
'string',
],
'BackupResourceArns': [
'string',
],
'BackupResourceTags': {
'string': 'string'
}
},
ItemFilters={
'S3ItemFilters': [
{
'ObjectKeys': [
{
'Value': 'string',
'Operator': 'EQUALS_TO'|'NOT_EQUALS_TO'|'CONTAINS'|'DOES_NOT_CONTAIN'|'BEGINS_WITH'|'ENDS_WITH'|'DOES_NOT_BEGIN_WITH'|'DOES_NOT_END_WITH'
},
],
'Sizes': [
{
'Value': 123,
'Operator': 'EQUALS_TO'|'NOT_EQUALS_TO'|'LESS_THAN_EQUAL_TO'|'GREATER_THAN_EQUAL_TO'
},
],
'CreationTimes': [
{
'Value': datetime(2015, 1, 1),
'Operator': 'EQUALS_TO'|'NOT_EQUALS_TO'|'LESS_THAN_EQUAL_TO'|'GREATER_THAN_EQUAL_TO'
},
],
'VersionIds': [
{
'Value': 'string',
'Operator': 'EQUALS_TO'|'NOT_EQUALS_TO'|'CONTAINS'|'DOES_NOT_CONTAIN'|'BEGINS_WITH'|'ENDS_WITH'|'DOES_NOT_BEGIN_WITH'|'DOES_NOT_END_WITH'
},
],
'ETags': [
{
'Value': 'string',
'Operator': 'EQUALS_TO'|'NOT_EQUALS_TO'|'CONTAINS'|'DOES_NOT_CONTAIN'|'BEGINS_WITH'|'ENDS_WITH'|'DOES_NOT_BEGIN_WITH'|'DOES_NOT_END_WITH'
},
]
},
],
'EBSItemFilters': [
{
'FilePaths': [
{
'Value': 'string',
'Operator': 'EQUALS_TO'|'NOT_EQUALS_TO'|'CONTAINS'|'DOES_NOT_CONTAIN'|'BEGINS_WITH'|'ENDS_WITH'|'DOES_NOT_BEGIN_WITH'|'DOES_NOT_END_WITH'
},
],
'Sizes': [
{
'Value': 123,
'Operator': 'EQUALS_TO'|'NOT_EQUALS_TO'|'LESS_THAN_EQUAL_TO'|'GREATER_THAN_EQUAL_TO'
},
],
'CreationTimes': [
{
'Value': datetime(2015, 1, 1),
'Operator': 'EQUALS_TO'|'NOT_EQUALS_TO'|'LESS_THAN_EQUAL_TO'|'GREATER_THAN_EQUAL_TO'
},
],
'LastModificationTimes': [
{
'Value': datetime(2015, 1, 1),
'Operator': 'EQUALS_TO'|'NOT_EQUALS_TO'|'LESS_THAN_EQUAL_TO'|'GREATER_THAN_EQUAL_TO'
},
]
},
]
}
)
dict
List of tags returned by the operation.
(string) --
(string) --
string
Include alphanumeric characters to create a name for this search job.
string
The encryption key for the specified search job.
string
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.
dict
[REQUIRED]
This object can contain BackupResourceTypes, BackupResourceArns, BackupResourceCreationTime, BackupResourceTags, and SourceResourceArns to filter the recovery points returned by the search job.
BackupResourceTypes (list) -- [REQUIRED]
The resource types included in a search.
Eligible resource types include S3 and EBS.
(string) --
BackupResourceCreationTime (dict) --
This is the time a backup resource was created.
CreatedAfter (datetime) --
This timestamp includes recovery points only created after the specified time.
CreatedBefore (datetime) --
This timestamp includes recovery points only created before the specified time.
SourceResourceArns (list) --
The Amazon Resource Name (ARN) that uniquely identifies the source resources.
(string) --
BackupResourceArns (list) --
The Amazon Resource Name (ARN) that uniquely identifies the backup resources.
(string) --
BackupResourceTags (dict) --
These are one or more tags on the backup (recovery point).
(string) --
(string) --
dict
Item Filters represent all input item properties specified when the search was created.
Contains either EBSItemFilters or S3ItemFilters
S3ItemFilters (list) --
This array can contain CreationTimes, ETags, ObjectKeys, Sizes, or VersionIds objects.
(dict) --
This contains arrays of objects, which may include ObjectKeys, Sizes, CreationTimes, VersionIds, and/or Etags.
ObjectKeys (list) --
You can include 1 to 10 values.
If one value is included, the results will return only items that match the value.
If more than one value is included, the results will return all items that match any of the values.
(dict) --
This contains the value of the string and can contain one or more operators.
Value (string) -- [REQUIRED]
The value of the string.
Operator (string) --
A string that defines what values will be returned.
If this is included, avoid combinations of operators that will return all possible values. For example, including both EQUALS_TO and NOT_EQUALS_TO with a value of 4 will return all values.
Sizes (list) --
You can include 1 to 10 values.
If one value is included, the results will return only items that match the value.
If more than one value is included, the results will return all items that match any of the values.
(dict) --
The long condition contains a Value and can optionally contain an Operator.
Value (integer) -- [REQUIRED]
The value of an item included in one of the search item filters.
Operator (string) --
A string that defines what values will be returned.
If this is included, avoid combinations of operators that will return all possible values. For example, including both EQUALS_TO and NOT_EQUALS_TO with a value of 4 will return all values.
CreationTimes (list) --
You can include 1 to 10 values.
If one value is included, the results will return only items that match the value.
If more than one value is included, the results will return all items that match any of the values.
(dict) --
A time condition denotes a creation time, last modification time, or other time.
Value (datetime) -- [REQUIRED]
This is the timestamp value of the time condition.
Operator (string) --
A string that defines what values will be returned.
If this is included, avoid combinations of operators that will return all possible values. For example, including both EQUALS_TO and NOT_EQUALS_TO with a value of 4 will return all values.
VersionIds (list) --
You can include 1 to 10 values.
If one value is included, the results will return only items that match the value.
If more than one value is included, the results will return all items that match any of the values.
(dict) --
This contains the value of the string and can contain one or more operators.
Value (string) -- [REQUIRED]
The value of the string.
Operator (string) --
A string that defines what values will be returned.
If this is included, avoid combinations of operators that will return all possible values. For example, including both EQUALS_TO and NOT_EQUALS_TO with a value of 4 will return all values.
ETags (list) --
You can include 1 to 10 values.
If one value is included, the results will return only items that match the value.
If more than one value is included, the results will return all items that match any of the values.
(dict) --
This contains the value of the string and can contain one or more operators.
Value (string) -- [REQUIRED]
The value of the string.
Operator (string) --
A string that defines what values will be returned.
If this is included, avoid combinations of operators that will return all possible values. For example, including both EQUALS_TO and NOT_EQUALS_TO with a value of 4 will return all values.
EBSItemFilters (list) --
This array can contain CreationTimes, FilePaths, LastModificationTimes, or Sizes objects.
(dict) --
This contains arrays of objects, which may include CreationTimes time condition objects, FilePaths string objects, LastModificationTimes time condition objects,
FilePaths (list) --
You can include 1 to 10 values.
If one file path is included, the results will return only items that match the file path.
If more than one file path is included, the results will return all items that match any of the file paths.
(dict) --
This contains the value of the string and can contain one or more operators.
Value (string) -- [REQUIRED]
The value of the string.
Operator (string) --
A string that defines what values will be returned.
If this is included, avoid combinations of operators that will return all possible values. For example, including both EQUALS_TO and NOT_EQUALS_TO with a value of 4 will return all values.
Sizes (list) --
You can include 1 to 10 values.
If one is included, the results will return only items that match.
If more than one is included, the results will return all items that match any of the included values.
(dict) --
The long condition contains a Value and can optionally contain an Operator.
Value (integer) -- [REQUIRED]
The value of an item included in one of the search item filters.
Operator (string) --
A string that defines what values will be returned.
If this is included, avoid combinations of operators that will return all possible values. For example, including both EQUALS_TO and NOT_EQUALS_TO with a value of 4 will return all values.
CreationTimes (list) --
You can include 1 to 10 values.
If one is included, the results will return only items that match.
If more than one is included, the results will return all items that match any of the included values.
(dict) --
A time condition denotes a creation time, last modification time, or other time.
Value (datetime) -- [REQUIRED]
This is the timestamp value of the time condition.
Operator (string) --
A string that defines what values will be returned.
If this is included, avoid combinations of operators that will return all possible values. For example, including both EQUALS_TO and NOT_EQUALS_TO with a value of 4 will return all values.
LastModificationTimes (list) --
You can include 1 to 10 values.
If one is included, the results will return only items that match.
If more than one is included, the results will return all items that match any of the included values.
(dict) --
A time condition denotes a creation time, last modification time, or other time.
Value (datetime) -- [REQUIRED]
This is the timestamp value of the time condition.
Operator (string) --
A string that defines what values will be returned.
If this is included, avoid combinations of operators that will return all possible values. For example, including both EQUALS_TO and NOT_EQUALS_TO with a value of 4 will return all values.
dict
Response Syntax
{
'SearchJobArn': 'string',
'CreationTime': datetime(2015, 1, 1),
'SearchJobIdentifier': 'string'
}
Response Structure
(dict) --
SearchJobArn (string) --
The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.
CreationTime (datetime) --
The date and time that a 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.
SearchJobIdentifier (string) --
The unique string that specifies the search job.
This operations starts a job to export the results of search job to a designated S3 bucket.
See also: AWS API Documentation
Request Syntax
client.start_search_result_export_job(
SearchJobIdentifier='string',
ExportSpecification={
's3ExportSpecification': {
'DestinationBucket': 'string',
'DestinationPrefix': 'string'
}
},
ClientToken='string',
Tags={
'string': 'string'
},
RoleArn='string'
)
string
[REQUIRED]
The unique string that specifies the search job.
dict
[REQUIRED]
This specification contains a required string of the destination bucket; optionally, you can include the destination prefix.
s3ExportSpecification (dict) --
This specifies the destination Amazon S3 bucket for the export job. And, if included, it also specifies the destination prefix.
DestinationBucket (string) -- [REQUIRED]
This specifies the destination Amazon S3 bucket for the export job.
DestinationPrefix (string) --
This specifies the prefix for the destination Amazon S3 bucket for the export job.
string
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.
dict
Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.
(string) --
(string) --
string
This parameter specifies the role ARN used to start the search results export jobs.
dict
Response Syntax
{
'ExportJobArn': 'string',
'ExportJobIdentifier': 'string'
}
Response Structure
(dict) --
ExportJobArn (string) --
This is the unique ARN (Amazon Resource Name) that belongs to the new export job.
ExportJobIdentifier (string) --
This is the unique identifier that specifies the new export job.
This operation returns a list of all backups (recovery points) in a paginated format that were included in the search job.
If a search does not display an expected backup in the results, you can call this operation to display each backup included in the search. Any backups that were not included because they have a FAILED status from a permissions issue will be displayed, along with a status message.
Only recovery points with a backup index that has a status of ACTIVE will be included in search results. If the index has any other status, its status will be displayed along with a status message.
See also: AWS API Documentation
Request Syntax
client.list_search_job_backups(
SearchJobIdentifier='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The unique string that specifies the search job.
string
The next item following a partial list of returned backups included in a search job.
For example, if a request is made to return MaxResults number of backups, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
integer
The maximum number of resource list items to be returned.
dict
Response Syntax
{
'Results': [
{
'Status': 'RUNNING'|'COMPLETED'|'STOPPING'|'STOPPED'|'FAILED',
'StatusMessage': 'string',
'ResourceType': 'S3'|'EBS',
'BackupResourceArn': 'string',
'SourceResourceArn': 'string',
'IndexCreationTime': datetime(2015, 1, 1),
'BackupCreationTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Results (list) --
The recovery points returned the results of a search job
(dict) --
This contains the information about recovery points returned in results of a search job.
Status (string) --
This is the status of the search job backup result.
StatusMessage (string) --
This is the status message included with the results.
ResourceType (string) --
This is the resource type of the search.
BackupResourceArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the backup resources.
SourceResourceArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the source resources.
IndexCreationTime (datetime) --
This is the creation time of the backup index.
BackupCreationTime (datetime) --
This is the creation time of the backup (recovery point).
NextToken (string) --
The next item following a partial list of returned backups included in a search job.
For example, if a request is made to return MaxResults number of backups, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
This operation returns the tags for a resource type.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
ResourceArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies the resource.>
dict
Response Syntax
{
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Tags (dict) --
List of tags returned by the operation.
(string) --
(string) --
This operation removes tags from the specified resource.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies the resource where you want to remove tags.
list
[REQUIRED]
This required parameter contains the tag keys you want to remove from the source.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
This operations ends a search job.
Only a search job with a status of RUNNING can be stopped.
See also: AWS API Documentation
Request Syntax
client.stop_search_job(
SearchJobIdentifier='string'
)
string
[REQUIRED]
The unique string that specifies the search job.
dict
Response Syntax
{}
Response Structure
(dict) --
This operation returns a list of search jobs belonging to an account.
See also: AWS API Documentation
Request Syntax
client.list_search_jobs(
ByStatus='RUNNING'|'COMPLETED'|'STOPPING'|'STOPPED'|'FAILED',
NextToken='string',
MaxResults=123
)
string
Include this parameter to filter list by search job status.
string
The next item following a partial list of returned search jobs.
For example, if a request is made to return MaxResults number of backups, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
integer
The maximum number of resource list items to be returned.
dict
Response Syntax
{
'SearchJobs': [
{
'SearchJobIdentifier': 'string',
'SearchJobArn': 'string',
'Name': 'string',
'Status': 'RUNNING'|'COMPLETED'|'STOPPING'|'STOPPED'|'FAILED',
'CreationTime': datetime(2015, 1, 1),
'CompletionTime': datetime(2015, 1, 1),
'SearchScopeSummary': {
'TotalRecoveryPointsToScanCount': 123,
'TotalItemsToScanCount': 123
},
'StatusMessage': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
SearchJobs (list) --
The search jobs among the list, with details of the returned search jobs.
(dict) --
This is information pertaining to a search job.
SearchJobIdentifier (string) --
The unique string that specifies the search job.
SearchJobArn (string) --
The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.
Name (string) --
This is the name of the search job.
Status (string) --
This is the status of the search job.
CreationTime (datetime) --
This is the creation time of the search job.
CompletionTime (datetime) --
This is the completion time of the search job.
SearchScopeSummary (dict) --
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.
TotalRecoveryPointsToScanCount (integer) --
This is the count of the total number of backups that will be scanned in a search.
TotalItemsToScanCount (integer) --
This is the count of the total number of items that will be scanned in a search.
StatusMessage (string) --
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.
NextToken (string) --
The next item following a partial list of returned backups included in a search job.
For example, if a request is made to return MaxResults number of backups, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
This operation exports search results of a search job to a specified destination S3 bucket.
See also: AWS API Documentation
Request Syntax
client.list_search_result_export_jobs(
Status='RUNNING'|'FAILED'|'COMPLETED',
SearchJobIdentifier='string',
NextToken='string',
MaxResults=123
)
string
The search jobs to be included in the export job can be filtered by including this parameter.
string
The unique string that specifies the search job.
string
The next item following a partial list of returned backups included in a search job.
For example, if a request is made to return MaxResults number of backups, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
integer
The maximum number of resource list items to be returned.
dict
Response Syntax
{
'ExportJobs': [
{
'ExportJobIdentifier': 'string',
'ExportJobArn': 'string',
'Status': 'RUNNING'|'FAILED'|'COMPLETED',
'CreationTime': datetime(2015, 1, 1),
'CompletionTime': datetime(2015, 1, 1),
'StatusMessage': 'string',
'SearchJobArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ExportJobs (list) --
The operation returns the included export jobs.
(dict) --
This is the summary of an export job.
ExportJobIdentifier (string) --
This is the unique string that identifies a specific export job.
ExportJobArn (string) --
This is the unique ARN (Amazon Resource Name) that belongs to the new export job.
Status (string) --
The status of the export job is one of the following:
CREATED; RUNNING; FAILED; or COMPLETED.
CreationTime (datetime) --
This is a timestamp of the time the export job was created.
CompletionTime (datetime) --
This is a timestamp of the time the export job compeleted.
StatusMessage (string) --
A status message is a string that is returned for an export job.
A status message is included for any status other than COMPLETED without issues.
SearchJobArn (string) --
The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.
NextToken (string) --
The next item following a partial list of returned backups included in a search job.
For example, if a request is made to return MaxResults number of backups, NextToken allows you to return more items in your list starting at the location pointed to by the next token.