StartArchiveExport
Initiates an export of emails from the specified archive.
Request Syntax
{
"ArchiveId": "string",
"ExportDestinationConfiguration": { ... },
"Filters": {
"Include": [
{ ... }
],
"Unless": [
{ ... }
]
},
"FromTimestamp": number,
"IncludeMetadata": boolean,
"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 export emails from.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 66.
Pattern:
^a-[\w]{1,64}$Required: Yes
- ExportDestinationConfiguration
-
Details on where to deliver the exported email data.
Type: ExportDestinationConfiguration object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
- Filters
-
Criteria to filter which emails are included in the export.
Type: ArchiveFilters object
Required: No
- FromTimestamp
-
The start of the timestamp range to include emails from.
Type: Timestamp
Required: Yes
- IncludeMetadata
-
Whether to include message metadata as JSON files in the export.
Type: Boolean
Required: No
- MaxResults
-
The maximum number of email items to include in the export.
Type: Integer
Required: No
- ToTimestamp
-
The end of the timestamp range to include emails from.
Type: Timestamp
Required: Yes
Response Syntax
{
"ExportId": "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.
- ExportId
-
The unique identifier for the initiated export 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
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
