marketplacecommerceanalytics

package
v0.12.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 17, 2019 License: Apache-2.0 Imports: 6 Imported by: 18

Documentation

Overview

Package marketplacecommerceanalytics provides the client and types for making API requests to AWS Marketplace Commerce Analytics.

Provides AWS Marketplace business intelligence data on-demand.

See https://docs.aws.amazon.com/goto/WebAPI/marketplacecommerceanalytics-2015-07-01 for more information on this service.

See marketplacecommerceanalytics package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/marketplacecommerceanalytics/

Using the Client

To use AWS Marketplace Commerce Analytics with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Marketplace Commerce Analytics client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/marketplacecommerceanalytics/#New

Index

Constants

View Source 
const (
	ServiceName = "AWS Marketplace Commerce Analytics" // Service's name
	ServiceID   = "MarketplaceCommerceAnalytics"       // Service's identifier
	EndpointsID = "marketplacecommerceanalytics"       // Service's Endpoint identifier
)
View Source 
const (

	// ErrCodeMarketplaceCommerceAnalyticsException for service response error code
	// "MarketplaceCommerceAnalyticsException".
	//
	// This exception is thrown when an internal service error occurs.
	ErrCodeMarketplaceCommerceAnalyticsException = "MarketplaceCommerceAnalyticsException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to AWS Marketplace Commerce Analytics. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := marketplacecommerceanalytics.New(myConfig)

func (*Client) GenerateDataSetRequest added in v0.9.0 

func (c *Client) GenerateDataSetRequest(input *GenerateDataSetInput) GenerateDataSetRequest

GenerateDataSetRequest returns a request value for making 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. 

// Example sending a request using GenerateDataSetRequest.
req := client.GenerateDataSetRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/marketplacecommerceanalytics-2015-07-01/GenerateDataSet

func (*Client) StartSupportDataExportRequest added in v0.9.0 

func (c *Client) StartSupportDataExportRequest(input *StartSupportDataExportInput) StartSupportDataExportRequest

StartSupportDataExportRequest returns a request value for making 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. 

// Example sending a request using StartSupportDataExportRequest.
req := client.StartSupportDataExportRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/marketplacecommerceanalytics-2015-07-01/StartSupportDataExport

type DataSetType 

type DataSetType string
const (
	DataSetTypeCustomerSubscriberHourlyMonthlySubscriptions DataSetType = "customer_subscriber_hourly_monthly_subscriptions"
	DataSetTypeCustomerSubscriberAnnualSubscriptions        DataSetType = "customer_subscriber_annual_subscriptions"
	DataSetTypeDailyBusinessUsageByInstanceType             DataSetType = "daily_business_usage_by_instance_type"
	DataSetTypeDailyBusinessFees                            DataSetType = "daily_business_fees"
	DataSetTypeDailyBusinessFreeTrialConversions            DataSetType = "daily_business_free_trial_conversions"
	DataSetTypeDailyBusinessNewInstances                    DataSetType = "daily_business_new_instances"
	DataSetTypeDailyBusinessNewProductSubscribers           DataSetType = "daily_business_new_product_subscribers"
	DataSetTypeDailyBusinessCanceledProductSubscribers      DataSetType = "daily_business_canceled_product_subscribers"
	DataSetTypeMonthlyRevenueBillingAndRevenueData          DataSetType = "monthly_revenue_billing_and_revenue_data"
	DataSetTypeMonthlyRevenueAnnualSubscriptions            DataSetType = "monthly_revenue_annual_subscriptions"
	DataSetTypeMonthlyRevenueFieldDemonstrationUsage        DataSetType = "monthly_revenue_field_demonstration_usage"
	DataSetTypeMonthlyRevenueFlexiblePaymentSchedule        DataSetType = "monthly_revenue_flexible_payment_schedule"
	DataSetTypeDisbursedAmountByProduct                     DataSetType = "disbursed_amount_by_product"
	DataSetTypeDisbursedAmountByProductWithUncollectedFunds DataSetType = "disbursed_amount_by_product_with_uncollected_funds"
	DataSetTypeDisbursedAmountByInstanceHours               DataSetType = "disbursed_amount_by_instance_hours"
	DataSetTypeDisbursedAmountByCustomerGeo                 DataSetType = "disbursed_amount_by_customer_geo"
	DataSetTypeDisbursedAmountByAgeOfUncollectedFunds       DataSetType = "disbursed_amount_by_age_of_uncollected_funds"
	DataSetTypeDisbursedAmountByAgeOfDisbursedFunds         DataSetType = "disbursed_amount_by_age_of_disbursed_funds"
	DataSetTypeCustomerProfileByIndustry                    DataSetType = "customer_profile_by_industry"
	DataSetTypeCustomerProfileByRevenue                     DataSetType = "customer_profile_by_revenue"
	DataSetTypeCustomerProfileByGeography                   DataSetType = "customer_profile_by_geography"
	DataSetTypeSalesCompensationBilledRevenue               DataSetType = "sales_compensation_billed_revenue"
	DataSetTypeUsSalesAndUseTaxRecords                      DataSetType = "us_sales_and_use_tax_records"
)

Enum values for DataSetType

func (DataSetType) MarshalValue added in v0.3.0 

func (enum DataSetType) MarshalValue() (string, error)

func (DataSetType) MarshalValueBuf added in v0.3.0 

func (enum DataSetType) MarshalValueBuf(b []byte) ([]byte, error)

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" required:"true"`

	// The desired data set type.
	//
	//    * customer_subscriber_hourly_monthly_subscriptions From 2014-07-21 to
	//    present: Available daily by 24:00 UTC.
	//
	//    * customer_subscriber_annual_subscriptions From 2014-07-21 to present:
	//    Available daily by 24:00 UTC.
	//
	//    * daily_business_usage_by_instance_type From 2015-01-26 to present: Available
	//    daily by 24:00 UTC.
	//
	//    * daily_business_fees From 2015-01-26 to present: Available daily by 24:00
	//    UTC.
	//
	//    * daily_business_free_trial_conversions From 2015-01-26 to present: Available
	//    daily by 24:00 UTC.
	//
	//    * daily_business_new_instances From 2015-01-26 to present: Available daily
	//    by 24:00 UTC.
	//
	//    * daily_business_new_product_subscribers From 2015-01-26 to present: Available
	//    daily by 24:00 UTC.
	//
	//    * daily_business_canceled_product_subscribers From 2015-01-26 to present:
	//    Available daily by 24:00 UTC.
	//
	//    * monthly_revenue_billing_and_revenue_data From 2015-02 to 2017-06: Available
	//    monthly on the 4th day of the month by 24:00 UTC. Data includes metered
	//    transactions (e.g. hourly) from two months prior. From 2017-07 to present:
	//    Available monthly on the 15th day of the month by 24:00 UTC. Data includes
	//    metered transactions (e.g. hourly) from one month prior.
	//
	//    * monthly_revenue_annual_subscriptions From 2015-02 to 2017-06: Available
	//    monthly on the 4th day of the month by 24:00 UTC. Data includes up-front
	//    software charges (e.g. annual) from one month prior. From 2017-07 to present:
	//    Available monthly on the 15th day of the month by 24:00 UTC. Data includes
	//    up-front software charges (e.g. annual) from one month prior.
	//
	//    * monthly_revenue_field_demonstration_usage From 2018-03-15 to present:
	//    Available monthly on the 15th day of the month by 24:00 UTC.
	//
	//    * monthly_revenue_flexible_payment_schedule From 2018-11-15 to present:
	//    Available monthly on the 15th day of the month by 24:00 UTC.
	//
	//    * disbursed_amount_by_product From 2015-01-26 to present: Available every
	//    30 days by 24:00 UTC.
	//
	//    * disbursed_amount_by_product_with_uncollected_funds From 2012-04-19 to
	//    2015-01-25: Available every 30 days by 24:00 UTC. From 2015-01-26 to present:
	//    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_instance_hours From 2012-09-04 to present: Available
	//    every 30 days by 24:00 UTC.
	//
	//    * disbursed_amount_by_customer_geo From 2012-04-19 to present: Available
	//    every 30 days by 24:00 UTC.
	//
	//    * disbursed_amount_by_age_of_uncollected_funds From 2015-01-26 to present:
	//    Available every 30 days by 24:00 UTC.
	//
	//    * disbursed_amount_by_age_of_disbursed_funds From 2015-01-26 to present:
	//    Available every 30 days by 24:00 UTC.
	//
	//    * customer_profile_by_industry From 2015-10-01 to 2017-06-29: Available
	//    daily by 24:00 UTC. From 2017-06-30 to present: This data set is no longer
	//    available.
	//
	//    * customer_profile_by_revenue From 2015-10-01 to 2017-06-29: Available
	//    daily by 24:00 UTC. From 2017-06-30 to present: This data set is no longer
	//    available.
	//
	//    * customer_profile_by_geography From 2015-10-01 to 2017-06-29: Available
	//    daily by 24:00 UTC. From 2017-06-30 to present: This data set is no longer
	//    available.
	//
	//    * sales_compensation_billed_revenue From 2016-12 to 2017-06: Available
	//    monthly on the 4th day of the month by 24:00 UTC. Data includes metered
	//    transactions (e.g. hourly) from two months prior, and up-front software
	//    charges (e.g. annual) from one month prior. From 2017-06 to present: Available
	//    monthly on the 15th day of the month by 24:00 UTC. Data includes metered
	//    transactions (e.g. hourly) from one month prior, and up-front software
	//    charges (e.g. annual) from one month prior.
	//
	//    * us_sales_and_use_tax_records From 2017-02-15 to present: Available monthly
	//    on the 15th day of the month by 24:00 UTC.
	//
	// DataSetType is a required field
	DataSetType DataSetType `locationName:"dataSetType" min:"1" type:"string" required:"true" enum:"true"`

	// 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) String 

func (s GenerateDataSetInput) String() string

String returns the string representation

func (*GenerateDataSetInput) Validate 

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) String 

