Amazon Clean Rooms Clean Rooms Idnamespaceassociations API
The Clean Rooms Idnamespaceassociations API from Amazon Clean Rooms — 4 operation(s) for clean rooms idnamespaceassociations.
The Clean Rooms Idnamespaceassociations API from Amazon Clean Rooms — 4 operation(s) for clean rooms idnamespaceassociations.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/amazon-clean-rooms:amazon-clean-rooms-idnamespaceassociations-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.1.0
info:
title: AWS Clean Rooms Service Idnamespaceassociations 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}/idnamespaceassociations/{idNamespaceAssociationIdentifier}:
get:
operationId: GetCollaborationIdNamespaceAssociation
summary: Get Collaboration Id Namespace Association
description: Retrieves an ID namespace association from a specific collaboration.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetCollaborationIdNamespaceAssociationOutput'
'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/GetCollaborationIdNamespaceAssociationInput'
tags:
- Idnamespaceassociations
/collaborations/{collaborationIdentifier}/idnamespaceassociations:
get:
operationId: ListCollaborationIdNamespaceAssociations
summary: List Collaboration Id Namespace Associations
description: Returns a list of the ID namespace associations in a collaboration.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListCollaborationIdNamespaceAssociationsOutput'
'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/ListCollaborationIdNamespaceAssociationsInput'
tags:
- Idnamespaceassociations
/memberships/{membershipIdentifier}/idnamespaceassociations:
post:
operationId: CreateIdNamespaceAssociation
summary: Create Id Namespace Association
description: Creates an ID namespace association.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateIdNamespaceAssociationOutput'
'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/CreateIdNamespaceAssociationInput'
tags:
- Idnamespaceassociations
get:
operationId: ListIdNamespaceAssociations
summary: List Id Namespace Associations
description: Returns a list of ID namespace associations.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListIdNamespaceAssociationsOutput'
'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/ListIdNamespaceAssociationsInput'
tags:
- Idnamespaceassociations
/memberships/{membershipIdentifier}/idnamespaceassociations/{idNamespaceAssociationIdentifier}:
get:
operationId: GetIdNamespaceAssociation
summary: Get Id Namespace Association
description: Retrieves an ID namespace association.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetIdNamespaceAssociationOutput'
'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/GetIdNamespaceAssociationInput'
tags:
- Idnamespaceassociations
patch:
operationId: UpdateIdNamespaceAssociation
summary: Update Id Namespace Association
description: Provides the details that are necessary to update an ID namespace association.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateIdNamespaceAssociationOutput'
'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/UpdateIdNamespaceAssociationInput'
tags:
- Idnamespaceassociations
delete:
operationId: DeleteIdNamespaceAssociation
summary: Delete Id Namespace Association
description: Deletes an ID namespace association.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteIdNamespaceAssociationOutput'
'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/DeleteIdNamespaceAssociationInput'
tags:
- Idnamespaceassociations
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.
CollaborationIdNamespaceAssociation:
type: object
properties:
id:
type: string
description: The unique identifier of the collaboration ID namespace association.
arn:
type: string
description: The Amazon Resource Name (ARN) of the collaboration ID namespace association.
collaborationId:
type: string
description: The unique identifier of the collaboration that contains the collaboration ID namespace association.
collaborationArn:
type: string
description: The Amazon Resource Name (ARN) of the collaboration that contains the collaboration ID namespace association.
name:
type: string
description: The name of the collaboration ID namespace association.
description:
type: string
description: The description of the collaboration ID namespace association.
creatorAccountId:
type: string
description: The unique identifier of the Amazon Web Services account that created the collaboration ID namespace
association.
createTime:
type: string
description: The time at which the collaboration ID namespace association was created.
updateTime:
type: string
description: The most recent time at which the collaboration ID namespace was updated.
inputReferenceConfig:
$ref: '#/components/schemas/IdNamespaceAssociationInputReferenceConfig'
inputReferenceProperties:
$ref: '#/components/schemas/IdNamespaceAssociationInputReferenceProperties'
idMappingConfig:
$ref: '#/components/schemas/IdMappingConfig'
required:
- id
- arn
- collaborationId
- collaborationArn
- name
- creatorAccountId
- createTime
- updateTime
- inputReferenceConfig
- inputReferenceProperties
CollaborationIdNamespaceAssociationSummary:
type: object
properties:
arn:
type: string
description: The Amazon Resource Name (ARN) of the collaboration ID namespace association.
createTime:
type: string
description: The time at which the collaboration ID namespace association was created.
id:
type: string
description: The unique identifier of the collaboration ID namespace association.
updateTime:
type: string
description: The most recent time at which the collaboration ID namespace association was updated.
collaborationArn:
type: string
description: The Amazon Resource Name (ARN) of the collaboration that contains this collaboration ID namespace association.
collaborationId:
type: string
description: The unique identifier of the collaboration that contains this collaboration ID namespace association.
creatorAccountId:
type: string
description: The Amazon Web Services account that created this collaboration ID namespace association.
inputReferenceConfig:
$ref: '#/components/schemas/IdNamespaceAssociationInputReferenceConfig'
name:
type: string
description: The name of the collaboration ID namespace association.
description:
type: string
description: The description of the collaboration ID namepsace association.
inputReferenceProperties:
$ref: '#/components/schemas/IdNamespaceAssociationInputReferencePropertiesSummary'
required:
- arn
- createTime
- id
- updateTime
- collaborationArn
- collaborationId
- creatorAccountId
- inputReferenceConfig
- name
- inputReferenceProperties
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.
CreateIdNamespaceAssociationInput:
type: object
properties:
membershipIdentifier:
type: string
description: The unique identifier of the membership that contains the ID namespace association.
inputReferenceConfig:
$ref: '#/components/schemas/IdNamespaceAssociationInputReferenceConfig'
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.
name:
type: string
description: The name for the ID namespace association.
description:
type: string
description: The description of the ID namespace association.
idMappingConfig:
$ref: '#/components/schemas/IdMappingConfig'
required:
- membershipIdentifier
- inputReferenceConfig
- name
CreateIdNamespaceAssociationOutput:
type: object
properties:
idNamespaceAssociation:
$ref: '#/components/schemas/IdNamespaceAssociation'
required:
- idNamespaceAssociation
DeleteIdNamespaceAssociationInput:
type: object
properties:
idNamespaceAssociationIdentifier:
type: string
description: The unique identifier of the ID namespace association that you want to delete.
membershipIdentifier:
type: string
description: The unique identifier of the membership that contains the ID namespace association that you want to
delete.
required:
- idNamespaceAssociationIdentifier
- membershipIdentifier
DeleteIdNamespaceAssociationOutput:
type: object
properties: {}
GetCollaborationIdNamespaceAssociationInput:
type: object
properties:
collaborationIdentifier:
type: string
description: The unique identifier of the collaboration that contains the ID namespace association that you want
to retrieve.
idNamespaceAssociationIdentifier:
type: string
description: The unique identifier of the ID namespace association that you want to retrieve.
required:
- collaborationIdentifier
- idNamespaceAssociationIdentifier
GetCollaborationIdNamespaceAssociationOutput:
type: object
properties:
collaborationIdNamespaceAssociation:
$ref: '#/components/schemas/CollaborationIdNamespaceAssociation'
required:
- collaborationIdNamespaceAssociation
GetIdNamespaceAssociationInput:
type: object
properties:
idNamespaceAssociationIdentifier:
type: string
description: The unique identifier of the ID namespace association that you want to retrieve.
membershipIdentifier:
type: string
description: The unique identifier of the membership that contains the ID namespace association that you want to
retrieve.
required:
- idNamespaceAssociationIdentifier
- membershipIdentifier
GetIdNamespaceAssociationOutput:
type: object
properties:
idNamespaceAssociation:
$ref: '#/components/schemas/IdNamespaceAssociation'
required:
- idNamespaceAssociation
IdMappingConfig:
type: object
properties:
allowUseAsDimensionColumn:
type: boolean
description: An indicator as to whether you can use your column as a dimension column in the ID mapping table (TRUE)
or not (FALSE). Default is FALSE.
required:
- allowUseAsDimensionColumn
IdNamespaceAssociation:
type: object
properties:
id:
type: string
description: The unique identifier for this ID namespace association.
arn:
type: string
description: The Amazon Resource Name (ARN) of the ID namespace association.
membershipId:
type: string
description: The unique identifier of the membership resource for this ID namespace association.
membershipArn:
type: string
description: The Amazon Resource Name (ARN) of the membership resource for this ID namespace association.
collaborationId:
type: string
description: The unique identifier of the collaboration that contains this ID namespace association.
collaborationArn:
type: string
description: The Amazon Resource Name (ARN) of the collaboration that contains this ID namespace association.
name:
type: string
description: The name of this ID namespace association.
description:
type: string
description: The description of the ID namespace association.
createTime:
type: string
description: The time at which the ID namespace association was created.
updateTime:
type: string
description: The most recent time at which the ID namespace association was updated.
inputReferenceConfig:
$ref: '#/components/schemas/IdNamespaceAssociationInputReferenceConfig'
inputReferenceProperties:
$ref: '#/components/schemas/IdNamespaceAssociationInputReferenceProperties'
idMappingConfig:
$ref: '#/components/schemas/IdMappingConfig'
required:
- id
- arn
- membershipId
- membershipArn
- collaborationId
- collaborationArn
- name
- createTime
- updateTime
- inputReferenceConfig
- inputReferenceProperties
IdNamespaceAssociationInputReferenceConfig:
type: object
properties:
inputReferenceArn:
type: string
description: The Amazon Resource Name (ARN) of the Entity Resolution resource that is being associated to the collaboration.
Valid resource ARNs are from the ID namespaces that you own.
manageResourcePolicies:
type: boolean
description: When TRUE, Clean Rooms manages permissions for the ID namespace association resource. When FALSE, the
resource owner manages permissions for the ID namespace association resource.
required:
- inputReferenceArn
- manageResourcePolicies
IdNamespaceAssociationInputReferenceProperties:
type: object
properties:
idNamespaceType:
type: string
enum:
- SOURCE
- TARGET
description: The ID namespace type for this ID namespace association.
idMappingWorkflowsSupported:
type: array
items:
type: object
description: Defines how ID mapping workflows are supported for this ID namespace association.
required:
- idNamespaceType
- idMappingWorkflowsSupported
IdNamespaceAssociationInputReferencePropertiesSummary:
type: object
properties:
idNamespaceType:
type: string
enum:
- SOURCE
- TARGET
description: The ID namespace type for this ID namespace association.
required:
- idNamespaceType
IdNamespaceAssociationSummary:
type: object
properties:
membershipId:
type: string
description: The unique identifier of the membership resource for this ID namespace association.
membershipArn:
type: string
description: The Amazon Resource Name (ARN) of the membership resource for this ID namespace association.
collaborationArn:
type: string
description: The Amazon Resource Name (ARN) of the collaboration that contains this ID namespace association.
collaborationId:
type: string
description: The unique identifier of the collaboration that contains this ID namespace association.
createTime:
type: string
description: The time at which this ID namespace association was created.
updateTime:
type: string
description: The most recent time at which this ID namespace association has been updated.
id:
type: string
description: The unique identifier of this ID namespace association.
arn:
type: string
description: The Amazon Resource Name (ARN) of this ID namespace association.
inputReferenceConfig:
$ref: '#/components/schemas/IdNamespaceAssociationInputReferenceConfig'
name:
type: string
description: The name of the ID namespace association.
description:
type: string
description: The description of the ID namespace association.
inputReferenceProperties:
$ref: '#/components/schemas/IdNamespaceAssociationInputReferencePropertiesSummary'
required:
- membershipId
- membershipArn
- collaborationArn
- collaborationId
- createTime
- updateTime
- id
- arn
- inputReferenceConfig
- name
- inputReferenceProperties
InternalServerException:
type: object
properties:
message:
type: string
ListCollaborationIdNamespaceAssociationsInput:
type: object
properties:
collaborationIdentifier:
type: string
description: The unique identifier of the collaboration that contains the ID namespace 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 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:
- collaborationIdentifier
ListCollaborationIdNamespaceAssociationsOutput:
type: object
properties:
nextToken:
type: string
description: The token value provided to access the next page of results.
collaborationIdNamespaceAssociationSummaries:
type: array
items:
$ref: '#/components/schemas/CollaborationIdNamespaceAssociationSummary'
description: The summary information of the collaboration ID namespace associations that you requested.
required:
- collaborationIdNamespaceAssociationSummaries
ListIdNamespaceAssociationsInput:
type: object
properties:
membershipIdentifier:
type: string
description: The unique identifier of the membership that contains the ID namespace association 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
ListIdNamespaceAssociationsOutput:
type: object
properties:
nextToken:
type: string
description: The token value provided to access the next page of results.
idNamespaceAssociationSummaries:
type: array
items:
$ref: '#/components/schemas/IdNamespaceAssociationSummary'
description: The summary information of the ID namespace associations that you requested.
required:
- idNamespaceAssociationSummaries
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
UpdateIdNamespaceAssociationInput:
type: object
properties:
idNamespaceAssociationIdentifier:
type: string
description: The unique identifier of the ID namespace association that you want to update.
membershipIdentifier:
type: string
description: The unique identifier of the membership that contains the ID namespace association that you want to
update.
name:
type: string
description: A new name for the ID namespace association.
description:
type: string
description: A new description for the ID namespace association.
idMappingConfig:
$ref: '#/components/schemas/IdMappingConfig'
required:
- idNamespaceAssociationIdentifier
- membershipIdentifier
UpdateIdNamespaceAssociationOutput:
type: object
properties:
idNamespaceAssociation:
$ref: '#/components/schemas/IdNamespaceAssociation'
required:
- idNamespaceAssociation
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)