UpdateGlossaryTerm
Updates a business glossary term in Amazon DataZone.
Request Syntax
PATCH /v2/domains/domainIdentifier/glossary-terms/identifier HTTP/1.1
Content-type: application/json
{
"glossaryIdentifier": "string",
"longDescription": "string",
"name": "string",
"shortDescription": "string",
"status": "string",
"termRelations": {
"classifies": [ "string" ],
"isA": [ "string" ]
}
}URI Request Parameters
The request uses the following URI parameters.
- domainIdentifier
-
The identifier of the Amazon DataZone domain in which a business glossary term is to be updated.
Pattern:
^dzd[-_][a-zA-Z0-9_-]{1,36}$Required: Yes
- identifier
-
The identifier of the business glossary term that is to be updated.
Pattern:
^[a-zA-Z0-9_-]{1,36}$Required: Yes
Request Body
The request accepts the following data in JSON format.
- glossaryIdentifier
-
The identifier of the business glossary in which a term is to be updated.
Type: String
Pattern:
^[a-zA-Z0-9_-]{1,36}$Required: No
- longDescription
-
The long description to be updated as part of the
UpdateGlossaryTermaction.Type: String
Length Constraints: Minimum length of 0. Maximum length of 4096.
Required: No
- name
-
The name to be updated as part of the
UpdateGlossaryTermaction.Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
- shortDescription
-
The short description to be updated as part of the
UpdateGlossaryTermaction.Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: No
- status
-
The status to be updated as part of the
UpdateGlossaryTermaction.Type: String
Valid Values:
ENABLED | DISABLEDRequired: No
- termRelations
-
The term relations to be updated as part of the
UpdateGlossaryTermaction.Type: TermRelations object
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"domainId": "string",
"glossaryId": "string",
"id": "string",
"longDescription": "string",
"name": "string",
"shortDescription": "string",
"status": "string",
"termRelations": {
"classifies": [ "string" ],
"isA": [ "string" ]
}
}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.
- domainId
-
The identifier of the Amazon DataZone domain in which a business glossary term is to be updated.
Type: String
Pattern:
^dzd[-_][a-zA-Z0-9_-]{1,36}$ - glossaryId
-
The identifier of the business glossary in which a term is to be updated.
Type: String
Pattern:
^[a-zA-Z0-9_-]{1,36}$ - id
-
The identifier of the business glossary term that is to be updated.
Type: String
Pattern:
^[a-zA-Z0-9_-]{1,36}$ - longDescription
-
The long description to be updated as part of the
UpdateGlossaryTermaction.Type: String
Length Constraints: Minimum length of 0. Maximum length of 4096.
- name
-
The name to be updated as part of the
UpdateGlossaryTermaction.Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
- shortDescription
-
The short description to be updated as part of the
UpdateGlossaryTermaction.Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
- status
-
The status to be updated as part of the
UpdateGlossaryTermaction.Type: String
Valid Values:
ENABLED | DISABLED - termRelations
-
The term relations to be updated as part of the
UpdateGlossaryTermaction.Type: TermRelations object
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