func (s GenerateDataSetOutput) String() string

String returns the string representation

type GenerateDataSetRequest 

type GenerateDataSetRequest struct {
	*aws.Request
	Input *GenerateDataSetInput
	Copy  func(*GenerateDataSetInput) GenerateDataSetRequest
}

GenerateDataSetRequest is the request type for the GenerateDataSet API operation.

func (GenerateDataSetRequest) Send 

func (r GenerateDataSetRequest) Send(ctx context.Context) (*GenerateDataSetResponse, error)

Send marshals and sends the GenerateDataSet API request.

type GenerateDataSetResponse added in v0.9.0 

type GenerateDataSetResponse struct {
	*GenerateDataSetOutput
	// contains filtered or unexported fields
}

GenerateDataSetResponse is the response type for the GenerateDataSet API operation.

func (*GenerateDataSetResponse) SDKResponseMetdata added in v0.9.0 

func (r *GenerateDataSetResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GenerateDataSet request.

type StartSupportDataExportInput 

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, Product
	// Code, Customer Guid, Subscription Guid, Subscription Start Date, Organization,
	// AWS Account Id, Given Name, Surname, Telephone Number, Email, Title, Country
	// Code, ZIP Code, Operation Type, and Operation Time.
	//
	//    * customer_support_contacts_data Customer support contact data. The data
	//    set will contain all changes (Creates, Updates, and Deletes) to customer
	//    support contact data from the date specified in the from_date parameter.
	//
	//    * test_customer_support_contacts_data An example data set containing static
	//    test data in the same format as customer_support_contacts_data
	//
	// DataSetType is a required field
	DataSetType SupportDataSetType `locationName:"dataSetType" min:"1" type:"string" required:"true" enum:"true"`

	// 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 in UTC. This parameter
	// only affects the customer_support_contacts_data data set type.
	//
	// FromDate is a required field
	FromDate *time.Time `locationName:"fromDate" type:"timestamp" 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) String 

func (s StartSupportDataExportInput) String() string

String returns the string representation

func (*StartSupportDataExportInput) Validate 

func (s *StartSupportDataExportInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartSupportDataExportOutput 

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) String 

func (s StartSupportDataExportOutput) String() string

String returns the string representation

type StartSupportDataExportRequest 

type StartSupportDataExportRequest struct {
	*aws.Request
	Input *StartSupportDataExportInput
	Copy  func(*StartSupportDataExportInput) StartSupportDataExportRequest
}

StartSupportDataExportRequest is the request type for the StartSupportDataExport API operation.

func (StartSupportDataExportRequest) Send 

func (r StartSupportDataExportRequest) Send(ctx context.Context) (*StartSupportDataExportResponse, error)

Send marshals and sends the StartSupportDataExport API request.

type StartSupportDataExportResponse added in v0.9.0 

type StartSupportDataExportResponse struct {
	*StartSupportDataExportOutput
	// contains filtered or unexported fields
}

StartSupportDataExportResponse is the response type for the StartSupportDataExport API operation.

func (*StartSupportDataExportResponse) SDKResponseMetdata added in v0.9.0 

func (r *StartSupportDataExportResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StartSupportDataExport request.

type SupportDataSetType 

type SupportDataSetType string
const (
	SupportDataSetTypeCustomerSupportContactsData     SupportDataSetType = "customer_support_contacts_data"
	SupportDataSetTypeTestCustomerSupportContactsData SupportDataSetType = "test_customer_support_contacts_data"
)

Enum values for SupportDataSetType

func (SupportDataSetType) MarshalValue added in v0.3.0 

func (enum SupportDataSetType) MarshalValue() (string, error)

func (SupportDataSetType) MarshalValueBuf added in v0.3.0 

func (enum SupportDataSetType) MarshalValueBuf(b []byte) ([]byte, error)

Source Files

View all Source files

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.