class Aws::MarketplaceCommerceAnalytics::Client
An API client for MarketplaceCommerceAnalytics
. To construct a client, you need to configure a `:region` and `:credentials`.
client = Aws::MarketplaceCommerceAnalytics::Client.new( region: region_name, credentials: credentials, # ... )
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See {#initialize} for a full list of supported configuration options.
Attributes
@api private
Public Class Methods
@api private
# File lib/aws-sdk-marketplacecommerceanalytics/client.rb, line 632 def errors_module Errors end
@overload initialize(options)
@param [Hash] options @option options [required, Aws::CredentialProvider] :credentials Your AWS credentials. This can be an instance of any one of the following classes: * `Aws::Credentials` - Used for configuring static, non-refreshing credentials. * `Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`. * `Aws::AssumeRoleCredentials` - Used when you need to assume a role. * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web. * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`. * `Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout. * `Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance. * `Aws::ECSCredentials` - Used for loading credentials from instances running in ECS. * `Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service. When `:credentials` are not configured directly, the following locations will be searched for credentials: * `Aws.config[:credentials]` * The `:access_key_id`, `:secret_access_key`, and `:session_token` options. * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'] * `~/.aws/credentials` * `~/.aws/config` * EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to enable retries and extended timeouts. @option options [required, String] :region The AWS region to connect to. The configured `:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations: * `Aws.config[:region]` * `ENV['AWS_REGION']` * `ENV['AMAZON_REGION']` * `ENV['AWS_DEFAULT_REGION']` * `~/.aws/credentials` * `~/.aws/config` @option options [String] :access_key_id @option options [Boolean] :active_endpoint_cache (false) When set to `true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`. @option options [Boolean] :adaptive_retry_wait_to_fill (true) Used only in `adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping. @option options [Boolean] :client_side_monitoring (false) When `true`, client-side metrics will be collected for all API requests from this client. @option options [String] :client_side_monitoring_client_id ("") Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string. @option options [String] :client_side_monitoring_host ("127.0.0.1") Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP. @option options [Integer] :client_side_monitoring_port (31000) Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP. @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher. @option options [Boolean] :convert_params (true) When `true`, an attempt is made to coerce request parameters into the required types. @option options [Boolean] :correct_clock_skew (true) Used only in `standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks. @option options [Boolean] :disable_host_prefix_injection (false) Set to true to disable SDK automatically adding host prefix to default service endpoint when available. @option options [String] :endpoint The client endpoint is normally constructed from the `:region` option. You should only configure an `:endpoint` when connecting to test or custom endpoints. This should be a valid HTTP(S) URI. @option options [Integer] :endpoint_cache_max_entries (1000) Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. @option options [Integer] :endpoint_cache_max_threads (10) Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. @option options [Integer] :endpoint_cache_poll_interval (60) When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. @option options [Boolean] :endpoint_discovery (false) When set to `true`, endpoint discovery will be enabled for operations when available. @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default) The log formatter. @option options [Symbol] :log_level (:info) The log level to send messages to the `:logger` at. @option options [Logger] :logger The Logger instance to send log messages to. If this option is not set, logging will be disabled. @option options [Integer] :max_attempts (3) An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in `standard` and `adaptive` retry modes. @option options [String] :profile ("default") Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. @option options [Proc] :retry_backoff A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the `legacy` retry mode. @option options [Float] :retry_base_delay (0.3) The base delay in seconds used by the default backoff function. This option is only used in the `legacy` retry mode. @option options [Symbol] :retry_jitter (:none) A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the `legacy` retry mode. @see https://www.awsarchitectureblog.com/2015/03/backoff.html @option options [Integer] :retry_limit (3) The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the `legacy` retry mode. @option options [Integer] :retry_max_delay (0) The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the `legacy` retry mode. @option options [String] :retry_mode ("legacy") Specifies which retry algorithm to use. Values are: * `legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided. * `standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make. * `adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future. @option options [String] :secret_access_key @option options [String] :session_token @option options [Boolean] :simple_json (false) Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures. When `:simple_json` is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects. @option options [Boolean] :stub_responses (false) Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling {ClientStubs#stub_responses}. See {ClientStubs} for more information. ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled. @option options [Boolean] :validate_params (true) When `true`, request parameters are validated before sending the request. @option options [URI::HTTP,String] :http_proxy A proxy to send requests through. Formatted like 'http://proxy.com:123'. @option options [Float] :http_open_timeout (15) The number of seconds to wait when opening a HTTP session before raising a `Timeout::Error`. @option options [Integer] :http_read_timeout (60) The default number of seconds to wait for response data. This value can safely be set per-request on the session. @option options [Float] :http_idle_timeout (5) The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request. @option options [Float] :http_continue_timeout (1) The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to `nil` which disables this behaviour. This value can safely be set per request on the session. @option options [Boolean] :http_wire_trace (false) When `true`, HTTP debug output will be sent to the `:logger`. @option options [Boolean] :ssl_verify_peer (true) When `true`, SSL peer certificates are verified when establishing a connection. @option options [String] :ssl_ca_bundle Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available. @option options [String] :ssl_ca_directory Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.
# File lib/aws-sdk-marketplacecommerceanalytics/client.rb, line 334 def initialize(*args) super end
Public Instance Methods
@param params ({}) @api private
# File lib/aws-sdk-marketplacecommerceanalytics/client.rb, line 607 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-marketplacecommerceanalytics' context[:gem_version] = '1.35.0' Seahorse::Client::Request.new(handlers, context) end
Given a data set type and data set publication date, asynchronously publishes the requested data set to the specified S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request identifier that can be used to correlate requests with notifications from the SNS topic. Data sets will be published in comma-separated values (CSV) format with the file name \{data_set_type\}_YYYY-MM-DD.csv. If a file with the same name already exists (e.g. if the same data set is requested twice), the original file will be overwritten by the new file. Requires a Role with an attached permissions policy providing Allow permissions for the following actions: s3:PutObject, s3:GetBucketLocation, sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy.
@option params [required, String] :data_set_type
The 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!
@option params [required, Time,DateTime,Date,Integer,String] :data_set_publication_date
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).
@option params [required, String] :role_name_arn
The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services.
@option params [required, String] :destination_s3_bucket_name
The name (friendly name, not ARN) of the destination S3 bucket.
@option params [String] :destination_s3_prefix
(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.
@option params [required, String] :sns_topic_arn
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.
@option params [Hash<String,String>] :customer_defined_values
(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.
@return [Types::GenerateDataSetResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::GenerateDataSetResult#data_set_request_id #data_set_request_id} => String
@example Request syntax with placeholder values
resp = client.generate_data_set({ data_set_type: "customer_subscriber_hourly_monthly_subscriptions", # required, accepts customer_subscriber_hourly_monthly_subscriptions, customer_subscriber_annual_subscriptions, daily_business_usage_by_instance_type, daily_business_fees, daily_business_free_trial_conversions, daily_business_new_instances, daily_business_new_product_subscribers, daily_business_canceled_product_subscribers, monthly_revenue_billing_and_revenue_data, monthly_revenue_annual_subscriptions, monthly_revenue_field_demonstration_usage, monthly_revenue_flexible_payment_schedule, disbursed_amount_by_product, disbursed_amount_by_product_with_uncollected_funds, disbursed_amount_by_instance_hours, disbursed_amount_by_customer_geo, disbursed_amount_by_age_of_uncollected_funds, disbursed_amount_by_age_of_disbursed_funds, disbursed_amount_by_age_of_past_due_funds, disbursed_amount_by_uncollected_funds_breakdown, customer_profile_by_industry, customer_profile_by_revenue, customer_profile_by_geography, sales_compensation_billed_revenue, us_sales_and_use_tax_records data_set_publication_date: Time.now, # required role_name_arn: "RoleNameArn", # required destination_s3_bucket_name: "DestinationS3BucketName", # required destination_s3_prefix: "DestinationS3Prefix", sns_topic_arn: "SnsTopicArn", # required customer_defined_values: { "OptionalKey" => "OptionalValue", }, })
@example Response structure
resp.data_set_request_id #=> String
@see docs.aws.amazon.com/goto/WebAPI/marketplacecommerceanalytics-2015-07-01/GenerateDataSet AWS API Documentation
@overload generate_data_set
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-marketplacecommerceanalytics/client.rb, line 507 def generate_data_set(params = {}, options = {}) req = build_request(:generate_data_set, params) req.send_request(options) end
Given a data set type and a from date, asynchronously publishes the requested customer support data to the specified S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request identifier that can be used to correlate requests with notifications from the SNS topic. Data sets will be published in comma-separated values (CSV) format with the file name \{data_set_type\}_YYYY-MM-DD'T'HH-mm-ss'Z'.csv. If a file with the same name already exists (e.g. if the same data set is requested twice), the original file will be overwritten by the new file. Requires a Role with an attached permissions policy providing Allow permissions for the following actions: s3:PutObject, s3:GetBucketLocation, sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy.
@option params [required, String] :data_set_type
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
@option params [required, Time,DateTime,Date,Integer,String] :from_date
The start date from which to retrieve the data set in UTC. This parameter only affects the customer\_support\_contacts\_data data set type.
@option params [required, String] :role_name_arn
The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services.
@option params [required, String] :destination_s3_bucket_name
The name (friendly name, not ARN) of the destination S3 bucket.
@option params [String] :destination_s3_prefix
(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.
@option params [required, String] :sns_topic_arn
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.
@option params [Hash<String,String>] :customer_defined_values
(Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file.
@return [Types::StartSupportDataExportResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::StartSupportDataExportResult#data_set_request_id #data_set_request_id} => String
@example Request syntax with placeholder values
resp = client.start_support_data_export({ data_set_type: "customer_support_contacts_data", # required, accepts customer_support_contacts_data, test_customer_support_contacts_data from_date: Time.now, # required role_name_arn: "RoleNameArn", # required destination_s3_bucket_name: "DestinationS3BucketName", # required destination_s3_prefix: "DestinationS3Prefix", sns_topic_arn: "SnsTopicArn", # required customer_defined_values: { "OptionalKey" => "OptionalValue", }, })
@example Response structure
resp.data_set_request_id #=> String
@see docs.aws.amazon.com/goto/WebAPI/marketplacecommerceanalytics-2015-07-01/StartSupportDataExport AWS API Documentation
@overload start_support_data_export
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-marketplacecommerceanalytics/client.rb, line 598 def start_support_data_export(params = {}, options = {}) req = build_request(:start_support_data_export, params) req.send_request(options) end
@api private @deprecated
# File lib/aws-sdk-marketplacecommerceanalytics/client.rb, line 622 def waiter_names [] end