list_schemas `async` ¶

list_schemas(
    registry_name: __string,
    *,
    config_overrides: Optional[AsyncschemasClientConfig] = None,
    limit: Optional[__integer] = None,
    next_token: Optional[__string] = None,
    schema_name_prefix: Optional[__string] = None,
) -> ListSchemasResponse

List the schemas.

Parameters:

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.
schema_name_prefix (Optional[__string], default: None ) –

Specifying this limits the results to only those schema names that start with the specified prefix.

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 list_schemas(
    self,
    registry_name: "capo_schemas.types.__string.__string",
    *,
    config_overrides: Optional[AsyncschemasClientConfig] = None,
    limit: Optional["capo_schemas.types.__integer.__integer"] = None,
    next_token: Optional["capo_schemas.types.__string.__string"] = None,
    schema_name_prefix: Optional["capo_schemas.types.__string.__string"] = None,
) -> "capo_schemas.types.list_schemas_response.ListSchemasResponse":
    """<p>List the schemas.</p>

    Args:
        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>
        schema_name_prefix: <p>Specifying this limits the results to only those schema names that start with the specified prefix.</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.list_schemas_request.ListSchemasRequest]",
    ) -> AsyncOperationResponse[
        "capo_schemas.types.list_schemas_response.ListSchemasResponse"
    ]:
        import capo_schemas._operations.schemas.list_schemas

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListSchemas")
    )
    input_: capo_schemas.types.list_schemas_request.ListSchemasRequest = {
        "registry_name": registry_name
    }
    if limit is not None:
        input_["limit"] = limit
    if next_token is not None:
        input_["next_token"] = next_token
    if schema_name_prefix is not None:
        input_["schema_name_prefix"] = schema_name_prefix

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

list_schemas async ¶

list_schemas `async` ¶