Skip to content

get_glossary

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

Gets a business glossary in Amazon DataZone.

Prerequisites:

  • The specified glossary ID must exist and be associated with the given domain.

  • The caller must have the datazone:GetGlossary permission on the domain.

Parameters:

  • domain_identifier (DomainId) –

    The ID of the Amazon DataZone domain in which this business glossary exists.

  • identifier (GlossaryId) –

    The ID of the business glossary.

Raises:

Source code in docs_src/capo_datazone/_services/data_zone.py
def get_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.get_glossary_output.GetGlossaryOutput":
    """<p>Gets a business glossary in Amazon DataZone.</p> <p>Prerequisites:</p> <ul> <li> <p>The specified glossary ID must exist and be associated with the given domain. </p> </li> <li> <p>The caller must have the <code>datazone:GetGlossary</code> permission on the domain.</p> </li> </ul>

    Args:
        domain_identifier: <p>The ID of the Amazon DataZone domain in which this business glossary exists.</p>
        identifier: <p>The ID of the business glossary.</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.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.get_glossary_input.GetGlossaryInput]",
    ) -> OperationResponse[
        "capo_datazone.types.get_glossary_output.GetGlossaryOutput"
    ]:
        import capo_datazone._operations.data_zone.get_glossary

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

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

        return capo_datazone.types.get_glossary_output.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetGlossary", redact_output=_redact_output),
    )
    input_: capo_datazone.types.get_glossary_input.GetGlossaryInput = {
        "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