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.
@@ -1,98 +1,96 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
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
7
7
 
8
- module Aws
9
- module MarketplaceCommerceAnalytics
10
- # @api private
11
- module ClientApi
12
-
13
- include Seahorse::Model
8
+ module Aws::MarketplaceCommerceAnalytics
9
+ # @api private
10
+ module ClientApi
14
11
 
15
- CustomerDefinedValues = Shapes::MapShape.new(name: 'CustomerDefinedValues')
16
- DataSetPublicationDate = Shapes::TimestampShape.new(name: 'DataSetPublicationDate')
17
- DataSetRequestId = Shapes::StringShape.new(name: 'DataSetRequestId')
18
- DataSetType = Shapes::StringShape.new(name: 'DataSetType')
19
- DestinationS3BucketName = Shapes::StringShape.new(name: 'DestinationS3BucketName')
20
- DestinationS3Prefix = Shapes::StringShape.new(name: 'DestinationS3Prefix')
21
- ExceptionMessage = Shapes::StringShape.new(name: 'ExceptionMessage')
22
- FromDate = Shapes::TimestampShape.new(name: 'FromDate')
23
- GenerateDataSetRequest = Shapes::StructureShape.new(name: 'GenerateDataSetRequest')
24
- GenerateDataSetResult = Shapes::StructureShape.new(name: 'GenerateDataSetResult')
25
- MarketplaceCommerceAnalyticsException = Shapes::StructureShape.new(name: 'MarketplaceCommerceAnalyticsException')
26
- OptionalKey = Shapes::StringShape.new(name: 'OptionalKey')
27
- OptionalValue = Shapes::StringShape.new(name: 'OptionalValue')
28
- RoleNameArn = Shapes::StringShape.new(name: 'RoleNameArn')
29
- SnsTopicArn = Shapes::StringShape.new(name: 'SnsTopicArn')
30
- StartSupportDataExportRequest = Shapes::StructureShape.new(name: 'StartSupportDataExportRequest')
31
- StartSupportDataExportResult = Shapes::StructureShape.new(name: 'StartSupportDataExportResult')
32
- SupportDataSetType = Shapes::StringShape.new(name: 'SupportDataSetType')
12
+ include Seahorse::Model
33
13
 
34
- CustomerDefinedValues.key = Shapes::ShapeRef.new(shape: OptionalKey)
35
- CustomerDefinedValues.value = Shapes::ShapeRef.new(shape: OptionalValue)
14
+ CustomerDefinedValues = Shapes::MapShape.new(name: 'CustomerDefinedValues')
15
+ DataSetPublicationDate = Shapes::TimestampShape.new(name: 'DataSetPublicationDate')
16
+ DataSetRequestId = Shapes::StringShape.new(name: 'DataSetRequestId')
17
+ DataSetType = Shapes::StringShape.new(name: 'DataSetType')
18
+ DestinationS3BucketName = Shapes::StringShape.new(name: 'DestinationS3BucketName')
19
+ DestinationS3Prefix = Shapes::StringShape.new(name: 'DestinationS3Prefix')
20
+ ExceptionMessage = Shapes::StringShape.new(name: 'ExceptionMessage')
21
+ FromDate = Shapes::TimestampShape.new(name: 'FromDate')
22
+ GenerateDataSetRequest = Shapes::StructureShape.new(name: 'GenerateDataSetRequest')
23
+ GenerateDataSetResult = Shapes::StructureShape.new(name: 'GenerateDataSetResult')
24
+ MarketplaceCommerceAnalyticsException = Shapes::StructureShape.new(name: 'MarketplaceCommerceAnalyticsException')
25
+ OptionalKey = Shapes::StringShape.new(name: 'OptionalKey')
26
+ OptionalValue = Shapes::StringShape.new(name: 'OptionalValue')
27
+ RoleNameArn = Shapes::StringShape.new(name: 'RoleNameArn')
28
+ SnsTopicArn = Shapes::StringShape.new(name: 'SnsTopicArn')
29
+ StartSupportDataExportRequest = Shapes::StructureShape.new(name: 'StartSupportDataExportRequest')
30
+ StartSupportDataExportResult = Shapes::StructureShape.new(name: 'StartSupportDataExportResult')
31
+ SupportDataSetType = Shapes::StringShape.new(name: 'SupportDataSetType')
36
32
 
