update_glossary_term ¶

def update_glossary_term(
    self,
    domain_identifier: "capo_datazone.types.domain_id.DomainId",
    identifier: "capo_datazone.types.glossary_term_id.GlossaryTermId",
    *,
    config_overrides: Optional[DataZoneClientConfig] = None,
    glossary_identifier: Optional[
        "capo_datazone.types.glossary_term_id.GlossaryTermId"
    ] = None,
    name: Optional[
        "capo_datazone.types.glossary_term_name.GlossaryTermName"
    ] = None,
    short_description: Optional[
        "capo_datazone.types.short_description.ShortDescription"
    ] = None,
    long_description: Optional[
        "capo_datazone.types.long_description.LongDescription"
    ] = None,
    term_relations: Optional[
        "capo_datazone.types.term_relations.TermRelations"
    ] = None,
    status: Optional[
        "capo_datazone.types.glossary_term_status.GlossaryTermStatus"
    ] = None,
) -> "capo_datazone.types.update_glossary_term_output.UpdateGlossaryTermOutput":
    """<p>Updates a business glossary term in Amazon DataZone.</p> <p>Prerequisites:</p> <ul> <li> <p>Glossary term must exist in the specified domain. </p> </li> <li> <p>New name must not conflict with existing terms in the same glossary.</p> </li> <li> <p>User must have permissions on the term.</p> </li> <li> <p>The term must not be in DELETED status.</p> </li> </ul>

    Args:
        domain_identifier: <p>The identifier of the Amazon DataZone domain in which a business glossary term is to be updated.</p>
        glossary_identifier: <p>The identifier of the business glossary in which a term is to be updated.</p>
        identifier: <p>The identifier of the business glossary term that is to be updated.</p>
        name: <p>The name to be updated as part of the <code>UpdateGlossaryTerm</code> action.</p>
        short_description: <p>The short description to be updated as part of the <code>UpdateGlossaryTerm</code> action.</p>
        long_description: <p>The long description to be updated as part of the <code>UpdateGlossaryTerm</code> action.</p>
        term_relations: <p>The term relations to be updated as part of the <code>UpdateGlossaryTerm</code> action.</p>
        status: <p>The status to be updated as part of the <code>UpdateGlossaryTerm</code> action.</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.update_glossary_term_input.UpdateGlossaryTermInput]",
    ) -> OperationResponse[
        "capo_datazone.types.update_glossary_term_output.UpdateGlossaryTermOutput"
    ]:
        import capo_datazone._operations.data_zone.update_glossary_term

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

    def _redact_input(
        input_: "capo_datazone.types.update_glossary_term_input.UpdateGlossaryTermInput",
    ) -> dict[str, Any]:
        import capo_datazone.types.update_glossary_term_input

        return capo_datazone.types.update_glossary_term_input.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_datazone.types.update_glossary_term_output.UpdateGlossaryTermOutput",
    ) -> dict[str, Any]:
        import capo_datazone.types.update_glossary_term_output

        return capo_datazone.types.update_glossary_term_output.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "UpdateGlossaryTerm",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_datazone.types.update_glossary_term_input.UpdateGlossaryTermInput = {
        "domain_identifier": domain_identifier,
        "identifier": identifier,
    }
    if glossary_identifier is not None:
        input_["glossary_identifier"] = glossary_identifier
    if name is not None:
        input_["name"] = name
    if short_description is not None:
        input_["short_description"] = short_description
    if long_description is not None:
        input_["long_description"] = long_description
    if term_relations is not None:
        input_["term_relations"] = term_relations
    if status is not None:
        input_["status"] = status

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