pub struct Client { /* private fields */ }
Expand description
Client for Data Automation for Amazon Bedrock
Client for invoking operations on Data Automation for Amazon Bedrock. Each operation on Data Automation for Amazon Bedrock 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_bedrockdataautomation::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 Builder
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_bedrockdataautomation::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 CreateBlueprint
operation has
a Client::create_blueprint
, 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_blueprint()
.blueprint_name("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.
Implementations§
Source§impl Client
impl Client
Sourcepub fn create_blueprint(&self) -> CreateBlueprintFluentBuilder
pub fn create_blueprint(&self) -> CreateBlueprintFluentBuilder
Constructs a fluent builder for the CreateBlueprint
operation.
- The fluent builder is configurable:
blueprint_name(impl Into<String>)
/set_blueprint_name(Option<String>)
:
required: true
Name of the Blueprintr#type(Type)
/set_type(Option<Type>)
:
required: true
Typeblueprint_stage(BlueprintStage)
/set_blueprint_stage(Option<BlueprintStage>)
:
required: false
Stage of the Blueprintschema(impl Into<String>)
/set_schema(Option<String>)
:
required: true
Schema of the blueprintclient_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: false
Client specified token used for idempotency checksencryption_configuration(EncryptionConfiguration)
/set_encryption_configuration(Option<EncryptionConfiguration>)
:
required: false
KMS Encryption Configurationtags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: false
List of tags
- On success, responds with
CreateBlueprintOutput
with field(s):blueprint(Option<Blueprint>)
: Contains the information of a Blueprint.
- On failure, responds with
SdkError<CreateBlueprintError>
Source§impl Client
impl Client
Sourcepub fn create_blueprint_version(&self) -> CreateBlueprintVersionFluentBuilder
pub fn create_blueprint_version(&self) -> CreateBlueprintVersionFluentBuilder
Constructs a fluent builder for the CreateBlueprintVersion
operation.
- The fluent builder is configurable:
blueprint_arn(impl Into<String>)
/set_blueprint_arn(Option<String>)
:
required: true
ARN generated at the server side when a Blueprint is createdclient_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: false
Client specified token used for idempotency checks
- On success, responds with
CreateBlueprintVersionOutput
with field(s):blueprint(Option<Blueprint>)
: Contains the information of a Blueprint.
- On failure, responds with
SdkError<CreateBlueprintVersionError>
Source§impl Client
impl Client
Sourcepub fn create_data_automation_project(
&self,
) -> CreateDataAutomationProjectFluentBuilder
pub fn create_data_automation_project( &self, ) -> CreateDataAutomationProjectFluentBuilder
Constructs a fluent builder for the CreateDataAutomationProject
operation.
- The fluent builder is configurable:
project_name(impl Into<String>)
/set_project_name(Option<String>)
:
required: true
Name of the DataAutomationProjectproject_description(impl Into<String>)
/set_project_description(Option<String>)
:
required: false
Description of the DataAutomationProjectproject_stage(DataAutomationProjectStage)
/set_project_stage(Option<DataAutomationProjectStage>)
:
required: false
Stage of the Projectstandard_output_configuration(StandardOutputConfiguration)
/set_standard_output_configuration(Option<StandardOutputConfiguration>)
:
required: true
Standard output configurationcustom_output_configuration(CustomOutputConfiguration)
/set_custom_output_configuration(Option<CustomOutputConfiguration>)
:
required: false
Custom output configurationoverride_configuration(OverrideConfiguration)
/set_override_configuration(Option<OverrideConfiguration>)
:
required: false
Override configurationclient_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: false
Client specified token used for idempotency checksencryption_configuration(EncryptionConfiguration)
/set_encryption_configuration(Option<EncryptionConfiguration>)
:
required: false
KMS Encryption Configurationtags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: false
List of tags
- On success, responds with
CreateDataAutomationProjectOutput
with field(s):project_arn(String)
: ARN of a DataAutomationProjectproject_stage(Option<DataAutomationProjectStage>)
: Stage of the Projectstatus(Option<DataAutomationProjectStatus>)
: Status of Data Automation Project
- On failure, responds with
SdkError<CreateDataAutomationProjectError>
Source§impl Client
impl Client
Sourcepub fn delete_blueprint(&self) -> DeleteBlueprintFluentBuilder
pub fn delete_blueprint(&self) -> DeleteBlueprintFluentBuilder
Constructs a fluent builder for the DeleteBlueprint
operation.
- The fluent builder is configurable:
blueprint_arn(impl Into<String>)
/set_blueprint_arn(Option<String>)
:
required: true
ARN generated at the server side when a Blueprint is createdblueprint_version(impl Into<String>)
/set_blueprint_version(Option<String>)
:
required: false
Optional field to delete a specific Blueprint version
- On success, responds with
DeleteBlueprintOutput
- On failure, responds with
SdkError<DeleteBlueprintError>
Source§impl Client
impl Client
Sourcepub fn delete_data_automation_project(
&self,
) -> DeleteDataAutomationProjectFluentBuilder
pub fn delete_data_automation_project( &self, ) -> DeleteDataAutomationProjectFluentBuilder
Constructs a fluent builder for the DeleteDataAutomationProject
operation.
- The fluent builder is configurable:
project_arn(impl Into<String>)
/set_project_arn(Option<String>)
:
required: true
ARN generated at the server side when a DataAutomationProject is created
- On success, responds with
DeleteDataAutomationProjectOutput
with field(s):project_arn(String)
: ARN of a DataAutomationProjectstatus(Option<DataAutomationProjectStatus>)
: Status of Data Automation Project
- On failure, responds with
SdkError<DeleteDataAutomationProjectError>
Source§impl Client
impl Client
Sourcepub fn get_blueprint(&self) -> GetBlueprintFluentBuilder
pub fn get_blueprint(&self) -> GetBlueprintFluentBuilder
Constructs a fluent builder for the GetBlueprint
operation.
- The fluent builder is configurable:
blueprint_arn(impl Into<String>)
/set_blueprint_arn(Option<String>)
:
required: true
ARN generated at the server side when a Blueprint is createdblueprint_version(impl Into<String>)
/set_blueprint_version(Option<String>)
:
required: false
Optional field to get a specific Blueprint versionblueprint_stage(BlueprintStage)
/set_blueprint_stage(Option<BlueprintStage>)
:
required: false
Optional field to get a specific Blueprint stage
- On success, responds with
GetBlueprintOutput
with field(s):blueprint(Option<Blueprint>)
: Contains the information of a Blueprint.
- On failure, responds with
SdkError<GetBlueprintError>
Source§impl Client
impl Client
Sourcepub fn get_data_automation_project(
&self,
) -> GetDataAutomationProjectFluentBuilder
pub fn get_data_automation_project( &self, ) -> GetDataAutomationProjectFluentBuilder
Constructs a fluent builder for the GetDataAutomationProject
operation.
- The fluent builder is configurable:
project_arn(impl Into<String>)
/set_project_arn(Option<String>)
:
required: true
ARN generated at the server side when a DataAutomationProject is createdproject_stage(DataAutomationProjectStage)
/set_project_stage(Option<DataAutomationProjectStage>)
:
required: false
Optional field to delete a specific DataAutomationProject stage
- On success, responds with
GetDataAutomationProjectOutput
with field(s):project(Option<DataAutomationProject>)
: Contains the information of a DataAutomationProject.
- On failure, responds with
SdkError<GetDataAutomationProjectError>
Source§impl Client
impl Client
Sourcepub fn list_blueprints(&self) -> ListBlueprintsFluentBuilder
pub fn list_blueprints(&self) -> ListBlueprintsFluentBuilder
Constructs a fluent builder for the ListBlueprints
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
blueprint_arn(impl Into<String>)
/set_blueprint_arn(Option<String>)
:
required: false
ARN of a Blueprintresource_owner(ResourceOwner)
/set_resource_owner(Option<ResourceOwner>)
:
required: false
Resource Ownerblueprint_stage_filter(BlueprintStageFilter)
/set_blueprint_stage_filter(Option<BlueprintStageFilter>)
:
required: false
Blueprint Stage filtermax_results(i32)
/set_max_results(Option<i32>)
:
required: false
Max Resultsnext_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
Pagination tokenproject_filter(DataAutomationProjectFilter)
/set_project_filter(Option<DataAutomationProjectFilter>)
:
required: false
Data Automation Project Filter
- On success, responds with
ListBlueprintsOutput
with field(s):blueprints(Vec::<BlueprintSummary>)
: List of Blueprintsnext_token(Option<String>)
: Pagination token
- On failure, responds with
SdkError<ListBlueprintsError>
Source§impl Client
impl Client
Sourcepub fn list_data_automation_projects(
&self,
) -> ListDataAutomationProjectsFluentBuilder
pub fn list_data_automation_projects( &self, ) -> ListDataAutomationProjectsFluentBuilder
Constructs a fluent builder for the ListDataAutomationProjects
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: false
Max Resultsnext_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
Pagination tokenproject_stage_filter(DataAutomationProjectStageFilter)
/set_project_stage_filter(Option<DataAutomationProjectStageFilter>)
:
required: false
Project Stage filterblueprint_filter(BlueprintFilter)
/set_blueprint_filter(Option<BlueprintFilter>)
:
required: false
Blueprint Filterresource_owner(ResourceOwner)
/set_resource_owner(Option<ResourceOwner>)
:
required: false
Resource Owner
- On success, responds with
ListDataAutomationProjectsOutput
with field(s):projects(Vec::<DataAutomationProjectSummary>)
: List of DataAutomationProjectSummarynext_token(Option<String>)
: Pagination token
- On failure, responds with
SdkError<ListDataAutomationProjectsError>
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: true
ARN of a taggable resource
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<Vec::<Tag>>)
: List of tags
- On failure, responds with
SdkError<ListTagsForResourceError>
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: true
ARN of a taggable resourcetags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: true
List of tags
- 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: true
ARN of a taggable resourcetag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: true
List of tag keys
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
Source§impl Client
impl Client
Sourcepub fn update_blueprint(&self) -> UpdateBlueprintFluentBuilder
pub fn update_blueprint(&self) -> UpdateBlueprintFluentBuilder
Constructs a fluent builder for the UpdateBlueprint
operation.
- The fluent builder is configurable:
blueprint_arn(impl Into<String>)
/set_blueprint_arn(Option<String>)
:
required: true
ARN generated at the server side when a Blueprint is createdschema(impl Into<String>)
/set_schema(Option<String>)
:
required: true
Schema of the blueprintblueprint_stage(BlueprintStage)
/set_blueprint_stage(Option<BlueprintStage>)
:
required: false
Stage of the Blueprintencryption_configuration(EncryptionConfiguration)
/set_encryption_configuration(Option<EncryptionConfiguration>)
:
required: false
KMS Encryption Configuration
- On success, responds with
UpdateBlueprintOutput
with field(s):blueprint(Option<Blueprint>)
: Contains the information of a Blueprint.
- On failure, responds with
SdkError<UpdateBlueprintError>
Source§impl Client
impl Client
Sourcepub fn update_data_automation_project(
&self,
) -> UpdateDataAutomationProjectFluentBuilder
pub fn update_data_automation_project( &self, ) -> UpdateDataAutomationProjectFluentBuilder
Constructs a fluent builder for the UpdateDataAutomationProject
operation.
- The fluent builder is configurable:
project_arn(impl Into<String>)
/set_project_arn(Option<String>)
:
required: true
ARN generated at the server side when a DataAutomationProject is createdproject_stage(DataAutomationProjectStage)
/set_project_stage(Option<DataAutomationProjectStage>)
:
required: false
Stage of the Projectproject_description(impl Into<String>)
/set_project_description(Option<String>)
:
required: false
Description of the DataAutomationProjectstandard_output_configuration(StandardOutputConfiguration)
/set_standard_output_configuration(Option<StandardOutputConfiguration>)
:
required: true
Standard output configurationcustom_output_configuration(CustomOutputConfiguration)
/set_custom_output_configuration(Option<CustomOutputConfiguration>)
:
required: false
Custom output configurationoverride_configuration(OverrideConfiguration)
/set_override_configuration(Option<OverrideConfiguration>)
:
required: false
Override configurationencryption_configuration(EncryptionConfiguration)
/set_encryption_configuration(Option<EncryptionConfiguration>)
:
required: false
KMS Encryption Configuration
- On success, responds with
UpdateDataAutomationProjectOutput
with field(s):project_arn(String)
: ARN of a DataAutomationProjectproject_stage(Option<DataAutomationProjectStage>)
: Stage of the Projectstatus(Option<DataAutomationProjectStatus>)
: Status of Data Automation Project
- On failure, responds with
SdkError<UpdateDataAutomationProjectError>
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§
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);