Struct aws_sdk_schemas::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.

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

source

impl Client

source

pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self

Creates a client with the given service configuration.

source

pub fn conf(&self) -> &Config

Returns the client’s configuration.

source

impl Client

source

pub fn create_discoverer(&self) -> CreateDiscoverer

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 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(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

pub fn create_registry(&self) -> CreateRegistry

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 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

pub fn create_schema(&self) -> CreateSchema

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 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

pub fn delete_discoverer(&self) -> DeleteDiscoverer

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>

source

pub fn delete_registry(&self) -> DeleteRegistry

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>

source

pub fn delete_resource_policy(&self) -> DeleteResourcePolicy

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>

source

pub fn delete_schema(&self) -> DeleteSchema

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>

source

pub fn delete_schema_version(&self) -> DeleteSchemaVersion

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>

source

pub fn describe_code_binding(&self) -> DescribeCodeBinding

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 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

pub fn describe_discoverer(&self) -> DescribeDiscoverer

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 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(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

pub fn describe_registry(&self) -> DescribeRegistry

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 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

pub fn describe_schema(&self) -> DescribeSchema

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 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

pub fn export_schema(&self) -> ExportSchema

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 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

pub fn get_code_binding_source(&self) -> GetCodeBindingSource

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 GetCodeBindingSourceOutput with field(s):
- body(Option<Blob>): (undocumented)
On failure, responds with SdkError<GetCodeBindingSourceError>

source

pub fn get_discovered_schema(&self) -> GetDiscoveredSchema

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 GetDiscoveredSchemaOutput with field(s):
- content(Option<String>):
 The source of the schema definition.
On failure, responds with SdkError<GetDiscoveredSchemaError>

source

pub fn get_resource_policy(&self) -> GetResourcePolicy

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 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

pub fn list_discoverers(&self) -> ListDiscoverers

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 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

pub fn list_registries(&self) -> ListRegistries

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 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

pub fn list_schemas(&self) -> ListSchemas

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 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

pub fn list_schema_versions(&self) -> ListSchemaVersions

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 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

pub fn list_tags_for_resource(&self) -> ListTagsForResource

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 ListTagsForResourceOutput with field(s):
- tags(Option<HashMap<String, String>>):
 Key-value pairs associated with a resource.
On failure, responds with SdkError<ListTagsForResourceError>

source

pub fn put_code_binding(&self) -> PutCodeBinding

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 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

pub fn put_resource_policy(&self) -> PutResourcePolicy

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 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

pub fn search_schemas(&self) -> SearchSchemas

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 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>