Amazon Clean Rooms Clean Rooms Configuredaudiencemodelassociations API

openapi: 3.1.0
info:
  title: AWS Clean Rooms Service Configuredaudiencemodelassociations API
  version: '2022-02-17'
  description: Generated from AWS's published Smithy model for AWS Clean Rooms Service. 7 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}/configuredaudiencemodelassociations/{configuredAudienceModelAssociationIdentifier}
  : get:
      operationId: GetCollaborationConfiguredAudienceModelAssociation
      summary: Get Collaboration Configured Audience Model Association
      description: Retrieves a configured audience model association within a collaboration.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollaborationConfiguredAudienceModelAssociationOutput'
        '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/GetCollaborationConfiguredAudienceModelAssociationInput'
      tags:
      - Configuredaudiencemodelassociations
  /collaborations/{collaborationIdentifier}/configuredaudiencemodelassociations:
    get:
      operationId: ListCollaborationConfiguredAudienceModelAssociations
      summary: List Collaboration Configured Audience Model Associations
      description: Lists configured audience model associations within a collaboration.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCollaborationConfiguredAudienceModelAssociationsOutput'
        '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/ListCollaborationConfiguredAudienceModelAssociationsInput'
      tags:
      - Configuredaudiencemodelassociations
  /memberships/{membershipIdentifier}/configuredaudiencemodelassociations:
    post:
      operationId: CreateConfiguredAudienceModelAssociation
      summary: Create Configured Audience Model Association
      description: Provides the details necessary to create a configured audience model association.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateConfiguredAudienceModelAssociationOutput'
        '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/CreateConfiguredAudienceModelAssociationInput'
      tags:
      - Configuredaudiencemodelassociations
    get:
      operationId: ListConfiguredAudienceModelAssociations
      summary: List Configured Audience Model Associations
      description: Lists information about requested configured audience model associations.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListConfiguredAudienceModelAssociationsOutput'
        '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/ListConfiguredAudienceModelAssociationsInput'
      tags:
      - Configuredaudiencemodelassociations
  /memberships/{membershipIdentifier}/configuredaudiencemodelassociations/{configuredAudienceModelAssociationIdentifier}:
    get:
      operationId: GetConfiguredAudienceModelAssociation
      summary: Get Configured Audience Model Association
      description: Returns information about a configured audience model association.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConfiguredAudienceModelAssociationOutput'
        '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/GetConfiguredAudienceModelAssociationInput'
      tags:
      - Configuredaudiencemodelassociations
    patch:
      operationId: UpdateConfiguredAudienceModelAssociation
      summary: Update Configured Audience Model Association
      description: Provides the details necessary to update a configured audience model association.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateConfiguredAudienceModelAssociationOutput'
        '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/UpdateConfiguredAudienceModelAssociationInput'
      tags:
      - Configuredaudiencemodelassociations
    delete:
      operationId: DeleteConfiguredAudienceModelAssociation
      summary: Delete Configured Audience Model Association
      description: Provides the information necessary to delete a configured audience model association.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteConfiguredAudienceModelAssociationOutput'
        '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/DeleteConfiguredAudienceModelAssociationInput'
      tags:
      - Configuredaudiencemodelassociations
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.
    CollaborationConfiguredAudienceModelAssociation:
      type: object
      properties:
        id:
          type: string
          description: The identifier of the configured audience model association.
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the configured audience model association.
        collaborationId:
          type: string
          description: A unique identifier for the collaboration that the configured audience model associations belong to.
            Accepts collaboration ID.
        collaborationArn:
          type: string
          description: The unique ARN for the configured audience model's associated collaboration.
        configuredAudienceModelArn:
          type: string
          description: The Amazon Resource Name (ARN) of the configure audience model.
        name:
          type: string
          description: The name of the configured audience model association.
        description:
          type: string
          description: The description of the configured audience model association.
        creatorAccountId:
          type: string
          description: The identifier used to reference members of the collaboration. Only supports Amazon Web Services account
            ID.
        createTime:
          type: string
          description: The time at which the configured audience model association was created.
        updateTime:
          type: string
          description: The most recent time at which the configured audience model association was updated.
      required:
      - id
      - arn
      - collaborationId
      - collaborationArn
      - configuredAudienceModelArn
      - name
      - creatorAccountId
      - createTime
      - updateTime
    CollaborationConfiguredAudienceModelAssociationSummary:
      type: object
      properties:
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the configured audience model association.
        createTime:
          type: string
          description: The time at which the configured audience model association was created.
        id:
          type: string
          description: The identifier of the configured audience model association.
        name:
          type: string
          description: The name of the configured audience model association.
        updateTime:
          type: string
          description: The most recent time at which the configured audience model association was updated.
        collaborationArn:
          type: string
          description: The unique ARN for the configured audience model's associated collaboration.
        collaborationId:
          type: string
          description: A unique identifier for the collaboration that the configured audience model associations belong to.
            Accepts collaboration ID.
        creatorAccountId:
          type: string
          description: The identifier used to reference members of the collaboration. Only supports Amazon Web Services account
            ID.
        description:
          type: string
          description: The description of the configured audience model association.
      required:
      - arn
      - createTime
      - id
      - name
      - updateTime
      - collaborationArn
      - collaborationId
      - creatorAccountId
    ConfiguredAudienceModelAssociation:
      type: object
      properties:
        id:
          type: string
          description: A unique identifier of the configured audience model association.
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the configured audience model association.
        configuredAudienceModelArn:
          type: string
          description: The Amazon Resource Name (ARN) of the configured audience model that was used for this configured audience
            model association.
        membershipId:
          type: string
          description: A unique identifier for the membership that contains this configured audience model association.
        membershipArn:
          type: string
          description: The Amazon Resource Name (ARN) of the membership that contains this configured audience model association.
        collaborationId:
          type: string
          description: A unique identifier of the collaboration that contains this configured audience model association.
        collaborationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the collaboration that contains this configured audience model association.
        name:
          type: string
          description: The name of the configured audience model association.
        manageResourcePolicies:
          type: boolean
          description: When TRUE, indicates that the resource policy for the configured audience model resource being associated
            is configured for Clean Rooms to manage permissions related to the given collaboration. When FALSE, indicates
            that the configured audience model resource owner will manage permissions related to the given collaboration.
        description:
          type: string
          description: The description of the configured audience model association.
        createTime:
          type: string
          description: The time at which the configured audience model association was created.
        updateTime:
          type: string
          description: The most recent time at which the configured audience model association was updated.
      required:
      - id
      - arn
      - configuredAudienceModelArn
      - membershipId
      - membershipArn
      - collaborationId
      - collaborationArn
      - name
      - manageResourcePolicies
      - createTime
      - updateTime
    ConfiguredAudienceModelAssociationSummary:
      type: object
      properties:
        membershipId:
          type: string
          description: A unique identifier of the membership that contains the configured audience model association.
        membershipArn:
          type: string
          description: The Amazon Resource Name (ARN) of the membership that contains the configured audience model association.
        collaborationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the collaboration that contains the configured audience model association.
        collaborationId:
          type: string
          description: A unique identifier of the collaboration that configured audience model is associated with.
        createTime:
          type: string
          description: The time at which the configured audience model association was created.
        updateTime:
          type: string
          description: The most recent time at which the configured audience model association was updated.
        id:
          type: string
          description: A unique identifier of the configured audience model association.
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the configured audience model association.
        name:
          type: string
          description: The name of the configured audience model association.
        configuredAudienceModelArn:
          type: string
          description: The Amazon Resource Name (ARN) of the configured audience model that was used for this configured audience
            model association.
        description:
          type: string
          description: The description of the configured audience model association.
      required:
      - membershipId
      - membershipArn
      - collaborationArn
      - collaborationId
      - createTime
      - updateTime
      - id
      - arn
      - name
      - configuredAudienceModelArn
    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.
    CreateConfiguredAudienceModelAssociationInput:
      type: object
      properties:
        membershipIdentifier:
          type: string
          description: A unique identifier for one of your memberships for a collaboration. The configured audience model
            is associated to the collaboration that this membership belongs to. Accepts a membership ID.
        configuredAudienceModelArn:
          type: string
          description: A unique identifier for the configured audience model that you want to associate.
        configuredAudienceModelAssociationName:
          type: string
          description: The name of the configured audience model association.
        manageResourcePolicies:
          type: boolean
          description: When TRUE, indicates that the resource policy for the configured audience model resource being associated
            is configured for Clean Rooms to manage permissions related to the given collaboration. When FALSE, indicates
            that the configured audience model resource owner will manage permissions related to the given collaboration.
            Setting this to TRUE requires you to have permissions to create, update, and delete the resource policy for the
            cleanrooms-ml resource when you call the DeleteConfiguredAudienceModelAssociation resource. In addition, if you
            are the collaboration creator and specify TRUE, yo
        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.
        description:
          type: string
          description: A description of the configured audience model association.
      required:
      - membershipIdentifier
      - configuredAudienceModelArn
      - configuredAudienceModelAssociationName
      - manageResourcePolicies
    CreateConfiguredAudienceModelAssociationOutput:
      type: object
      properties:
        configuredAudienceModelAssociation:
          $ref: '#/components/schemas/ConfiguredAudienceModelAssociation'
      required:
      - configuredAudienceModelAssociation
    DeleteConfiguredAudienceModelAssociationInput:
      type: object
      properties:
        configuredAudienceModelAssociationIdentifier:
          type: string
          description: A unique identifier of the configured audience model association that you want to delete.
        membershipIdentifier:
          type: string
          description: A unique identifier of the membership that contains the audience model association that you want to
            delete.
      required:
      - configuredAudienceModelAssociationIdentifier
      - membershipIdentifier
    DeleteConfiguredAudienceModelAssociationOutput:
      type: object
      properties: {}
    GetCollaborationConfiguredAudienceModelAssociationInput:
      type: object
      properties:
        collaborationIdentifier:
          type: string
          description: A unique identifier for the collaboration that the configured audience model association belongs to.
            Accepts a collaboration ID.
        configuredAudienceModelAssociationIdentifier:
          type: string
          description: A unique identifier for the configured audience model association that you want to retrieve.
      required:
      - collaborationIdentifier
      - configuredAudienceModelAssociationIdentifier
    GetCollaborationConfiguredAudienceModelAssociationOutput:
      type: object
      properties:
        collaborationConfiguredAudienceModelAssociation:
          $ref: '#/components/schemas/CollaborationConfiguredAudienceModelAssociation'
      required:
      - collaborationConfiguredAudienceModelAssociation
    GetConfiguredAudienceModelAssociationInput:
      type: object
      properties:
        configuredAudienceModelAssociationIdentifier:
          type: string
          description: A unique identifier for the configured audience model association that you want to retrieve.
        membershipIdentifier:
          type: string
          description: A unique identifier for the membership that contains the configured audience model association that
            you want to retrieve.
      required:
      - configuredAudienceModelAssociationIdentifier
      - membershipIdentifier
    GetConfiguredAudienceModelAssociationOutput:
      type: object
      properties:
        configuredAudienceModelAssociation:
          $ref: '#/components/schemas/ConfiguredAudienceModelAssociation'
      required:
      - configuredAudienceModelAssociation
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    ListCollaborationConfiguredAudienceModelAssociationsInput:
      type: object
      properties:
        collaborationIdentifier:
          type: string
          description: A unique identifier for the collaboration that the configured audience model association belongs to.
            Accepts a collaboration ID.
        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:
      - collaborationIdentifier
    ListCollaborationConfiguredAudienceModelAssociationsOutput:
      type: object
      properties:
        collaborationConfiguredAudienceModelAssociationSummaries:
          type: array
          items:
            $ref: '#/components/schemas/CollaborationConfiguredAudienceModelAssociationSummary'
          description: The metadata of the configured audience model association within a collaboration.
        nextToken:
          type: string
          description: The pagination token that's used to fetch the next set of results.
      required:
      - collaborationConfiguredAudienceModelAssociationSummaries
    ListConfiguredAudienceModelAssociationsInput:
      type: object
      properties:
        membershipIdentifier:
          type: string
          description: A unique identifier for a membership that contains the configured audience model associations that
            you want to retrieve.
        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
    ListConfiguredAudienceModelAssociationsOutput:
      type: object
      properties:
        configuredAudienceModelAssociationSummaries:
          type: array
          items:
            $ref: '#/components/schemas/ConfiguredAudienceModelAssociationSummary'
          description: Summaries of the configured audience model associations that you requested.
        nextToken:
          type: string
          description: The token value provided to access the next page of results.
      required:
      - configuredAudienceModelAssociationSummaries
    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
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
    UpdateConfiguredAudienceModelAssociationInput:
      type: object
      properties:
        configuredAudienceModelAssociationIdentifier:
          type: string
          description: A unique identifier for the configured audience model association that you want to update.
        membershipIdentifier:
          type: string
          description: A unique identifier of the membership that contains the configured audience model association that
            you want to update.
        description:
          type: string
          description: A new description for the configured audience model association.
        name:
          type: string
          description: A new name for the configured audience model association.
      required:
      - configuredAudienceModelAssociationIdentifier
      - membershipIdentifier
    UpdateConfiguredAudienceModelAssociationOutput:
      type: object
      properties:
        configuredAudienceModelAssociation:
          $ref: '#/components/schemas/ConfiguredAudienceModelAssociation'
      required:
      - configuredAudienceModelAssociation
    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)