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

DeleteGlossary

Deletes a business glossary in Amazon DataZone.

Prerequisites:

The glossary must be in DISABLED state.
The glossary must not have any glossary terms associated with it.
The glossary must exist in the specified domain.
The caller must have the datazone:DeleteGlossary permission in the domain and glossary.
There should be no active assets or metadata linked to the glossary.

Request Syntax


DELETE /v2/domains/domainIdentifier/glossaries/identifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

The ID of the Amazon DataZone domain in which the business glossary is deleted.

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

Required: Yes

identifier

The ID of the business glossary that is deleted.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 204

Response Elements

If the action is successful, the service sends back an HTTP 204 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

Examples

Example

This example illustrates one usage of DeleteGlossary.

Sample Request



aws datazone delete-glossary \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "gls8m3nqx2wkfp"

Example

Failure case - glossary must be disabled:

Sample Request



aws datazone delete-glossary \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "gls8m3nqx2wkfp"

Sample Response



An error occurred (ValidationException) when calling the DeleteGlossary operation: Glossary must be DISABLED for deletion

Example

Failure case - conflict is data is associated with it:

Sample Request



aws datazone delete-glossary \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "gls8m3nqx2wkfp"

Sample Response



An error occurred (ConflictException) when calling the DeleteGlossary operation: Glossary can't be deleted while having glossary terms attached

Example

Failure case - resource does not exist:

Sample Request



aws datazone delete-glossary \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "gls_nonexistent"

Sample Response



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

Example

Failure case - missing required parameter

Sample Request



 aws datazone delete-glossary \
--domain-identifier "dzd_53ielnpxktdilj"

Sample Response



aws: error: the following arguments are required: --identifier