GetSearchJob

$result = $client->getSearchJob([/* ... */]);
$promise = $client->getSearchJobAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getSearchJob([
    'SearchJobIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CompletionTime' => <DateTime>,
    'CreationTime' => <DateTime>,
    'CurrentSearchProgress' => [
        'ItemsMatchedCount' => <integer>,
        'ItemsScannedCount' => <integer>,
        'RecoveryPointsScannedCount' => <integer>,
    ],
    'EncryptionKeyArn' => '<string>',
    'ItemFilters' => [
        'EBSItemFilters' => [
            [
                'CreationTimes' => [
                    [
                        'Operator' => 'EQUALS_TO|NOT_EQUALS_TO|LESS_THAN_EQUAL_TO|GREATER_THAN_EQUAL_TO',
                        'Value' => <DateTime>,
                    ],
                    // ...
                ],
                'FilePaths' => [
                    [
                        'Operator' => 'EQUALS_TO|NOT_EQUALS_TO|CONTAINS|DOES_NOT_CONTAIN|BEGINS_WITH|ENDS_WITH|DOES_NOT_BEGIN_WITH|DOES_NOT_END_WITH',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'LastModificationTimes' => [
                    [
                        'Operator' => 'EQUALS_TO|NOT_EQUALS_TO|LESS_THAN_EQUAL_TO|GREATER_THAN_EQUAL_TO',
                        'Value' => <DateTime>,
                    ],
                    // ...
                ],
                'Sizes' => [
                    [
                        'Operator' => 'EQUALS_TO|NOT_EQUALS_TO|LESS_THAN_EQUAL_TO|GREATER_THAN_EQUAL_TO',
                        'Value' => <integer>,
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'S3ItemFilters' => [
            [
                'CreationTimes' => [
                    [
                        'Operator' => 'EQUALS_TO|NOT_EQUALS_TO|LESS_THAN_EQUAL_TO|GREATER_THAN_EQUAL_TO',
                        'Value' => <DateTime>,
                    ],
                    // ...
                ],
                'ETags' => [
                    [
                        'Operator' => 'EQUALS_TO|NOT_EQUALS_TO|CONTAINS|DOES_NOT_CONTAIN|BEGINS_WITH|ENDS_WITH|DOES_NOT_BEGIN_WITH|DOES_NOT_END_WITH',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ObjectKeys' => [
                    [
                        'Operator' => 'EQUALS_TO|NOT_EQUALS_TO|CONTAINS|DOES_NOT_CONTAIN|BEGINS_WITH|ENDS_WITH|DOES_NOT_BEGIN_WITH|DOES_NOT_END_WITH',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'Sizes' => [
                    [
                        'Operator' => 'EQUALS_TO|NOT_EQUALS_TO|LESS_THAN_EQUAL_TO|GREATER_THAN_EQUAL_TO',
                        'Value' => <integer>,
                    ],
                    // ...
                ],
                'VersionIds' => [
                    [
                        'Operator' => 'EQUALS_TO|NOT_EQUALS_TO|CONTAINS|DOES_NOT_CONTAIN|BEGINS_WITH|ENDS_WITH|DOES_NOT_BEGIN_WITH|DOES_NOT_END_WITH',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
    'Name' => '<string>',
    'SearchJobArn' => '<string>',
    'SearchJobIdentifier' => '<string>',
    'SearchScope' => [
        'BackupResourceArns' => ['<string>', ...],
        'BackupResourceCreationTime' => [
            'CreatedAfter' => <DateTime>,
            'CreatedBefore' => <DateTime>,
        ],
        'BackupResourceTags' => ['<string>', ...],
        'BackupResourceTypes' => ['<string>', ...],
        'SourceResourceArns' => ['<string>', ...],
    ],
    'SearchScopeSummary' => [
        'TotalItemsToScanCount' => <integer>,
        'TotalRecoveryPointsToScanCount' => <integer>,
    ],
    'Status' => 'RUNNING|COMPLETED|STOPPING|STOPPED|FAILED',
    'StatusMessage' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource was not found for this request.

Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by a service.

InternalServerException:

An internal server error occurred. Retry your request.

GetSearchResultExportJob

$result = $client->getSearchResultExportJob([/* ... */]);
$promise = $client->getSearchResultExportJobAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getSearchResultExportJob([
    'ExportJobIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CompletionTime' => <DateTime>,
    'CreationTime' => <DateTime>,
    'ExportJobArn' => '<string>',
    'ExportJobIdentifier' => '<string>',
    'ExportSpecification' => [
        's3ExportSpecification' => [
            'DestinationBucket' => '<string>',
            'DestinationPrefix' => '<string>',
        ],
    ],
    'SearchJobArn' => '<string>',
    'Status' => 'RUNNING|FAILED|COMPLETED',
    'StatusMessage' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource was not found for this request.

Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by a service.

InternalServerException:

An internal server error occurred. Retry your request.

ListSearchJobBackups

$result = $client->listSearchJobBackups([/* ... */]);
$promise = $client->listSearchJobBackupsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listSearchJobBackups([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SearchJobIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Results' => [
        [
            'BackupCreationTime' => <DateTime>,
            'BackupResourceArn' => '<string>',
            'IndexCreationTime' => <DateTime>,
            'ResourceType' => 'S3|EBS',
            'SourceResourceArn' => '<string>',
            'Status' => 'RUNNING|COMPLETED|STOPPING|STOPPED|FAILED',
            'StatusMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource was not found for this request.

Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by a service.

InternalServerException:

An internal server error occurred. Retry your request.

ListSearchJobResults

$result = $client->listSearchJobResults([/* ... */]);
$promise = $client->listSearchJobResultsAsync([/* ... */]);

This operation returns a list of a specified search job.

Parameter Syntax

$result = $client->listSearchJobResults([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SearchJobIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Results' => [
        [
            'EBSResultItem' => [
                'BackupResourceArn' => '<string>',
                'BackupVaultName' => '<string>',
                'CreationTime' => <DateTime>,
                'FilePath' => '<string>',
                'FileSize' => <integer>,
                'FileSystemIdentifier' => '<string>',
                'LastModifiedTime' => <DateTime>,
                'SourceResourceArn' => '<string>',
            ],
            'S3ResultItem' => [
                'BackupResourceArn' => '<string>',
                'BackupVaultName' => '<string>',
                'CreationTime' => <DateTime>,
                'ETag' => '<string>',
                'ObjectKey' => '<string>',
                'ObjectSize' => <integer>,
                'SourceResourceArn' => '<string>',
                'VersionId' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource was not found for this request.

Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by a service.

InternalServerException:

An internal server error occurred. Retry your request.

ListSearchJobs

$result = $client->listSearchJobs([/* ... */]);
$promise = $client->listSearchJobsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listSearchJobs([
    'ByStatus' => 'RUNNING|COMPLETED|STOPPING|STOPPED|FAILED',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'SearchJobs' => [
        [
            'CompletionTime' => <DateTime>,
            'CreationTime' => <DateTime>,
            'Name' => '<string>',
            'SearchJobArn' => '<string>',
            'SearchJobIdentifier' => '<string>',
            'SearchScopeSummary' => [
                'TotalItemsToScanCount' => <integer>,
                'TotalRecoveryPointsToScanCount' => <integer>,
            ],
            'Status' => 'RUNNING|COMPLETED|STOPPING|STOPPED|FAILED',
            'StatusMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by a service.

InternalServerException:

An internal server error occurred. Retry your request.

ListSearchResultExportJobs

$result = $client->listSearchResultExportJobs([/* ... */]);
$promise = $client->listSearchResultExportJobsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listSearchResultExportJobs([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SearchJobIdentifier' => '<string>',
    'Status' => 'RUNNING|FAILED|COMPLETED',
]);

Parameter Details

Result Syntax

[
    'ExportJobs' => [
        [
            'CompletionTime' => <DateTime>,
            'CreationTime' => <DateTime>,
            'ExportJobArn' => '<string>',
            'ExportJobIdentifier' => '<string>',
            'SearchJobArn' => '<string>',
            'Status' => 'RUNNING|FAILED|COMPLETED',
            'StatusMessage' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource was not found for this request.

Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by a service.

InternalServerException:

An internal server error occurred. Retry your request.

ServiceQuotaExceededException:

The request denied due to exceeding the quota limits permitted.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

This operation returns the tags for a resource type.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

The resource was not found for this request.

Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by a service.

InternalServerException:

An internal server error occurred. Retry your request.

StartSearchJob

$result = $client->startSearchJob([/* ... */]);
$promise = $client->startSearchJobAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->startSearchJob([
    'ClientToken' => '<string>',
    'EncryptionKeyArn' => '<string>',
    'ItemFilters' => [
        'EBSItemFilters' => [
            [
                'CreationTimes' => [
                    [
                        'Operator' => 'EQUALS_TO|NOT_EQUALS_TO|LESS_THAN_EQUAL_TO|GREATER_THAN_EQUAL_TO',
                        'Value' => <integer || string || DateTime>, // REQUIRED
                    ],
                    // ...
                ],
                'FilePaths' => [
                    [
                        'Operator' => 'EQUALS_TO|NOT_EQUALS_TO|CONTAINS|DOES_NOT_CONTAIN|BEGINS_WITH|ENDS_WITH|DOES_NOT_BEGIN_WITH|DOES_NOT_END_WITH',
                        'Value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'LastModificationTimes' => [
                    [
                        'Operator' => 'EQUALS_TO|NOT_EQUALS_TO|LESS_THAN_EQUAL_TO|GREATER_THAN_EQUAL_TO',
                        'Value' => <integer || string || DateTime>, // REQUIRED
                    ],
                    // ...
                ],
                'Sizes' => [
                    [
                        'Operator' => 'EQUALS_TO|NOT_EQUALS_TO|LESS_THAN_EQUAL_TO|GREATER_THAN_EQUAL_TO',
                        'Value' => <integer>, // REQUIRED
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'S3ItemFilters' => [
            [
                'CreationTimes' => [
                    [
                        'Operator' => 'EQUALS_TO|NOT_EQUALS_TO|LESS_THAN_EQUAL_TO|GREATER_THAN_EQUAL_TO',
                        'Value' => <integer || string || DateTime>, // REQUIRED
                    ],
                    // ...
                ],
                'ETags' => [
                    [
                        'Operator' => 'EQUALS_TO|NOT_EQUALS_TO|CONTAINS|DOES_NOT_CONTAIN|BEGINS_WITH|ENDS_WITH|DOES_NOT_BEGIN_WITH|DOES_NOT_END_WITH',
                        'Value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'ObjectKeys' => [
                    [
                        'Operator' => 'EQUALS_TO|NOT_EQUALS_TO|CONTAINS|DOES_NOT_CONTAIN|BEGINS_WITH|ENDS_WITH|DOES_NOT_BEGIN_WITH|DOES_NOT_END_WITH',
                        'Value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'Sizes' => [
                    [
                        'Operator' => 'EQUALS_TO|NOT_EQUALS_TO|LESS_THAN_EQUAL_TO|GREATER_THAN_EQUAL_TO',
                        'Value' => <integer>, // REQUIRED
                    ],
                    // ...
                ],
                'VersionIds' => [
                    [
                        'Operator' => 'EQUALS_TO|NOT_EQUALS_TO|CONTAINS|DOES_NOT_CONTAIN|BEGINS_WITH|ENDS_WITH|DOES_NOT_BEGIN_WITH|DOES_NOT_END_WITH',
                        'Value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
    'Name' => '<string>',
    'SearchScope' => [ // REQUIRED
        'BackupResourceArns' => ['<string>', ...],
        'BackupResourceCreationTime' => [
            'CreatedAfter' => <integer || string || DateTime>,
            'CreatedBefore' => <integer || string || DateTime>,
        ],
        'BackupResourceTags' => ['<string>', ...],
        'BackupResourceTypes' => ['<string>', ...], // REQUIRED
        'SourceResourceArns' => ['<string>', ...],
    ],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'CreationTime' => <DateTime>,
    'SearchJobArn' => '<string>',
    'SearchJobIdentifier' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by a service.

InternalServerException:

An internal server error occurred. Retry your request.

ServiceQuotaExceededException:

The request denied due to exceeding the quota limits permitted.

ConflictException:

This exception occurs when a conflict with a previous successful operation is detected. This generally occurs when the previous operation did not have time to propagate to the host serving the current request.

A retry (with appropriate backoff logic) is the recommended response to this exception.

StartSearchResultExportJob

$result = $client->startSearchResultExportJob([/* ... */]);
$promise = $client->startSearchResultExportJobAsync([/* ... */]);

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

Parameter Syntax

$result = $client->startSearchResultExportJob([
    'ClientToken' => '<string>',
    'ExportSpecification' => [ // REQUIRED
        's3ExportSpecification' => [
            'DestinationBucket' => '<string>', // REQUIRED
            'DestinationPrefix' => '<string>',
        ],
    ],
    'RoleArn' => '<string>',
    'SearchJobIdentifier' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'ExportJobArn' => '<string>',
    'ExportJobIdentifier' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource was not found for this request.

Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by a service.

InternalServerException:

An internal server error occurred. Retry your request.

ServiceQuotaExceededException:

The request denied due to exceeding the quota limits permitted.

ConflictException:

This exception occurs when a conflict with a previous successful operation is detected. This generally occurs when the previous operation did not have time to propagate to the host serving the current request.

A retry (with appropriate backoff logic) is the recommended response to this exception.

StopSearchJob

$result = $client->stopSearchJob([/* ... */]);
$promise = $client->stopSearchJobAsync([/* ... */]);

This operations ends a search job.

Only a search job with a status of RUNNING can be stopped.

Parameter Syntax

$result = $client->stopSearchJob([
    'SearchJobIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource was not found for this request.

Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by a service.

InternalServerException:

An internal server error occurred. Retry your request.

ConflictException:

This exception occurs when a conflict with a previous successful operation is detected. This generally occurs when the previous operation did not have time to propagate to the host serving the current request.

A retry (with appropriate backoff logic) is the recommended response to this exception.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

This operation puts tags on the resource you indicate.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource was not found for this request.

Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by a service.

InternalServerException:

An internal server error occurred. Retry your request.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

This operation removes tags from the specified resource.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource was not found for this request.

Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by a service.

InternalServerException:

An internal server error occurred. Retry your request.