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

UpdateGlossary

Updates the business glossary in Amazon DataZone.

Prerequisites:

The glossary must exist in the given domain.
The caller must have the datazone:UpdateGlossary permission to update it.
When updating the name, the new name must be unique within the domain.
The glossary must not be deleted or in a terminal state.

Request Syntax


PATCH /v2/domains/domainIdentifier/glossaries/identifier HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "name": "string",
   "status": "string"
}

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

The identifier of the Amazon DataZone domain in which a business glossary is to be updated.

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

Required: Yes

identifier

The identifier of the business glossary to be updated.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

Type: String

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

Pattern: [\x21-\x7E]+

Required: No

description

The description to be updated as part of the UpdateGlossary 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 UpdateGlossary action.

Type: String

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

Required: No

status

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

Type: String

Valid Values: DISABLED | ENABLED

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "description": "string",
   "domainId": "string",
   "id": "string",
   "name": "string",
   "owningProjectId": "string",
   "status": "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.

description

The description to be updated as part of the UpdateGlossary action.

Type: String

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

domainId

The identifier of the Amazon DataZone domain in which a business glossary is to be updated.

Type: String

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

id

The identifier of the business glossary that is to be updated.

Type: String

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

name

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

Type: String

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

owningProjectId

The identifier of the project in which to update a business glossary.

Type: String

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

status

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

Type: String

Valid Values: DISABLED | ENABLED

usageRestrictions

The usage restriction of the 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 UpdateGlossary.

Sample Request



aws datazone update-glossary \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "gls8m3nqx2wkfp" \
--name "UpdatedCustomerAnalyticsGlossary"

Sample Response



{
    "domainId": "dzd_53ielnpxktdilj",
    "id": "gls8m3nqx2wkfp",
    "name": "UpdatedCustomerAnalyticsGlossary",
    "owningProjectId": "prj7nx82mkl",
    "status": "ENABLED"
}

Example

Failure case - invalid input:

Sample Request



aws datazone update-glossary \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "gls8m3nqx2wkfp" \
--name ""

Sample Response



Parameter validation failed:
Invalid length for parameter name, value: 0, valid min length: 1

Example

Failure case - resource not found:

Sample Request



aws datazone update-glossary \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "gls_nonexistent" \
--name "NewGlossaryName"

Sample Response



An error occurred (ResourceNotFoundException) when calling the UpdateGlossary operation: Requested businessGlossary cannot be found in domain

Example

Failure case - duplicate terms:

Sample Request



 aws datazone update-glossary \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "gls8m3nqx2wkfp" \
--name "ExistingGlossaryName"

Sample Response



An error occurred (ConflictException) when calling the UpdateGlossary operation: Conflict with businessGlossary 41dkjgc9m5xj8n