forked from aws/aws-sdk-go
-
Notifications
You must be signed in to change notification settings - Fork 1
/
api.go
180 lines (157 loc) · 8.9 KB
/
api.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
// THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT.
// Package marketplacecommerceanalytics provides a client for AWS Marketplace Commerce Analytics.
package marketplacecommerceanalytics
import (
"time"
"github.com/aws/aws-sdk-go/aws/awsutil"
"github.com/aws/aws-sdk-go/aws/request"
)
const opGenerateDataSet = "GenerateDataSet"
// GenerateDataSetRequest generates a request for the GenerateDataSet operation.
func (c *MarketplaceCommerceAnalytics) GenerateDataSetRequest(input *GenerateDataSetInput) (req *request.Request, output *GenerateDataSetOutput) {
op := &request.Operation{
Name: opGenerateDataSet,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &GenerateDataSetInput{}
}
req = c.newRequest(op, input, output)
output = &GenerateDataSetOutput{}
req.Data = output
return
}
// 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.
func (c *MarketplaceCommerceAnalytics) GenerateDataSet(input *GenerateDataSetInput) (*GenerateDataSetOutput, error) {
req, out := c.GenerateDataSetRequest(input)
err := req.Send()
return out, err
}
// Container for the parameters to the GenerateDataSet operation.
type GenerateDataSetInput struct {
_ struct{} `type:"structure"`
// (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.
CustomerDefinedValues map[string]*string `locationName:"customerDefinedValues" min:"1" type:"map"`
// The date a data set was published. For daily data sets, provide a date with
// day-level granularity for the desired day. For weekly data sets, provide
// a date with day-level granularity within the desired week (the day value
// will be ignored). For monthly data sets, provide a date with month-level
// granularity for the desired month (the day value will be ignored).
DataSetPublicationDate *time.Time `locationName:"dataSetPublicationDate" type:"timestamp" timestampFormat:"unix" required:"true"`
// The desired data set type.
//
// customer_subscriber_hourly_monthly_subscriptions - Available daily by
// 5:00 PM Pacific Time since 2014-07-21. customer_subscriber_annual_subscriptions
// - Available daily by 5:00 PM Pacific Time since 2014-07-21. daily_business_usage_by_instance_type
// - Available daily by 5:00 PM Pacific Time since 2015-01-26. daily_business_fees
// - Available daily by 5:00 PM Pacific Time since 2015-01-26. daily_business_free_trial_conversions
// - Available daily by 5:00 PM Pacific Time since 2015-01-26. daily_business_new_instances
// - Available daily by 5:00 PM Pacific Time since 2015-01-26. daily_business_new_product_subscribers
// - Available daily by 5:00 PM Pacific Time since 2015-01-26. daily_business_canceled_product_subscribers
// - Available daily by 5:00 PM Pacific Time since 2015-01-26. monthly_revenue_billing_and_revenue_data
// - Available monthly on the 4th day of the month by 5:00 PM Pacific Time since
// 2015-02. monthly_revenue_annual_subscriptions - Available monthly on the
// 4th day of the month by 5:00 PM Pacific Time since 2015-02. disbursed_amount_by_product
// - Available every 30 days by 5:00 PM Pacific Time since 2015-01-26. disbursed_amount_by_product_with_uncollected_funds
// -This data set is only available from 2012-04-19 until 2015-01-25. After
// 2015-01-25, this data set was split into three data sets: disbursed_amount_by_product,
// disbursed_amount_by_age_of_uncollected_funds, and disbursed_amount_by_age_of_disbursed_funds.
// disbursed_amount_by_customer_geo - Available every 30 days by 5:00 PM Pacific
// Time since 2012-04-19. disbursed_amount_by_age_of_uncollected_funds - Available
// every 30 days by 5:00 PM Pacific Time since 2015-01-26. disbursed_amount_by_age_of_disbursed_funds
// - Available every 30 days by 5:00 PM Pacific Time since 2015-01-26. customer_profile_by_industry
// - Available daily by 5:00 PM Pacific Time since 2015-10-01. customer_profile_by_revenue
// - Available daily by 5:00 PM Pacific Time since 2015-10-01. customer_profile_by_geography
// - Available daily by 5:00 PM Pacific Time since 2015-10-01.
DataSetType *string `locationName:"dataSetType" min:"1" type:"string" required:"true" enum:"DataSetType"`
// The name (friendly name, not ARN) of the destination S3 bucket.
DestinationS3BucketName *string `locationName:"destinationS3BucketName" min:"1" type:"string" required:"true"`
// (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.
DestinationS3Prefix *string `locationName:"destinationS3Prefix" type:"string"`
// The Amazon Resource Name (ARN) of the Role with an attached permissions policy
// to interact with the provided AWS services.
RoleNameArn *string `locationName:"roleNameArn" min:"1" type:"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.
SnsTopicArn *string `locationName:"snsTopicArn" min:"1" type:"string" required:"true"`
}
// String returns the string representation
func (s GenerateDataSetInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s GenerateDataSetInput) GoString() string {
return s.String()
}
// Container for the result of the GenerateDataSet operation.
type GenerateDataSetOutput struct {
_ struct{} `type:"structure"`
// 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.
DataSetRequestId *string `locationName:"dataSetRequestId" type:"string"`
}
// String returns the string representation
func (s GenerateDataSetOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s GenerateDataSetOutput) GoString() string {
return s.String()
}
const (
// @enum DataSetType
DataSetTypeCustomerSubscriberHourlyMonthlySubscriptions = "customer_subscriber_hourly_monthly_subscriptions"
// @enum DataSetType
DataSetTypeCustomerSubscriberAnnualSubscriptions = "customer_subscriber_annual_subscriptions"
// @enum DataSetType
DataSetTypeDailyBusinessUsageByInstanceType = "daily_business_usage_by_instance_type"
// @enum DataSetType
DataSetTypeDailyBusinessFees = "daily_business_fees"
// @enum DataSetType
DataSetTypeDailyBusinessFreeTrialConversions = "daily_business_free_trial_conversions"
// @enum DataSetType
DataSetTypeDailyBusinessNewInstances = "daily_business_new_instances"
// @enum DataSetType
DataSetTypeDailyBusinessNewProductSubscribers = "daily_business_new_product_subscribers"
// @enum DataSetType
DataSetTypeDailyBusinessCanceledProductSubscribers = "daily_business_canceled_product_subscribers"
// @enum DataSetType
DataSetTypeMonthlyRevenueBillingAndRevenueData = "monthly_revenue_billing_and_revenue_data"
// @enum DataSetType
DataSetTypeMonthlyRevenueAnnualSubscriptions = "monthly_revenue_annual_subscriptions"
// @enum DataSetType
DataSetTypeDisbursedAmountByProduct = "disbursed_amount_by_product"
// @enum DataSetType
DataSetTypeDisbursedAmountByProductWithUncollectedFunds = "disbursed_amount_by_product_with_uncollected_funds"
// @enum DataSetType
DataSetTypeDisbursedAmountByCustomerGeo = "disbursed_amount_by_customer_geo"
// @enum DataSetType
DataSetTypeDisbursedAmountByAgeOfUncollectedFunds = "disbursed_amount_by_age_of_uncollected_funds"
// @enum DataSetType
DataSetTypeDisbursedAmountByAgeOfDisbursedFunds = "disbursed_amount_by_age_of_disbursed_funds"
// @enum DataSetType
DataSetTypeCustomerProfileByIndustry = "customer_profile_by_industry"
// @enum DataSetType
DataSetTypeCustomerProfileByRevenue = "customer_profile_by_revenue"
// @enum DataSetType
DataSetTypeCustomerProfileByGeography = "customer_profile_by_geography"
)