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

source

pub fn create_discoverer(&self) -> CreateDiscovererFluentBuilder

Constructs a fluent builder for the CreateDiscoverer operation.

source§

impl Client

source

pub fn create_registry(&self) -> CreateRegistryFluentBuilder

Constructs a fluent builder for the CreateRegistry operation.

source§

impl Client

source

pub fn create_schema(&self) -> CreateSchemaFluentBuilder

Constructs a fluent builder for the CreateSchema operation.

source§

impl Client

source

pub fn delete_discoverer(&self) -> DeleteDiscovererFluentBuilder

Constructs a fluent builder for the DeleteDiscoverer operation.

source§

impl Client

source

pub fn delete_registry(&self) -> DeleteRegistryFluentBuilder

Constructs a fluent builder for the DeleteRegistry operation.

source§

impl Client

source

pub fn delete_resource_policy(&self) -> DeleteResourcePolicyFluentBuilder

Constructs a fluent builder for the DeleteResourcePolicy operation.

source§

impl Client

source

pub fn delete_schema(&self) -> DeleteSchemaFluentBuilder

Constructs a fluent builder for the DeleteSchema operation.

source§

impl Client

source

pub fn delete_schema_version(&self) -> DeleteSchemaVersionFluentBuilder

Constructs a fluent builder for the DeleteSchemaVersion operation.

source§

impl Client

source

pub fn describe_code_binding(&self) -> DescribeCodeBindingFluentBuilder

Constructs a fluent builder for the DescribeCodeBinding operation.

source§

impl Client

source

pub fn describe_discoverer(&self) -> DescribeDiscovererFluentBuilder

Constructs a fluent builder for the DescribeDiscoverer operation.

source§

impl Client

source

pub fn describe_registry(&self) -> DescribeRegistryFluentBuilder

Constructs a fluent builder for the DescribeRegistry operation.

source§

impl Client

source

pub fn describe_schema(&self) -> DescribeSchemaFluentBuilder

Constructs a fluent builder for the DescribeSchema operation.

source§

impl Client

source

pub fn export_schema(&self) -> ExportSchemaFluentBuilder

Constructs a fluent builder for the ExportSchema operation.

source§

impl Client

source

pub fn get_code_binding_source(&self) -> GetCodeBindingSourceFluentBuilder

Constructs a fluent builder for the GetCodeBindingSource operation.

source§

impl Client

source

pub fn get_discovered_schema(&self) -> GetDiscoveredSchemaFluentBuilder

Constructs a fluent builder for the GetDiscoveredSchema operation.

source§

impl Client

source

pub fn get_resource_policy(&self) -> GetResourcePolicyFluentBuilder

Constructs a fluent builder for the GetResourcePolicy operation.

source§

impl Client

source

pub fn list_discoverers(&self) -> ListDiscoverersFluentBuilder

Constructs a fluent builder for the ListDiscoverers operation. This operation supports pagination; See into_paginator().

source§

impl Client

source

pub fn list_registries(&self) -> ListRegistriesFluentBuilder

Constructs a fluent builder for the ListRegistries operation. This operation supports pagination; See into_paginator().

source§

impl Client

source

pub fn list_schema_versions(&self) -> ListSchemaVersionsFluentBuilder

Constructs a fluent builder for the ListSchemaVersions operation. This operation supports pagination; See into_paginator().

source§

impl Client

source

pub fn list_schemas(&self) -> ListSchemasFluentBuilder

Constructs a fluent builder for the ListSchemas operation. This operation supports pagination; See into_paginator().

source§

impl Client

source

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

source§

impl Client

source

pub fn put_code_binding(&self) -> PutCodeBindingFluentBuilder

Constructs a fluent builder for the PutCodeBinding operation.

source§

impl Client

source

pub fn put_resource_policy(&self) -> PutResourcePolicyFluentBuilder

Constructs a fluent builder for the PutResourcePolicy operation.

source§

impl Client

source

pub fn search_schemas(&self) -> SearchSchemasFluentBuilder

Constructs a fluent builder for the SearchSchemas operation. This operation supports pagination; See into_paginator().

source§

impl Client

source

pub fn start_discoverer(&self) -> StartDiscovererFluentBuilder

Constructs a fluent builder for the StartDiscoverer operation.

source§

impl Client

source

pub fn stop_discoverer(&self) -> StopDiscovererFluentBuilder

Constructs a fluent builder for the StopDiscoverer operation.

source§

impl Client

source

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

source§

impl Client

source

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

source§

impl Client

source

pub fn update_discoverer(&self) -> UpdateDiscovererFluentBuilder

Constructs a fluent builder for the UpdateDiscoverer operation.

source§

impl Client

source

pub fn update_registry(&self) -> UpdateRegistryFluentBuilder

Constructs a fluent builder for the UpdateRegistry operation.

source§

impl Client

source

pub fn update_schema(&self) -> UpdateSchemaFluentBuilder

Constructs a fluent builder for the UpdateSchema operation.

source§

impl Client

source

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 and time_source configured.
  • No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

source

pub fn config(&self) -> &Config

Returns the client’s configuration.

source§

impl Client

source

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 the sleep_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 the http_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, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations§

source§

impl Clone for Client

source§

fn clone(&self) -> Client

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Client

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Waiters for Client

source§

fn wait_until_code_binding_exists(&self) -> CodeBindingExistsFluentBuilder

Wait until code binding is generated

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> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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
source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more