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

AssociateGovernedTerms

Associates governed terms with an asset.

Request Syntax


PATCH /v2/domains/domainIdentifier/entities/entityType/entityIdentifier/associate-governed-terms HTTP/1.1
Content-type: application/json

{
   "governedGlossaryTerms": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

The ID of the domain where governed terms are to be associated with an asset.

Pattern: dzd[-_][a-zA-Z0-9_-]{1,36}

Required: Yes

entityIdentifier

The ID of the asset with which you want to associate a governed term.

Pattern: [a-zA-Z0-9_-]{1,36}

Required: Yes

entityType

The type of the asset with which you want to associate a governed term.

Valid Values: ASSET

Required: Yes

Request Body

The request accepts the following data in JSON format.

governedGlossaryTerms

The glossary terms in a restricted glossary.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Pattern: [a-zA-Z0-9_-]{1,36}

Required: Yes

Response Syntax


HTTP/1.1 200

Response Elements

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

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

There is a conflict while performing this action.

HTTP Status Code: 409

InternalServerException

The request has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource cannot be found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

UnauthorizedException

You do not have permission to perform this action.

HTTP Status Code: 401

ValidationException

The input fails to satisfy the constraints specified by the AWS service.

HTTP Status Code: 400