Documentation ¶
Overview ¶
Package marketplacecommerceanalytics provides a client for AWS Marketplace Commerce Analytics.
Index ¶
- Constants
- type GenerateDataSetInput
- type GenerateDataSetOutput
- type MarketplaceCommerceAnalytics
- func (c *MarketplaceCommerceAnalytics) GenerateDataSet(input *GenerateDataSetInput) (*GenerateDataSetOutput, error)
- func (c *MarketplaceCommerceAnalytics) GenerateDataSetRequest(input *GenerateDataSetInput) (req *request.Request, output *GenerateDataSetOutput)
- func (c *MarketplaceCommerceAnalytics) StartSupportDataExport(input *StartSupportDataExportInput) (*StartSupportDataExportOutput, error)
- func (c *MarketplaceCommerceAnalytics) StartSupportDataExportRequest(input *StartSupportDataExportInput) (req *request.Request, output *StartSupportDataExportOutput)
- type StartSupportDataExportInput
- type StartSupportDataExportOutput
Examples ¶
Constants ¶
const ( // DataSetTypeCustomerSubscriberHourlyMonthlySubscriptions is a DataSetType enum value DataSetTypeCustomerSubscriberHourlyMonthlySubscriptions = "customer_subscriber_hourly_monthly_subscriptions" // DataSetTypeCustomerSubscriberAnnualSubscriptions is a DataSetType enum value DataSetTypeCustomerSubscriberAnnualSubscriptions = "customer_subscriber_annual_subscriptions" // DataSetTypeDailyBusinessUsageByInstanceType is a DataSetType enum value DataSetTypeDailyBusinessUsageByInstanceType = "daily_business_usage_by_instance_type" // DataSetTypeDailyBusinessFees is a DataSetType enum value DataSetTypeDailyBusinessFees = "daily_business_fees" // DataSetTypeDailyBusinessFreeTrialConversions is a DataSetType enum value DataSetTypeDailyBusinessFreeTrialConversions = "daily_business_free_trial_conversions" // DataSetTypeDailyBusinessNewInstances is a DataSetType enum value DataSetTypeDailyBusinessNewInstances = "daily_business_new_instances" // DataSetTypeDailyBusinessNewProductSubscribers is a DataSetType enum value DataSetTypeDailyBusinessNewProductSubscribers = "daily_business_new_product_subscribers" // DataSetTypeDailyBusinessCanceledProductSubscribers is a DataSetType enum value DataSetTypeDailyBusinessCanceledProductSubscribers = "daily_business_canceled_product_subscribers" // DataSetTypeMonthlyRevenueBillingAndRevenueData is a DataSetType enum value DataSetTypeMonthlyRevenueBillingAndRevenueData = "monthly_revenue_billing_and_revenue_data" // DataSetTypeMonthlyRevenueAnnualSubscriptions is a DataSetType enum value DataSetTypeMonthlyRevenueAnnualSubscriptions = "monthly_revenue_annual_subscriptions" // DataSetTypeDisbursedAmountByProduct is a DataSetType enum value DataSetTypeDisbursedAmountByProduct = "disbursed_amount_by_product" // DataSetTypeDisbursedAmountByProductWithUncollectedFunds is a DataSetType enum value DataSetTypeDisbursedAmountByProductWithUncollectedFunds = "disbursed_amount_by_product_with_uncollected_funds" // DataSetTypeDisbursedAmountByCustomerGeo is a DataSetType enum value DataSetTypeDisbursedAmountByCustomerGeo = "disbursed_amount_by_customer_geo" // DataSetTypeDisbursedAmountByAgeOfUncollectedFunds is a DataSetType enum value DataSetTypeDisbursedAmountByAgeOfUncollectedFunds = "disbursed_amount_by_age_of_uncollected_funds" // DataSetTypeDisbursedAmountByAgeOfDisbursedFunds is a DataSetType enum value DataSetTypeDisbursedAmountByAgeOfDisbursedFunds = "disbursed_amount_by_age_of_disbursed_funds" // DataSetTypeCustomerProfileByIndustry is a DataSetType enum value DataSetTypeCustomerProfileByIndustry = "customer_profile_by_industry" // DataSetTypeCustomerProfileByRevenue is a DataSetType enum value DataSetTypeCustomerProfileByRevenue = "customer_profile_by_revenue" // DataSetTypeCustomerProfileByGeography is a DataSetType enum value DataSetTypeCustomerProfileByGeography = "customer_profile_by_geography" )
const ( // SupportDataSetTypeCustomerSupportContactsData is a SupportDataSetType enum value SupportDataSetTypeCustomerSupportContactsData = "customer_support_contacts_data" // SupportDataSetTypeTestCustomerSupportContactsData is a SupportDataSetType enum value SupportDataSetTypeTestCustomerSupportContactsData = "test_customer_support_contacts_data" )
const ServiceName = "marketplacecommerceanalytics"
A ServiceName is the name of the service the client will make API calls to.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GenerateDataSetInput ¶
type GenerateDataSetInput struct { // (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 is a required field 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 is a required field DataSetType *string `locationName:"dataSetType" min:"1" type:"string" required:"true" enum:"DataSetType"` // The name (friendly name, not ARN) of the destination S3 bucket. // // DestinationS3BucketName is a required field 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 is a required field 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 is a required field SnsTopicArn *string `locationName:"snsTopicArn" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Container for the parameters to the GenerateDataSet operation.
func (GenerateDataSetInput) GoString ¶
func (s GenerateDataSetInput) GoString() string
GoString returns the string representation
func (GenerateDataSetInput) String ¶
func (s GenerateDataSetInput) String() string
String returns the string representation
func (*GenerateDataSetInput) Validate ¶ added in v1.1.21
func (s *GenerateDataSetInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GenerateDataSetOutput ¶
type GenerateDataSetOutput struct { // 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"` // contains filtered or unexported fields }
Container for the result of the GenerateDataSet operation.
func (GenerateDataSetOutput) GoString ¶
func (s GenerateDataSetOutput) GoString() string
GoString returns the string representation
func (GenerateDataSetOutput) String ¶
func (s GenerateDataSetOutput) String() string
String returns the string representation
type MarketplaceCommerceAnalytics ¶
Provides AWS Marketplace business intelligence data on-demand. The service client's operations are safe to be used concurrently. It is not safe to mutate any of the client's properties though.
func New ¶
func New(p client.ConfigProvider, cfgs ...*aws.Config) *MarketplaceCommerceAnalytics
New creates a new instance of the MarketplaceCommerceAnalytics client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
// Create a MarketplaceCommerceAnalytics client from just a session. svc := marketplacecommerceanalytics.New(mySession) // Create a MarketplaceCommerceAnalytics client with additional configuration svc := marketplacecommerceanalytics.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (*MarketplaceCommerceAnalytics) GenerateDataSet ¶
func (c *MarketplaceCommerceAnalytics) GenerateDataSet(input *GenerateDataSetInput) (*GenerateDataSetOutput, error)
GenerateDataSet API operation for AWS Marketplace Commerce Analytics.
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.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Marketplace Commerce Analytics's API operation GenerateDataSet for usage and error information.
Returned Error Codes:
- Exception This exception is thrown when an internal service error occurs.
func (*MarketplaceCommerceAnalytics) GenerateDataSetRequest ¶
func (c *MarketplaceCommerceAnalytics) GenerateDataSetRequest(input *GenerateDataSetInput) (req *request.Request, output *GenerateDataSetOutput)
GenerateDataSetRequest generates a "aws/request.Request" representing the client's request for the GenerateDataSet operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GenerateDataSet for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GenerateDataSet method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GenerateDataSetRequest method. req, resp := client.GenerateDataSetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*MarketplaceCommerceAnalytics) StartSupportDataExport ¶ added in v1.4.0
func (c *MarketplaceCommerceAnalytics) StartSupportDataExport(input *StartSupportDataExportInput) (*StartSupportDataExportOutput, error)
StartSupportDataExport API operation for AWS Marketplace Commerce Analytics.
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.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Marketplace Commerce Analytics's API operation StartSupportDataExport for usage and error information.
Returned Error Codes:
- Exception This exception is thrown when an internal service error occurs.
func (*MarketplaceCommerceAnalytics) StartSupportDataExportRequest ¶ added in v1.4.0
func (c *MarketplaceCommerceAnalytics) StartSupportDataExportRequest(input *StartSupportDataExportInput) (req *request.Request, output *StartSupportDataExportOutput)
StartSupportDataExportRequest generates a "aws/request.Request" representing the client's request for the StartSupportDataExport operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See StartSupportDataExport for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the StartSupportDataExport method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the StartSupportDataExportRequest method. req, resp := client.StartSupportDataExportRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
type StartSupportDataExportInput ¶ added in v1.4.0
type StartSupportDataExportInput struct { // (Optional) Key-value pairs which will be returned, unmodified, in the Amazon // SNS notification message and the data set metadata file. CustomerDefinedValues map[string]*string `locationName:"customerDefinedValues" min:"1" type:"map"` // 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, 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. Currently, only the test_customer_support_contacts_data // value is supported // // 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 // // DataSetType is a required field DataSetType *string `locationName:"dataSetType" min:"1" type:"string" required:"true" enum:"SupportDataSetType"` // The name (friendly name, not ARN) of the destination S3 bucket. // // DestinationS3BucketName is a required field 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 start date from which to retrieve the data set. This parameter only affects // the customer_support_contacts_data data set type. // // FromDate is a required field FromDate *time.Time `locationName:"fromDate" type:"timestamp" timestampFormat:"unix" required:"true"` // The Amazon Resource Name (ARN) of the Role with an attached permissions policy // to interact with the provided AWS services. // // RoleNameArn is a required field 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 is a required field SnsTopicArn *string `locationName:"snsTopicArn" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Container for the parameters to the StartSupportDataExport operation.
func (StartSupportDataExportInput) GoString ¶ added in v1.4.0
func (s StartSupportDataExportInput) GoString() string
GoString returns the string representation
func (StartSupportDataExportInput) String ¶ added in v1.4.0
func (s StartSupportDataExportInput) String() string
String returns the string representation
func (*StartSupportDataExportInput) Validate ¶ added in v1.4.0
func (s *StartSupportDataExportInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StartSupportDataExportOutput ¶ added in v1.4.0
type StartSupportDataExportOutput struct { // A unique identifier representing a specific request to the StartSupportDataExport // operation. This identifier can be used to correlate a request with notifications // from the SNS topic. DataSetRequestId *string `locationName:"dataSetRequestId" type:"string"` // contains filtered or unexported fields }
Container for the result of the StartSupportDataExport operation.
func (StartSupportDataExportOutput) GoString ¶ added in v1.4.0
func (s StartSupportDataExportOutput) GoString() string
GoString returns the string representation
func (StartSupportDataExportOutput) String ¶ added in v1.4.0
func (s StartSupportDataExportOutput) String() string
String returns the string representation
Directories ¶
Path | Synopsis |
---|---|
Package marketplacecommerceanalyticsiface provides an interface to enable mocking the AWS Marketplace Commerce Analytics service client for testing your code.
|
Package marketplacecommerceanalyticsiface provides an interface to enable mocking the AWS Marketplace Commerce Analytics service client for testing your code. |