CreateIdNamespaceAssociation
Creates an ID namespace association.
Request Syntax
POST /memberships/membershipIdentifier
/idnamespaceassociations HTTP/1.1
Content-type: application/json
{
"description": "string
",
"idMappingConfig": {
"allowUseAsDimensionColumn": boolean
},
"inputReferenceConfig": {
"inputReferenceArn": "string
",
"manageResourcePolicies": boolean
},
"name": "string
",
"tags": {
"string
" : "string
"
}
}
URI Request Parameters
The request uses the following URI parameters.
- membershipIdentifier
-
The unique identifier of the membership that contains the ID namespace association.
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
-
The description of 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
- inputReferenceConfig
-
The input reference configuration needed to create the ID namespace association.
Type: IdNamespaceAssociationInputReferenceConfig object
Required: Yes
- name
-
The 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: Yes
-
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.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 200 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
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 ID namespace association that was created.
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
- ConflictException
-
Updating or deleting a resource can cause an inconsistent state.
HTTP Status Code: 409
- InternalServerException
-
Unexpected error during processing of request.
HTTP Status Code: 500
- ResourceNotFoundException
-
Request references a resource which does not exist.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
Request denied because service quota has been exceeded.
HTTP Status Code: 402
- 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: