Skip to content

list_schemas

list_schemas(
    *,
    config_overrides: Optional[GlueClientConfig] = None,
    registry_id: Optional[RegistryId] = None,
    max_results: Optional[MaxResultsNumber] = None,
    next_token: Optional[SchemaRegistryTokenString] = None,
) -> ListSchemasResponse

Returns a list of schemas with minimal details. Schemas in Deleting status will not be included in the results. Empty results will be returned if there are no schemas available.

When the RegistryId is not provided, all the schemas across registries will be part of the API response.

Parameters:

  • registry_id (Optional[RegistryId], default: None ) –

    A wrapper structure that may contain the registry name and Amazon Resource Name (ARN).

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

    Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.

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

    A continuation token, if this is a continuation call.

Raises:

Source code in docs_src/capo_glue/_services/glue.py
def list_schemas(
    self,
    *,
    config_overrides: Optional[GlueClientConfig] = None,
    registry_id: Optional["capo_glue.types.registry_id.RegistryId"] = None,
    max_results: Optional[
        "capo_glue.types.max_results_number.MaxResultsNumber"
    ] = None,
    next_token: Optional[
        "capo_glue.types.schema_registry_token_string.SchemaRegistryTokenString"
    ] = None,
) -> "capo_glue.types.list_schemas_response.ListSchemasResponse":
    """<p>Returns a list of schemas with minimal details. Schemas in Deleting status will not be included in the results. Empty results will be returned if there are no schemas available.</p> <p>When the <code>RegistryId</code> is not provided, all the schemas across registries will be part of the API response.</p>

    Args:
        registry_id: <p>A wrapper structure that may contain the registry name and Amazon Resource Name (ARN).</p>
        max_results: <p>Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.</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.entity_not_found_exception.EntityNotFoundException: <p>A specified entity does not exist</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.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_glue.types.list_schemas_input.ListSchemasInput]",
    ) -> OperationResponse[
        "capo_glue.types.list_schemas_response.ListSchemasResponse"
    ]:
        import capo_glue._operations.aws_glue.list_schemas

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListSchemas")
    )
    input_: capo_glue.types.list_schemas_input.ListSchemasInput = {}
    if registry_id is not None:
        input_["registry_id"] = registry_id
    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