Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateIdMappingTable

Provides the details that are necessary to update an ID mapping table.

Request Syntax


PATCH /memberships/membershipIdentifier/idmappingtables/idMappingTableIdentifier HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "kmsKeyArn": "string"
}

URI Request Parameters

The request uses the following URI parameters.

idMappingTableIdentifier

The unique identifier of the ID mapping table 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 mapping table 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 mapping table.

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

kmsKeyArn

The Amazon Resource Name (ARN) of the AWS KMS key.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws:kms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:key/[a-zA-Z0-9-]+

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "idMappingTable": { 
      "arn": "string",
      "collaborationArn": "string",
      "collaborationId": "string",
      "createTime": number,
      "description": "string",
      "id": "string",
      "inputReferenceConfig": { 
         "inputReferenceArn": "string",
         "manageResourcePolicies": boolean
      },
      "inputReferenceProperties": { 
         "idMappingTableInputSource": [ 
            { 
               "idNamespaceAssociationId": "string",
               "type": "string"
            }
         ]
      },
      "kmsKeyArn": "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.

idMappingTable

The updated ID mapping table.

Type: IdMappingTable 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.

reason: A reason code for the exception.

HTTP Status Code: 403

InternalServerException

Unexpected error during processing of request.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which does not exist.

resourceId: The Id of the missing resource.
resourceType: The type of the missing resource.

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.

fieldList: Validation errors for specific input parameters.
reason: A reason code for the exception.

HTTP Status Code: 400