37
- GenerateDataSetRequest.add_member(:data_set_type, Shapes::ShapeRef.new(shape: DataSetType, required: true, location_name: "dataSetType"))
38
- GenerateDataSetRequest.add_member(:data_set_publication_date, Shapes::ShapeRef.new(shape: DataSetPublicationDate, required: true, location_name: "dataSetPublicationDate"))
39
- GenerateDataSetRequest.add_member(:role_name_arn, Shapes::ShapeRef.new(shape: RoleNameArn, required: true, location_name: "roleNameArn"))
40
- GenerateDataSetRequest.add_member(:destination_s3_bucket_name, Shapes::ShapeRef.new(shape: DestinationS3BucketName, required: true, location_name: "destinationS3BucketName"))
41
- GenerateDataSetRequest.add_member(:destination_s3_prefix, Shapes::ShapeRef.new(shape: DestinationS3Prefix, location_name: "destinationS3Prefix"))
42
- GenerateDataSetRequest.add_member(:sns_topic_arn, Shapes::ShapeRef.new(shape: SnsTopicArn, required: true, location_name: "snsTopicArn"))
43
- GenerateDataSetRequest.add_member(:customer_defined_values, Shapes::ShapeRef.new(shape: CustomerDefinedValues, location_name: "customerDefinedValues"))
44
- GenerateDataSetRequest.struct_class = Types::GenerateDataSetRequest
33
+ CustomerDefinedValues.key = Shapes::ShapeRef.new(shape: OptionalKey)
34
+ CustomerDefinedValues.value = Shapes::ShapeRef.new(shape: OptionalValue)
45
35
 
46
- GenerateDataSetResult.add_member(:data_set_request_id, Shapes::ShapeRef.new(shape: DataSetRequestId, location_name: "dataSetRequestId"))
47
- GenerateDataSetResult.struct_class = Types::GenerateDataSetResult
36
+ GenerateDataSetRequest.add_member(:data_set_type, Shapes::ShapeRef.new(shape: DataSetType, required: true, location_name: "dataSetType"))
37
+ GenerateDataSetRequest.add_member(:data_set_publication_date, Shapes::ShapeRef.new(shape: DataSetPublicationDate, required: true, location_name: "dataSetPublicationDate"))
38
+ GenerateDataSetRequest.add_member(:role_name_arn, Shapes::ShapeRef.new(shape: RoleNameArn, required: true, location_name: "roleNameArn"))
39
+ GenerateDataSetRequest.add_member(:destination_s3_bucket_name, Shapes::ShapeRef.new(shape: DestinationS3BucketName, required: true, location_name: "destinationS3BucketName"))
40
+ GenerateDataSetRequest.add_member(:destination_s3_prefix, Shapes::ShapeRef.new(shape: DestinationS3Prefix, location_name: "destinationS3Prefix"))
41
+ GenerateDataSetRequest.add_member(:sns_topic_arn, Shapes::ShapeRef.new(shape: SnsTopicArn, required: true, location_name: "snsTopicArn"))
42
+ GenerateDataSetRequest.add_member(:customer_defined_values, Shapes::ShapeRef.new(shape: CustomerDefinedValues, location_name: "customerDefinedValues"))
43
+ GenerateDataSetRequest.struct_class = Types::GenerateDataSetRequest
48
44
 
49
- StartSupportDataExportRequest.add_member(:data_set_type, Shapes::ShapeRef.new(shape: SupportDataSetType, required: true, location_name: "dataSetType"))
50
- StartSupportDataExportRequest.add_member(:from_date, Shapes::ShapeRef.new(shape: FromDate, required: true, location_name: "fromDate"))
51
- StartSupportDataExportRequest.add_member(:role_name_arn, Shapes::ShapeRef.new(shape: RoleNameArn, required: true, location_name: "roleNameArn"))
52
- StartSupportDataExportRequest.add_member(:destination_s3_bucket_name, Shapes::ShapeRef.new(shape: DestinationS3BucketName, required: true, location_name: "destinationS3BucketName"))
53
- StartSupportDataExportRequest.add_member(:destination_s3_prefix, Shapes::ShapeRef.new(shape: DestinationS3Prefix, location_name: "destinationS3Prefix"))
54
- StartSupportDataExportRequest.add_member(:sns_topic_arn, Shapes::ShapeRef.new(shape: SnsTopicArn, required: true, location_name: "snsTopicArn"))
55
- StartSupportDataExportRequest.add_member(:customer_defined_values, Shapes::ShapeRef.new(shape: CustomerDefinedValues, location_name: "customerDefinedValues"))
56
- StartSupportDataExportRequest.struct_class = Types::StartSupportDataExportRequest
45
+ GenerateDataSetResult.add_member(:data_set_request_id, Shapes::ShapeRef.new(shape: DataSetRequestId, location_name: "dataSetRequestId"))
46
+ GenerateDataSetResult.struct_class = Types::GenerateDataSetResult
57
47
 
58
- StartSupportDataExportResult.add_member(:data_set_request_id, Shapes::ShapeRef.new(shape: DataSetRequestId, location_name: "dataSetRequestId"))
59
- StartSupportDataExportResult.struct_class = Types::StartSupportDataExportResult
48
+ StartSupportDataExportRequest.add_member(:data_set_type, Shapes::ShapeRef.new(shape: SupportDataSetType, required: true, location_name: "dataSetType"))
49
+ StartSupportDataExportRequest.add_member(:from_date, Shapes::ShapeRef.new(shape: FromDate, required: true, location_name: "fromDate"))
50
+ StartSupportDataExportRequest.add_member(:role_name_arn, Shapes::ShapeRef.new(shape: RoleNameArn, required: true, location_name: "roleNameArn"))
51
+ StartSupportDataExportRequest.add_member(:destination_s3_bucket_name, Shapes::ShapeRef.new(shape: DestinationS3BucketName, required: true, location_name: "destinationS3BucketName"))
52
+ StartSupportDataExportRequest.add_member(:destination_s3_prefix, Shapes::ShapeRef.new(shape: DestinationS3Prefix, location_name: "destinationS3Prefix"))
53
+ StartSupportDataExportRequest.add_member(:sns_topic_arn, Shapes::ShapeRef.new(shape: SnsTopicArn, required: true, location_name: "snsTopicArn"))
54
+ StartSupportDataExportRequest.add_member(:customer_defined_values, Shapes::ShapeRef.new(shape: CustomerDefinedValues, location_name: "customerDefinedValues"))
55
+ StartSupportDataExportRequest.struct_class = Types::StartSupportDataExportRequest
60
56
 
57
+ StartSupportDataExportResult.add_member(:data_set_request_id, Shapes::ShapeRef.new(shape: DataSetRequestId, location_name: "dataSetRequestId"))
58
+ StartSupportDataExportResult.struct_class = Types::StartSupportDataExportResult
61
59
 
62
- # @api private
63
- API = Seahorse::Model::Api.new.tap do |api|
64
60
 
65
- api.version = "2015-07-01"
61
+ # @api private
62
+ API = Seahorse::Model::Api.new.tap do |api|
66
63
 
67
- api.metadata = {
68
- "endpointPrefix" => "marketplacecommerceanalytics",
69
- "jsonVersion" => "1.1",
70
- "protocol" => "json",
71
- "serviceFullName" => "AWS Marketplace Commerce Analytics",
72
- "signatureVersion" => "v4",
73
- "signingName" => "marketplacecommerceanalytics",
74
- "targetPrefix" => "MarketplaceCommerceAnalytics20150701",
75
- }
64
+ api.version = "2015-07-01"
76
65
 
77
- api.add_operation(:generate_data_set, Seahorse::Model::Operation.new.tap do |o|
78
- o.name = "GenerateDataSet"
79
- o.http_method = "POST"
80
- o.http_request_uri = "/"
81
- o.input = Shapes::ShapeRef.new(shape: GenerateDataSetRequest)
82
- o.output = Shapes::ShapeRef.new(shape: GenerateDataSetResult)
83
- o.errors << Shapes::ShapeRef.new(shape: MarketplaceCommerceAnalyticsException)
84
- end)
66
+ api.metadata = {
67
+ "endpointPrefix" => "marketplacecommerceanalytics",
68
+ "jsonVersion" => "1.1",
69
+ "protocol" => "json",
70
+ "serviceFullName" => "AWS Marketplace Commerce Analytics",
71
+ "signatureVersion" => "v4",
72
+ "signingName" => "marketplacecommerceanalytics",
73
+ "targetPrefix" => "MarketplaceCommerceAnalytics20150701",
74
+ }
85
75
 
86
- api.add_operation(:start_support_data_export, Seahorse::Model::Operation.new.tap do |o|
87
- o.name = "StartSupportDataExport"
88
- o.http_method = "POST"
89
- o.http_request_uri = "/"
90
- o.input = Shapes::ShapeRef.new(shape: StartSupportDataExportRequest)
91
- o.output = Shapes::ShapeRef.new(shape: StartSupportDataExportResult)
92
- o.errors << Shapes::ShapeRef.new(shape: MarketplaceCommerceAnalyticsException)
93
- end)
94
- end
76
+ api.add_operation(:generate_data_set, Seahorse::Model::Operation.new.tap do |o|
77
+ o.name = "GenerateDataSet"
78
+ o.http_method = "POST"
79
+ o.http_request_uri = "/"
80
+ o.input = Shapes::ShapeRef.new(shape: GenerateDataSetRequest)
81
+ o.output = Shapes::ShapeRef.new(shape: GenerateDataSetResult)
82
+ o.errors << Shapes::ShapeRef.new(shape: MarketplaceCommerceAnalyticsException)
83
+ end)
95
84
 
85
+ api.add_operation(:start_support_data_export, Seahorse::Model::Operation.new.tap do |o|
86
+ o.name = "StartSupportDataExport"
87
+ o.http_method = "POST"
88
+ o.http_request_uri = "/"
89
+ o.input = Shapes::ShapeRef.new(shape: StartSupportDataExportRequest)
90
+ o.output = Shapes::ShapeRef.new(shape: StartSupportDataExportResult)
91
+ o.errors << Shapes::ShapeRef.new(shape: MarketplaceCommerceAnalyticsException)
92
+ end)
96
93
  end
94
+
97
95
  end
98
96
  end
@@ -1,23 +1,14 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
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
7
7
 
8
- module Aws
9
- module MarketplaceCommerceAnalytics
10
- module Errors
8
+ module Aws::MarketplaceCommerceAnalytics
9
+ module Errors
11
10
 
12
- extend Aws::Errors::DynamicErrors
11
+ extend Aws::Errors::DynamicErrors
13
12
 
14
- # Raised when calling #load or #data on a resource class that can not be
15
- # loaded. This can happen when:
16
- #
17
- # * A resource class has identifiers, but no data attributes.
18
- # * Resource data is only available when making an API call that
19
- # enumerates all resources of that type.
20
- class ResourceNotLoadable < RuntimeError; end
21
- end
22
13
  end
23
14
  end
@@ -1,25 +1,23 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
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
7
7
 
8
- module Aws
9
- module MarketplaceCommerceAnalytics
10
- class Resource
8
+ module Aws::MarketplaceCommerceAnalytics
9
+ class Resource
11
10
 
12
- # @param options ({})
13
- # @option options [Client] :client
14
- def initialize(options = {})
15
- @client = options[:client] || Client.new(options)
16
- end
17
-
18
- # @return [Client]
19
- def client
20
- @client
21
- end
11
+ # @param options ({})
12
+ # @option options [Client] :client
13
+ def initialize(options = {})
14
+ @client = options[:client] || Client.new(options)
15
+ end
22
16
 
17
+ # @return [Client]
18
+ def client
19
+ @client
23
20
  end
21
+
24
22
  end
25
23
  end
@@ -1,226 +1,237 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
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
7
7
 
8
- module Aws
9
- module MarketplaceCommerceAnalytics
10
- module Types
8
+ module Aws::MarketplaceCommerceAnalytics
9
+ module Types
11
10
 
