Skip to content

list_glossary_terms

list_glossary_terms(
    glossary_identifier: GlossaryId,
    *,
    config_overrides: Optional[GlueClientConfig] = None,
    max_results: Optional[PageSize] = None,
    next_token: Optional[Token] = None,
) -> ListGlossaryTermsResponse

Lists glossary terms within a business glossary in Glue Data Catalog.

Parameters:

  • glossary_identifier (GlossaryId) –

    The unique identifier of the glossary whose terms to list.

  • max_results (Optional[PageSize], default: None ) –

    The maximum number of results to return in the response.

  • next_token (Optional[Token], default: None ) –

    A continuation token, if this is a continuation call.

Raises:

Source code in docs_src/capo_glue/_services/glue.py
def list_glossary_terms(
    self,
    glossary_identifier: "capo_glue.types.glossary_id.GlossaryId",
    *,
    config_overrides: Optional[GlueClientConfig] = None,
    max_results: Optional["capo_glue.types.page_size.PageSize"] = None,
    next_token: Optional["capo_glue.types.token.Token"] = None,
) -> "capo_glue.types.list_glossary_terms_response.ListGlossaryTermsResponse":
    """<p>Lists glossary terms within a business glossary in Glue Data Catalog.</p>

    Args:
        glossary_identifier: <p>The unique identifier of the glossary whose terms to list.</p>
        max_results: <p>The maximum number of results to return in the response.</p>
        next_token: <p>A continuation token, if this is a continuation call.</p>

    Raises:
        capo_glue.errors.access_denied_exception.AccessDeniedException: <p>Access to a resource was denied.</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.list_glossary_terms_request.ListGlossaryTermsRequest]",
    ) -> OperationResponse[
        "capo_glue.types.list_glossary_terms_response.ListGlossaryTermsResponse"
    ]:
        import capo_glue._operations.aws_glue.list_glossary_terms

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListGlossaryTerms")
    )
    input_: capo_glue.types.list_glossary_terms_request.ListGlossaryTermsRequest = {
        "glossary_identifier": glossary_identifier
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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