View a markdown version of this page

StartAnalysisLogExport - AWS Clean Rooms

StartAnalysisLogExport

Starts an export of the Apache Spark logs for a protected query to an Amazon S3 bucket that you own. Use the exported logs to diagnose a query that failed or that ran more slowly than you expected.

AWS Clean Rooms exports a redacted copy of the Spark logs instead of the raw logs. Analyze the exported logs with the tooling of your choice, such as Spark History Server. For details about what the exported logs contain, see https://docs.aws.amazon.com/clean-rooms/latest/userguide/export-analysis-logs-contents.html.

The export runs asynchronously and returns with a status of IN_PROGRESS. Call GetAnalysisLogExport to poll for the final status.

Important

To use this operation, you must have the CAN_EXPORT_QUERY_ANALYSIS_LOG ability for your membership. You must also be the query runner or the query payer. Having the ability alone is not sufficient.

The query must have reached a terminal state, and it must have reached the execution stage. A query that failed validation or that was canceled before it started produces no Spark logs.

Log export isn't supported for queries that use differential privacy, and isn't supported for PySpark jobs.

The destination bucket must be in the same AWS Region as the collaboration. Cross-Region export isn't supported.

For more information, see https://docs.aws.amazon.com/clean-rooms/latest/userguide/export-analysis-logs.html.

Request Syntax

POST /memberships/membershipIdentifier/analysislogexports HTTP/1.1 Content-type: application/json { "analysisId": "string", "analysisType": "string", "resultConfiguration": { "outputConfiguration": { "s3": { "bucket": "string", "keyPrefix": "string" } } } }

URI Request Parameters

The request uses the following URI parameters.

membershipIdentifier

A unique identifier for the membership to export the analysis logs for. Currently accepts a membership ID.

Length Constraints: Fixed length of 36.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]