Skip to content

delete_glossary

delete_glossary(
    domain_identifier: DomainId,
    identifier: GlossaryId,
    *,
    config_overrides: Optional[DataZoneClientConfig] = None,
) -> DeleteGlossaryOutput

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.

  • Glossary should not be linked to any active metadata forms.

Parameters:

  • domain_identifier (DomainId) –

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

  • identifier (GlossaryId) –

    The ID of the business glossary that is deleted.

Raises:

Source code in docs_src/capo_datazone/_services/data_zone.py
def delete_glossary(
    self,
    domain_identifier: "capo_datazone.types.domain_id.DomainId",
    identifier: "capo_datazone.types.glossary_id.GlossaryId",
    *,
    config_overrides: Optional[DataZoneClientConfig] = None,
) -> "capo_datazone.types.delete_glossary_output.DeleteGlossaryOutput":
    """<p>Deletes a business glossary in Amazon DataZone.</p> <p>Prerequisites:</p> <ul> <li> <p>The glossary must be in DISABLED state. </p> </li> <li> <p>The glossary must not have any glossary terms associated with it.</p> </li> <li> <p>The glossary must exist in the specified domain.</p> </li> <li> <p>The caller must have the <code>datazone:DeleteGlossary</code> permission in the domain and glossary.</p> </li> <li> <p>Glossary should not be linked to any active metadata forms.</p> </li> </ul>

    Args:
        domain_identifier: <p>The ID of the Amazon DataZone domain in which the business glossary is deleted.</p>
        identifier: <p>The ID of the business glossary that is deleted.</p>

    Raises:
        capo_datazone.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_datazone.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_datazone.errors.unauthorized_exception.UnauthorizedException: <p>You do not have permission to perform this action.</p>
        capo_datazone.errors.conflict_exception.ConflictException: <p>There is a conflict while performing this action.</p>
        capo_datazone.errors.internal_server_exception.InternalServerException: <p>The request has failed because of an unknown error, exception or failure.</p>
        capo_datazone.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource cannot be found.</p>
        capo_datazone.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the Amazon Web Services service.</p>
        capo_datazone.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_datazone.types.delete_glossary_input.DeleteGlossaryInput]",
    ) -> OperationResponse[
        "capo_datazone.types.delete_glossary_output.DeleteGlossaryOutput"
    ]:
        import capo_datazone._operations.data_zone.delete_glossary

        output, http_response = (
            capo_datazone._operations.data_zone.delete_glossary.delete_glossary(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteGlossary")
    )
    input_: capo_datazone.types.delete_glossary_input.DeleteGlossaryInput = {
        "domain_identifier": domain_identifier,
        "identifier": identifier,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output