12
- # Container for the parameters to the GenerateDataSet operation.
13
- # @note When making an API call, pass GenerateDataSetRequest
14
- # data as a hash:
15
- #
16
- # {
17
- # 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
18
- # data_set_publication_date: Time.now, # required
19
- # role_name_arn: "RoleNameArn", # required
20
- # destination_s3_bucket_name: "DestinationS3BucketName", # required
21
- # destination_s3_prefix: "DestinationS3Prefix",
22
- # sns_topic_arn: "SnsTopicArn", # required
23
- # customer_defined_values: {
24
- # "OptionalKey" => "OptionalValue",
25
- # },
26
- # }
27
- # @!attribute [rw] data_set_type
28
- # The desired data set type.
29
- #
30
- # * *customer\_subscriber\_hourly\_monthly\_subscriptions* - Available
31
- # daily by 5:00 PM Pacific Time since 2014-07-21.
32
- # * *customer\_subscriber\_annual\_subscriptions* - Available daily by
33
- # 5:00 PM Pacific Time since 2014-07-21.
34
- # * *daily\_business\_usage\_by\_instance\_type* - Available daily by
35
- # 5:00 PM Pacific Time since 2015-01-26.
36
- # * *daily\_business\_fees* - Available daily by 5:00 PM Pacific Time
37
- # since 2015-01-26.
38
- # * *daily\_business\_free\_trial\_conversions* - Available daily by
39
- # 5:00 PM Pacific Time since 2015-01-26.
40
- # * *daily\_business\_new\_instances* - Available daily by 5:00 PM
41
- # Pacific Time since 2015-01-26.
42
- # * *daily\_business\_new\_product\_subscribers* - Available daily by
43
- # 5:00 PM Pacific Time since 2015-01-26.
44
- # * *daily\_business\_canceled\_product\_subscribers* - Available
45
- # daily by 5:00 PM Pacific Time since 2015-01-26.
46
- # * *monthly\_revenue\_billing\_and\_revenue\_data* - Available
47
- # monthly on the 4th day of the month by 5:00 PM Pacific Time since
48
- # 2015-02.
49
- # * *monthly\_revenue\_annual\_subscriptions* - Available monthly on
50
- # the 4th day of the month by 5:00 PM Pacific Time since 2015-02.
51
- # * *disbursed\_amount\_by\_product* - Available every 30 days by 5:00
52
- # PM Pacific Time since 2015-01-26.
53
- # * *disbursed\_amount\_by\_product\_with\_uncollected\_funds* -This
54
- # data set is only available from 2012-04-19 until 2015-01-25. After
55
- # 2015-01-25, this data set was split into three data sets:
56
- # disbursed\_amount\_by\_product,
57
- # disbursed\_amount\_by\_age\_of\_uncollected\_funds, and
58
- # disbursed\_amount\_by\_age\_of\_disbursed\_funds.
59
- # * *disbursed\_amount\_by\_customer\_geo* - Available every 30 days
60
- # by 5:00 PM Pacific Time since 2012-04-19.
61
- # * *disbursed\_amount\_by\_age\_of\_uncollected\_funds* - Available
62
- # every 30 days by 5:00 PM Pacific Time since 2015-01-26.
63
- # * *disbursed\_amount\_by\_age\_of\_disbursed\_funds* - Available
64
- # every 30 days by 5:00 PM Pacific Time since 2015-01-26.
65
- # * *customer\_profile\_by\_industry* - Available daily by 5:00 PM
66
- # Pacific Time since 2015-10-01.
67
- # * *customer\_profile\_by\_revenue* - Available daily by 5:00 PM
68
- # Pacific Time since 2015-10-01.
69
- # * *customer\_profile\_by\_geography* - Available daily by 5:00 PM
70
- # Pacific Time since 2015-10-01.
71
- # @return [String]
72
- #
73
- # @!attribute [rw] data_set_publication_date
74
- # The date a data set was published. For daily data sets, provide a
75
- # date with day-level granularity for the desired day. For weekly data
76
- # sets, provide a date with day-level granularity within the desired
77
- # week (the day value will be ignored). For monthly data sets, provide
78
- # a date with month-level granularity for the desired month (the day
79
- # value will be ignored).
80
- # @return [Time]
81
- #
82
- # @!attribute [rw] role_name_arn
83
- # The Amazon Resource Name (ARN) of the Role with an attached
84
- # permissions policy to interact with the provided AWS services.
85
- # @return [String]
86
- #
87
- # @!attribute [rw] destination_s3_bucket_name
88
- # The name (friendly name, not ARN) of the destination S3 bucket.
89
- # @return [String]
90
- #
91
- # @!attribute [rw] destination_s3_prefix
92
- # (Optional) The desired S3 prefix for the published data set, similar
93
- # to a directory path in standard file systems. For example, if given
94
- # the bucket name "mybucket" and the prefix "myprefix/mydatasets",
95
- # the output file "outputfile" would be published to
96
- # "s3://mybucket/myprefix/mydatasets/outputfile". If the prefix
97
- # directory structure does not exist, it will be created. If no prefix
98
- # is provided, the data set will be published to the S3 bucket root.
99
- # @return [String]
100
- #
101
- # @!attribute [rw] sns_topic_arn
102
- # Amazon Resource Name (ARN) for the SNS Topic that will be notified
103
- # when the data set has been published or if an error has occurred.
104
- # @return [String]
105
- #
106
- # @!attribute [rw] customer_defined_values
107
- # (Optional) Key-value pairs which will be returned, unmodified, in
108
- # the Amazon SNS notification message and the data set metadata file.
109
- # These key-value pairs can be used to correlated responses with
110
- # tracking information from other systems.
111
- # @return [Hash<String,String>]
112
- class GenerateDataSetRequest < Struct.new(
113
- :data_set_type,
114
- :data_set_publication_date,
115
- :role_name_arn,
116
- :destination_s3_bucket_name,
117
- :destination_s3_prefix,
118
- :sns_topic_arn,
119
- :customer_defined_values)
120
- include Aws::Structure
121
- end
122
-
123
- # Container for the result of the GenerateDataSet operation.
124
- # @!attribute [rw] data_set_request_id
125
- # A unique identifier representing a specific request to the
126
- # GenerateDataSet operation. This identifier can be used to correlate
127
- # a request with notifications from the SNS topic.
128
- # @return [String]
129
- class GenerateDataSetResult < Struct.new(
130
- :data_set_request_id)
131
- include Aws::Structure
132
- end
11
+ # Container for the parameters to the GenerateDataSet operation.
12
+ #
13
+ # @note When making an API call, you may pass GenerateDataSetRequest
14
+ # data as a hash:
15
+ #
16
+ # {
17
+ # 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
18
+ # data_set_publication_date: Time.now, # required
19
+ # role_name_arn: "RoleNameArn", # required
20
+ # destination_s3_bucket_name: "DestinationS3BucketName", # required
21
+ # destination_s3_prefix: "DestinationS3Prefix",
22
+ # sns_topic_arn: "SnsTopicArn", # required
23
+ # customer_defined_values: {
24
+ # "OptionalKey" => "OptionalValue",
25
+ # },
26
+ # }
27
+ #
28
+ # @!attribute [rw] data_set_type
29
+ # The desired data set type.
30
+ #
31
+ # * *customer\_subscriber\_hourly\_monthly\_subscriptions* - Available
32
+ # daily by 5:00 PM Pacific Time since 2014-07-21.
33
+ # * *customer\_subscriber\_annual\_subscriptions* - Available daily by
34
+ # 5:00 PM Pacific Time since 2014-07-21.
35
+ # * *daily\_business\_usage\_by\_instance\_type* - Available daily by
36
+ # 5:00 PM Pacific Time since 2015-01-26.
37
+ # * *daily\_business\_fees* - Available daily by 5:00 PM Pacific Time
38
+ # since 2015-01-26.
39
+ # * *daily\_business\_free\_trial\_conversions* - Available daily by
40
+ # 5:00 PM Pacific Time since 2015-01-26.
41
+ # * *daily\_business\_new\_instances* - Available daily by 5:00 PM
42
+ # Pacific Time since 2015-01-26.
43
+ # * *daily\_business\_new\_product\_subscribers* - Available daily by
44
+ # 5:00 PM Pacific Time since 2015-01-26.
45
+ # * *daily\_business\_canceled\_product\_subscribers* - Available
46
+ # daily by 5:00 PM Pacific Time since 2015-01-26.
47
+ # * *monthly\_revenue\_billing\_and\_revenue\_data* - Available
48
+ # monthly on the 4th day of the month by 5:00 PM Pacific Time since
49
+ # 2015-02.
50
+ # * *monthly\_revenue\_annual\_subscriptions* - Available monthly on
51
+ # the 4th day of the month by 5:00 PM Pacific Time since 2015-02.
52
+ # * *disbursed\_amount\_by\_product* - Available every 30 days by 5:00
53
+ # PM Pacific Time since 2015-01-26.
54
+ # * *disbursed\_amount\_by\_product\_with\_uncollected\_funds* -This
55
+ # data set is only available from 2012-04-19 until 2015-01-25. After
56
+ # 2015-01-25, this data set was split into three data sets:
57
+ # disbursed\_amount\_by\_product,
58
+ # disbursed\_amount\_by\_age\_of\_uncollected\_funds, and
59
+ # disbursed\_amount\_by\_age\_of\_disbursed\_funds.
60
+ # * *disbursed\_amount\_by\_instance\_hours* - Available every 30 days
61
+ # by 5:00 PM Pacific Time since 2012-09-04.
62
+ # * *disbursed\_amount\_by\_customer\_geo* - Available every 30 days
63
+ # by 5:00 PM Pacific Time since 2012-04-19.
64
+ # * *disbursed\_amount\_by\_age\_of\_uncollected\_funds* - Available
65
+ # every 30 days by 5:00 PM Pacific Time since 2015-01-26.
66
+ # * *disbursed\_amount\_by\_age\_of\_disbursed\_funds* - Available
67
+ # every 30 days by 5:00 PM Pacific Time since 2015-01-26.
68
+ # * *customer\_profile\_by\_industry* - Available daily by 5:00 PM
69
+ # Pacific Time since 2015-10-01.
70
+ # * *customer\_profile\_by\_revenue* - Available daily by 5:00 PM
71
+ # Pacific Time since 2015-10-01.
72
+ # * *customer\_profile\_by\_geography* - Available daily by 5:00 PM
73
+ # Pacific Time since 2015-10-01.
74
+ # * *sales\_compensation\_billed\_revenue* - Available monthly on the
75
+ # 4th day of the month by 5:00 PM Pacific Time since 2016-12.
76
+ # @return [String]
77
+ #
78
+ # @!attribute [rw] data_set_publication_date
79
+ # The date a data set was published. For daily data sets, provide a
80
+ # date with day-level granularity for the desired day. For weekly data
81
+ # sets, provide a date with day-level granularity within the desired
82
+ # week (the day value will be ignored). For monthly data sets, provide
83
+ # a date with month-level granularity for the desired month (the day
84
+ # value will be ignored).
85
+ # @return [Time]
86
+ #
87
+ # @!attribute [rw] role_name_arn
88
+ # The Amazon Resource Name (ARN) of the Role with an attached
89
+ # permissions policy to interact with the provided AWS services.
90
+ # @return [String]
91
+ #
92
+ # @!attribute [rw] destination_s3_bucket_name
93
+ # The name (friendly name, not ARN) of the destination S3 bucket.
94
+ # @return [String]
95
+ #
96
+ # @!attribute [rw] destination_s3_prefix
97
+ # (Optional) The desired S3 prefix for the published data set, similar
98
+ # to a directory path in standard file systems. For example, if given
99
+ # the bucket name "mybucket" and the prefix "myprefix/mydatasets",
100
+ # the output file "outputfile" would be published to
101
+ # "s3://mybucket/myprefix/mydatasets/outputfile". If the prefix
102
+ # directory structure does not exist, it will be created. If no prefix
103
+ # is provided, the data set will be published to the S3 bucket root.
104
+ # @return [String]
105
+ #
106
+ # @!attribute [rw] sns_topic_arn
107
+ # Amazon Resource Name (ARN) for the SNS Topic that will be notified
108
+ # when the data set has been published or if an error has occurred.
109
+ # @return [String]
110
+ #
111
+ # @!attribute [rw] customer_defined_values
112
+ # (Optional) Key-value pairs which will be returned, unmodified, in
113
+ # the Amazon SNS notification message and the data set metadata file.
114
+ # These key-value pairs can be used to correlated responses with
115
+ # tracking information from other systems.
116
+ # @return [Hash<String,String>]
117
+ #
118
+ class GenerateDataSetRequest < Struct.new(
119
+ :data_set_type,
120
+ :data_set_publication_date,
121
+ :role_name_arn,
122
+ :destination_s3_bucket_name,
123
+ :destination_s3_prefix,
124
+ :sns_topic_arn,
125
+ :customer_defined_values)
126
+ include Aws::Structure
127
+ end
133
128
 
134
- # Container for the parameters to the StartSupportDataExport operation.
135
- # @note When making an API call, pass StartSupportDataExportRequest
136
- # data as a hash:
137
- #
138
- # {
139
- # data_set_type: "customer_support_contacts_data", # required, accepts customer_support_contacts_data, test_customer_support_contacts_data
140
- # from_date: Time.now, # required
141
- # role_name_arn: "RoleNameArn", # required
142
- # destination_s3_bucket_name: "DestinationS3BucketName", # required
143
- # destination_s3_prefix: "DestinationS3Prefix",
144
- # sns_topic_arn: "SnsTopicArn", # required
145
- # customer_defined_values: {
146
- # "OptionalKey" => "OptionalValue",
147
- # },
148
- # }
149
- # @!attribute [rw] data_set_type
150
- # Specifies the data set type to be written to the output csv file.
151
- # The data set types customer\_support\_contacts\_data and
152
- # test\_customer\_support\_contacts\_data both result in a csv file
153
- # containing the following fields: Product Id, Customer Guid,
154
- # Subscription Guid, Subscription Start Date, Organization, AWS
155
- # Account Id, Given Name, Surname, Telephone Number, Email, Title,
156
- # Country Code, ZIP Code, Operation Type, and Operation Time.
157
- # Currently, only the test\_customer\_support\_contacts\_data value is
158
- # supported
159
- #
160
- # * *customer\_support\_contacts\_data* Customer support contact data.
161
- # The data set will contain all changes (Creates, Updates, and
162
- # Deletes) to customer support contact data from the date specified
163
- # in the from\_date parameter.
164
- # * *test\_customer\_support\_contacts\_data* An example data set
165
- # containing static test data in the same format as
166
- # customer\_support\_contacts\_data
167
- # @return [String]
168
- #
169
- # @!attribute [rw] from_date
170
- # The start date from which to retrieve the data set. This parameter
171
- # only affects the customer\_support\_contacts\_data data set type.
172
- # @return [Time]
173
- #
174
- # @!attribute [rw] role_name_arn
175
- # The Amazon Resource Name (ARN) of the Role with an attached
176
- # permissions policy to interact with the provided AWS services.
177
- # @return [String]
178
- #
179
- # @!attribute [rw] destination_s3_bucket_name
180
- # The name (friendly name, not ARN) of the destination S3 bucket.
181
- # @return [String]
182
- #
183
- # @!attribute [rw] destination_s3_prefix
184
- # (Optional) The desired S3 prefix for the published data set, similar
185
- # to a directory path in standard file systems. For example, if given
186
- # the bucket name "mybucket" and the prefix "myprefix/mydatasets",
187
- # the output file "outputfile" would be published to
188
- # "s3://mybucket/myprefix/mydatasets/outputfile". If the prefix
189
- # directory structure does not exist, it will be created. If no prefix
190
- # is provided, the data set will be published to the S3 bucket root.
191
- # @return [String]
192
- #
193
- # @!attribute [rw] sns_topic_arn
194
- # Amazon Resource Name (ARN) for the SNS Topic that will be notified
195
- # when the data set has been published or if an error has occurred.
196
- # @return [String]
197
- #
198
- # @!attribute [rw] customer_defined_values
199
- # (Optional) Key-value pairs which will be returned, unmodified, in
200
- # the Amazon SNS notification message and the data set metadata file.
201
- # @return [Hash<String,String>]
202
- class StartSupportDataExportRequest < Struct.new(
203
- :data_set_type,
204
- :from_date,
205
- :role_name_arn,
206
- :destination_s3_bucket_name,
207
- :destination_s3_prefix,
208
- :sns_topic_arn,
209
- :customer_defined_values)
210
- include Aws::Structure
211
- end
129
+ # Container for the result of the GenerateDataSet operation.
130
+ #
131
+ # @!attribute [rw] data_set_request_id
132
+ # A unique identifier representing a specific request to the
133
+ # GenerateDataSet operation. This identifier can be used to correlate
134
+ # a request with notifications from the SNS topic.
135
+ # @return [String]
136
+ #
137
+ class GenerateDataSetResult < Struct.new(
138
+ :data_set_request_id)
139
+ include Aws::Structure
140
+ end
212
141
 
