search_schemas `async` ¶

search_schemas(
    registry_name: __string,
    *,
    config_overrides: Optional[AsyncschemasClientConfig] = None,
    keywords: Optional[__string] = None,
    limit: Optional[__integer] = None,
    next_token: Optional[__string] = None,
) -> SearchSchemasResponse

Search the schemas

Parameters:

keywords (Optional[__string], default: None ) –

Specifying this limits the results to only schemas that include the provided keywords.
next_token (Optional[__string], default: None ) –

The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.
registry_name (__string) –

The name of the registry.

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 search_schemas(
    self,
    registry_name: "capo_schemas.types.__string.__string",
    *,
    config_overrides: Optional[AsyncschemasClientConfig] = None,
    keywords: Optional["capo_schemas.types.__string.__string"] = None,
    limit: Optional["capo_schemas.types.__integer.__integer"] = None,
    next_token: Optional["capo_schemas.types.__string.__string"] = None,
) -> "capo_schemas.types.search_schemas_response.SearchSchemasResponse":
    """<p>Search the schemas</p>

    Args:
        keywords: <p>Specifying this limits the results to only schemas that include the provided keywords.</p>
        next_token: <p>The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.</p>
        registry_name: <p>The name of the registry.</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.search_schemas_request.SearchSchemasRequest]",
    ) -> AsyncOperationResponse[
        "capo_schemas.types.search_schemas_response.SearchSchemasResponse"
    ]:
        import capo_schemas._operations.schemas.search_schemas

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("SearchSchemas")
    )
    input_: capo_schemas.types.search_schemas_request.SearchSchemasRequest = {
        "registry_name": registry_name
    }
    if keywords is not None:
        input_["keywords"] = keywords
    if limit is not None:
        input_["limit"] = limit
    if next_token is not None:
        input_["next_token"] = next_token

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

search_schemas async ¶

search_schemas `async` ¶