aws-sdk-marketplacecommerceanalytics 1.0.0.rc1 → 1.0.0.rc2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-marketplacecommerceanalytics.rb +1 -1
- data/lib/aws-sdk-marketplacecommerceanalytics/client.rb +362 -323
- data/lib/aws-sdk-marketplacecommerceanalytics/client_api.rb +74 -76
- data/lib/aws-sdk-marketplacecommerceanalytics/errors.rb +4 -13
- data/lib/aws-sdk-marketplacecommerceanalytics/resource.rb +12 -14
- data/lib/aws-sdk-marketplacecommerceanalytics/types.rb +224 -213
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 69e7d8c7fe83d060711aee485f0cf2daf7cc27d1
|
|
4
|
+
data.tar.gz: d9c879c7e83084d343cd2154c690cfc4e23c028e
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 7c05800992cae08b170d655b0d729856340dea95b3b9c14faeb281880742f6e9c85af03276020e3393120c895db986817bac5ff6cafacc2460e5938ce677bfa7
|
|
7
|
+
data.tar.gz: 76348f9dfb2c6cd6643235740e1be82acdd8746c4c40538ba3b2d278c1470ebb682609ca82a079c58bc1177e7c0c55b5085b773d03b253f34704cb818ea21573
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# WARNING ABOUT GENERATED CODE
|
|
2
2
|
#
|
|
3
|
-
# This file is generated. See the contributing for
|
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
|
4
4
|
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
|
5
5
|
#
|
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# WARNING ABOUT GENERATED CODE
|
|
2
2
|
#
|
|
3
|
-
# This file is generated. See the contributing for
|
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
|
4
4
|
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
|
5
5
|
#
|
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
|
@@ -23,343 +23,382 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
|
|
23
23
|
|
|
24
24
|
Aws::Plugins::GlobalConfiguration.add_identifier(:marketplacecommerceanalytics)
|
|
25
25
|
|
|
26
|
-
module Aws
|
|
27
|
-
|
|
28
|
-
class Client < Seahorse::Client::Base
|
|
26
|
+
module Aws::MarketplaceCommerceAnalytics
|
|
27
|
+
class Client < Seahorse::Client::Base
|
|
29
28
|
|
|
30
|
-
|
|
29
|
+
include Aws::ClientStubs
|
|
31
30
|
|
|
32
|
-
|
|
31
|
+
@identifier = :marketplacecommerceanalytics
|
|
33
32
|
|
|
34
|
-
|
|
33
|
+
set_api(ClientApi::API)
|
|
35
34
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
35
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
|
36
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
|
37
|
+
add_plugin(Aws::Plugins::Logging)
|
|
38
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
|
39
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
|
40
|
+
add_plugin(Aws::Plugins::UserAgent)
|
|
41
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
|
42
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
|
43
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
|
44
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
|
45
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
|
46
|
+
add_plugin(Aws::Plugins::StubResponses)
|
|
47
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
|
48
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
|
49
|
+
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
|
51
50
|
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
51
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
|
52
|
+
# Your AWS credentials. This can be an instance of any one of the
|
|
53
|
+
# following classes:
|
|
54
|
+
#
|
|
55
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
|
56
|
+
# credentials.
|
|
57
|
+
#
|
|
58
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
|
59
|
+
# from an EC2 IMDS on an EC2 instance.
|
|
60
|
+
#
|
|
61
|
+
# * `Aws::SharedCredentials` - Used for loading credentials from a
|
|
62
|
+
# shared file, such as `~/.aws/config`.
|
|
63
|
+
#
|
|
64
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
|
65
|
+
#
|
|
66
|
+
# When `:credentials` are not configured directly, the following
|
|
67
|
+
# locations will be searched for credentials:
|
|
68
|
+
#
|
|
69
|
+
# * `Aws.config[:credentials]`
|
|
70
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
|
71
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
|
72
|
+
# * `~/.aws/credentials`
|
|
73
|
+
# * `~/.aws/config`
|
|
74
|
+
# * EC2 IMDS instance profile - When used by default, the timeouts are
|
|
75
|
+
# very aggressive. Construct and pass an instance of
|
|
76
|
+
# `Aws::InstanceProfileCredentails` to enable retries and extended
|
|
77
|
+
# timeouts.
|
|
78
|
+
#
|
|
79
|
+
# @option options [required, String] :region
|
|
80
|
+
# The AWS region to connect to. The configured `:region` is
|
|
81
|
+
# used to determine the service `:endpoint`. When not passed,
|
|
82
|
+
# a default `:region` is search for in the following locations:
|
|
83
|
+
#
|
|
84
|
+
# * `Aws.config[:region]`
|
|
85
|
+
# * `ENV['AWS_REGION']`
|
|
86
|
+
# * `ENV['AMAZON_REGION']`
|
|
87
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
|
88
|
+
# * `~/.aws/credentials`
|
|
89
|
+
# * `~/.aws/config`
|
|
90
|
+
#
|
|
91
|
+
# @option options [String] :access_key_id
|
|
92
|
+
#
|
|
93
|
+
# @option options [Boolean] :convert_params (true)
|
|
94
|
+
# When `true`, an attempt is made to coerce request parameters into
|
|
95
|
+
# the required types.
|
|
96
|
+
#
|
|
97
|
+
# @option options [String] :endpoint
|
|
98
|
+
# The client endpoint is normally constructed from the `:region`
|
|
99
|
+
# option. You should only configure an `:endpoint` when connecting
|
|
100
|
+
# to test endpoints. This should be avalid HTTP(S) URI.
|
|
101
|
+
#
|
|
102
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
|
103
|
+
# The log formatter.
|
|
104
|
+
#
|
|
105
|
+
# @option options [Symbol] :log_level (:info)
|
|
106
|
+
# The log level to send messages to the `:logger` at.
|
|
107
|
+
#
|
|
108
|
+
# @option options [Logger] :logger
|
|
109
|
+
# The Logger instance to send log messages to. If this option
|
|
110
|
+
# is not set, logging will be disabled.
|
|
111
|
+
#
|
|
112
|
+
# @option options [String] :profile ("default")
|
|
113
|
+
# Used when loading credentials from the shared credentials file
|
|
114
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
|
115
|
+
#
|
|
116
|
+
# @option options [Integer] :retry_limit (3)
|
|
117
|
+
# The maximum number of times to retry failed requests. Only
|
|
118
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
|
119
|
+
# are retried. Generally, these are throttling errors, data
|
|
120
|
+
# checksum errors, networking errors, timeout errors and auth
|
|
121
|
+
# errors from expired credentials.
|
|
122
|
+
#
|
|
123
|
+
# @option options [String] :secret_access_key
|
|
124
|
+
#
|
|
125
|
+
# @option options [String] :session_token
|
|
126
|
+
#
|
|
127
|
+
# @option options [Boolean] :simple_json (false)
|
|
128
|
+
# Disables request parameter conversion, validation, and formatting.
|
|
129
|
+
# Also disable response data type conversions. This option is useful
|
|
130
|
+
# when you want to ensure the highest level of performance by
|
|
131
|
+
# avoiding overhead of walking request parameters and response data
|
|
132
|
+
# structures.
|
|
133
|
+
#
|
|
134
|
+
# When `:simple_json` is enabled, the request parameters hash must
|
|
135
|
+
# be formatted exactly as the DynamoDB API expects.
|
|
136
|
+
#
|
|
137
|
+
# @option options [Boolean] :stub_responses (false)
|
|
138
|
+
# Causes the client to return stubbed responses. By default
|
|
139
|
+
# fake responses are generated and returned. You can specify
|
|
140
|
+
# the response data to return or errors to raise by calling
|
|
141
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
|
142
|
+
#
|
|
143
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
|
144
|
+
# requests are made, and retries are disabled.
|
|
145
|
+
#
|
|
146
|
+
# @option options [Boolean] :validate_params (true)
|
|
147
|
+
# When `true`, request parameters are validated before
|
|
148
|
+
# sending the request.
|
|
149
|
+
#
|
|
150
|
+
def initialize(*args)
|
|
151
|
+
super
|
|
152
|
+
end
|
|
141
153
|
|
|
142
|
-
|
|
143
|
-
# publishes the requested data set to the specified S3 bucket and
|
|
144
|
-
# notifies the specified SNS topic once the data is available. Returns a
|
|
145
|
-
# unique request identifier that can be used to correlate requests with
|
|
146
|
-
# notifications from the SNS topic. Data sets will be published in
|
|
147
|
-
# comma-separated values (CSV) format with the file name
|
|
148
|
-
# \\\{data\_set\_type\\}\_YYYY-MM-DD.csv. If a file with the same name
|
|
149
|
-
# already exists (e.g. if the same data set is requested twice), the
|
|
150
|
-
# original file will be overwritten by the new file. Requires a Role
|
|
151
|
-
# with an attached permissions policy providing Allow permissions for
|
|
152
|
-
# the following actions: s3:PutObject, s3:GetBucketLocation,
|
|
153
|
-
# sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy.
|
|
154
|
-
# @option params [required, String] :data_set_type
|
|
155
|
-
# The desired data set type.
|
|
156
|
-
#
|
|
157
|
-
# * *customer\_subscriber\_hourly\_monthly\_subscriptions* - Available
|
|
158
|
-
# daily by 5:00 PM Pacific Time since 2014-07-21.
|
|
159
|
-
# * *customer\_subscriber\_annual\_subscriptions* - Available daily by
|
|
160
|
-
# 5:00 PM Pacific Time since 2014-07-21.
|
|
161
|
-
# * *daily\_business\_usage\_by\_instance\_type* - Available daily by
|
|
162
|
-
# 5:00 PM Pacific Time since 2015-01-26.
|
|
163
|
-
# * *daily\_business\_fees* - Available daily by 5:00 PM Pacific Time
|
|
164
|
-
# since 2015-01-26.
|
|
165
|
-
# * *daily\_business\_free\_trial\_conversions* - Available daily by
|
|
166
|
-
# 5:00 PM Pacific Time since 2015-01-26.
|
|
167
|
-
# * *daily\_business\_new\_instances* - Available daily by 5:00 PM
|
|
168
|
-
# Pacific Time since 2015-01-26.
|
|
169
|
-
# * *daily\_business\_new\_product\_subscribers* - Available daily by
|
|
170
|
-
# 5:00 PM Pacific Time since 2015-01-26.
|
|
171
|
-
# * *daily\_business\_canceled\_product\_subscribers* - Available daily
|
|
172
|
-
# by 5:00 PM Pacific Time since 2015-01-26.
|
|
173
|
-
# * *monthly\_revenue\_billing\_and\_revenue\_data* - Available monthly
|
|
174
|
-
# on the 4th day of the month by 5:00 PM Pacific Time since 2015-02.
|
|
175
|
-
# * *monthly\_revenue\_annual\_subscriptions* - Available monthly on the
|
|
176
|
-
# 4th day of the month by 5:00 PM Pacific Time since 2015-02.
|
|
177
|
-
# * *disbursed\_amount\_by\_product* - Available every 30 days by 5:00
|
|
178
|
-
# PM Pacific Time since 2015-01-26.
|
|
179
|
-
# * *disbursed\_amount\_by\_product\_with\_uncollected\_funds* -This
|
|
180
|
-
# data set is only available from 2012-04-19 until 2015-01-25. After
|
|
181
|
-
# 2015-01-25, this data set was split into three data sets:
|
|
182
|
-
# disbursed\_amount\_by\_product,
|
|
183
|
-
# disbursed\_amount\_by\_age\_of\_uncollected\_funds, and
|
|
184
|
-
# disbursed\_amount\_by\_age\_of\_disbursed\_funds.
|
|
185
|
-
# * *disbursed\_amount\_by\_customer\_geo* - Available every 30 days by
|
|
186
|
-
# 5:00 PM Pacific Time since 2012-04-19.
|
|
187
|
-
# * *disbursed\_amount\_by\_age\_of\_uncollected\_funds* - Available
|
|
188
|
-
# every 30 days by 5:00 PM Pacific Time since 2015-01-26.
|
|
189
|
-
# * *disbursed\_amount\_by\_age\_of\_disbursed\_funds* - Available every
|
|
190
|
-
# 30 days by 5:00 PM Pacific Time since 2015-01-26.
|
|
191
|
-
# * *customer\_profile\_by\_industry* - Available daily by 5:00 PM
|
|
192
|
-
# Pacific Time since 2015-10-01.
|
|
193
|
-
# * *customer\_profile\_by\_revenue* - Available daily by 5:00 PM
|
|
194
|
-
# Pacific Time since 2015-10-01.
|
|
195
|
-
# * *customer\_profile\_by\_geography* - Available daily by 5:00 PM
|
|
196
|
-
# Pacific Time since 2015-10-01.
|
|
197
|
-
# @option params [required, Time,DateTime,Date,Integer,String] :data_set_publication_date
|
|
198
|
-
# The date a data set was published. For daily data sets, provide a date
|
|
199
|
-
# with day-level granularity for the desired day. For weekly data sets,
|
|
200
|
-
# provide a date with day-level granularity within the desired week (the
|
|
201
|
-
# day value will be ignored). For monthly data sets, provide a date with
|
|
202
|
-
# month-level granularity for the desired month (the day value will be
|
|
203
|
-
# ignored).
|
|
204
|
-
# @option params [required, String] :role_name_arn
|
|
205
|
-
# The Amazon Resource Name (ARN) of the Role with an attached
|
|
206
|
-
# permissions policy to interact with the provided AWS services.
|
|
207
|
-
# @option params [required, String] :destination_s3_bucket_name
|
|
208
|
-
# The name (friendly name, not ARN) of the destination S3 bucket.
|
|
209
|
-
# @option params [String] :destination_s3_prefix
|
|
210
|
-
# (Optional) The desired S3 prefix for the published data set, similar
|
|
211
|
-
# to a directory path in standard file systems. For example, if given
|
|
212
|
-
# the bucket name "mybucket" and the prefix "myprefix/mydatasets",
|
|
213
|
-
# the output file "outputfile" would be published to
|
|
214
|
-
# "s3://mybucket/myprefix/mydatasets/outputfile". If the prefix
|
|
215
|
-
# directory structure does not exist, it will be created. If no prefix
|
|
216
|
-
# is provided, the data set will be published to the S3 bucket root.
|
|
217
|
-
# @option params [required, String] :sns_topic_arn
|
|
218
|
-
# Amazon Resource Name (ARN) for the SNS Topic that will be notified
|
|
219
|
-
# when the data set has been published or if an error has occurred.
|
|
220
|
-
# @option params [Hash<String,String>] :customer_defined_values
|
|
221
|
-
# (Optional) Key-value pairs which will be returned, unmodified, in the
|
|
222
|
-
# Amazon SNS notification message and the data set metadata file. These
|
|
223
|
-
# key-value pairs can be used to correlated responses with tracking
|
|
224
|
-
# information from other systems.
|
|
225
|
-
# @return [Types::GenerateDataSetResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
226
|
-
#
|
|
227
|
-
# * {Types::GenerateDataSetResult#data_set_request_id #dataSetRequestId} => String
|
|
228
|
-
#
|
|
229
|
-
# @example Request syntax with placeholder values
|
|
230
|
-
# resp = client.generate_data_set({
|
|
231
|
-
# 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, disbursed_amount_by_product, disbursed_amount_by_product_with_uncollected_funds, disbursed_amount_by_customer_geo, disbursed_amount_by_age_of_uncollected_funds, disbursed_amount_by_age_of_disbursed_funds, customer_profile_by_industry, customer_profile_by_revenue, customer_profile_by_geography
|
|
232
|
-
# data_set_publication_date: Time.now, # required
|
|
233
|
-
# role_name_arn: "RoleNameArn", # required
|
|
234
|
-
# destination_s3_bucket_name: "DestinationS3BucketName", # required
|
|
235
|
-
# destination_s3_prefix: "DestinationS3Prefix",
|
|
236
|
-
# sns_topic_arn: "SnsTopicArn", # required
|
|
237
|
-
# customer_defined_values: {
|
|
238
|
-
# "OptionalKey" => "OptionalValue",
|
|
239
|
-
# },
|
|
240
|
-
# })
|
|
241
|
-
#
|
|
242
|
-
# @example Response structure
|
|
243
|
-
# resp.data_set_request_id #=> String
|
|
244
|
-
# @overload generate_data_set(params = {})
|
|
245
|
-
# @param [Hash] params ({})
|
|
246
|
-
def generate_data_set(params = {}, options = {})
|
|
247
|
-
req = build_request(:generate_data_set, params)
|
|
248
|
-
req.send_request(options)
|
|
249
|
-
end
|
|
154
|
+
# @!group API Operations
|
|
250
155
|
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
156
|
+
# Given a data set type and data set publication date, asynchronously
|
|
157
|
+
# publishes the requested data set to the specified S3 bucket and
|
|
158
|
+
# notifies the specified SNS topic once the data is available. Returns a
|
|
159
|
+
# unique request identifier that can be used to correlate requests with
|
|
160
|
+
# notifications from the SNS topic. Data sets will be published in
|
|
161
|
+
# comma-separated values (CSV) format with the file name
|
|
162
|
+
# \\\{data\_set\_type\\}\_YYYY-MM-DD.csv. If a file with the same name
|
|
163
|
+
# already exists (e.g. if the same data set is requested twice), the
|
|
164
|
+
# original file will be overwritten by the new file. Requires a Role
|
|
165
|
+
# with an attached permissions policy providing Allow permissions for
|
|
166
|
+
# the following actions: s3:PutObject, s3:GetBucketLocation,
|
|
167
|
+
# sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy.
|
|
168
|
+
#
|
|
169
|
+
# @option params [required, String] :data_set_type
|
|
170
|
+
# The desired data set type.
|
|
171
|
+
#
|
|
172
|
+
# * *customer\_subscriber\_hourly\_monthly\_subscriptions* - Available
|
|
173
|
+
# daily by 5:00 PM Pacific Time since 2014-07-21.
|
|
174
|
+
# * *customer\_subscriber\_annual\_subscriptions* - Available daily by
|
|
175
|
+
# 5:00 PM Pacific Time since 2014-07-21.
|
|
176
|
+
# * *daily\_business\_usage\_by\_instance\_type* - Available daily by
|
|
177
|
+
# 5:00 PM Pacific Time since 2015-01-26.
|
|
178
|
+
# * *daily\_business\_fees* - Available daily by 5:00 PM Pacific Time
|
|
179
|
+
# since 2015-01-26.
|
|
180
|
+
# * *daily\_business\_free\_trial\_conversions* - Available daily by
|
|
181
|
+
# 5:00 PM Pacific Time since 2015-01-26.
|
|
182
|
+
# * *daily\_business\_new\_instances* - Available daily by 5:00 PM
|
|
183
|
+
# Pacific Time since 2015-01-26.
|
|
184
|
+
# * *daily\_business\_new\_product\_subscribers* - Available daily by
|
|
185
|
+
# 5:00 PM Pacific Time since 2015-01-26.
|
|
186
|
+
# * *daily\_business\_canceled\_product\_subscribers* - Available daily
|
|
187
|
+
# by 5:00 PM Pacific Time since 2015-01-26.
|
|
188
|
+
# * *monthly\_revenue\_billing\_and\_revenue\_data* - Available monthly
|
|
189
|
+
# on the 4th day of the month by 5:00 PM Pacific Time since 2015-02.
|
|
190
|
+
# * *monthly\_revenue\_annual\_subscriptions* - Available monthly on the
|
|
191
|
+
# 4th day of the month by 5:00 PM Pacific Time since 2015-02.
|
|
192
|
+
# * *disbursed\_amount\_by\_product* - Available every 30 days by 5:00
|
|
193
|
+
# PM Pacific Time since 2015-01-26.
|
|
194
|
+
# * *disbursed\_amount\_by\_product\_with\_uncollected\_funds* -This
|
|
195
|
+
# data set is only available from 2012-04-19 until 2015-01-25. After
|
|
196
|
+
# 2015-01-25, this data set was split into three data sets:
|
|
197
|
+
# disbursed\_amount\_by\_product,
|
|
198
|
+
# disbursed\_amount\_by\_age\_of\_uncollected\_funds, and
|
|
199
|
+
# disbursed\_amount\_by\_age\_of\_disbursed\_funds.
|
|
200
|
+
# * *disbursed\_amount\_by\_instance\_hours* - Available every 30 days
|
|
201
|
+
# by 5:00 PM Pacific Time since 2012-09-04.
|
|
202
|
+
# * *disbursed\_amount\_by\_customer\_geo* - Available every 30 days by
|
|
203
|
+
# 5:00 PM Pacific Time since 2012-04-19.
|
|
204
|
+
# * *disbursed\_amount\_by\_age\_of\_uncollected\_funds* - Available
|
|
205
|
+
# every 30 days by 5:00 PM Pacific Time since 2015-01-26.
|
|
206
|
+
# * *disbursed\_amount\_by\_age\_of\_disbursed\_funds* - Available every
|
|
207
|
+
# 30 days by 5:00 PM Pacific Time since 2015-01-26.
|
|
208
|
+
# * *customer\_profile\_by\_industry* - Available daily by 5:00 PM
|
|
209
|
+
# Pacific Time since 2015-10-01.
|
|
210
|
+
# * *customer\_profile\_by\_revenue* - Available daily by 5:00 PM
|
|
211
|
+
# Pacific Time since 2015-10-01.
|
|
212
|
+
# * *customer\_profile\_by\_geography* - Available daily by 5:00 PM
|
|
213
|
+
# Pacific Time since 2015-10-01.
|
|
214
|
+
# * *sales\_compensation\_billed\_revenue* - Available monthly on the
|
|
215
|
+
# 4th day of the month by 5:00 PM Pacific Time since 2016-12.
|
|
216
|
+
#
|
|
217
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :data_set_publication_date
|
|
218
|
+
# The date a data set was published. For daily data sets, provide a date
|
|
219
|
+
# with day-level granularity for the desired day. For weekly data sets,
|
|
220
|
+
# provide a date with day-level granularity within the desired week (the
|
|
221
|
+
# day value will be ignored). For monthly data sets, provide a date with
|
|
222
|
+
# month-level granularity for the desired month (the day value will be
|
|
223
|
+
# ignored).
|
|
224
|
+
#
|
|
225
|
+
# @option params [required, String] :role_name_arn
|
|
226
|
+
# The Amazon Resource Name (ARN) of the Role with an attached
|
|
227
|
+
# permissions policy to interact with the provided AWS services.
|
|
228
|
+
#
|
|
229
|
+
# @option params [required, String] :destination_s3_bucket_name
|
|
230
|
+
# The name (friendly name, not ARN) of the destination S3 bucket.
|
|
231
|
+
#
|
|
232
|
+
# @option params [String] :destination_s3_prefix
|
|
233
|
+
# (Optional) The desired S3 prefix for the published data set, similar
|
|
234
|
+
# to a directory path in standard file systems. For example, if given
|
|
235
|
+
# the bucket name "mybucket" and the prefix "myprefix/mydatasets",
|
|
236
|
+
# the output file "outputfile" would be published to
|
|
237
|
+
# "s3://mybucket/myprefix/mydatasets/outputfile". If the prefix
|
|
238
|
+
# directory structure does not exist, it will be created. If no prefix
|
|
239
|
+
# is provided, the data set will be published to the S3 bucket root.
|
|
240
|
+
#
|
|
241
|
+
# @option params [required, String] :sns_topic_arn
|
|
242
|
+
# Amazon Resource Name (ARN) for the SNS Topic that will be notified
|
|
243
|
+
# when the data set has been published or if an error has occurred.
|
|
244
|
+
#
|
|
245
|
+
# @option params [Hash<String,String>] :customer_defined_values
|
|
246
|
+
# (Optional) Key-value pairs which will be returned, unmodified, in the
|
|
247
|
+
# Amazon SNS notification message and the data set metadata file. These
|
|
248
|
+
# key-value pairs can be used to correlated responses with tracking
|
|
249
|
+
# information from other systems.
|
|
250
|
+
#
|
|
251
|
+
# @return [Types::GenerateDataSetResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
252
|
+
#
|
|
253
|
+
# * {Types::GenerateDataSetResult#data_set_request_id #data_set_request_id} => String
|
|
254
|
+
#
|
|
255
|
+
# @example Request syntax with placeholder values
|
|
256
|
+
#
|
|
257
|
+
# resp = client.generate_data_set({
|
|
258
|
+
# 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, 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, customer_profile_by_industry, customer_profile_by_revenue, customer_profile_by_geography, sales_compensation_billed_revenue
|
|
259
|
+
# data_set_publication_date: Time.now, # required
|
|
260
|
+
# role_name_arn: "RoleNameArn", # required
|
|
261
|
+
# destination_s3_bucket_name: "DestinationS3BucketName", # required
|
|
262
|
+
# destination_s3_prefix: "DestinationS3Prefix",
|
|
263
|
+
# sns_topic_arn: "SnsTopicArn", # required
|
|
264
|
+
# customer_defined_values: {
|
|
265
|
+
# "OptionalKey" => "OptionalValue",
|
|
266
|
+
# },
|
|
267
|
+
# })
|
|
268
|
+
#
|
|
269
|
+
# @example Response structure
|
|
270
|
+
#
|
|
271
|
+
# resp.data_set_request_id #=> String
|
|
272
|
+
#
|
|
273
|
+
# @overload generate_data_set(params = {})
|
|
274
|
+
# @param [Hash] params ({})
|
|
275
|
+
def generate_data_set(params = {}, options = {})
|
|
276
|
+
req = build_request(:generate_data_set, params)
|
|
277
|
+
req.send_request(options)
|
|
278
|
+
end
|
|
328
279
|
|
|
329
|
-
|
|
280
|
+
# Given a data set type and a from date, asynchronously publishes the
|
|
281
|
+
# requested customer support data to the specified S3 bucket and
|
|
282
|
+
# notifies the specified SNS topic once the data is available. Returns a
|
|
283
|
+
# unique request identifier that can be used to correlate requests with
|
|
284
|
+
# notifications from the SNS topic. Data sets will be published in
|
|
285
|
+
# comma-separated values (CSV) format with the file name
|
|
286
|
+
# \\\{data\_set\_type\\}\_YYYY-MM-DD'T'HH-mm-ss'Z'.csv. If a file
|
|
287
|
+
# with the same name already exists (e.g. if the same data set is
|
|
288
|
+
# requested twice), the original file will be overwritten by the new
|
|
289
|
+
# file. Requires a Role with an attached permissions policy providing
|
|
290
|
+
# Allow permissions for the following actions: s3:PutObject,
|
|
291
|
+
# s3:GetBucketLocation, sns:GetTopicAttributes, sns:Publish,
|
|
292
|
+
# iam:GetRolePolicy.
|
|
293
|
+
#
|
|
294
|
+
# @option params [required, String] :data_set_type
|
|
295
|
+
# Specifies the data set type to be written to the output csv file. The
|
|
296
|
+
# data set types customer\_support\_contacts\_data and
|
|
297
|
+
# test\_customer\_support\_contacts\_data both result in a csv file
|
|
298
|
+
# containing the following fields: Product Id, Product Code, Customer
|
|
299
|
+
# Guid, Subscription Guid, Subscription Start Date, Organization, AWS
|
|
300
|
+
# Account Id, Given Name, Surname, Telephone Number, Email, Title,
|
|
301
|
+
# Country Code, ZIP Code, Operation Type, and Operation Time.
|
|
302
|
+
#
|
|
303
|
+
# * *customer\_support\_contacts\_data* Customer support contact data.
|
|
304
|
+
# The data set will contain all changes (Creates, Updates, and
|
|
305
|
+
# Deletes) to customer support contact data from the date specified in
|
|
306
|
+
# the from\_date parameter.
|
|
307
|
+
# * *test\_customer\_support\_contacts\_data* An example data set
|
|
308
|
+
# containing static test data in the same format as
|
|
309
|
+
# customer\_support\_contacts\_data
|
|
310
|
+
#
|
|
311
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :from_date
|
|
312
|
+
# The start date from which to retrieve the data set in UTC. This
|
|
313
|
+
# parameter only affects the customer\_support\_contacts\_data data set
|
|
314
|
+
# type.
|
|
315
|
+
#
|
|
316
|
+
# @option params [required, String] :role_name_arn
|
|
317
|
+
# The Amazon Resource Name (ARN) of the Role with an attached
|
|
318
|
+
# permissions policy to interact with the provided AWS services.
|
|
319
|
+
#
|
|
320
|
+
# @option params [required, String] :destination_s3_bucket_name
|
|
321
|
+
# The name (friendly name, not ARN) of the destination S3 bucket.
|
|
322
|
+
#
|
|
323
|
+
# @option params [String] :destination_s3_prefix
|
|
324
|
+
# (Optional) The desired S3 prefix for the published data set, similar
|
|
325
|
+
# to a directory path in standard file systems. For example, if given
|
|
326
|
+
# the bucket name "mybucket" and the prefix "myprefix/mydatasets",
|
|
327
|
+
# the output file "outputfile" would be published to
|
|
328
|
+
# "s3://mybucket/myprefix/mydatasets/outputfile". If the prefix
|
|
329
|
+
# directory structure does not exist, it will be created. If no prefix
|
|
330
|
+
# is provided, the data set will be published to the S3 bucket root.
|
|
331
|
+
#
|
|
332
|
+
# @option params [required, String] :sns_topic_arn
|
|
333
|
+
# Amazon Resource Name (ARN) for the SNS Topic that will be notified
|
|
334
|
+
# when the data set has been published or if an error has occurred.
|
|
335
|
+
#
|
|
336
|
+
# @option params [Hash<String,String>] :customer_defined_values
|
|
337
|
+
# (Optional) Key-value pairs which will be returned, unmodified, in the
|
|
338
|
+
# Amazon SNS notification message and the data set metadata file.
|
|
339
|
+
#
|
|
340
|
+
# @return [Types::StartSupportDataExportResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
341
|
+
#
|
|
342
|
+
# * {Types::StartSupportDataExportResult#data_set_request_id #data_set_request_id} => String
|
|
343
|
+
#
|
|
344
|
+
# @example Request syntax with placeholder values
|
|
345
|
+
#
|
|
346
|
+
# resp = client.start_support_data_export({
|
|
347
|
+
# data_set_type: "customer_support_contacts_data", # required, accepts customer_support_contacts_data, test_customer_support_contacts_data
|
|
348
|
+
# from_date: Time.now, # required
|
|
349
|
+
# role_name_arn: "RoleNameArn", # required
|
|
350
|
+
# destination_s3_bucket_name: "DestinationS3BucketName", # required
|
|
351
|
+
# destination_s3_prefix: "DestinationS3Prefix",
|
|
352
|
+
# sns_topic_arn: "SnsTopicArn", # required
|
|
353
|
+
# customer_defined_values: {
|
|
354
|
+
# "OptionalKey" => "OptionalValue",
|
|
355
|
+
# },
|
|
356
|
+
# })
|
|
357
|
+
#
|
|
358
|
+
# @example Response structure
|
|
359
|
+
#
|
|
360
|
+
# resp.data_set_request_id #=> String
|
|
361
|
+
#
|
|
362
|
+
# @overload start_support_data_export(params = {})
|
|
363
|
+
# @param [Hash] params ({})
|
|
364
|
+
def start_support_data_export(params = {}, options = {})
|
|
365
|
+
req = build_request(:start_support_data_export, params)
|
|
366
|
+
req.send_request(options)
|
|
367
|
+
end
|
|
330
368
|
|
|
331
|
-
|
|
332
|
-
# @api private
|
|
333
|
-
def build_request(operation_name, params = {})
|
|
334
|
-
handlers = @handlers.for(operation_name)
|
|
335
|
-
context = Seahorse::Client::RequestContext.new(
|
|
336
|
-
operation_name: operation_name,
|
|
337
|
-
operation: config.api.operation(operation_name),
|
|
338
|
-
client: self,
|
|
339
|
-
params: params,
|
|
340
|
-
config: config)
|
|
341
|
-
context[:gem_name] = 'aws-sdk-marketplacecommerceanalytics'
|
|
342
|
-
context[:gem_version] = '1.0.0.rc1'
|
|
343
|
-
Seahorse::Client::Request.new(handlers, context)
|
|
344
|
-
end
|
|
369
|
+
# @!endgroup
|
|
345
370
|
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
371
|
+
# @param params ({})
|
|
372
|
+
# @api private
|
|
373
|
+
def build_request(operation_name, params = {})
|
|
374
|
+
handlers = @handlers.for(operation_name)
|
|
375
|
+
context = Seahorse::Client::RequestContext.new(
|
|
376
|
+
operation_name: operation_name,
|
|
377
|
+
operation: config.api.operation(operation_name),
|
|
378
|
+
client: self,
|
|
379
|
+
params: params,
|
|
380
|
+
config: config)
|
|
381
|
+
context[:gem_name] = 'aws-sdk-marketplacecommerceanalytics'
|
|
382
|
+
context[:gem_version] = '1.0.0.rc1'
|
|
383
|
+
Seahorse::Client::Request.new(handlers, context)
|
|
384
|
+
end
|
|
351
385
|
|
|
352
|
-
|
|
386
|
+
# @api private
|
|
387
|
+
# @deprecated
|
|
388
|
+
def waiter_names
|
|
389
|
+
[]
|
|
390
|
+
end
|
|
353
391
|
|
|
354
|
-
|
|
355
|
-
attr_reader :identifier
|
|
392
|
+
class << self
|
|
356
393
|
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
Errors
|
|
360
|
-
end
|
|
394
|
+
# @api private
|
|
395
|
+
attr_reader :identifier
|
|
361
396
|
|
|
397
|
+
# @api private
|
|
398
|
+
def errors_module
|
|
399
|
+
Errors
|
|
362
400
|
end
|
|
401
|
+
|
|
363
402
|
end
|
|
364
403
|
end
|
|
365
404
|
end
|