AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . mailmanager ]

start-archive-export

Description

Initiates an export of emails from the specified archive.

See also: AWS API Documentation

Synopsis

  start-archive-export
--archive-id <value>
--export-destination-configuration <value>
[--filters <value>]
--from-timestamp <value>
[--max-results <value>]
--to-timestamp <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--archive-id (string)

The identifier of the archive to export emails from.

--export-destination-configuration (tagged union structure)

Details on where to deliver the exported email data.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: S3.

S3 -> (structure)

Configuration for delivering to an Amazon S3 bucket.

S3Location -> (string)

The S3 location to deliver the exported email data.

Shorthand Syntax:

S3={S3Location=string}

JSON Syntax:

{
  "S3": {
    "S3Location": "string"
  }
}

--filters (structure)

Criteria to filter which emails are included in the export.

Include -> (list)

The filter conditions for emails to include.

(tagged union structure)

A filter condition used to include or exclude emails when exporting from or searching an archive.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: BooleanExpression, StringExpression.

BooleanExpression -> (structure)

A boolean expression to evaluate against email attributes.

Evaluate -> (tagged union structure)

The email attribute value to evaluate.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Attribute.

Attribute -> (string)

The name of the email attribute to evaluate.

Operator -> (string)

The boolean operator to use for evaluation.

StringExpression -> (structure)

A string expression to evaluate against email attributes.

Evaluate -> (tagged union structure)

The attribute of the email to evaluate.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Attribute.

Attribute -> (string)

The name of the email attribute to evaluate.

Operator -> (string)

The operator to use when evaluating the string values.

Values -> (list)

The list of string values to evaluate the email attribute against.

(string)

Unless -> (list)

The filter conditions for emails to exclude.

(tagged union structure)

A filter condition used to include or exclude emails when exporting from or searching an archive.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: BooleanExpression, StringExpression.

BooleanExpression -> (structure)

A boolean expression to evaluate against email attributes.

Evaluate -> (tagged union structure)

The email attribute value to evaluate.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Attribute.

Attribute -> (string)

The name of the email attribute to evaluate.

Operator -> (string)

The boolean operator to use for evaluation.

StringExpression -> (structure)

A string expression to evaluate against email attributes.

Evaluate -> (tagged union structure)

The attribute of the email to evaluate.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Attribute.

Attribute -> (string)

The name of the email attribute to evaluate.

Operator -> (string)

The operator to use when evaluating the string values.

Values -> (list)

The list of string values to evaluate the email attribute against.

(string)

JSON Syntax:

{
  "Include": [
    {
      "BooleanExpression": {
        "Evaluate": {
          "Attribute": "HAS_ATTACHMENTS"
        },
        "Operator": "IS_TRUE"|"IS_FALSE"
      },
      "StringExpression": {
        "Evaluate": {
          "Attribute": "TO"|"FROM"|"CC"|"SUBJECT"
        },
        "Operator": "CONTAINS",
        "Values": ["string", ...]
      }
    }
    ...
  ],
  "Unless": [
    {
      "BooleanExpression": {
        "Evaluate": {
          "Attribute": "HAS_ATTACHMENTS"
        },
        "Operator": "IS_TRUE"|"IS_FALSE"
      },
      "StringExpression": {
        "Evaluate": {
          "Attribute": "TO"|"FROM"|"CC"|"SUBJECT"
        },
        "Operator": "CONTAINS",
        "Values": ["string", ...]
      }
    }
    ...
  ]
}

--from-timestamp (timestamp)

The start of the timestamp range to include emails from.

--max-results (integer)

The maximum number of email items to include in the export.

--to-timestamp (timestamp)

The end of the timestamp range to include emails from.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

ExportId -> (string)

The unique identifier for the initiated export job.