AWS CLI Command Reference

[ aws . cleanrooms ]

get-analysis-log-export

Description

Returns information about an analysis log export, including its current status and, if the export failed, the reason for the failure.

Poll this operation until the status is SUCCESS or FAILED . An export can’t be canceled after it starts.

See also: AWS API Documentation

Synopsis

  get-analysis-log-export
--membership-identifier <value>
--analysis-log-export-identifier <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]
[--cli-error-format <value>]

Options

--membership-identifier (string) [required]

A unique identifier for the membership that the analysis log export belongs to. Currently accepts the membership ID.

Constraints:

  • min: 36
  • max: 36
  • pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

--analysis-log-export-identifier (string) [required]

The unique identifier of the analysis log export to retrieve.

Constraints:

  • min: 36
  • max: 36
  • pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

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

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

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

analysisLogExport -> (structure)

The analysis log export processing metadata.

analysisLogExportId -> (string) [required]

The unique identifier of the analysis log export.

Constraints:

  • min: 36
  • max: 36
  • pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

analysisId -> (string) [required]

The unique identifier of the protected query that the analysis logs were exported for.

Constraints:

  • min: 36
  • max: 36
  • pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

analysisType -> (string) [required]

The type of analysis that the logs were exported for. Currently, only PROTECTED_QUERY is supported.

Possible values:

  • PROTECTED_QUERY

membershipId -> (string) [required]

The unique identifier of the membership that the analysis log export belongs to.

Constraints:

  • min: 36
  • max: 36
  • pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

status -> (string) [required]

The status of the analysis log export. Possible values are:

  • IN_PROGRESS – The export is currently running.
  • SUCCESS – The export completed successfully.
  • FAILED – The export failed. See the error field for details.

Possible values:

  • IN_PROGRESS
  • SUCCESS
  • FAILED

resultConfiguration -> (structure) [required]

Contains the details needed to write the exported analysis logs.

outputConfiguration -> (structure) [required]

The configuration for analysis log export results.

s3 -> (structure) [required]

Required configuration for an analysis log export with an s3 output type.

bucket -> (string) [required]

The S3 bucket that the exported analysis logs are written to. The bucket must be in the same Amazon Web Services Region as the collaboration.

Constraints:

  • min: 3
  • max: 63
  • pattern: .*(?!^(\d+\.)+\d+$)(^(([a-z0-9]|[a-z0-9][a-z0-9\-]*[a-z0-9])\.)*([a-z0-9]|[a-z0-9][a-z0-9\-]*[a-z0-9])$).*

keyPrefix -> (string)

The S3 key prefix under which the exported analysis logs are written.

Only one export can be in progress at a time for a given query and destination. To export the same query twice at once, use a different key prefix for the second export.

Constraints:

  • min: 0
  • max: 512
  • pattern: [\w!.=*/-]*

createTime -> (timestamp) [required]

The time the analysis log export was created.

updateTime -> (timestamp) [required]

The time the analysis log export was last updated.

error -> (structure)

The analysis log export error. This is present only when the export status is FAILED .

code -> (string) [required]

The error code for the analysis log export.

message -> (string) [required]

The message for the analysis log export error.
© Copyright 2026, Amazon Web Services. Created using Sphinx.