create_glossary ¶

create_glossary(
    name: GlossaryName,
    *,
    config_overrides: Optional[GlueClientConfig] = None,
    description: Optional[MetadataDescription] = None,
    client_token: Optional[HashString] = None,
) -> CreateGlossaryResponse

Creates a business glossary in Glue Data Catalog. A glossary is a container for glossary terms that define business concepts.

Parameters:

name (GlossaryName) –

The name of the glossary.
description (Optional[MetadataDescription], default: None ) –

The description of the glossary.
client_token (Optional[HashString], default: None ) –

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Raises:

AccessDeniedException –

Access to a resource was denied.
AlreadyExistsException –

A resource to be created or added already exists.
ConcurrentModificationException –

Two processes are trying to modify a resource simultaneously.
InternalServiceException –

An internal service error occurred.
InvalidInputException –

The input provided was not valid.
ThrottlingException –

The throttling threshhold was exceeded.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_glue/_services/glue.py

def create_glossary(
    self,
    name: "capo_glue.types.glossary_name.GlossaryName",
    *,
    config_overrides: Optional[GlueClientConfig] = None,
    description: Optional[
        "capo_glue.types.metadata_description.MetadataDescription"
    ] = None,
    client_token: Optional["capo_glue.types.hash_string.HashString"] = None,
) -> "capo_glue.types.create_glossary_response.CreateGlossaryResponse":
    """<p>Creates a business glossary in Glue Data Catalog. A glossary is a container for glossary terms that define business concepts.</p>

    Args:
        name: <p>The name of the glossary.</p>
        description: <p>The description of the glossary.</p>
        client_token: <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>

    Raises:
        capo_glue.errors.access_denied_exception.AccessDeniedException: <p>Access to a resource was denied.</p>
        capo_glue.errors.already_exists_exception.AlreadyExistsException: <p>A resource to be created or added already exists.</p>
        capo_glue.errors.concurrent_modification_exception.ConcurrentModificationException: <p>Two processes are trying to modify a resource simultaneously.</p>
        capo_glue.errors.internal_service_exception.InternalServiceException: <p>An internal service error occurred.</p>
        capo_glue.errors.invalid_input_exception.InvalidInputException: <p>The input provided was not valid.</p>
        capo_glue.errors.throttling_exception.ThrottlingException: <p>The throttling threshhold was exceeded.</p>
        capo_glue.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_glue.types.create_glossary_request.CreateGlossaryRequest]",
    ) -> OperationResponse[
        "capo_glue.types.create_glossary_response.CreateGlossaryResponse"
    ]:
        import capo_glue._operations.aws_glue.create_glossary

        output, http_response = (
            capo_glue._operations.aws_glue.create_glossary.create_glossary(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateGlossary")
    )
    input_: capo_glue.types.create_glossary_request.CreateGlossaryRequest = {
        "name": name
    }
    if description is not None:
        input_["description"] = description
    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