Struct aws_sdk_pipes::client::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for Amazon EventBridge Pipes
Client for invoking operations on Amazon EventBridge Pipes. Each operation on Amazon EventBridge Pipes 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_pipes::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_pipes::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 ListTagsForResource
operation has
a Client::list_tags_for_resource
, 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.list_tags_for_resource()
.resource_arn("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_pipe(&self) -> CreatePipeFluentBuilder
pub fn create_pipe(&self) -> CreatePipeFluentBuilder
Constructs a fluent builder for the CreatePipe
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the pipe.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the pipe.
desired_state(RequestedPipeState)
/set_desired_state(Option<RequestedPipeState>)
:
required: falseThe state the pipe should be in.
source(impl Into<String>)
/set_source(Option<String>)
:
required: trueThe ARN of the source resource.
source_parameters(PipeSourceParameters)
/set_source_parameters(Option<PipeSourceParameters>)
:
required: falseThe parameters required to set up a source for your pipe.
enrichment(impl Into<String>)
/set_enrichment(Option<String>)
:
required: falseThe ARN of the enrichment resource.
enrichment_parameters(PipeEnrichmentParameters)
/set_enrichment_parameters(Option<PipeEnrichmentParameters>)
:
required: falseThe parameters required to set up enrichment on your pipe.
target(impl Into<String>)
/set_target(Option<String>)
:
required: trueThe ARN of the target resource.
target_parameters(PipeTargetParameters)
/set_target_parameters(Option<PipeTargetParameters>)
:
required: falseThe parameters required to set up a target for your pipe.
For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: trueThe ARN of the role that allows the pipe to send data to the target.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe list of key-value pairs to associate with the pipe.
log_configuration(PipeLogConfigurationParameters)
/set_log_configuration(Option<PipeLogConfigurationParameters>)
:
required: falseThe logging configuration settings for the pipe.
- On success, responds with
CreatePipeOutput
with field(s):arn(Option<String>)
:The ARN of the pipe.
name(Option<String>)
:The name of the pipe.
desired_state(Option<RequestedPipeState>)
:The state the pipe should be in.
current_state(Option<PipeState>)
:The state the pipe is in.
creation_time(Option<DateTime>)
:The time the pipe was created.
last_modified_time(Option<DateTime>)
:When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
- On failure, responds with
SdkError<CreatePipeError>
source§impl Client
impl Client
sourcepub fn delete_pipe(&self) -> DeletePipeFluentBuilder
pub fn delete_pipe(&self) -> DeletePipeFluentBuilder
Constructs a fluent builder for the DeletePipe
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the pipe.
- On success, responds with
DeletePipeOutput
with field(s):arn(Option<String>)
:The ARN of the pipe.
name(Option<String>)
:The name of the pipe.
desired_state(Option<RequestedPipeStateDescribeResponse>)
:The state the pipe should be in.
current_state(Option<PipeState>)
:The state the pipe is in.
creation_time(Option<DateTime>)
:The time the pipe was created.
last_modified_time(Option<DateTime>)
:When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
- On failure, responds with
SdkError<DeletePipeError>
source§impl Client
impl Client
sourcepub fn describe_pipe(&self) -> DescribePipeFluentBuilder
pub fn describe_pipe(&self) -> DescribePipeFluentBuilder
Constructs a fluent builder for the DescribePipe
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the pipe.
- On success, responds with
DescribePipeOutput
with field(s):arn(Option<String>)
:The ARN of the pipe.
name(Option<String>)
:The name of the pipe.
description(Option<String>)
:A description of the pipe.
desired_state(Option<RequestedPipeStateDescribeResponse>)
:The state the pipe should be in.
current_state(Option<PipeState>)
:The state the pipe is in.
state_reason(Option<String>)
:The reason the pipe is in its current state.
source(Option<String>)
:The ARN of the source resource.
source_parameters(Option<PipeSourceParameters>)
:The parameters required to set up a source for your pipe.
enrichment(Option<String>)
:The ARN of the enrichment resource.
enrichment_parameters(Option<PipeEnrichmentParameters>)
:The parameters required to set up enrichment on your pipe.
target(Option<String>)
:The ARN of the target resource.
target_parameters(Option<PipeTargetParameters>)
:The parameters required to set up a target for your pipe.
For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.
role_arn(Option<String>)
:The ARN of the role that allows the pipe to send data to the target.
tags(Option<HashMap::<String, String>>)
:The list of key-value pairs to associate with the pipe.
creation_time(Option<DateTime>)
:The time the pipe was created.
last_modified_time(Option<DateTime>)
:When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
log_configuration(Option<PipeLogConfiguration>)
:The logging configuration settings for the pipe.
- On failure, responds with
SdkError<DescribePipeError>
source§impl Client
impl Client
sourcepub fn list_pipes(&self) -> ListPipesFluentBuilder
pub fn list_pipes(&self) -> ListPipesFluentBuilder
Constructs a fluent builder for the ListPipes
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
name_prefix(impl Into<String>)
/set_name_prefix(Option<String>)
:
required: falseA value that will return a subset of the pipes associated with this account. For example,
“NamePrefix”: “ABC”
will return all endpoints with “ABC” in the name.desired_state(RequestedPipeState)
/set_desired_state(Option<RequestedPipeState>)
:
required: falseThe state the pipe should be in.
current_state(PipeState)
/set_current_state(Option<PipeState>)
:
required: falseThe state the pipe is in.
source_prefix(impl Into<String>)
/set_source_prefix(Option<String>)
:
required: falseThe prefix matching the pipe source.
target_prefix(impl Into<String>)
/set_target_prefix(Option<String>)
:
required: falseThe prefix matching the pipe target.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of pipes to include in the response.
- On success, responds with
ListPipesOutput
with field(s):pipes(Option<Vec::<Pipe>>)
:The pipes returned by the call.
next_token(Option<String>)
:If
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
- On failure, responds with
SdkError<ListPipesError>
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 pipe for which you want to view tags.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<HashMap::<String, String>>)
:The list of key-value pairs to associate with the pipe.
- On failure, responds with
SdkError<ListTagsForResourceError>
source§impl Client
impl Client
sourcepub fn start_pipe(&self) -> StartPipeFluentBuilder
pub fn start_pipe(&self) -> StartPipeFluentBuilder
Constructs a fluent builder for the StartPipe
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the pipe.
- On success, responds with
StartPipeOutput
with field(s):arn(Option<String>)
:The ARN of the pipe.
name(Option<String>)
:The name of the pipe.
desired_state(Option<RequestedPipeState>)
:The state the pipe should be in.
current_state(Option<PipeState>)
:The state the pipe is in.
creation_time(Option<DateTime>)
:The time the pipe was created.
last_modified_time(Option<DateTime>)
:When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
- On failure, responds with
SdkError<StartPipeError>
source§impl Client
impl Client
sourcepub fn stop_pipe(&self) -> StopPipeFluentBuilder
pub fn stop_pipe(&self) -> StopPipeFluentBuilder
Constructs a fluent builder for the StopPipe
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the pipe.
- On success, responds with
StopPipeOutput
with field(s):arn(Option<String>)
:The ARN of the pipe.
name(Option<String>)
:The name of the pipe.
desired_state(Option<RequestedPipeState>)
:The state the pipe should be in.
current_state(Option<PipeState>)
:The state the pipe is in.
creation_time(Option<DateTime>)
:The time the pipe was created.
last_modified_time(Option<DateTime>)
:When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
- On failure, responds with
SdkError<StopPipeError>
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 pipe.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: trueThe list of key-value pairs associated with the pipe.
- 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 pipe.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueThe list of tag keys to remove from the pipe.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
sourcepub fn update_pipe(&self) -> UpdatePipeFluentBuilder
pub fn update_pipe(&self) -> UpdatePipeFluentBuilder
Constructs a fluent builder for the UpdatePipe
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the pipe.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the pipe.
desired_state(RequestedPipeState)
/set_desired_state(Option<RequestedPipeState>)
:
required: falseThe state the pipe should be in.
source_parameters(UpdatePipeSourceParameters)
/set_source_parameters(Option<UpdatePipeSourceParameters>)
:
required: falseThe parameters required to set up a source for your pipe.
enrichment(impl Into<String>)
/set_enrichment(Option<String>)
:
required: falseThe ARN of the enrichment resource.
enrichment_parameters(PipeEnrichmentParameters)
/set_enrichment_parameters(Option<PipeEnrichmentParameters>)
:
required: falseThe parameters required to set up enrichment on your pipe.
target(impl Into<String>)
/set_target(Option<String>)
:
required: falseThe ARN of the target resource.
target_parameters(PipeTargetParameters)
/set_target_parameters(Option<PipeTargetParameters>)
:
required: falseThe parameters required to set up a target for your pipe.
For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: trueThe ARN of the role that allows the pipe to send data to the target.
log_configuration(PipeLogConfigurationParameters)
/set_log_configuration(Option<PipeLogConfigurationParameters>)
:
required: falseThe logging configuration settings for the pipe.
- On success, responds with
UpdatePipeOutput
with field(s):arn(Option<String>)
:The ARN of the pipe.
name(Option<String>)
:The name of the pipe.
desired_state(Option<RequestedPipeState>)
:The state the pipe should be in.
current_state(Option<PipeState>)
:The state the pipe is in.
creation_time(Option<DateTime>)
:The time the pipe was created.
last_modified_time(Option<DateTime>)
:When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
- On failure, responds with
SdkError<UpdatePipeError>
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> 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