213
- # Container for the result of the StartSupportDataExport operation.
214
- # @!attribute [rw] data_set_request_id
215
- # A unique identifier representing a specific request to the
216
- # StartSupportDataExport operation. This identifier can be used to
217
- # correlate a request with notifications from the SNS topic.
218
- # @return [String]
219
- class StartSupportDataExportResult < Struct.new(
220
- :data_set_request_id)
221
- include Aws::Structure
222
- end
142
+ # Container for the parameters to the StartSupportDataExport operation.
143
+ #
144
+ # @note When making an API call, you may pass StartSupportDataExportRequest
145
+ # data as a hash:
146
+ #
147
+ # {
148
+ # data_set_type: "customer_support_contacts_data", # required, accepts customer_support_contacts_data, test_customer_support_contacts_data
149
+ # from_date: Time.now, # required
150
+ # role_name_arn: "RoleNameArn", # required
151
+ # destination_s3_bucket_name: "DestinationS3BucketName", # required
152
+ # destination_s3_prefix: "DestinationS3Prefix",
153
+ # sns_topic_arn: "SnsTopicArn", # required
154
+ # customer_defined_values: {
155
+ # "OptionalKey" => "OptionalValue",
156
+ # },
157
+ # }
158
+ #
159
+ # @!attribute [rw] data_set_type
160
+ # Specifies the data set type to be written to the output csv file.
161
+ # The data set types customer\_support\_contacts\_data and
162
+ # test\_customer\_support\_contacts\_data both result in a csv file
163
+ # containing the following fields: Product Id, Product Code, Customer
164
+ # Guid, Subscription Guid, Subscription Start Date, Organization, AWS
165
+ # Account Id, Given Name, Surname, Telephone Number, Email, Title,
166
+ # Country Code, ZIP Code, Operation Type, and Operation Time.
167
+ #
168
+ # * *customer\_support\_contacts\_data* Customer support contact data.
169
+ # The data set will contain all changes (Creates, Updates, and
170
+ # Deletes) to customer support contact data from the date specified
171
+ # in the from\_date parameter.
172
+ # * *test\_customer\_support\_contacts\_data* An example data set
173
+ # containing static test data in the same format as
174
+ # customer\_support\_contacts\_data
175
+ # @return [String]
176
+ #
177
+ # @!attribute [rw] from_date
178
+ # The start date from which to retrieve the data set in UTC. This
179
+ # parameter only affects the customer\_support\_contacts\_data data
180
+ # set type.
181
+ # @return [Time]
182
+ #
183
+ # @!attribute [rw] role_name_arn
184
+ # The Amazon Resource Name (ARN) of the Role with an attached
185
+ # permissions policy to interact with the provided AWS services.
186
+ # @return [String]
187
+ #
188
+ # @!attribute [rw] destination_s3_bucket_name
189
+ # The name (friendly name, not ARN) of the destination S3 bucket.
190
+ # @return [String]
191
+ #
192
+ # @!attribute [rw] destination_s3_prefix
193
+ # (Optional) The desired S3 prefix for the published data set, similar
194
+ # to a directory path in standard file systems. For example, if given
195
+ # the bucket name "mybucket" and the prefix "myprefix/mydatasets",
196
+ # the output file "outputfile" would be published to
197
+ # "s3://mybucket/myprefix/mydatasets/outputfile". If the prefix
198
+ # directory structure does not exist, it will be created. If no prefix
199
+ # is provided, the data set will be published to the S3 bucket root.
200
+ # @return [String]
201
+ #
202
+ # @!attribute [rw] sns_topic_arn
203
+ # Amazon Resource Name (ARN) for the SNS Topic that will be notified
204
+ # when the data set has been published or if an error has occurred.
205
+ # @return [String]
206
+ #
207
+ # @!attribute [rw] customer_defined_values
208
+ # (Optional) Key-value pairs which will be returned, unmodified, in
209
+ # the Amazon SNS notification message and the data set metadata file.
210
+ # @return [Hash<String,String>]
211
+ #
212
+ class StartSupportDataExportRequest < Struct.new(
213
+ :data_set_type,
214
+ :from_date,
215
+ :role_name_arn,
216
+ :destination_s3_bucket_name,
217
+ :destination_s3_prefix,
218
+ :sns_topic_arn,
219
+ :customer_defined_values)
220
+ include Aws::Structure
221
+ end
223
222
 
223
+ # Container for the result of the StartSupportDataExport operation.
224
+ #
225
+ # @!attribute [rw] data_set_request_id
226
+ # A unique identifier representing a specific request to the
227
+ # StartSupportDataExport operation. This identifier can be used to
228
+ # correlate a request with notifications from the SNS topic.
229
+ # @return [String]
230
+ #
231
+ class StartSupportDataExportResult < Struct.new(
232
+ :data_set_request_id)
233
+ include Aws::Structure
224
234
  end
235
+
225
236
  end
226
237
  end