Amazon Clean Rooms Clean Rooms Analysislogexports API

openapi: 3.1.0
info:
  title: AWS Clean Rooms Service Analysislogexports API
  version: '2022-02-17'
  description: Generated from AWS's published Smithy model for AWS Clean Rooms Service. 3 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://cleanrooms.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /memberships/{membershipIdentifier}/analysislogexports/{analysisLogExportIdentifier}:
    get:
      operationId: GetAnalysisLogExport
      summary: 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.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAnalysisLogExportOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAnalysisLogExportInput'
      tags:
      - Analysislogexports
  /memberships/{membershipIdentifier}/analysislogexports:
    get:
      operationId: ListAnalysisLogExports
      summary: List Analysis Log Exports
      description: Lists analysis log exports, sorted by the most recent export. Results are paginated. Use the nextToken
        parameter to retrieve additional results.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAnalysisLogExportsOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListAnalysisLogExportsInput'
      tags:
      - Analysislogexports
    post:
      operationId: StartAnalysisLogExport
      summary: Start Analysis Log Export
      description: 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. 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. 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 Amazon Web Services Reg
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartAnalysisLogExportOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartAnalysisLogExportInput'
      tags:
      - Analysislogexports
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: cleanrooms
  schemas:
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
          description: A reason code for the exception.
    AnalysisLogExport:
      type: object
      properties:
        analysisLogExportId:
          type: string
          description: The unique identifier of the analysis log export.
        analysisId:
          type: string
          description: The unique identifier of the protected query that the analysis logs were exported for.
        analysisType:
          type: string
          enum:
          - PROTECTED_QUERY
          description: The type of analysis that the logs were exported for. Currently, only PROTECTED_QUERY is supported.
        membershipId:
          type: string
          description: The unique identifier of the membership that the analysis log export belongs to.
        status:
          type: string
          enum:
          - IN_PROGRESS
          - SUCCESS
          - FAILED
          description: '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:
          $ref: '#/components/schemas/AnalysisLogExportResultConfiguration'
        createTime:
          type: string
          description: The time the analysis log export was created.
        updateTime:
          type: string
          description: The time the analysis log export was last updated.
        error:
          $ref: '#/components/schemas/AnalysisLogExportError'
      required:
      - analysisLogExportId
      - analysisId
      - analysisType
      - membershipId
      - status
      - resultConfiguration
      - createTime
      - updateTime
    AnalysisLogExportError:
      type: object
      properties:
        code:
          type: string
          description: The error code for the analysis log export.
        message:
          type: string
          description: The message for the analysis log export error.
      required:
      - code
      - message
    AnalysisLogExportOutputConfiguration:
      type: object
      properties:
        s3:
          $ref: '#/components/schemas/AnalysisLogExportS3OutputConfiguration'
      required:
      - s3
    AnalysisLogExportResultConfiguration:
      type: object
      properties:
        outputConfiguration:
          $ref: '#/components/schemas/AnalysisLogExportOutputConfiguration'
      required:
      - outputConfiguration
    AnalysisLogExportS3OutputConfiguration:
      type: object
      properties:
        bucket:
          type: string
          description: 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:
          type: string
          description: 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.
      required:
      - bucket
    AnalysisLogExportSummary:
      type: object
      properties:
        analysisLogExportId:
          type: string
          description: The unique identifier of the analysis log export.
        analysisId:
          type: string
          description: The unique identifier of the protected query that the analysis logs were exported for.
        analysisType:
          type: string
          enum:
          - PROTECTED_QUERY
          description: The type of analysis that the logs were exported for. Currently, only PROTECTED_QUERY is supported.
        status:
          type: string
          enum:
          - IN_PROGRESS
          - SUCCESS
          - FAILED
          description: '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:
          type: string
          description: The time the analysis log export was created.
      required:
      - analysisLogExportId
      - analysisId
      - analysisType
      - status
      - createTime
    GetAnalysisLogExportInput:
      type: object
      properties:
        membershipIdentifier:
          type: string
          description: A unique identifier for the membership that the analysis log export belongs to. Currently accepts the
            membership ID.
        analysisLogExportIdentifier:
          type: string
          description: The unique identifier of the analysis log export to retrieve.
      required:
      - membershipIdentifier
      - analysisLogExportIdentifier
    GetAnalysisLogExportOutput:
      type: object
      properties:
        analysisLogExport:
          $ref: '#/components/schemas/AnalysisLogExport'
      required:
      - analysisLogExport
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    ListAnalysisLogExportsInput:
      type: object
      properties:
        membershipIdentifier:
          type: string
          description: A unique identifier for the membership to list analysis log exports for. Currently accepts the membership
            ID.
        analysisIdentifier:
          type: string
          description: A filter on the unique identifier of the protected query that the analysis logs were exported for.
        status:
          type: string
          enum:
          - IN_PROGRESS
          - SUCCESS
          - FAILED
          description: A filter on the status of the analysis log export.
        nextToken:
          type: string
          description: The pagination token that's used to fetch the next set of results.
        maxResults:
          type: integer
          description: 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.
      required:
      - membershipIdentifier
    ListAnalysisLogExportsOutput:
      type: object
      properties:
        nextToken:
          type: string
          description: The pagination token that's used to fetch the next set of results.
        analysisLogExports:
          type: array
          items:
            $ref: '#/components/schemas/AnalysisLogExportSummary'
          description: A list of analysis log exports.
      required:
      - analysisLogExports
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The Id of the missing resource.
        resourceType:
          type: string
          description: The type of the missing resource.
      required:
      - message
      - resourceId
      - resourceType
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
        quotaName:
          type: string
          description: The name of the quota.
        quotaValue:
          type: number
          description: The value of the quota.
      required:
      - message
      - quotaName
      - quotaValue
    StartAnalysisLogExportInput:
      type: object
      properties:
        membershipIdentifier:
          type: string
          description: A unique identifier for the membership to export the analysis logs for. Currently accepts a membership
            ID.
        analysisId:
          type: string
          description: The unique identifier of the protected query that you want to export the analysis logs for.
        analysisType:
          type: string
          enum:
          - PROTECTED_QUERY
          description: The type of analysis that the logs are exported for. Currently, only PROTECTED_QUERY is supported.
        resultConfiguration:
          $ref: '#/components/schemas/AnalysisLogExportResultConfiguration'
      required:
      - membershipIdentifier
      - analysisId
      - analysisType
      - resultConfiguration
    StartAnalysisLogExportOutput:
      type: object
      properties:
        analysisLogExport:
          $ref: '#/components/schemas/AnalysisLogExport'
      required:
      - analysisLogExport
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
    ValidationException:
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
          description: A reason code for the exception.
        fieldList:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
          description: Validation errors for specific input parameters.
    ValidationExceptionField:
      type: object
      properties:
        name:
          type: string
          description: The name of the input parameter.
        message:
          type: string
          description: A message for the input validation error.
      required:
      - name
      - message
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/cleanrooms/service/2022-02-17/cleanrooms-2022-02-17.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)