Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListArchiveSearches

Returns a list of email archive search jobs.

Request Syntax


{
   "ArchiveId": "string",
   "NextToken": "string",
   "PageSize": number
}

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.

ArchiveId

The identifier of the archive.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 66.

Pattern: ^a-[\w]{1,64}$

Required: Yes

NextToken

If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

PageSize

The maximum number of archive search jobs that are returned per call. You can use NextToken to obtain further pages of archives.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No

Response Syntax


{
   "NextToken": "string",
   "Searches": [ 
      { 
         "SearchId": "string",
         "Status": { 
            "CompletionTimestamp": number,
            "ErrorMessage": "string",
            "State": "string",
            "SubmissionTimestamp": 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.

NextToken

If present, use to retrieve the next page of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Searches

The list of search job identifiers and statuses.

Type: Array of SearchSummary objects

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

ResourceNotFoundException

Occurs when a requested resource is not found.

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