pub struct Client { /* private fields */ }
Expand description
Client for AWS Marketplace Commerce Analytics
Client for invoking operations on AWS Marketplace Commerce Analytics. Each operation on AWS Marketplace Commerce Analytics 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_marketplacecommerceanalytics::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_marketplacecommerceanalytics::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 GenerateDataSet
operation has
a Client::generate_data_set
, 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.generate_data_set()
.data_set_type("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 generate_data_set(&self) -> GenerateDataSetFluentBuilder
pub fn generate_data_set(&self) -> GenerateDataSetFluentBuilder
Constructs a fluent builder for the GenerateDataSet
operation.
- The fluent builder is configurable:
data_set_type(DataSetType)
/set_data_set_type(Option<DataSetType>)
:
required: trueThe desired data set type.
- customer_subscriber_hourly_monthly_subscriptions
From 2017-09-15 to present: Available daily by 24:00 UTC.
- customer_subscriber_annual_subscriptions
From 2017-09-15 to present: Available daily by 24:00 UTC.
- daily_business_usage_by_instance_type
From 2017-09-15 to present: Available daily by 24:00 UTC.
- daily_business_fees
From 2017-09-15 to present: Available daily by 24:00 UTC.
- daily_business_free_trial_conversions
From 2017-09-15 to present: Available daily by 24:00 UTC.
- daily_business_new_instances
From 2017-09-15 to present: Available daily by 24:00 UTC.
- daily_business_new_product_subscribers
From 2017-09-15 to present: Available daily by 24:00 UTC.
- daily_business_canceled_product_subscribers
From 2017-09-15 to present: Available daily by 24:00 UTC.
- monthly_revenue_billing_and_revenue_data
From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes metered transactions (e.g. hourly) from one month prior.
- monthly_revenue_annual_subscriptions
From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes up-front software charges (e.g. annual) from one month prior.
- monthly_revenue_field_demonstration_usage
From 2018-03-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.
- monthly_revenue_flexible_payment_schedule
From 2018-11-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.
- disbursed_amount_by_product
From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
- disbursed_amount_by_instance_hours
From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
- disbursed_amount_by_customer_geo
From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
- disbursed_amount_by_age_of_uncollected_funds
From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
- disbursed_amount_by_age_of_disbursed_funds
From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
- disbursed_amount_by_age_of_past_due_funds
From 2018-04-07 to present: Available every 30 days by 24:00 UTC.
- disbursed_amount_by_uncollected_funds_breakdown
From 2019-10-04 to present: Available every 30 days by 24:00 UTC.
- sales_compensation_billed_revenue
From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes metered transactions (e.g. hourly) from one month prior, and up-front software charges (e.g. annual) from one month prior.
- us_sales_and_use_tax_records
From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.
- disbursed_amount_by_product_with_uncollected_funds
This data set is deprecated. Download related reports from AMMP instead!
- customer_profile_by_industry
This data set is deprecated. Download related reports from AMMP instead!
- customer_profile_by_revenue
This data set is deprecated. Download related reports from AMMP instead!
- customer_profile_by_geography
This data set is deprecated. Download related reports from AMMP instead!
- customer_subscriber_hourly_monthly_subscriptions
data_set_publication_date(DateTime)
/set_data_set_publication_date(Option<DateTime>)
:
required: true
The date a data set was published. For daily data sets, provide a date with day-level granularity for the desired day. For monthly data sets except those with prefix disbursed_amount, provide a date with month-level granularity for the desired month (the day value will be ignored). For data sets with prefix disbursed_amount, provide a date with day-level granularity for the desired day. For these data sets we will look backwards in time over the range of 31 days until the first data set is found (the latest one).role_name_arn(impl Into<String>)
/set_role_name_arn(Option<String>)
:
required: true
The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services.destination_s3_bucket_name(impl Into<String>)
/set_destination_s3_bucket_name(Option<String>)
:
required: true
The name (friendly name, not ARN) of the destination S3 bucket.destination_s3_prefix(impl Into<String>)
/set_destination_s3_prefix(Option<String>)
:
required: false
(Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems. For example, if given the bucket name “mybucket” and the prefix “myprefix/mydatasets”, the output file “outputfile” would be published to “s3://mybucket/myprefix/mydatasets/outputfile”. If the prefix directory structure does not exist, it will be created. If no prefix is provided, the data set will be published to the S3 bucket root.sns_topic_arn(impl Into<String>)
/set_sns_topic_arn(Option<String>)
:
required: true
Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data set has been published or if an error has occurred.customer_defined_values(impl Into<String>, impl Into<String>)
/set_customer_defined_values(Option<HashMap::<String, String>>)
:
required: false
(Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file. These key-value pairs can be used to correlated responses with tracking information from other systems.
- On success, responds with
GenerateDataSetOutput
with field(s):data_set_request_id(Option<String>)
: A unique identifier representing a specific request to the GenerateDataSet operation. This identifier can be used to correlate a request with notifications from the SNS topic.
- On failure, responds with
SdkError<GenerateDataSetError>
Source§impl Client
impl Client
Sourcepub fn start_support_data_export(&self) -> StartSupportDataExportFluentBuilder
👎Deprecated: This target has been deprecated. As of December 2022 Product Support Connection is no longer supported.
pub fn start_support_data_export(&self) -> StartSupportDataExportFluentBuilder
Constructs a fluent builder for the StartSupportDataExport
operation.
- The fluent builder is configurable:
data_set_type(SupportDataSetType)
/set_data_set_type(Option<SupportDataSetType>)
:
required: trueThis target has been deprecated. Specifies the data set type to be written to the output csv file. The data set types customer_support_contacts_data and test_customer_support_contacts_data both result in a csv file containing the following fields: Product Id, Product Code, Customer Guid, Subscription Guid, Subscription Start Date, Organization, AWS Account Id, Given Name, Surname, Telephone Number, Email, Title, Country Code, ZIP Code, Operation Type, and Operation Time.
- customer_support_contacts_data Customer support contact data. The data set will contain all changes (Creates, Updates, and Deletes) to customer support contact data from the date specified in the from_date parameter.
- test_customer_support_contacts_data An example data set containing static test data in the same format as customer_support_contacts_data
from_date(DateTime)
/set_from_date(Option<DateTime>)
:
required: true
This target has been deprecated. The start date from which to retrieve the data set in UTC. This parameter only affects the customer_support_contacts_data data set type.role_name_arn(impl Into<String>)
/set_role_name_arn(Option<String>)
:
required: true
This target has been deprecated. The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services.destination_s3_bucket_name(impl Into<String>)
/set_destination_s3_bucket_name(Option<String>)
:
required: true
This target has been deprecated. The name (friendly name, not ARN) of the destination S3 bucket.destination_s3_prefix(impl Into<String>)
/set_destination_s3_prefix(Option<String>)
:
required: false
This target has been deprecated. (Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems. For example, if given the bucket name “mybucket” and the prefix “myprefix/mydatasets”, the output file “outputfile” would be published to “s3://mybucket/myprefix/mydatasets/outputfile”. If the prefix directory structure does not exist, it will be created. If no prefix is provided, the data set will be published to the S3 bucket root.sns_topic_arn(impl Into<String>)
/set_sns_topic_arn(Option<String>)
:
required: true
This target has been deprecated. Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data set has been published or if an error has occurred.customer_defined_values(impl Into<String>, impl Into<String>)
/set_customer_defined_values(Option<HashMap::<String, String>>)
:
required: false
This target has been deprecated. (Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file.
- On success, responds with
StartSupportDataExportOutput
with field(s):data_set_request_id(Option<String>)
: This target has been deprecated. A unique identifier representing a specific request to the StartSupportDataExport operation. This identifier can be used to correlate a request with notifications from the SNS topic.
- On failure, responds with
SdkError<StartSupportDataExportError>
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);