Struct aws_sdk_schemas::client::Client
source · [−]pub struct Client<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* 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.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_schemas::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_schemas::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_schemas::Client::from_conf(config);Implementations
impl<C, M, R> Client<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> Client<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
Constructs a fluent builder for the CreateDiscoverer operation.
- The fluent builder is configurable:
description(impl Into<String>)/set_description(Option<String>):A description for the discoverer.
source_arn(impl Into<String>)/set_source_arn(Option<String>):The ARN of the event bus.
cross_account(bool)/set_cross_account(bool):Support discovery of schemas in events sent to the bus from another account. (default: true).
tags(HashMap<String, String>)/set_tags(Option<HashMap<String, String>>):Tags associated with the resource.
- On success, responds with
CreateDiscovererOutputwith 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(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>
Constructs a fluent builder for the CreateRegistry operation.
- The fluent builder is configurable:
description(impl Into<String>)/set_description(Option<String>):A description of the registry to be created.
registry_name(impl Into<String>)/set_registry_name(Option<String>):The name of the registry.
tags(HashMap<String, String>)/set_tags(Option<HashMap<String, String>>):Tags to associate with the registry.
- On success, responds with
CreateRegistryOutputwith 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>
Constructs a fluent builder for the CreateSchema operation.
- The fluent builder is configurable:
content(impl Into<String>)/set_content(Option<String>):The source of the schema definition.
description(impl Into<String>)/set_description(Option<String>):A description of the schema.
registry_name(impl Into<String>)/set_registry_name(Option<String>):The name of the registry.
schema_name(impl Into<String>)/set_schema_name(Option<String>):The name of the schema.
tags(HashMap<String, String>)/set_tags(Option<HashMap<String, String>>):Tags associated with the schema.
r#type(Type)/set_type(Option<Type>):The type of schema.
- On success, responds with
CreateSchemaOutputwith 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>
Constructs a fluent builder for the DeleteDiscoverer operation.
- The fluent builder is configurable:
discoverer_id(impl Into<String>)/set_discoverer_id(Option<String>):The ID of the discoverer.
- On success, responds with
DeleteDiscovererOutput - On failure, responds with
SdkError<DeleteDiscovererError>
Constructs a fluent builder for the DeleteRegistry operation.
- The fluent builder is configurable:
registry_name(impl Into<String>)/set_registry_name(Option<String>):The name of the registry.
- On success, responds with
DeleteRegistryOutput - On failure, responds with
SdkError<DeleteRegistryError>
Constructs a fluent builder for the DeleteResourcePolicy operation.
- The fluent builder is configurable:
registry_name(impl Into<String>)/set_registry_name(Option<String>):The name of the registry.
- On success, responds with
DeleteResourcePolicyOutput - On failure, responds with
SdkError<DeleteResourcePolicyError>
Constructs a fluent builder for the DeleteSchema operation.
- The fluent builder is configurable:
registry_name(impl Into<String>)/set_registry_name(Option<String>):The name of the registry.
schema_name(impl Into<String>)/set_schema_name(Option<String>):The name of the schema.
- On success, responds with
DeleteSchemaOutput - On failure, responds with
SdkError<DeleteSchemaError>
Constructs a fluent builder for the DeleteSchemaVersion operation.
- The fluent builder is configurable:
registry_name(impl Into<String>)/set_registry_name(Option<String>):The name of the registry.
schema_name(impl Into<String>)/set_schema_name(Option<String>):The name of the schema.
schema_version(impl Into<String>)/set_schema_version(Option<String>): The version number of the schema
- On success, responds with
DeleteSchemaVersionOutput - On failure, responds with
SdkError<DeleteSchemaVersionError>
Constructs a fluent builder for the DescribeCodeBinding operation.
- The fluent builder is configurable:
language(impl Into<String>)/set_language(Option<String>):The language of the code binding.
registry_name(impl Into<String>)/set_registry_name(Option<String>):The name of the registry.
schema_name(impl Into<String>)/set_schema_name(Option<String>):The name of the schema.
schema_version(impl Into<String>)/set_schema_version(Option<String>):Specifying this limits the results to only this schema version.
- On success, responds with
DescribeCodeBindingOutputwith 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>
Constructs a fluent builder for the DescribeDiscoverer operation.
- The fluent builder is configurable:
discoverer_id(impl Into<String>)/set_discoverer_id(Option<String>):The ID of the discoverer.
- On success, responds with
DescribeDiscovererOutputwith 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(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>
Constructs a fluent builder for the DescribeRegistry operation.
- The fluent builder is configurable:
registry_name(impl Into<String>)/set_registry_name(Option<String>):The name of the registry.
- On success, responds with
DescribeRegistryOutputwith 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>
Constructs a fluent builder for the DescribeSchema operation.
- The fluent builder is configurable:
registry_name(impl Into<String>)/set_registry_name(Option<String>):The name of the registry.
schema_name(impl Into<String>)/set_schema_name(Option<String>):The name of the schema.
schema_version(impl Into<String>)/set_schema_version(Option<String>):Specifying this limits the results to only this schema version.
- On success, responds with
DescribeSchemaOutputwith 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>
Constructs a fluent builder for the ExportSchema operation.
- The fluent builder is configurable:
registry_name(impl Into<String>)/set_registry_name(Option<String>):The name of the registry.
schema_name(impl Into<String>)/set_schema_name(Option<String>):The name of the schema.
schema_version(impl Into<String>)/set_schema_version(Option<String>):Specifying this limits the results to only this schema version.
r#type(impl Into<String>)/set_type(Option<String>): (undocumented)
- On success, responds with
ExportSchemaOutputwith 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>
Constructs a fluent builder for the GetCodeBindingSource operation.
- The fluent builder is configurable:
language(impl Into<String>)/set_language(Option<String>):The language of the code binding.
registry_name(impl Into<String>)/set_registry_name(Option<String>):The name of the registry.
schema_name(impl Into<String>)/set_schema_name(Option<String>):The name of the schema.
schema_version(impl Into<String>)/set_schema_version(Option<String>):Specifying this limits the results to only this schema version.
- On success, responds with
GetCodeBindingSourceOutputwith field(s):body(Option<Blob>): (undocumented)
- On failure, responds with
SdkError<GetCodeBindingSourceError>
Constructs a fluent builder for the GetDiscoveredSchema operation.
- The fluent builder is configurable:
events(Vec<String>)/set_events(Option<Vec<String>>):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.
r#type(Type)/set_type(Option<Type>):The type of event.
- On success, responds with
GetDiscoveredSchemaOutputwith field(s):content(Option<String>):The source of the schema definition.
- On failure, responds with
SdkError<GetDiscoveredSchemaError>
Constructs a fluent builder for the GetResourcePolicy operation.
- The fluent builder is configurable:
registry_name(impl Into<String>)/set_registry_name(Option<String>):The name of the registry.
- On success, responds with
GetResourcePolicyOutputwith field(s):policy(Option<String>):The resource-based policy.
revision_id(Option<String>):The revision ID.
- On failure, responds with
SdkError<GetResourcePolicyError>
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>):Specifying this limits the results to only those discoverer IDs that start with the specified prefix.
limit(i32)/set_limit(i32): (undocumented)next_token(impl Into<String>)/set_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.
source_arn_prefix(impl Into<String>)/set_source_arn_prefix(Option<String>):Specifying this limits the results to only those ARNs that start with the specified prefix.
- On success, responds with
ListDiscoverersOutputwith 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>
Constructs a fluent builder for the ListRegistries operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
limit(i32)/set_limit(i32): (undocumented)next_token(impl Into<String>)/set_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.
registry_name_prefix(impl Into<String>)/set_registry_name_prefix(Option<String>):Specifying this limits the results to only those registry names that start with the specified prefix.
scope(impl Into<String>)/set_scope(Option<String>):Can be set to Local or AWS to limit responses to your custom registries, or the ones provided by AWS.
- On success, responds with
ListRegistriesOutputwith 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>
Constructs a fluent builder for the ListSchemas operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
limit(i32)/set_limit(i32): (undocumented)next_token(impl Into<String>)/set_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.
registry_name(impl Into<String>)/set_registry_name(Option<String>):The name of the registry.
schema_name_prefix(impl Into<String>)/set_schema_name_prefix(Option<String>):Specifying this limits the results to only those schema names that start with the specified prefix.
- On success, responds with
ListSchemasOutputwith 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>
Constructs a fluent builder for the ListSchemaVersions operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
limit(i32)/set_limit(i32): (undocumented)next_token(impl Into<String>)/set_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.
registry_name(impl Into<String>)/set_registry_name(Option<String>):The name of the registry.
schema_name(impl Into<String>)/set_schema_name(Option<String>):The name of the schema.
- On success, responds with
ListSchemaVersionsOutputwith 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>
Constructs a fluent builder for the ListTagsForResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):The ARN of the resource.
- On success, responds with
ListTagsForResourceOutputwith field(s):tags(Option<HashMap<String, String>>):Key-value pairs associated with a resource.
- On failure, responds with
SdkError<ListTagsForResourceError>
Constructs a fluent builder for the PutCodeBinding operation.
- The fluent builder is configurable:
language(impl Into<String>)/set_language(Option<String>):The language of the code binding.
registry_name(impl Into<String>)/set_registry_name(Option<String>):The name of the registry.
schema_name(impl Into<String>)/set_schema_name(Option<String>):The name of the schema.
schema_version(impl Into<String>)/set_schema_version(Option<String>):Specifying this limits the results to only this schema version.
- On success, responds with
PutCodeBindingOutputwith 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>
Constructs a fluent builder for the PutResourcePolicy operation.
- The fluent builder is configurable:
policy(impl Into<String>)/set_policy(Option<String>):The resource-based policy.
registry_name(impl Into<String>)/set_registry_name(Option<String>):The name of the registry.
revision_id(impl Into<String>)/set_revision_id(Option<String>):The revision ID of the policy.
- On success, responds with
PutResourcePolicyOutputwith 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>
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>):Specifying this limits the results to only schemas that include the provided keywords.
limit(i32)/set_limit(i32): (undocumented)next_token(impl Into<String>)/set_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.
registry_name(impl Into<String>)/set_registry_name(Option<String>):The name of the registry.
- On success, responds with
SearchSchemasOutputwith 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>
Constructs a fluent builder for the StartDiscoverer operation.
- The fluent builder is configurable:
discoverer_id(impl Into<String>)/set_discoverer_id(Option<String>):The ID of the discoverer.
- On success, responds with
StartDiscovererOutputwith 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>
Constructs a fluent builder for the StopDiscoverer operation.
- The fluent builder is configurable:
discoverer_id(impl Into<String>)/set_discoverer_id(Option<String>):The ID of the discoverer.
- On success, responds with
StopDiscovererOutputwith 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>
Constructs a fluent builder for the TagResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):The ARN of the resource.
tags(HashMap<String, String>)/set_tags(Option<HashMap<String, String>>):Tags associated with the resource.
- On success, responds with
TagResourceOutput - On failure, responds with
SdkError<TagResourceError>
Constructs a fluent builder for the UntagResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):The ARN of the resource.
tag_keys(Vec<String>)/set_tag_keys(Option<Vec<String>>):Keys of key-value pairs.
- On success, responds with
UntagResourceOutput - On failure, responds with
SdkError<UntagResourceError>
Constructs a fluent builder for the UpdateDiscoverer operation.
- The fluent builder is configurable:
description(impl Into<String>)/set_description(Option<String>):The description of the discoverer to update.
discoverer_id(impl Into<String>)/set_discoverer_id(Option<String>):The ID of the discoverer.
cross_account(bool)/set_cross_account(bool):Support discovery of schemas in events sent to the bus from another account. (default: true)
- On success, responds with
UpdateDiscovererOutputwith 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(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>
Constructs a fluent builder for the UpdateRegistry operation.
- The fluent builder is configurable:
description(impl Into<String>)/set_description(Option<String>):The description of the registry to update.
registry_name(impl Into<String>)/set_registry_name(Option<String>):The name of the registry.
- On success, responds with
UpdateRegistryOutputwith 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>
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>):The ID of the client token.
content(impl Into<String>)/set_content(Option<String>):The source of the schema definition.
description(impl Into<String>)/set_description(Option<String>):The description of the schema.
registry_name(impl Into<String>)/set_registry_name(Option<String>):The name of the registry.
schema_name(impl Into<String>)/set_schema_name(Option<String>):The name of the schema.
r#type(Type)/set_type(Option<Type>):The schema type for the events schema.
- On success, responds with
UpdateSchemaOutputwith 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>
Creates a client with the given service config and connector override.
Trait Implementations
Auto Trait Implementations
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !RefUnwindSafe for Client<C, M, R>
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !UnwindSafe for Client<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber to this type, returning a
WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more