Struct aws_sdk_supplychain::client::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for AWS Supply Chain
Client for invoking operations on AWS Supply Chain. Each operation on AWS Supply Chain 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_supplychain::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_supplychain::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.
Implementations§
source§impl Client
impl Client
sourcepub fn create_bill_of_materials_import_job(
&self
) -> CreateBillOfMaterialsImportJobFluentBuilder
pub fn create_bill_of_materials_import_job( &self ) -> CreateBillOfMaterialsImportJobFluentBuilder
Constructs a fluent builder for the CreateBillOfMaterialsImportJob
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:
required: trueThe AWS Supply Chain instance identifier.
s3_uri(impl Into<String>)
/set_s3_uri(Option<String>)
:
required: trueThe S3 URI of the CSV file to be imported. The bucket must grant permissions for AWS Supply Chain to read the file.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseAn idempotency token.
- On success, responds with
CreateBillOfMaterialsImportJobOutput
with field(s):job_id(String)
:The new BillOfMaterialsImportJob identifier.
- On failure, responds with
SdkError<CreateBillOfMaterialsImportJobError>
source§impl Client
impl Client
sourcepub fn get_bill_of_materials_import_job(
&self
) -> GetBillOfMaterialsImportJobFluentBuilder
pub fn get_bill_of_materials_import_job( &self ) -> GetBillOfMaterialsImportJobFluentBuilder
Constructs a fluent builder for the GetBillOfMaterialsImportJob
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:
required: trueThe AWS Supply Chain instance identifier.
job_id(impl Into<String>)
/set_job_id(Option<String>)
:
required: trueThe BillOfMaterialsImportJob identifier.
- On success, responds with
GetBillOfMaterialsImportJobOutput
with field(s):job(Option<BillOfMaterialsImportJob>)
:The BillOfMaterialsImportJob.
- On failure, responds with
SdkError<GetBillOfMaterialsImportJobError>
source§impl Client
impl Client
sourcepub fn send_data_integration_event(
&self
) -> SendDataIntegrationEventFluentBuilder
pub fn send_data_integration_event( &self ) -> SendDataIntegrationEventFluentBuilder
Constructs a fluent builder for the SendDataIntegrationEvent
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:
required: trueThe AWS Supply Chain instance identifier.
event_type(DataIntegrationEventType)
/set_event_type(Option<DataIntegrationEventType>)
:
required: trueThe data event type.
data(impl Into<String>)
/set_data(Option<String>)
:
required: trueThe data payload of the event.
event_group_id(impl Into<String>)
/set_event_group_id(Option<String>)
:
required: trueEvent identifier (for example, orderId for InboundOrder) used for data sharing or partitioning.
event_timestamp(DateTime)
/set_event_timestamp(Option<DateTime>)
:
required: falseThe event timestamp (in epoch seconds).
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseThe idempotent client token.
- On success, responds with
SendDataIntegrationEventOutput
with field(s):event_id(String)
:The unique event identifier.
- On failure, responds with
SdkError<SendDataIntegrationEventError>
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