CleanRoomsService / Client / get_analysis_log_export

get_analysis_log_export

CleanRoomsService.Client.get_analysis_log_export(**kwargs)

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

Request Syntax

response = client.get_analysis_log_export(
    membershipIdentifier='string',
    analysisLogExportIdentifier='string'
)

Parameters:

• membershipIdentifier (string) –

  [REQUIRED]

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

• analysisLogExportIdentifier (string) –

  [REQUIRED]

  The unique identifier of the analysis log export to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'analysisLogExport': {
        'analysisLogExportId': 'string',
        'analysisId': 'string',
        'analysisType': 'PROTECTED_QUERY',
        'membershipId': 'string',
        'status': 'IN_PROGRESS'|'SUCCESS'|'FAILED',
        'resultConfiguration': {
            'outputConfiguration': {
                's3': {
                    'bucket': 'string',
                    'keyPrefix': 'string'
                }
            }
        },
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1),
        'error': {
            'code': 'string',
            'message': 'string'
        }
    }
}

Response Structure

• (dict) –

  • analysisLogExport (dict) –

    The analysis log export processing metadata.

    • analysisLogExportId (string) –

      The unique identifier of the analysis log export.

    • analysisId (string) –

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

    • analysisType (string) –

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

    • membershipId (string) –

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

    • status (string) –

      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.

    • resultConfiguration (dict) –

      Contains the details needed to write the exported analysis logs.

      • outputConfiguration (dict) –

        The configuration for analysis log export results.

        • s3 (dict) –

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

          • bucket (string) –

            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.

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

    • createTime (datetime) –

      The time the analysis log export was created.

    • updateTime (datetime) –

      The time the analysis log export was last updated.

    • error (dict) –

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

      • code (string) –

        The error code for the analysis log export.

      • message (string) –

        The message for the analysis log export error.

Exceptions

• CleanRoomsService.Client.exceptions.ResourceNotFoundException

• CleanRoomsService.Client.exceptions.InternalServerException

• CleanRoomsService.Client.exceptions.ValidationException

• CleanRoomsService.Client.exceptions.ThrottlingException

• CleanRoomsService.Client.exceptions.AccessDeniedException