Amazon Clean Rooms Collaborations API

openapi: 3.1.0
info:
  title: AWS Clean Rooms Service Collaborations API
  version: '2022-02-17'
  description: Generated from AWS's published Smithy model for AWS Clean Rooms Service. 5 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:
  /collaborations:
    post:
      operationId: CreateCollaboration
      summary: Create Collaboration
      description: Creates a new collaboration.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCollaborationOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '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/CreateCollaborationInput'
      tags:
      - Collaborations
    get:
      operationId: ListCollaborations
      summary: List Collaborations
      description: Lists collaborations the caller owns, is active in, or has been invited to.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCollaborationsOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '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/ListCollaborationsInput'
      tags:
      - Collaborations
  /collaborations/{collaborationIdentifier}:
    get:
      operationId: GetCollaboration
      summary: Get Collaboration
      description: Returns metadata about a collaboration.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollaborationOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '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/GetCollaborationInput'
      tags:
      - Collaborations
    patch:
      operationId: UpdateCollaboration
      summary: Update Collaboration
      description: Updates collaboration metadata and can only be called by the collaboration owner.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateCollaborationOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '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/UpdateCollaborationInput'
      tags:
      - Collaborations
    delete:
      operationId: DeleteCollaboration
      summary: Delete Collaboration
      description: Deletes a collaboration. It can only be called by the collaboration owner.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteCollaborationOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '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/DeleteCollaborationInput'
      tags:
      - Collaborations
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.
    Collaboration:
      type: object
      properties:
        id:
          type: string
          description: The unique ID for the collaboration.
        arn:
          type: string
          description: The unique ARN for the collaboration.
        name:
          type: string
          description: A human-readable identifier provided by the collaboration owner. Display names are not unique.
        description:
          type: string
          description: A description of the collaboration provided by the collaboration owner.
        creatorAccountId:
          type: string
          description: The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services
            account ID.
        creatorDisplayName:
          type: string
          description: A display name of the collaboration creator.
        createTime:
          type: string
          description: The time when the collaboration was created.
        updateTime:
          type: string
          description: The time the collaboration metadata was last updated.
        memberStatus:
          type: string
          description: The status of a member in a collaboration.
        membershipId:
          type: string
          description: The unique ID for your membership within the collaboration.
        membershipArn:
          type: string
          description: The unique ARN for your membership within the collaboration.
        dataEncryptionMetadata:
          $ref: '#/components/schemas/DataEncryptionMetadata'
        queryLogStatus:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: An indicator as to whether query logging has been enabled or disabled for the collaboration. When ENABLED,
            Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch
            Logs. The default value is DISABLED.
        jobLogStatus:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: An indicator as to whether job logging has been enabled or disabled for the collaboration. When ENABLED,
            Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch
            Logs. The default value is DISABLED.
        analyticsEngine:
          type: string
          enum:
          - SPARK
          - CLEAN_ROOMS_SQL
          description: The analytics engine for the collaboration. After July 16, 2025, the CLEAN_ROOMS_SQL parameter will
            no longer be available.
        autoApprovedChangeTypes:
          type: array
          items:
            type: string
            enum:
            - ADD_MEMBER
            - GRANT_RECEIVE_RESULTS_ABILITY
            - REVOKE_RECEIVE_RESULTS_ABILITY
            - GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY
            - REVOKE_EXPORT_QUERY_ANALYSIS_LOG_ABILITY
          description: The types of change requests that are automatically approved for this collaboration.
        allowedResultRegions:
          type: array
          items:
            type: string
            enum:
            - us-west-1
            - us-west-2
            - us-east-1
            - us-east-2
            - af-south-1
            - ap-east-1
            - ap-east-2
            - ap-south-2
            - ap-southeast-1
            - ap-southeast-2
            - ap-southeast-3
            - ap-southeast-5
            - ap-southeast-4
            - ap-southeast-7
            - ap-south-1
            - ap-northeast-3
            - ap-northeast-1
            - ap-northeast-2
            - ca-central-1
            - ca-west-1
            - eu-south-1
            - eu-west-3
            - eu-south-2
            - eu-central-2
            - eu-central-1
            - eu-north-1
            - eu-west-1
            - eu-west-2
            - me-south-1
            - me-central-1
            - il-central-1
            - sa-east-1
            - mx-central-1
          description: The Amazon Web Services Regions where collaboration query results can be stored. Returns the list of
            Region identifiers that were specified when the collaboration was created. This list is used to enforce regional
            storage policies and compliance requirements.
        isMetricsEnabled:
          type: boolean
          description: An indicator as to whether metrics are enabled for the collaboration. When true, collaboration members
            can opt in to Amazon CloudWatch metrics for their membership queries.
      required:
      - id
      - arn
      - name
      - creatorAccountId
      - creatorDisplayName
      - createTime
      - updateTime
      - memberStatus
      - queryLogStatus
    CollaborationSummary:
      type: object
      properties:
        id:
          type: string
          description: The identifier for the collaboration.
        arn:
          type: string
          description: The ARN of the collaboration.
        name:
          type: string
          description: A human-readable identifier provided by the collaboration owner. Display names are not unique.
        creatorAccountId:
          type: string
          description: The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services
            account ID.
        creatorDisplayName:
          type: string
          description: The display name of the collaboration creator.
        createTime:
          type: string
          description: The time when the collaboration was created.
        updateTime:
          type: string
          description: The time the collaboration metadata was last updated.
        memberStatus:
          type: string
          description: The status of a member in a collaboration.
        membershipId:
          type: string
          description: The identifier of a member in a collaboration.
        membershipArn:
          type: string
          description: The ARN of a member in a collaboration.
        analyticsEngine:
          type: string
          enum:
          - SPARK
          - CLEAN_ROOMS_SQL
          description: The analytics engine. After July 16, 2025, the CLEAN_ROOMS_SQL parameter will no longer be available.
      required:
      - id
      - arn
      - name
      - creatorAccountId
      - creatorDisplayName
      - createTime
      - updateTime
      - memberStatus
    CreateCollaborationInput:
      type: object
      properties:
        members:
          type: array
          items:
            $ref: '#/components/schemas/MemberSpecification'
          description: A list of initial members, not including the creator. This list is immutable.
        name:
          type: string
          description: The display name for a collaboration.
        description:
          type: string
          description: A description of the collaboration provided by the collaboration owner.
        creatorMemberAbilities:
          type: array
          items:
            type: string
            enum:
            - CAN_QUERY
            - CAN_RECEIVE_RESULTS
            - CAN_RUN_JOB
            - CAN_EXPORT_QUERY_ANALYSIS_LOG
          description: The abilities granted to the collaboration creator.
        creatorMLMemberAbilities:
          $ref: '#/components/schemas/MLMemberAbilities'
        creatorDisplayName:
          type: string
          description: The display name of the collaboration creator.
        dataEncryptionMetadata:
          $ref: '#/components/schemas/DataEncryptionMetadata'
        queryLogStatus:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: An indicator as to whether query logging has been enabled or disabled for the collaboration. When ENABLED,
            Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch
            Logs. The default value is DISABLED.
        jobLogStatus:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Specifies whether job logs are enabled for this collaboration. When ENABLED, Clean Rooms logs details
            about jobs run within this collaboration; those logs can be viewed in Amazon CloudWatch Logs. The default value
            is DISABLED.
        tags:
          type: object
          additionalProperties:
            type: string
          description: An optional label that you can assign to a resource when you create it. Each tag consists of a key
            and an optional value, both of which you define. When you use tagging, you can also use tag-based access control
            in IAM policies to control access to this resource.
        creatorPaymentConfiguration:
          $ref: '#/components/schemas/PaymentConfiguration'
        analyticsEngine:
          type: string
          enum:
          - SPARK
          - CLEAN_ROOMS_SQL
          description: The analytics engine. After July 16, 2025, the CLEAN_ROOMS_SQL parameter will no longer be available.
        autoApprovedChangeRequestTypes:
          type: array
          items:
            type: string
            enum:
            - ADD_MEMBER
            - GRANT_RECEIVE_RESULTS_ABILITY
            - REVOKE_RECEIVE_RESULTS_ABILITY
            - GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY
            - REVOKE_EXPORT_QUERY_ANALYSIS_LOG_ABILITY
          description: The types of change requests that are automatically approved for this collaboration.
        allowedResultRegions:
          type: array
          items:
            type: string
            enum:
            - us-west-1
            - us-west-2
            - us-east-1
            - us-east-2
            - af-south-1
            - ap-east-1
            - ap-east-2
            - ap-south-2
            - ap-southeast-1
            - ap-southeast-2
            - ap-southeast-3
            - ap-southeast-5
            - ap-southeast-4
            - ap-southeast-7
            - ap-south-1
            - ap-northeast-3
            - ap-northeast-1
            - ap-northeast-2
            - ca-central-1
            - ca-west-1
            - eu-south-1
            - eu-west-3
            - eu-south-2
            - eu-central-2
            - eu-central-1
            - eu-north-1
            - eu-west-1
            - eu-west-2
            - me-south-1
            - me-central-1
            - il-central-1
            - sa-east-1
            - mx-central-1
          description: The Amazon Web Services Regions where collaboration query results can be stored. When specified, results
            can only be written to these Regions. This parameter enables you to meet your compliance and data governance requirements,
            and implement regional data governance policies.
        isMetricsEnabled:
          type: boolean
          description: An indicator as to whether metrics have been enabled or disabled for the collaboration. When true,
            collaboration members can opt in to Amazon CloudWatch metrics for their membership queries. The default value
            is false.
      required:
      - members
      - name
      - creatorMemberAbilities
      - creatorDisplayName
      - queryLogStatus
    CreateCollaborationOutput:
      type: object
      properties:
        collaboration:
          $ref: '#/components/schemas/Collaboration'
      required:
      - collaboration
    DataEncryptionMetadata:
      type: object
      properties:
        allowCleartext:
          type: boolean
          description: Indicates whether encrypted tables can contain cleartext data (TRUE) or are to cryptographically process
            every column (FALSE).
        allowDuplicates:
          type: boolean
          description: Indicates whether Fingerprint columns can contain duplicate entries (TRUE) or are to contain only non-repeated
            values (FALSE).
        allowJoinsOnColumnsWithDifferentNames:
          type: boolean
          description: Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different
            name (TRUE) or can only be joined on Fingerprint columns of the same name (FALSE).
        preserveNulls:
          type: boolean
          description: Indicates whether NULL values are to be copied as NULL to encrypted tables (TRUE) or cryptographically
            processed (FALSE).
      required:
      - allowCleartext
      - allowDuplicates
      - allowJoinsOnColumnsWithDifferentNames
      - preserveNulls
    DeleteCollaborationInput:
      type: object
      properties:
        collaborationIdentifier:
          type: string
          description: The identifier for the collaboration.
      required:
      - collaborationIdentifier
    DeleteCollaborationOutput:
      type: object
      properties: {}
    GetCollaborationInput:
      type: object
      properties:
        collaborationIdentifier:
          type: string
          description: The identifier for the collaboration.
      required:
      - collaborationIdentifier
    GetCollaborationOutput:
      type: object
      properties:
        collaboration:
          $ref: '#/components/schemas/Collaboration'
      required:
      - collaboration
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    JobComputePaymentConfig:
      type: object
      properties:
        isResponsible:
          type: boolean
          description: Indicates whether the collaboration creator has configured the collaboration member to pay for query
            and job compute costs (TRUE) or has not configured the collaboration member to pay for query and job compute costs
            (FALSE). One or more members can be configured as payer candidates for query and job compute costs. An error is
            returned if the collaboration creator sets a FALSE value for the member who can run queries and jobs.
      required:
      - isResponsible
    ListCollaborationsInput:
      type: object
      properties:
        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.
        memberStatus:
          type: string
          description: The caller's status in a collaboration.
    ListCollaborationsOutput:
      type: object
      properties:
        nextToken:
          type: string
          description: The pagination token that's used to fetch the next set of results.
        collaborationList:
          type: array
          items:
            $ref: '#/components/schemas/CollaborationSummary'
          description: The list of collaborations.
      required:
      - collaborationList
    MLMemberAbilities:
      type: object
      properties:
        customMLMemberAbilities:
          type: array
          items:
            type: string
            enum:
            - CAN_RECEIVE_MODEL_OUTPUT
            - CAN_RECEIVE_INFERENCE_OUTPUT
          description: The custom ML member abilities for a collaboration member.
      required:
      - customMLMemberAbilities
    MLPaymentConfig:
      type: object
      properties:
        modelTraining:
          $ref: '#/components/schemas/ModelTrainingPaymentConfig'
        modelInference:
          $ref: '#/components/schemas/ModelInferencePaymentConfig'
        syntheticDataGeneration:
          $ref: '#/components/schemas/SyntheticDataGenerationPaymentConfig'
    MemberSpecification:
      type: object
      properties:
        accountId:
          type: string
          description: The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services
            account ID.
        memberAbilities:
          type: array
          items:
            type: string
            enum:
            - CAN_QUERY
            - CAN_RECEIVE_RESULTS
            - CAN_RUN_JOB
            - CAN_EXPORT_QUERY_ANALYSIS_LOG
          description: The abilities granted to the collaboration member.
        mlMemberAbilities:
          $ref: '#/components/schemas/MLMemberAbilities'
        displayName:
          type: string
          description: The member's display name.
        paymentConfiguration:
          $ref: '#/components/schemas/PaymentConfiguration'
      required:
      - accountId
      - memberAbilities
      - displayName
    ModelInferencePaymentConfig:
      type: object
      properties:
        isResponsible:
          type: boolean
          description: Indicates whether the collaboration creator has configured the collaboration member to pay for model
            inference costs (TRUE) or has not configured the collaboration member to pay for model inference costs (FALSE).
            One or more members can be configured as payer candidates for model inference costs. If the collaboration creator
            hasn't specified anyone as the member paying for model inference costs, then the member who can query is the default
            payer.
      required:
      - isResponsible
    ModelTrainingPaymentConfig:
      type: object
      properties:
        isResponsible:
          type: boolean
          description: Indicates whether the collaboration creator has configured the collaboration member to pay for model
            training costs (TRUE) or has not configured the collaboration member to pay for model training costs (FALSE).
            One or more members can be configured as payer candidates for model training costs. If the collaboration creator
            hasn't specified anyone as the member paying for model training costs, then the member who can query is the default
            payer.
      required:
      - isResponsible
    PaymentConfiguration:
      type: object
      properties:
        queryCompute:
          $ref: '#/components/schemas/QueryComputePaymentConfig'
        machineLearning:
          $ref: '#/components/schemas/MLPaymentConfig'
        jobCompute:
          $ref: '#/components/schemas/JobComputePaymentConfig'
      required:
      - queryCompute
    QueryComputePaymentConfig:
      type: object
      properties:
        isResponsible:
          type: boolean
          description: Indicates whether the collaboration creator has configured the collaboration member to pay for query
            compute costs (TRUE) or has not configured the collaboration member to pay for query compute costs (FALSE). One
            or more members can be configured as payer candidates for query compute costs. If the collaboration creator hasn't
            specified anyone as the member paying for query compute costs, then the member who can query is the default payer.
      required:
      - isResponsible
    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
    SyntheticDataGenerationPaymentConfig:
      type: object
      properties:
        isResponsible:
          type: boolean
          description: Indicates who is responsible for paying for synthetic data generation.
      required:
      - isResponsible
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
    UpdateCollaborationInput:
      type: object
      properties:
        collaborationIdentifier:
          type: string
          description: The identifier for the collaboration.
        name:
          type: string
          description: A human-readable identifier provided by the collaboration owner. Display names are not unique.
        description:
          type: string
          description: A description of the collaboration.
        analyticsEngine:
          type: string
          enum:
          - SPARK
          - CLEAN_ROOMS_SQL
          description: The analytics engine. After July 16, 2025, the CLEAN_ROOMS_SQL parameter will no longer be available.
      required:
      - collaborationIdentifier
    UpdateCollaborationOutput:
      type: object
      properties:
        collaboration:
          $ref: '#/components/schemas/Collaboration'
      required:
      - collaboration
    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)