CleanRoomsService / Client / list_analysis_log_exports

list_analysis_log_exports

CleanRoomsService.Client.list_analysis_log_exports(**kwargs)

Lists analysis log exports, sorted by the most recent export. Results are paginated. Use the nextToken parameter to retrieve additional results.

See also: AWS API Documentation

Request Syntax

response = client.list_analysis_log_exports(
    membershipIdentifier='string',
    analysisIdentifier='string',
    status='IN_PROGRESS'|'SUCCESS'|'FAILED',
    nextToken='string',
    maxResults=123
)
Parameters:

  • membershipIdentifier (string) –

    [REQUIRED]

    A unique identifier for the membership to list analysis log exports for. Currently accepts the membership ID.

  • analysisIdentifier (string) – A filter on the unique identifier of the protected query that the analysis logs were exported for.

  • status (string) – A filter on the status of the analysis log export.

  • nextToken (string) – The pagination token that’s used to fetch the next set of results.

  • maxResults (integer) – The maximum number of results that are returned for an API request call. The service chooses a default number if you don’t set one. The service might return a nextToken even if the maxResults value has not been met.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'analysisLogExports': [
        {
            'analysisLogExportId': 'string',
            'analysisId': 'string',
            'analysisType': 'PROTECTED_QUERY',
            'status': 'IN_PROGRESS'|'SUCCESS'|'FAILED',
            'createTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      The pagination token that’s used to fetch the next set of results.

    • analysisLogExports (list) –

      A list of analysis log exports.

      • (dict) –

        A summary of an analysis log export, including its identifier, status, analysis type, and creation time. Returned by ListAnalysisLogExports.

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

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

        • createTime (datetime) –

          The time the analysis log export was created.

Exceptions

  • CleanRoomsService.Client.exceptions.ResourceNotFoundException

  • CleanRoomsService.Client.exceptions.InternalServerException

  • CleanRoomsService.Client.exceptions.ValidationException

  • CleanRoomsService.Client.exceptions.ThrottlingException

  • CleanRoomsService.Client.exceptions.AccessDeniedException