Skip to content

delete_glossary_term async

delete_glossary_term(
    domain_identifier: DomainId,
    identifier: GlossaryTermId,
    *,
    config_overrides: Optional[AsyncDataZoneClientConfig] = None,
) -> DeleteGlossaryTermOutput

Deletes a business glossary term in Amazon DataZone.

Prerequisites:

  • Glossary term must exist and be active.

  • The term must not be linked to other assets or child terms.

  • Caller must have delete permissions in the domain/glossary.

  • Ensure all associations (such as to assets or parent terms) are removed before deletion.

Parameters:

  • domain_identifier (DomainId) –

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

  • identifier (GlossaryTermId) –

    The ID of the business glossary term that is deleted.

Raises:

Source code in docs_src/capo_datazone/_services/async_data_zone.py
async def delete_glossary_term(
    self,
    domain_identifier: "capo_datazone.types.domain_id.DomainId",
    identifier: "capo_datazone.types.glossary_term_id.GlossaryTermId",
    *,
    config_overrides: Optional[AsyncDataZoneClientConfig] = None,
) -> "capo_datazone.types.delete_glossary_term_output.DeleteGlossaryTermOutput":
    """<p>Deletes a business glossary term in Amazon DataZone.</p> <p>Prerequisites:</p> <ul> <li> <p>Glossary term must exist and be active. </p> </li> <li> <p>The term must not be linked to other assets or child terms.</p> </li> <li> <p>Caller must have delete permissions in the domain/glossary.</p> </li> <li> <p>Ensure all associations (such as to assets or parent terms) are removed before deletion.</p> </li> </ul>

    Args:
        domain_identifier: <p>The ID of the Amazon DataZone domain in which the business glossary term is deleted.</p>
        identifier: <p>The ID of the business glossary term 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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_datazone.types.delete_glossary_term_input.DeleteGlossaryTermInput]",
    ) -> AsyncOperationResponse[
        "capo_datazone.types.delete_glossary_term_output.DeleteGlossaryTermOutput"
    ]:
        import capo_datazone._operations.data_zone.delete_glossary_term

        (
            output,
            http_response,
        ) = await capo_datazone._operations.data_zone.delete_glossary_term.async_delete_glossary_term(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteGlossaryTerm")
    )
    input_: capo_datazone.types.delete_glossary_term_input.DeleteGlossaryTermInput = {
        "domain_identifier": domain_identifier,
        "identifier": identifier,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output