Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

StartArchiveSearch

Initiates a search across emails in the specified archive.

Request Syntax


{
   "ArchiveId": "string",
   "Filters": { 
      "Include": [ 
         { ... }
      ],
      "Unless": [ 
         { ... }
      ]
   },
   "FromTimestamp": number,
   "MaxResults": number,
   "ToTimestamp": 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 to search emails in.

Type: String

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

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

Required: Yes

Filters

Criteria to filter which emails are included in the search results.

Type: ArchiveFilters object

Required: No

FromTimestamp

The start timestamp of the range to search emails from.

Type: Timestamp

Required: Yes

MaxResults

The maximum number of search results to return.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 1000.

Required: Yes

ToTimestamp

The end timestamp of the range to search emails from.

Type: Timestamp

Required: Yes

Response Syntax


{
   "SearchId": "string"
}

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.

SearchId

The unique identifier for the initiated search job.

Type: String

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

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

ConflictException

The request configuration has conflicts. For details, see the accompanying error message.

HTTP Status Code: 400

ResourceNotFoundException

Occurs when a requested resource is not found.

HTTP Status Code: 400

ServiceQuotaExceededException

Occurs when an operation exceeds a predefined service quota or limit.

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