create_glossary ¶

def create_glossary(
    self,
    domain_identifier: "capo_datazone.types.domain_id.DomainId",
    name: "capo_datazone.types.glossary_name.GlossaryName",
    owning_project_identifier: "capo_datazone.types.project_id.ProjectId",
    *,
    config_overrides: Optional[DataZoneClientConfig] = None,
    description: Optional[
        "capo_datazone.types.glossary_description.GlossaryDescription"
    ] = None,
    status: Optional["capo_datazone.types.glossary_status.GlossaryStatus"] = None,
    usage_restrictions: Optional[
        "capo_datazone.types.glossary_usage_restrictions.GlossaryUsageRestrictions"
    ] = None,
    client_token: Optional["capo_datazone.types.client_token.ClientToken"] = None,
) -> "capo_datazone.types.create_glossary_output.CreateGlossaryOutput":
    """<p>Creates an Amazon DataZone business glossary.</p> <p>Specifies that this is a create glossary policy.</p> <p>A glossary serves as the central repository for business terminology and definitions within an organization. It helps establish and maintain a common language across different departments and teams, reducing miscommunication and ensuring consistent interpretation of business concepts. Glossaries can include hierarchical relationships between terms, cross-references, and links to actual data assets, making them invaluable for both business users and technical teams trying to understand and use data correctly.</p> <p>Prerequisites:</p> <ul> <li> <p>Domain must exist and be in an active state. </p> </li> <li> <p>Owning project must exist and be accessible by the caller.</p> </li> <li> <p>The glossary name must be unique within the domain.</p> </li> </ul>

    Args:
        domain_identifier: <p>The ID of the Amazon DataZone domain in which this business glossary is created.</p>
        name: <p>The name of this business glossary.</p>
        owning_project_identifier: <p>The ID of the project that currently owns business glossary.</p>
        description: <p>The description of this business glossary.</p>
        status: <p>The status of this business glossary.</p>
        usage_restrictions: <p>The usage restriction of the restricted glossary.</p>
        client_token: <p>A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.</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.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request has exceeded the specified service quota.</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.create_glossary_input.CreateGlossaryInput]",
    ) -> OperationResponse[
        "capo_datazone.types.create_glossary_output.CreateGlossaryOutput"
    ]:
        import capo_datazone._operations.data_zone.create_glossary

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

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

        return capo_datazone.types.create_glossary_input.redact_sensitive(input_)

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

        return capo_datazone.types.create_glossary_output.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "CreateGlossary",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_datazone.types.create_glossary_input.CreateGlossaryInput = {
        "domain_identifier": domain_identifier,
        "name": name,
        "owning_project_identifier": owning_project_identifier,
    }
    if description is not None:
        input_["description"] = description
    if status is not None:
        input_["status"] = status
    if usage_restrictions is not None:
        input_["usage_restrictions"] = usage_restrictions
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

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