[ aws . mailmanager ]

get-archive-search

Description

Retrieves the details and current status of a specific email archive search job.

See also: AWS API Documentation

Synopsis

  get-archive-search
--search-id <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--search-id (string)

The identifier of the search job to get details for.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
• yaml
• yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

ArchiveId -> (string)

The identifier of the archive the email search was performed in.

Filters -> (structure)

The criteria used to filter emails included in the search.

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)

FromTimestamp -> (timestamp)

The start timestamp of the range the searched emails cover.

MaxResults -> (integer)

The maximum number of search results to return.

Status -> (structure)

The current status of the search job.

CompletionTimestamp -> (timestamp)

The timestamp of when the search completed (if finished).

ErrorMessage -> (string)

An error message if the search failed.

State -> (string)

The current state of the search job.

SubmissionTimestamp -> (timestamp)

The timestamp of when the search was submitted.

ToTimestamp -> (timestamp)

The end timestamp of the range the searched emails cover.