GetArchiveSearch
Retrieves the details and current status of a specific email archive search job.
Request Syntax
{
"SearchId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- SearchId
-
The identifier of the search job to get details for.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: Yes
Response Syntax
{
"ArchiveId": "string",
"Filters": {
"Include": [
{ ... }
],
"Unless": [
{ ... }
]
},
"FromTimestamp": number,
"MaxResults": number,
"Status": {
"CompletionTimestamp": number,
"ErrorMessage": "string",
"State": "string",
"SubmissionTimestamp": number
},
"ToTimestamp": number
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ArchiveId
-
The identifier of the archive the email search was performed in.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 66.
Pattern:
^a-[\w]{1,64}$ - Filters
-
The criteria used to filter emails included in the search.
Type: ArchiveFilters object
- FromTimestamp
-
The start timestamp of the range the searched emails cover.
Type: Timestamp
- MaxResults
-
The maximum number of search results to return.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 1000.
- Status
-
The current status of the search job.
Type: SearchStatus object
- ToTimestamp
-
The end timestamp of the range the searched emails cover.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Occurs when a user is denied access to a specific resource or action.
HTTP Status Code: 400
- ThrottlingException
-
Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
HTTP Status Code: 400
- ValidationException
-
The request validation has failed. For details, see the accompanying error message.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
