Amazon Clean Rooms Clean Rooms Idmappingtables API

openapi: 3.1.0
info:
  title: AWS Clean Rooms Service Idmappingtables 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:
  /memberships/{membershipIdentifier}/idmappingtables:
    post:
      operationId: CreateIdMappingTable
      summary: Create Id Mapping Table
      description: Creates an ID mapping table.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateIdMappingTableOutput'
        '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/CreateIdMappingTableInput'
      tags:
      - Idmappingtables
    get:
      operationId: ListIdMappingTables
      summary: List Id Mapping Tables
      description: Returns a list of ID mapping tables.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListIdMappingTablesOutput'
        '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/ListIdMappingTablesInput'
      tags:
      - Idmappingtables
  /memberships/{membershipIdentifier}/idmappingtables/{idMappingTableIdentifier}:
    get:
      operationId: GetIdMappingTable
      summary: Get Id Mapping Table
      description: Retrieves an ID mapping table.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetIdMappingTableOutput'
        '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/GetIdMappingTableInput'
      tags:
      - Idmappingtables
    patch:
      operationId: UpdateIdMappingTable
      summary: Update Id Mapping Table
      description: Provides the details that are necessary to update an ID mapping table.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateIdMappingTableOutput'
        '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/UpdateIdMappingTableInput'
      tags:
      - Idmappingtables
    delete:
      operationId: DeleteIdMappingTable
      summary: Delete Id Mapping Table
      description: Deletes an ID mapping table.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteIdMappingTableOutput'
        '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/DeleteIdMappingTableInput'
      tags:
      - Idmappingtables
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.
    ChildResource:
      type: object
      properties:
        resourceId:
          type: string
          description: The unique identifier of the child resource.
        resourceType:
          type: string
          enum:
          - INTERMEDIATE_TABLE
          description: The type of the child resource.
        resourceName:
          type: string
          description: The name of the child resource.
        ownerAccountId:
          type: string
          description: The Amazon Web Services account ID of the member who owns the child resource.
        resourceStatus:
          type: string
          enum:
          - CREATED
          - POPULATE_STARTED
          - POPULATE_SUCCESS
          - POPULATE_FAILED
          - DISALLOWED_BY_DATA_PROVIDER
          - BASE_TABLE_REMOVED
          - RETENTION_PERIOD_EXPIRED
          description: The current status of the child resource.
      required:
      - resourceType
      - resourceName
      - ownerAccountId
    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.
    CreateIdMappingTableInput:
      type: object
      properties:
        membershipIdentifier:
          type: string
          description: The unique identifier of the membership that contains the ID mapping table.
        name:
          type: string
          description: A name for the ID mapping table.
        description:
          type: string
          description: A description of the ID mapping table.
        inputReferenceConfig:
          $ref: '#/components/schemas/IdMappingTableInputReferenceConfig'
        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.
        kmsKeyArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon Web Services KMS key. This value is used to encrypt the
            mapping table data that is stored by Clean Rooms.
      required:
      - membershipIdentifier
      - name
      - inputReferenceConfig
    CreateIdMappingTableOutput:
      type: object
      properties:
        idMappingTable:
          $ref: '#/components/schemas/IdMappingTable'
      required:
      - idMappingTable
    DeleteIdMappingTableInput:
      type: object
      properties:
        idMappingTableIdentifier:
          type: string
          description: The unique identifier of the ID mapping table that you want to delete.
        membershipIdentifier:
          type: string
          description: The unique identifier of the membership that contains the ID mapping table that you want to delete.
      required:
      - idMappingTableIdentifier
      - membershipIdentifier
    DeleteIdMappingTableOutput:
      type: object
      properties: {}
    GetIdMappingTableInput:
      type: object
      properties:
        idMappingTableIdentifier:
          type: string
          description: The unique identifier of the ID mapping table identifier that you want to retrieve.
        membershipIdentifier:
          type: string
          description: The unique identifier of the membership that contains the ID mapping table that you want to retrieve.
      required:
      - idMappingTableIdentifier
      - membershipIdentifier
    GetIdMappingTableOutput:
      type: object
      properties:
        idMappingTable:
          $ref: '#/components/schemas/IdMappingTable'
      required:
      - idMappingTable
    IdMappingTable:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the ID mapping table.
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the ID mapping table.
        inputReferenceConfig:
          $ref: '#/components/schemas/IdMappingTableInputReferenceConfig'
        membershipId:
          type: string
          description: The unique identifier of the membership resource for the ID mapping table.
        membershipArn:
          type: string
          description: The Amazon Resource Name (ARN) of the membership resource for the ID mapping table.
        collaborationId:
          type: string
          description: The unique identifier of the collaboration that contains this ID mapping table.
        collaborationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the collaboration that contains this ID mapping table.
        description:
          type: string
          description: The description of the ID mapping table.
        name:
          type: string
          description: The name of the ID mapping table.
        createTime:
          type: string
          description: The time at which the ID mapping table was created.
        updateTime:
          type: string
          description: The most recent time at which the ID mapping table was updated.
        inputReferenceProperties:
          $ref: '#/components/schemas/IdMappingTableInputReferenceProperties'
        kmsKeyArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon Web Services KMS key.
        childResources:
          type: array
          items:
            $ref: '#/components/schemas/ChildResource'
          description: The child resources that depend on this ID mapping table.
      required:
      - id
      - arn
      - inputReferenceConfig
      - membershipId
      - membershipArn
      - collaborationId
      - collaborationArn
      - name
      - createTime
      - updateTime
      - inputReferenceProperties
    IdMappingTableInputReferenceConfig:
      type: object
      properties:
        inputReferenceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the referenced resource in Entity Resolution. Valid values are ID
            mapping workflow ARNs.
        manageResourcePolicies:
          type: boolean
          description: When TRUE, Clean Rooms manages permissions for the ID mapping table resource. When FALSE, the resource
            owner manages permissions for the ID mapping table resource.
      required:
      - inputReferenceArn
      - manageResourcePolicies
    IdMappingTableInputReferenceProperties:
      type: object
      properties:
        idMappingTableInputSource:
          type: array
          items:
            $ref: '#/components/schemas/IdMappingTableInputSource'
          description: The input source of the ID mapping table.
      required:
      - idMappingTableInputSource
    IdMappingTableInputSource:
      type: object
      properties:
        idNamespaceAssociationId:
          type: string
          description: The unique identifier of the ID namespace association.
        type:
          type: string
          enum:
          - SOURCE
          - TARGET
          description: The type of the input source of the ID mapping table.
      required:
      - idNamespaceAssociationId
      - type
    IdMappingTableSummary:
      type: object
      properties:
        collaborationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the collaboration that contains this ID mapping table.
        collaborationId:
          type: string
          description: The unique identifier of the collaboration that contains this ID mapping table.
        membershipId:
          type: string
          description: The unique identifier of the membership resource for this ID mapping table.
        membershipArn:
          type: string
          description: The Amazon Resource Name (ARN) of the membership resource for this ID mapping table.
        createTime:
          type: string
          description: The time at which this ID mapping table was created.
        updateTime:
          type: string
          description: The most recent time at which this ID mapping table was updated.
        id:
          type: string
          description: The unique identifier of this ID mapping table.
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of this ID mapping table.
        description:
          type: string
          description: The description of this ID mapping table.
        inputReferenceConfig:
          $ref: '#/components/schemas/IdMappingTableInputReferenceConfig'
        name:
          type: string
          description: The name of this ID mapping table.
      required:
      - collaborationArn
      - collaborationId
      - membershipId
      - membershipArn
      - createTime
      - updateTime
      - id
      - arn
      - inputReferenceConfig
      - name
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    ListIdMappingTablesInput:
      type: object
      properties:
        membershipIdentifier:
          type: string
          description: The unique identifier of the membership that contains the ID mapping tables that you want to view.
        nextToken:
          type: string
          description: The pagination token that's used to fetch the next set of results.
        maxResults:
          type: integer
          description: The maximum size of the results that is returned per call. Service chooses a default if it has not
            been set. Service may return a nextToken even if the maximum results has not been met.
      required:
      - membershipIdentifier
    ListIdMappingTablesOutput:
      type: object
      properties:
        idMappingTableSummaries:
          type: array
          items:
            $ref: '#/components/schemas/IdMappingTableSummary'
          description: The summary information of the ID mapping tables that you requested.
        nextToken:
          type: string
          description: The token value provided to access the next page of results.
      required:
      - idMappingTableSummaries
    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
    UpdateIdMappingTableInput:
      type: object
      properties:
        idMappingTableIdentifier:
          type: string
          description: The unique identifier of the ID mapping table that you want to update.
        membershipIdentifier:
          type: string
          description: The unique identifier of the membership that contains the ID mapping table that you want to update.
        description:
          type: string
          description: A new description for the ID mapping table.
        kmsKeyArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon Web Services KMS key.
      required:
      - idMappingTableIdentifier
      - membershipIdentifier
    UpdateIdMappingTableOutput:
      type: object
      properties:
        idMappingTable:
          $ref: '#/components/schemas/IdMappingTable'
      required:
      - idMappingTable
    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)