UpdateIdNamespaceAssociation - AWS Clean Rooms

UpdateIdNamespaceAssociation

Provides the details that are necessary to update an ID namespace association.

Request Syntax

PATCH /memberships/membershipIdentifier/idnamespaceassociations/idNamespaceAssociationIdentifier HTTP/1.1 Content-type: application/json { "description": "string", "idMappingConfig": { "allowUseAsDimensionColumn": boolean }, "name": "string" }

URI Request Parameters

The request uses the following URI parameters.

idNamespaceAssociationIdentifier

The unique identifier of the ID namespace association that you want to update.

Length Constraints: Fixed length of 36.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

membershipIdentifier

The unique identifier of the membership that contains the ID namespace association that you want to update.

Length Constraints: Fixed length of 36.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

Request Body

The request accepts the following data in JSON format.

description

A new description for the ID namespace association.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*

Required: No

idMappingConfig

The configuration settings for the ID mapping table.

Type: IdMappingConfig object

Required: No

name

A new name for the ID namespace association.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: (?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "idNamespaceAssociation": { "arn": "string", "collaborationArn": "string", "collaborationId": "string", "createTime": number, "description": "string", "id": "string", "idMappingConfig": { "allowUseAsDimensionColumn": boolean }, "inputReferenceConfig": { "inputReferenceArn": "string", "manageResourcePolicies": boolean }, "inputReferenceProperties": { "idMappingWorkflowsSupported": [ JSON value ], "idNamespaceType": "string" }, "membershipArn": "string", "membershipId": "string", "name": "string", "updateTime": number } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

idNamespaceAssociation

The updated ID namespace association.

Type: IdNamespaceAssociation object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Caller does not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

Unexpected error during processing of request.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which does not exist.

HTTP Status Code: 404

ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the specified constraints.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: