- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
ListMailboxExportJobsCommand
Lists the mailbox export jobs started for the specified organization within the last seven days.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { WorkMailClient, ListMailboxExportJobsCommand } from "@aws-sdk/client-workmail"; // ES Modules import
// const { WorkMailClient, ListMailboxExportJobsCommand } = require("@aws-sdk/client-workmail"); // CommonJS import
const client = new WorkMailClient(config);
const input = { // ListMailboxExportJobsRequest
OrganizationId: "STRING_VALUE", // required
NextToken: "STRING_VALUE",
MaxResults: Number("int"),
};
const command = new ListMailboxExportJobsCommand(input);
const response = await client.send(command);
// { // ListMailboxExportJobsResponse
// Jobs: [ // Jobs
// { // MailboxExportJob
// JobId: "STRING_VALUE",
// EntityId: "STRING_VALUE",
// Description: "STRING_VALUE",
// S3BucketName: "STRING_VALUE",
// S3Path: "STRING_VALUE",
// EstimatedProgress: Number("int"),
// State: "RUNNING" || "COMPLETED" || "FAILED" || "CANCELLED",
// StartTime: new Date("TIMESTAMP"),
// EndTime: new Date("TIMESTAMP"),
// },
// ],
// NextToken: "STRING_VALUE",
// };
ListMailboxExportJobsCommand Input
See ListMailboxExportJobsCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
OrganizationIdRequired | string | undefined | The organization ID. |
MaxResults | number | undefined | The maximum number of results to return in a single call. |
NextToken | string | undefined | The token to use to retrieve the next page of results. |
ListMailboxExportJobsCommand Output
See ListMailboxExportJobsCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Jobs | MailboxExportJob[] | undefined | The mailbox export job details. |
NextToken | string | undefined | The token to use to retrieve the next page of results. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| InvalidParameterException | client | One or more of the input parameters don't match the service's restrictions. |
| OrganizationNotFoundException | client | An operation received a valid organization identifier that either doesn't belong or exist in the system. |
| OrganizationStateException | client | The organization must have a valid state to perform certain operations on the organization or its members. |
| WorkMailServiceException | Base exception class for all service exceptions from WorkMail service. |