Skip to content

describe_schema 

describe_schema(
    registry_name: __string,
    schema_name: __string,
    *,
    config_overrides: Optional[schemasClientConfig] = None,
    schema_version: Optional[__string] = None,
) -> DescribeSchemaResponse

Retrieve the schema definition.

Parameters:

  • registry_name (__string) –

    The name of the registry.

  • schema_name (__string) –

    The name of the schema.

  • schema_version (Optional[__string], default: None ) –

    Specifying this limits the results to only this schema version.

Raises:

Source code in docs_src/capo_schemas/_services/schemas.py 
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
def describe_schema(
    self,
    registry_name: "capo_schemas.types.__string.__string",
    schema_name: "capo_schemas.types.__string.__string",
    *,
    config_overrides: Optional[schemasClientConfig] = None,
    schema_version: Optional["capo_schemas.types.__string.__string"] = None,
) -> "capo_schemas.types.describe_schema_response.DescribeSchemaResponse":
    """<p>Retrieve the schema definition.</p>

    Args:
        registry_name: <p>The name of the registry.</p>
        schema_name: <p>The name of the schema.</p>
        schema_version: <p>Specifying this limits the results to only this schema version.</p>

    Raises:
        capo_schemas.errors.bad_request_exception.BadRequestException
        capo_schemas.errors.forbidden_exception.ForbiddenException
        capo_schemas.errors.internal_server_error_exception.InternalServerErrorException
        capo_schemas.errors.not_found_exception.NotFoundException
        capo_schemas.errors.service_unavailable_exception.ServiceUnavailableException
        capo_schemas.errors.unauthorized_exception.UnauthorizedException
        capo_schemas.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_schemas.types.describe_schema_request.DescribeSchemaRequest]",
    ) -> OperationResponse[
        "capo_schemas.types.describe_schema_response.DescribeSchemaResponse"
    ]:
        import capo_schemas._operations.schemas.describe_schema

        output, http_response = (
            capo_schemas._operations.schemas.describe_schema.describe_schema(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeSchema")
    )
    input_: capo_schemas.types.describe_schema_request.DescribeSchemaRequest = {
        "registry_name": registry_name,
        "schema_name": schema_name,
    }
    if schema_version is not None:
        input_["schema_version"] = schema_version

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