describe_schema `async` ¶

describe_schema(
    registry_name: __string,
    schema_name: __string,
    *,
    config_overrides: Optional[AsyncschemasClientConfig] = 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:

UnknownServiceError –

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

Source code in docs_src/capo_schemas/_services/async_schemas.py

async def describe_schema(
    self,
    registry_name: "capo_schemas.types.__string.__string",
    schema_name: "capo_schemas.types.__string.__string",
    *,
    config_overrides: Optional[AsyncschemasClientConfig] = 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.
    """

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

        (
            output,
            http_response,
        ) = await capo_schemas._operations.schemas.describe_schema.async_describe_schema(
            req.options, req.input
        )
        return AsyncOperationResponse(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 = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_schema async ¶

describe_schema `async` ¶