get_discovered_schema `async` ¶

get_discovered_schema(
    *,
    config_overrides: Optional[AsyncschemasClientConfig] = None,
    events: Optional[__listOfGetDiscoveredSchemaVersionItemInput] = None,
    type: Optional[Type] = None,
) -> GetDiscoveredSchemaResponse

Get the discovered schema that was generated based on sampled events.

Parameters:

events (Optional[__listOfGetDiscoveredSchemaVersionItemInput], default: None ) –

An array of strings where each string is a JSON event. These are the events that were used to generate the schema. The array includes a single type of event and has a maximum size of 10 events.
type (Optional[Type], default: None ) –

The type of event.

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 get_discovered_schema(
    self,
    *,
    config_overrides: Optional[AsyncschemasClientConfig] = None,
    events: Optional[
        "capo_schemas.types.__list_of_get_discovered_schema_version_item_input.__listOfGetDiscoveredSchemaVersionItemInput"
    ] = None,
    type: Optional["capo_schemas.types.type.Type"] = None,
) -> (
    "capo_schemas.types.get_discovered_schema_response.GetDiscoveredSchemaResponse"
):
    """<p>Get the discovered schema that was generated based on sampled events.</p>

    Args:
        events: <p>An array of strings where each string is a JSON event. These are the events that were used to generate the schema. The array includes a single type of event and has a maximum size of 10 events.</p>
        type: <p>The type of event.</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.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.get_discovered_schema_request.GetDiscoveredSchemaRequest]",
    ) -> AsyncOperationResponse[
        "capo_schemas.types.get_discovered_schema_response.GetDiscoveredSchemaResponse"
    ]:
        import capo_schemas._operations.schemas.get_discovered_schema

        (
            output,
            http_response,
        ) = await capo_schemas._operations.schemas.get_discovered_schema.async_get_discovered_schema(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetDiscoveredSchema")
    )
    input_: capo_schemas.types.get_discovered_schema_request.GetDiscoveredSchemaRequest = {}
    if events is not None:
        input_["events"] = events
    if type is not None:
        input_["type"] = type

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

get_discovered_schema async ¶

get_discovered_schema `async` ¶