Amazon Clean Rooms Clean Rooms Changerequests API

openapi: 3.1.0
info:
  title: AWS Clean Rooms Service Changerequests API
  version: '2022-02-17'
  description: Generated from AWS's published Smithy model for AWS Clean Rooms Service. 4 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/{collaborationIdentifier}/changeRequests:
    post:
      operationId: CreateCollaborationChangeRequest
      summary: Create Collaboration Change Request
      description: Creates a new change request to modify an existing collaboration. This enables post-creation modifications
        to collaborations through a structured API-driven approach.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCollaborationChangeRequestOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '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/CreateCollaborationChangeRequestInput'
      tags:
      - Changerequests
    get:
      operationId: ListCollaborationChangeRequests
      summary: List Collaboration Change Requests
      description: Lists all change requests for a collaboration with pagination support. Returns change requests sorted by
        creation time.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCollaborationChangeRequestsOutput'
        '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/ListCollaborationChangeRequestsInput'
      tags:
      - Changerequests
  /collaborations/{collaborationIdentifier}/changeRequests/{changeRequestIdentifier}:
    get:
      operationId: GetCollaborationChangeRequest
      summary: Get Collaboration Change Request
      description: Retrieves detailed information about a specific collaboration change request.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollaborationChangeRequestOutput'
        '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/GetCollaborationChangeRequestInput'
      tags:
      - Changerequests
    patch:
      operationId: UpdateCollaborationChangeRequest
      summary: Update Collaboration Change Request
      description: Updates an existing collaboration change request. This operation allows approval actions for pending change
        requests in collaborations (APPROVE, DENY, CANCEL, COMMIT). For change requests without automatic approval, a member
        in the collaboration can manually APPROVE or DENY a change request. The collaboration owner can manually CANCEL or
        COMMIT a change request.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateCollaborationChangeRequestOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '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/UpdateCollaborationChangeRequestInput'
      tags:
      - Changerequests
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.
    ApprovalStatusDetails:
      type: object
      properties:
        status:
          type: string
          enum:
          - APPROVED
          - DENIED
          - PENDING
          description: The approval status of a member's vote on the change request. Valid values are PENDING (if they haven't
            voted), APPROVED, or DENIED.
      required:
      - status
    Change:
      type: object
      properties:
        specificationType:
          type: string
          enum:
          - MEMBER
          - COLLABORATION
          description: The type of specification for this change.
        specification:
          $ref: '#/components/schemas/ChangeSpecification'
        types:
          type: array
          items:
            type: string
            enum:
            - ADD_MEMBER
            - GRANT_RECEIVE_RESULTS_ABILITY
            - REVOKE_RECEIVE_RESULTS_ABILITY
            - EDIT_AUTO_APPROVED_CHANGE_TYPES
            - ADD_PAYER_CANDIDATE
            - REMOVE_PAYER_CANDIDATE
            - GRANT_CAN_RECEIVE_MODEL_OUTPUT
            - GRANT_CAN_RECEIVE_INFERENCE_OUTPUT
            - REVOKE_CAN_RECEIVE_MODEL_OUTPUT
            - REVOKE_CAN_RECEIVE_INFERENCE_OUTPUT
            - GRANT_EXPORT_QUERY_ANALYSIS_LOG_ABILITY
            - REVOKE_EXPORT_QUERY_ANALYSIS_LOG_ABILITY
          description: The list of change types that were applied.
      required:
      - specificationType
      - specification
      - types
    ChangeInput:
      type: object
      properties:
        specificationType:
          type: string
          enum:
          - MEMBER
          - COLLABORATION
          description: The type of specification for the change. Currently supports MEMBER for member-related changes.
        specification:
          $ref: '#/components/schemas/ChangeSpecification'
      required:
      - specificationType
      - specification
    ChangeSpecification:
      type: object
      properties:
        member:
          $ref: '#/components/schemas/MemberChangeSpecification'
        collaboration:
          $ref: '#/components/schemas/CollaborationChangeSpecification'
      description: Exactly one member is set.
    CollaborationChangeRequest:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the change request.
        collaborationId:
          type: string
          description: The unique identifier for the collaboration being modified.
        createTime:
          type: string
          description: The time when the change request was created.
        updateTime:
          type: string
          description: The time when the change request was last updated.
        status:
          type: string
          enum:
          - PENDING
          - APPROVED
          - CANCELLED
          - DENIED
          - COMMITTED
          description: The current status of the change request. Valid values are PENDING, APPROVED, DENIED, COMMITTED, and
            CANCELLED.
        isAutoApproved:
          type: boolean
          description: Whether the change request was automatically approved based on the collaboration's auto-approval settings.
        changes:
          type: array
          items:
            $ref: '#/components/schemas/Change'
          description: The list of changes specified in this change request.
        approvals:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ApprovalStatusDetails'
          description: A list of approval details from collaboration members, including approval status and multi-party approval
            workflow information.
      required:
      - id
      - collaborationId
      - createTime
      - updateTime
      - status
      - isAutoApproved
      - changes
    CollaborationChangeRequestSummary:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the change request.
        collaborationId:
          type: string
          description: The unique identifier for the collaboration.
        createTime:
          type: string
          description: The time when the change request was created.
        updateTime:
          type: string
          description: The time when the change request was last updated.
        status:
          type: string
          enum:
          - PENDING
          - APPROVED
          - CANCELLED
          - DENIED
          - COMMITTED
          description: The current status of the change request.
        isAutoApproved:
          type: boolean
          description: Whether the change request was automatically approved.
        changes:
          type: array
          items:
            $ref: '#/components/schemas/Change'
          description: Summary of the changes in this change request.
        approvals:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ApprovalStatusDetails'
          description: Summary of approval statuses from all collaboration members for this change request.
      required:
      - id
      - collaborationId
      - createTime
      - updateTime
      - status
      - isAutoApproved
      - changes
    CollaborationChangeSpecification:
      type: object
      properties:
        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: Defines requested updates to properties of the collaboration. Currently, this only supports modifying
            which change types are auto-approved for the collaboration.
    ConflictException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The ID of the conflicting resource.
        resourceType:
          type: string
          description: The type of the conflicting resource.
        reason:
          type: string
          description: A reason code for the exception.
    CreateCollaborationChangeRequestInput:
      type: object
      properties:
        collaborationIdentifier:
          type: string
          description: The identifier of the collaboration that the change request is made against.
        changes:
          type: array
          items:
            $ref: '#/components/schemas/ChangeInput'
          description: The list of changes to apply to the collaboration. Each change specifies the type of modification and
            the details of what should be changed.
      required:
      - collaborationIdentifier
      - changes
    CreateCollaborationChangeRequestOutput:
      type: object
      properties:
        collaborationChangeRequest:
          $ref: '#/components/schemas/CollaborationChangeRequest'
      required:
      - collaborationChangeRequest
    GetCollaborationChangeRequestInput:
      type: object
      properties:
        collaborationIdentifier:
          type: string
          description: The identifier of the collaboration that the change request is made against.
        changeRequestIdentifier:
          type: string
          description: A unique identifier for the change request to retrieve.
      required:
      - collaborationIdentifier
      - changeRequestIdentifier
    GetCollaborationChangeRequestOutput:
      type: object
      properties:
        collaborationChangeRequest:
          $ref: '#/components/schemas/CollaborationChangeRequest'
      required:
      - collaborationChangeRequest
    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
    ListCollaborationChangeRequestsInput:
      type: object
      properties:
        collaborationIdentifier:
          type: string
          description: The identifier of the collaboration that the change request is made against.
        status:
          type: string
          enum:
          - PENDING
          - APPROVED
          - CANCELLED
          - DENIED
          - COMMITTED
          description: A filter to only return change requests with the specified status.
        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.
      required:
      - collaborationIdentifier
    ListCollaborationChangeRequestsOutput:
      type: object
      properties:
        collaborationChangeRequestSummaries:
          type: array
          items:
            $ref: '#/components/schemas/CollaborationChangeRequestSummary'
          description: The list of collaboration change request summaries.
        nextToken:
          type: string
          description: The pagination token that's used to fetch the next set of results.
      required:
      - collaborationChangeRequestSummaries
    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'
    MemberChangeSpecification:
      type: object
      properties:
        accountId:
          type: string
          description: The Amazon Web Services account ID of the member to add to the collaboration.
        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. These determine what actions the member can perform
            within the collaboration. The following values are currently not supported: CAN_QUERY and CAN_RUN_JOB. Set the
            value of memberAbilities to [] to allow a member to contribute data. Set the value of memberAbilities to [CAN_RECEIVE_RESULTS]
            to allow a member to contribute data and receive results. Set the value of memberAbilities to [CAN_EXPORT_QUERY_ANALYSIS_LOG]
            so that the member can export the analysis logs for a protected query. Having this ability isn''t sufficient on
            its own: You can expor'
        mlMemberAbilities:
          $ref: '#/components/schemas/MLMemberAbilities'
        paymentConfiguration:
          $ref: '#/components/schemas/PaymentConfiguration'
        displayName:
          type: string
          description: Specifies the display name that will be shown for this member in the collaboration. While this field
            is required when inviting new members, it becomes optional when modifying abilities of existing collaboration
            members.
      required:
      - accountId
      - memberAbilities
    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
    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
    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
    UpdateCollaborationChangeRequestInput:
      type: object
      properties:
        collaborationIdentifier:
          type: string
          description: The unique identifier of the collaboration that contains the change request to be updated.
        changeRequestIdentifier:
          type: string
          description: The unique identifier of the specific change request to be updated within the collaboration.
        action:
          type: string
          enum:
          - APPROVE
          - DENY
          - CANCEL
          - COMMIT
          description: The action to perform on the change request. Valid values include APPROVE (approve the change), DENY
            (reject the change), CANCEL (cancel the request), and COMMIT (commit after the request is approved). For change
            requests without automatic approval, a member in the collaboration can manually APPROVE or DENY a change request.
            The collaboration owner can manually CANCEL or COMMIT a change request.
      required:
      - collaborationIdentifier
      - changeRequestIdentifier
      - action
    UpdateCollaborationChangeRequestOutput:
      type: object
      properties:
        collaborationChangeRequest:
          $ref: '#/components/schemas/CollaborationChangeRequest'
      required:
      - collaborationChangeRequest
    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)