Struct aws_sdk_schemas::client::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for Schemas
Client for invoking operations on Schemas. Each operation on Schemas is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_schemas::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Config
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_schemas::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the CreateDiscoverer
operation has
a Client::create_discoverer
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.create_discoverer()
.description("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
§Waiters
This client provides wait_until
methods behind the Waiters
trait.
To use them, simply import the trait, and then call one of the wait_until
methods. This will
return a waiter fluent builder that takes various parameters, which are documented on the builder
type. Once parameters have been provided, the wait
method can be called to initiate waiting.
For example, if there was a wait_until_thing
method, it could look like:
let result = client.wait_until_thing()
.thing_id("someId")
.wait(Duration::from_secs(120))
.await;
Implementations§
source§impl Client
impl Client
sourcepub fn create_discoverer(&self) -> CreateDiscovererFluentBuilder
pub fn create_discoverer(&self) -> CreateDiscovererFluentBuilder
Constructs a fluent builder for the CreateDiscoverer
operation.
- The fluent builder is configurable:
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description for the discoverer.
source_arn(impl Into<String>)
/set_source_arn(Option<String>)
:
required: trueThe ARN of the event bus.
cross_account(bool)
/set_cross_account(Option<bool>)
:
required: falseSupport discovery of schemas in events sent to the bus from another account. (default: true).
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseTags associated with the resource.
- On success, responds with
CreateDiscovererOutput
with field(s):description(Option<String>)
:The description of the discoverer.
discoverer_arn(Option<String>)
:The ARN of the discoverer.
discoverer_id(Option<String>)
:The ID of the discoverer.
source_arn(Option<String>)
:The ARN of the event bus.
state(Option<DiscovererState>)
:The state of the discoverer.
cross_account(Option<bool>)
:The Status if the discoverer will discover schemas from events sent from another account.
tags(Option<HashMap::<String, String>>)
:Tags associated with the resource.
- On failure, responds with
SdkError<CreateDiscovererError>
source§impl Client
impl Client
sourcepub fn create_registry(&self) -> CreateRegistryFluentBuilder
pub fn create_registry(&self) -> CreateRegistryFluentBuilder
Constructs a fluent builder for the CreateRegistry
operation.
- The fluent builder is configurable:
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the registry to be created.
registry_name(impl Into<String>)
/set_registry_name(Option<String>)
:
required: trueThe name of the registry.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseTags to associate with the registry.
- On success, responds with
CreateRegistryOutput
with field(s):description(Option<String>)
:The description of the registry.
registry_arn(Option<String>)
:The ARN of the registry.
registry_name(Option<String>)
:The name of the registry.
tags(Option<HashMap::<String, String>>)
:Tags associated with the registry.
- On failure, responds with
SdkError<CreateRegistryError>
source§impl Client
impl Client
sourcepub fn create_schema(&self) -> CreateSchemaFluentBuilder
pub fn create_schema(&self) -> CreateSchemaFluentBuilder
Constructs a fluent builder for the CreateSchema
operation.
- The fluent builder is configurable:
content(impl Into<String>)
/set_content(Option<String>)
:
required: trueThe source of the schema definition.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the schema.
registry_name(impl Into<String>)
/set_registry_name(Option<String>)
:
required: trueThe name of the registry.
schema_name(impl Into<String>)
/set_schema_name(Option<String>)
:
required: trueThe name of the schema.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseTags associated with the schema.
r#type(Type)
/set_type(Option<Type>)
:
required: trueThe type of schema.
- On success, responds with
CreateSchemaOutput
with field(s):description(Option<String>)
:The description of the schema.
last_modified(Option<DateTime>)
:The date and time that schema was modified.
schema_arn(Option<String>)
:The ARN of the schema.
schema_name(Option<String>)
:The name of the schema.
schema_version(Option<String>)
:The version number of the schema
tags(Option<HashMap::<String, String>>)
:Key-value pairs associated with a resource.
r#type(Option<String>)
:The type of the schema.
version_created_date(Option<DateTime>)
:The date the schema version was created.
- On failure, responds with
SdkError<CreateSchemaError>
source§impl Client
impl Client
sourcepub fn delete_discoverer(&self) -> DeleteDiscovererFluentBuilder
pub fn delete_discoverer(&self) -> DeleteDiscovererFluentBuilder
Constructs a fluent builder for the DeleteDiscoverer
operation.
- The fluent builder is configurable:
discoverer_id(impl Into<String>)
/set_discoverer_id(Option<String>)
:
required: trueThe ID of the discoverer.
- On success, responds with
DeleteDiscovererOutput
- On failure, responds with
SdkError<DeleteDiscovererError>
source§impl Client
impl Client
sourcepub fn delete_registry(&self) -> DeleteRegistryFluentBuilder
pub fn delete_registry(&self) -> DeleteRegistryFluentBuilder
Constructs a fluent builder for the DeleteRegistry
operation.
- The fluent builder is configurable:
registry_name(impl Into<String>)
/set_registry_name(Option<String>)
:
required: trueThe name of the registry.
- On success, responds with
DeleteRegistryOutput
- On failure, responds with
SdkError<DeleteRegistryError>
source§impl Client
impl Client
sourcepub fn delete_resource_policy(&self) -> DeleteResourcePolicyFluentBuilder
pub fn delete_resource_policy(&self) -> DeleteResourcePolicyFluentBuilder
Constructs a fluent builder for the DeleteResourcePolicy
operation.
- The fluent builder is configurable:
registry_name(impl Into<String>)
/set_registry_name(Option<String>)
:
required: falseThe name of the registry.
- On success, responds with
DeleteResourcePolicyOutput
- On failure, responds with
SdkError<DeleteResourcePolicyError>
source§impl Client
impl Client
sourcepub fn delete_schema(&self) -> DeleteSchemaFluentBuilder
pub fn delete_schema(&self) -> DeleteSchemaFluentBuilder
Constructs a fluent builder for the DeleteSchema
operation.
- The fluent builder is configurable:
registry_name(impl Into<String>)
/set_registry_name(Option<String>)
:
required: trueThe name of the registry.
schema_name(impl Into<String>)
/set_schema_name(Option<String>)
:
required: trueThe name of the schema.
- On success, responds with
DeleteSchemaOutput
- On failure, responds with
SdkError<DeleteSchemaError>
source§impl Client
impl Client
sourcepub fn delete_schema_version(&self) -> DeleteSchemaVersionFluentBuilder
pub fn delete_schema_version(&self) -> DeleteSchemaVersionFluentBuilder
Constructs a fluent builder for the DeleteSchemaVersion
operation.
- The fluent builder is configurable:
registry_name(impl Into<String>)
/set_registry_name(Option<String>)
:
required: trueThe name of the registry.
schema_name(impl Into<String>)
/set_schema_name(Option<String>)
:
required: trueThe name of the schema.
schema_version(impl Into<String>)
/set_schema_version(Option<String>)
:
required: true
The version number of the schema
- On success, responds with
DeleteSchemaVersionOutput
- On failure, responds with
SdkError<DeleteSchemaVersionError>
source§impl Client
impl Client
sourcepub fn describe_code_binding(&self) -> DescribeCodeBindingFluentBuilder
pub fn describe_code_binding(&self) -> DescribeCodeBindingFluentBuilder
Constructs a fluent builder for the DescribeCodeBinding
operation.
- The fluent builder is configurable:
language(impl Into<String>)
/set_language(Option<String>)
:
required: trueThe language of the code binding.
registry_name(impl Into<String>)
/set_registry_name(Option<String>)
:
required: trueThe name of the registry.
schema_name(impl Into<String>)
/set_schema_name(Option<String>)
:
required: trueThe name of the schema.
schema_version(impl Into<String>)
/set_schema_version(Option<String>)
:
required: falseSpecifying this limits the results to only this schema version.
- On success, responds with
DescribeCodeBindingOutput
with field(s):creation_date(Option<DateTime>)
:The time and date that the code binding was created.
last_modified(Option<DateTime>)
:The date and time that code bindings were modified.
schema_version(Option<String>)
:The version number of the schema.
status(Option<CodeGenerationStatus>)
:The current status of code binding generation.
- On failure, responds with
SdkError<DescribeCodeBindingError>
source§impl Client
impl Client
sourcepub fn describe_discoverer(&self) -> DescribeDiscovererFluentBuilder
pub fn describe_discoverer(&self) -> DescribeDiscovererFluentBuilder
Constructs a fluent builder for the DescribeDiscoverer
operation.
- The fluent builder is configurable:
discoverer_id(impl Into<String>)
/set_discoverer_id(Option<String>)
:
required: trueThe ID of the discoverer.
- On success, responds with
DescribeDiscovererOutput
with field(s):description(Option<String>)
:The description of the discoverer.
discoverer_arn(Option<String>)
:The ARN of the discoverer.
discoverer_id(Option<String>)
:The ID of the discoverer.
source_arn(Option<String>)
:The ARN of the event bus.
state(Option<DiscovererState>)
:The state of the discoverer.
cross_account(Option<bool>)
:The Status if the discoverer will discover schemas from events sent from another account.
tags(Option<HashMap::<String, String>>)
:Tags associated with the resource.
- On failure, responds with
SdkError<DescribeDiscovererError>
source§impl Client
impl Client
sourcepub fn describe_registry(&self) -> DescribeRegistryFluentBuilder
pub fn describe_registry(&self) -> DescribeRegistryFluentBuilder
Constructs a fluent builder for the DescribeRegistry
operation.
- The fluent builder is configurable:
registry_name(impl Into<String>)
/set_registry_name(Option<String>)
:
required: trueThe name of the registry.
- On success, responds with
DescribeRegistryOutput
with field(s):description(Option<String>)
:The description of the registry.
registry_arn(Option<String>)
:The ARN of the registry.
registry_name(Option<String>)
:The name of the registry.
tags(Option<HashMap::<String, String>>)
:Tags associated with the registry.
- On failure, responds with
SdkError<DescribeRegistryError>
source§impl Client
impl Client
sourcepub fn describe_schema(&self) -> DescribeSchemaFluentBuilder
pub fn describe_schema(&self) -> DescribeSchemaFluentBuilder
Constructs a fluent builder for the DescribeSchema
operation.
- The fluent builder is configurable:
registry_name(impl Into<String>)
/set_registry_name(Option<String>)
:
required: trueThe name of the registry.
schema_name(impl Into<String>)
/set_schema_name(Option<String>)
:
required: trueThe name of the schema.
schema_version(impl Into<String>)
/set_schema_version(Option<String>)
:
required: falseSpecifying this limits the results to only this schema version.
- On success, responds with
DescribeSchemaOutput
with field(s):content(Option<String>)
:The source of the schema definition.
description(Option<String>)
:The description of the schema.
last_modified(Option<DateTime>)
:The date and time that schema was modified.
schema_arn(Option<String>)
:The ARN of the schema.
schema_name(Option<String>)
:The name of the schema.
schema_version(Option<String>)
:The version number of the schema
tags(Option<HashMap::<String, String>>)
:Tags associated with the resource.
r#type(Option<String>)
:The type of the schema.
version_created_date(Option<DateTime>)
:The date the schema version was created.
- On failure, responds with
SdkError<DescribeSchemaError>
source§impl Client
impl Client
sourcepub fn export_schema(&self) -> ExportSchemaFluentBuilder
pub fn export_schema(&self) -> ExportSchemaFluentBuilder
Constructs a fluent builder for the ExportSchema
operation.
- The fluent builder is configurable:
registry_name(impl Into<String>)
/set_registry_name(Option<String>)
:
required: trueThe name of the registry.
schema_name(impl Into<String>)
/set_schema_name(Option<String>)
:
required: trueThe name of the schema.
schema_version(impl Into<String>)
/set_schema_version(Option<String>)
:
required: falseSpecifying this limits the results to only this schema version.
r#type(impl Into<String>)
/set_type(Option<String>)
:
required: true
(undocumented)
- On success, responds with
ExportSchemaOutput
with field(s):content(Option<String>)
: (undocumented)schema_arn(Option<String>)
: (undocumented)schema_name(Option<String>)
: (undocumented)schema_version(Option<String>)
: (undocumented)r#type(Option<String>)
: (undocumented)
- On failure, responds with
SdkError<ExportSchemaError>
source§impl Client
impl Client
sourcepub fn get_code_binding_source(&self) -> GetCodeBindingSourceFluentBuilder
pub fn get_code_binding_source(&self) -> GetCodeBindingSourceFluentBuilder
Constructs a fluent builder for the GetCodeBindingSource
operation.
- The fluent builder is configurable:
language(impl Into<String>)
/set_language(Option<String>)
:
required: trueThe language of the code binding.
registry_name(impl Into<String>)
/set_registry_name(Option<String>)
:
required: trueThe name of the registry.
schema_name(impl Into<String>)
/set_schema_name(Option<String>)
:
required: trueThe name of the schema.
schema_version(impl Into<String>)
/set_schema_version(Option<String>)
:
required: falseSpecifying this limits the results to only this schema version.
- On success, responds with
GetCodeBindingSourceOutput
with field(s):body(Option<Blob>)
: (undocumented)
- On failure, responds with
SdkError<GetCodeBindingSourceError>
source§impl Client
impl Client
sourcepub fn get_discovered_schema(&self) -> GetDiscoveredSchemaFluentBuilder
pub fn get_discovered_schema(&self) -> GetDiscoveredSchemaFluentBuilder
Constructs a fluent builder for the GetDiscoveredSchema
operation.
- The fluent builder is configurable:
events(impl Into<String>)
/set_events(Option<Vec::<String>>)
:
required: trueAn 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.
r#type(Type)
/set_type(Option<Type>)
:
required: trueThe type of event.
- On success, responds with
GetDiscoveredSchemaOutput
with field(s):content(Option<String>)
:The source of the schema definition.
- On failure, responds with
SdkError<GetDiscoveredSchemaError>
source§impl Client
impl Client
sourcepub fn get_resource_policy(&self) -> GetResourcePolicyFluentBuilder
pub fn get_resource_policy(&self) -> GetResourcePolicyFluentBuilder
Constructs a fluent builder for the GetResourcePolicy
operation.
- The fluent builder is configurable:
registry_name(impl Into<String>)
/set_registry_name(Option<String>)
:
required: falseThe name of the registry.
- On success, responds with
GetResourcePolicyOutput
with field(s):policy(Option<String>)
:The resource-based policy.
revision_id(Option<String>)
:The revision ID.
- On failure, responds with
SdkError<GetResourcePolicyError>
source§impl Client
impl Client
sourcepub fn list_discoverers(&self) -> ListDiscoverersFluentBuilder
pub fn list_discoverers(&self) -> ListDiscoverersFluentBuilder
Constructs a fluent builder for the ListDiscoverers
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
discoverer_id_prefix(impl Into<String>)
/set_discoverer_id_prefix(Option<String>)
:
required: falseSpecifying this limits the results to only those discoverer IDs that start with the specified prefix.
limit(i32)
/set_limit(Option<i32>)
:
required: false
(undocumented)next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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.
source_arn_prefix(impl Into<String>)
/set_source_arn_prefix(Option<String>)
:
required: falseSpecifying this limits the results to only those ARNs that start with the specified prefix.
- On success, responds with
ListDiscoverersOutput
with field(s):discoverers(Option<Vec::<DiscovererSummary>>)
:An array of DiscovererSummary information.
next_token(Option<String>)
: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.
- On failure, responds with
SdkError<ListDiscoverersError>
source§impl Client
impl Client
sourcepub fn list_registries(&self) -> ListRegistriesFluentBuilder
pub fn list_registries(&self) -> ListRegistriesFluentBuilder
Constructs a fluent builder for the ListRegistries
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
limit(i32)
/set_limit(Option<i32>)
:
required: false
(undocumented)next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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_prefix(impl Into<String>)
/set_registry_name_prefix(Option<String>)
:
required: falseSpecifying this limits the results to only those registry names that start with the specified prefix.
scope(impl Into<String>)
/set_scope(Option<String>)
:
required: falseCan be set to Local or AWS to limit responses to your custom registries, or the ones provided by AWS.
- On success, responds with
ListRegistriesOutput
with field(s):next_token(Option<String>)
: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.
registries(Option<Vec::<RegistrySummary>>)
:An array of registry summaries.
- On failure, responds with
SdkError<ListRegistriesError>
source§impl Client
impl Client
sourcepub fn list_schema_versions(&self) -> ListSchemaVersionsFluentBuilder
pub fn list_schema_versions(&self) -> ListSchemaVersionsFluentBuilder
Constructs a fluent builder for the ListSchemaVersions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
limit(i32)
/set_limit(Option<i32>)
:
required: false
(undocumented)next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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(impl Into<String>)
/set_registry_name(Option<String>)
:
required: trueThe name of the registry.
schema_name(impl Into<String>)
/set_schema_name(Option<String>)
:
required: trueThe name of the schema.
- On success, responds with
ListSchemaVersionsOutput
with field(s):next_token(Option<String>)
: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.
schema_versions(Option<Vec::<SchemaVersionSummary>>)
:An array of schema version summaries.
- On failure, responds with
SdkError<ListSchemaVersionsError>
source§impl Client
impl Client
sourcepub fn list_schemas(&self) -> ListSchemasFluentBuilder
pub fn list_schemas(&self) -> ListSchemasFluentBuilder
Constructs a fluent builder for the ListSchemas
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
limit(i32)
/set_limit(Option<i32>)
:
required: false
(undocumented)next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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(impl Into<String>)
/set_registry_name(Option<String>)
:
required: trueThe name of the registry.
schema_name_prefix(impl Into<String>)
/set_schema_name_prefix(Option<String>)
:
required: falseSpecifying this limits the results to only those schema names that start with the specified prefix.
- On success, responds with
ListSchemasOutput
with field(s):next_token(Option<String>)
: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.
schemas(Option<Vec::<SchemaSummary>>)
:An array of schema summaries.
- On failure, responds with
SdkError<ListSchemasError>
source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe ARN of the resource.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<HashMap::<String, String>>)
:Key-value pairs associated with a resource.
- On failure, responds with
SdkError<ListTagsForResourceError>
source§impl Client
impl Client
sourcepub fn put_code_binding(&self) -> PutCodeBindingFluentBuilder
pub fn put_code_binding(&self) -> PutCodeBindingFluentBuilder
Constructs a fluent builder for the PutCodeBinding
operation.
- The fluent builder is configurable:
language(impl Into<String>)
/set_language(Option<String>)
:
required: trueThe language of the code binding.
registry_name(impl Into<String>)
/set_registry_name(Option<String>)
:
required: trueThe name of the registry.
schema_name(impl Into<String>)
/set_schema_name(Option<String>)
:
required: trueThe name of the schema.
schema_version(impl Into<String>)
/set_schema_version(Option<String>)
:
required: falseSpecifying this limits the results to only this schema version.
- On success, responds with
PutCodeBindingOutput
with field(s):creation_date(Option<DateTime>)
:The time and date that the code binding was created.
last_modified(Option<DateTime>)
:The date and time that code bindings were modified.
schema_version(Option<String>)
:The version number of the schema.
status(Option<CodeGenerationStatus>)
:The current status of code binding generation.
- On failure, responds with
SdkError<PutCodeBindingError>
source§impl Client
impl Client
sourcepub fn put_resource_policy(&self) -> PutResourcePolicyFluentBuilder
pub fn put_resource_policy(&self) -> PutResourcePolicyFluentBuilder
Constructs a fluent builder for the PutResourcePolicy
operation.
- The fluent builder is configurable:
policy(impl Into<String>)
/set_policy(Option<String>)
:
required: trueThe resource-based policy.
registry_name(impl Into<String>)
/set_registry_name(Option<String>)
:
required: falseThe name of the registry.
revision_id(impl Into<String>)
/set_revision_id(Option<String>)
:
required: falseThe revision ID of the policy.
- On success, responds with
PutResourcePolicyOutput
with field(s):policy(Option<String>)
:The resource-based policy.
revision_id(Option<String>)
:The revision ID of the policy.
- On failure, responds with
SdkError<PutResourcePolicyError>
source§impl Client
impl Client
sourcepub fn search_schemas(&self) -> SearchSchemasFluentBuilder
pub fn search_schemas(&self) -> SearchSchemasFluentBuilder
Constructs a fluent builder for the SearchSchemas
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
keywords(impl Into<String>)
/set_keywords(Option<String>)
:
required: trueSpecifying this limits the results to only schemas that include the provided keywords.
limit(i32)
/set_limit(Option<i32>)
:
required: false
(undocumented)next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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(impl Into<String>)
/set_registry_name(Option<String>)
:
required: trueThe name of the registry.
- On success, responds with
SearchSchemasOutput
with field(s):next_token(Option<String>)
: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.
schemas(Option<Vec::<SearchSchemaSummary>>)
:An array of SearchSchemaSummary information.
- On failure, responds with
SdkError<SearchSchemasError>
source§impl Client
impl Client
sourcepub fn start_discoverer(&self) -> StartDiscovererFluentBuilder
pub fn start_discoverer(&self) -> StartDiscovererFluentBuilder
Constructs a fluent builder for the StartDiscoverer
operation.
- The fluent builder is configurable:
discoverer_id(impl Into<String>)
/set_discoverer_id(Option<String>)
:
required: trueThe ID of the discoverer.
- On success, responds with
StartDiscovererOutput
with field(s):discoverer_id(Option<String>)
:The ID of the discoverer.
state(Option<DiscovererState>)
:The state of the discoverer.
- On failure, responds with
SdkError<StartDiscovererError>
source§impl Client
impl Client
sourcepub fn stop_discoverer(&self) -> StopDiscovererFluentBuilder
pub fn stop_discoverer(&self) -> StopDiscovererFluentBuilder
Constructs a fluent builder for the StopDiscoverer
operation.
- The fluent builder is configurable:
discoverer_id(impl Into<String>)
/set_discoverer_id(Option<String>)
:
required: trueThe ID of the discoverer.
- On success, responds with
StopDiscovererOutput
with field(s):discoverer_id(Option<String>)
:The ID of the discoverer.
state(Option<DiscovererState>)
:The state of the discoverer.
- On failure, responds with
SdkError<StopDiscovererError>
source§impl Client
impl Client
sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe ARN of the resource.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: trueTags associated with the resource.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
source§impl Client
impl Client
sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe ARN of the resource.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueKeys of key-value pairs.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
sourcepub fn update_discoverer(&self) -> UpdateDiscovererFluentBuilder
pub fn update_discoverer(&self) -> UpdateDiscovererFluentBuilder
Constructs a fluent builder for the UpdateDiscoverer
operation.
- The fluent builder is configurable:
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the discoverer to update.
discoverer_id(impl Into<String>)
/set_discoverer_id(Option<String>)
:
required: trueThe ID of the discoverer.
cross_account(bool)
/set_cross_account(Option<bool>)
:
required: falseSupport discovery of schemas in events sent to the bus from another account. (default: true)
- On success, responds with
UpdateDiscovererOutput
with field(s):description(Option<String>)
:The description of the discoverer.
discoverer_arn(Option<String>)
:The ARN of the discoverer.
discoverer_id(Option<String>)
:The ID of the discoverer.
source_arn(Option<String>)
:The ARN of the event bus.
state(Option<DiscovererState>)
:The state of the discoverer.
cross_account(Option<bool>)
:The Status if the discoverer will discover schemas from events sent from another account.
tags(Option<HashMap::<String, String>>)
:Tags associated with the resource.
- On failure, responds with
SdkError<UpdateDiscovererError>
source§impl Client
impl Client
sourcepub fn update_registry(&self) -> UpdateRegistryFluentBuilder
pub fn update_registry(&self) -> UpdateRegistryFluentBuilder
Constructs a fluent builder for the UpdateRegistry
operation.
- The fluent builder is configurable:
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the registry to update.
registry_name(impl Into<String>)
/set_registry_name(Option<String>)
:
required: trueThe name of the registry.
- On success, responds with
UpdateRegistryOutput
with field(s):description(Option<String>)
:The description of the registry.
registry_arn(Option<String>)
:The ARN of the registry.
registry_name(Option<String>)
:The name of the registry.
tags(Option<HashMap::<String, String>>)
:Tags associated with the registry.
- On failure, responds with
SdkError<UpdateRegistryError>
source§impl Client
impl Client
sourcepub fn update_schema(&self) -> UpdateSchemaFluentBuilder
pub fn update_schema(&self) -> UpdateSchemaFluentBuilder
Constructs a fluent builder for the UpdateSchema
operation.
- The fluent builder is configurable:
client_token_id(impl Into<String>)
/set_client_token_id(Option<String>)
:
required: falseThe ID of the client token.
content(impl Into<String>)
/set_content(Option<String>)
:
required: falseThe source of the schema definition.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the schema.
registry_name(impl Into<String>)
/set_registry_name(Option<String>)
:
required: trueThe name of the registry.
schema_name(impl Into<String>)
/set_schema_name(Option<String>)
:
required: trueThe name of the schema.
r#type(Type)
/set_type(Option<Type>)
:
required: falseThe schema type for the events schema.
- On success, responds with
UpdateSchemaOutput
with field(s):description(Option<String>)
:The description of the schema.
last_modified(Option<DateTime>)
:The date and time that schema was modified.
schema_arn(Option<String>)
:The ARN of the schema.
schema_name(Option<String>)
:The name of the schema.
schema_version(Option<String>)
:The version number of the schema
tags(Option<HashMap::<String, String>>)
:Key-value pairs associated with a resource.
r#type(Option<String>)
:The type of the schema.
version_created_date(Option<DateTime>)
:The date the schema version was created.
- On failure, responds with
SdkError<UpdateSchemaError>
source§impl Client
impl Client
sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
source§impl Waiters for Client
impl Waiters for Client
source§fn wait_until_code_binding_exists(&self) -> CodeBindingExistsFluentBuilder
fn wait_until_code_binding_exists(&self) -> CodeBindingExistsFluentBuilder
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more