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

UpdateGlossaryTerm

Updates a business glossary term in Amazon DataZone.

Prerequisites:

Glossary term must exist in the specified domain.
New name must not conflict with existing terms in the same glossary.
User must have permissions on the term.
The term must not be in DELETED status.

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 UpdateGlossaryTerm action.

Type: String

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

Required: No

name

The name to be updated as part of the UpdateGlossaryTerm action.

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 UpdateGlossaryTerm action.

Type: String

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

Required: No

status

The status to be updated as part of the UpdateGlossaryTerm action.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

termRelations

The term relations to be updated as part of the UpdateGlossaryTerm action.

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" ]
   },
   "usageRestrictions": [ "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 UpdateGlossaryTerm action.

Type: String

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

name

The name to be updated as part of the UpdateGlossaryTerm action.

Type: String

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

shortDescription

The short description to be updated as part of the UpdateGlossaryTerm action.

Type: String

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

status

The status to be updated as part of the UpdateGlossaryTerm action.

Type: String

Valid Values: ENABLED | DISABLED

termRelations

The term relations to be updated as part of the UpdateGlossaryTerm action.

Type: TermRelations object

usageRestrictions

The usage restriction of a term within a restricted glossary.

Type: Array of strings

Array Members: Fixed number of 1 item.

Valid Values: ASSET_GOVERNED_TERMS

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

Examples

Example

This example illustrates one usage of UpdateGlossaryTerm.

Sample Request



aws datazone update-glossary-term \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "trm9k4pq7xwnmh" \
--name "CustomerLifetimeValueMetric"

Sample Response



{
    "domainId": "dzd_53ielnpxktdilj",
    "glossaryId": "gls8m3nqx2wkfp",
    "id": "trm9k4pq7xwnmh",
    "name": "CustomerLifetimeValueMetric",
    "status": "ENABLED"
}

Example

Failure case - resource does not exist:

Sample Request



aws datazone update-glossary-term \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "trm_nonexistent" \
--name "NewTermName"

Sample Response



An error occurred (ResourceNotFoundException) when calling the UpdateGlossaryTerm operation: The given GlossaryTerm doesn't exist. Try creating GlossaryTerm before accessing it.

Example

Failure case - invalid input:

Sample Request



aws datazone update-glossary-term \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "trm9k4pq7xwnmh" \
--name "$(head -c 300 </dev/zero | tr '\0' 'A')"

Sample Response



An error occurred (ValidationException) when calling the UpdateGlossaryTerm operation: 1 validation error detected: Value at 'name' failed to satisfy constraint: Member must have length less than or equal to 256