AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . mailmanager ]

get-archive-message

Description

Returns a pre-signed URL that provides temporary download access to the specific email message stored in the archive.

See also: AWS API Documentation

Synopsis

  get-archive-message
--archived-message-id <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>]
[--v2-debug]

Options

--archived-message-id (string)

The unique identifier of the archived email message.

--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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--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.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

MessageDownloadLink -> (string)

A pre-signed URL to temporarily download the full message content.

Metadata -> (structure)

The metadata about the email.

Timestamp -> (timestamp)

The timestamp of when the email was received.

IngressPointId -> (string)

The ID of the ingress endpoint through which the email was received.

TrafficPolicyId -> (string)

The ID of the traffic policy that was in effect when the email was received.

RuleSetId -> (string)

The ID of the rule set that processed the email.

SenderHostname -> (string)

The name of the host from which the email was received.

SenderIpAddress -> (string)

The IP address of the host from which the email was received.

TlsCipherSuite -> (string)

The TLS cipher suite used to communicate with the host from which the email was received.

TlsProtocol -> (string)

The TLS protocol used to communicate with the host from which the email was received.

SendingMethod -> (string)

The name of the API call used when sent through a configuration set with archiving enabled.

SourceIdentity -> (string)

The identity name used to authorize the sending action when sent through a configuration set with archiving enabled.

SendingPool -> (string)

The name of the dedicated IP pool used when sent through a configuration set with archiving enabled.

ConfigurationSet -> (string)

The name of the configuration set used when sent through a configuration set with archiving enabled.

SourceArn -> (string)

Specifies the archived email source, identified by either a Rule Set’s ARN with an Archive action, or a Configuration Set’s Archive ARN.

Envelope -> (structure)

The SMTP envelope information of the email.

Helo -> (string)

The HELO used by the host from which the email was received.

From -> (string)

The RCPT FROM given by the host from which the email was received.

To -> (list)

All SMTP TO entries given by the host from which the email was received.

(string)