Documentation

Overview

    Package marketplacecommerceanalytics provides the API client, operations, and parameter types for AWS Marketplace Commerce Analytics.

    Provides AWS Marketplace business intelligence data on-demand.

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2015-07-01"
    View Source
    const ServiceID = "Marketplace Commerce Analytics"

    Variables

    This section is empty.

    Functions

    func NewDefaultEndpointResolver

    func NewDefaultEndpointResolver() *internalendpoints.Resolver

      NewDefaultEndpointResolver constructs a new service endpoint resolver

      func WithAPIOptions

      func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

        WithAPIOptions returns a functional option for setting the Client's APIOptions option.

        func WithEndpointResolver

        func WithEndpointResolver(v EndpointResolver) func(*Options)

          WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

          Types

          type Client

          type Client struct {
          	// contains filtered or unexported fields
          }

            Client provides the API client to make operations call for AWS Marketplace Commerce Analytics.

            func New

            func New(options Options, optFns ...func(*Options)) *Client

              New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

              func NewFromConfig

              func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

                NewFromConfig returns a new client from the provided config.

                func (*Client) GenerateDataSet

                func (c *Client) GenerateDataSet(ctx context.Context, params *GenerateDataSetInput, optFns ...func(*Options)) (*GenerateDataSetOutput, error)

                  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 (*Client) StartSupportDataExport

                  func (c *Client) StartSupportDataExport(ctx context.Context, params *StartSupportDataExportInput, optFns ...func(*Options)) (*StartSupportDataExportOutput, error)

                    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.

                    type EndpointResolver

                    type EndpointResolver interface {
                    	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
                    }

                      EndpointResolver interface for resolving service endpoints.

                      func EndpointResolverFromURL

                      func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

                        EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

                        type EndpointResolverFunc

                        type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

                          EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

                          func (EndpointResolverFunc) ResolveEndpoint

                          func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

                          type EndpointResolverOptions

                          type EndpointResolverOptions = internalendpoints.Options

                            EndpointResolverOptions is the service endpoint resolver options

                            type GenerateDataSetInput

                            type GenerateDataSetInput struct {
                            
                            	// The date a data set was published. For daily data sets, provide a date with
                            	// day-level granularity for the desired day. For monthly data sets except those
                            	// with prefix disbursed_amount, provide a date with month-level granularity for
                            	// the desired month (the day value will be ignored). For data sets with prefix
                            	// disbursed_amount, provide a date with day-level granularity for the desired day.
                            	// For these data sets we will look backwards in time over the range of 31 days
                            	// until the first data set is found (the latest one).
                            	//
                            	// This member is required.
                            	DataSetPublicationDate *time.Time
                            
                            	// The desired data set type.
                            	//
                            	// * customer_subscriber_hourly_monthly_subscriptions
                            	// From 2017-09-15 to present: Available daily by 24:00 UTC.
                            	//
                            	// *
                            	// customer_subscriber_annual_subscriptions From 2017-09-15 to present: Available
                            	// daily by 24:00 UTC.
                            	//
                            	// * daily_business_usage_by_instance_type From 2017-09-15 to
                            	// present: Available daily by 24:00 UTC.
                            	//
                            	// * daily_business_fees From 2017-09-15 to
                            	// present: Available daily by 24:00 UTC.
                            	//
                            	// * daily_business_free_trial_conversions
                            	// From 2017-09-15 to present: Available daily by 24:00 UTC.
                            	//
                            	// *
                            	// daily_business_new_instances From 2017-09-15 to present: Available daily by
                            	// 24:00 UTC.
                            	//
                            	// * daily_business_new_product_subscribers From 2017-09-15 to present:
                            	// Available daily by 24:00 UTC.
                            	//
                            	// * daily_business_canceled_product_subscribers
                            	// From 2017-09-15 to present: Available daily by 24:00 UTC.
                            	//
                            	// *
                            	// monthly_revenue_billing_and_revenue_data From 2017-09-15 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 2017-09-15 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 2017-09-15 to present: Available every 30 days
                            	// by 24:00 UTC.
                            	//
                            	// * disbursed_amount_by_instance_hours From 2017-09-15 to present:
                            	// Available every 30 days by 24:00 UTC.
                            	//
                            	// * disbursed_amount_by_customer_geo From
                            	// 2017-09-15 to present: Available every 30 days by 24:00 UTC.
                            	//
                            	// *
                            	// disbursed_amount_by_age_of_uncollected_funds From 2017-09-15 to present:
                            	// Available every 30 days by 24:00 UTC.
                            	//
                            	// *
                            	// disbursed_amount_by_age_of_disbursed_funds From 2017-09-15 to present: Available
                            	// every 30 days by 24:00 UTC.
                            	//
                            	// * disbursed_amount_by_age_of_past_due_funds From
                            	// 2018-04-07 to present: Available every 30 days by 24:00 UTC.
                            	//
                            	// *
                            	// disbursed_amount_by_uncollected_funds_breakdown From 2019-10-04 to present:
                            	// Available every 30 days by 24:00 UTC.
                            	//
                            	// * sales_compensation_billed_revenue From
                            	// 2017-09-15 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-09-15 to present: Available monthly on
                            	// the 15th day of the month by 24:00 UTC.
                            	//
                            	// *
                            	// disbursed_amount_by_product_with_uncollected_funds This data set is deprecated.
                            	// Download related reports from AMMP instead!
                            	//
                            	// * customer_profile_by_industry This
                            	// data set is deprecated. Download related reports from AMMP instead!
                            	//
                            	// *
                            	// customer_profile_by_revenue This data set is deprecated. Download related
                            	// reports from AMMP instead!
                            	//
                            	// * customer_profile_by_geography This data set is
                            	// deprecated. Download related reports from AMMP instead!
                            	//
                            	// This member is required.
                            	DataSetType types.DataSetType
                            
                            	// The name (friendly name, not ARN) of the destination S3 bucket.
                            	//
                            	// This member is required.
                            	DestinationS3BucketName *string
                            
                            	// The Amazon Resource Name (ARN) of the Role with an attached permissions policy
                            	// to interact with the provided AWS services.
                            	//
                            	// This member is required.
                            	RoleNameArn *string
                            
                            	// 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.
                            	//
                            	// This member is required.
                            	SnsTopicArn *string
                            
                            	// (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
                            
                            	// (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
                            }

                              Container for the parameters to the GenerateDataSet operation.

                              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
                              
                              	// Metadata pertaining to the operation's result.
                              	ResultMetadata middleware.Metadata
                              }

                                Container for the result of the GenerateDataSet operation.

                                type HTTPClient

                                type HTTPClient interface {
                                	Do(*http.Request) (*http.Response, error)
                                }

                                type HTTPSignerV4

                                type HTTPSignerV4 interface {
                                	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
                                }

                                type Options

                                type Options struct {
                                	// Set of options to modify how an operation is invoked. These apply to all
                                	// operations invoked for this client. Use functional options on operation call to
                                	// modify this list for per operation behavior.
                                	APIOptions []func(*middleware.Stack) error
                                
                                	// Configures the events that will be sent to the configured logger.
                                	ClientLogMode aws.ClientLogMode
                                
                                	// The credentials object to use when signing requests.
                                	Credentials aws.CredentialsProvider
                                
                                	// The endpoint options to be used when attempting to resolve an endpoint.
                                	EndpointOptions EndpointResolverOptions
                                
                                	// The service endpoint resolver.
                                	EndpointResolver EndpointResolver
                                
                                	// Signature Version 4 (SigV4) Signer
                                	HTTPSignerV4 HTTPSignerV4
                                
                                	// The logger writer interface to write logging messages to.
                                	Logger logging.Logger
                                
                                	// The region to send requests to. (Required)
                                	Region string
                                
                                	// Retryer guides how HTTP requests should be retried in case of recoverable
                                	// failures. When nil the API client will use a default retryer.
                                	Retryer aws.Retryer
                                
                                	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
                                	// implementation if nil.
                                	HTTPClient HTTPClient
                                }

                                func (Options) Copy

                                func (o Options) Copy() Options

                                  Copy creates a clone where the APIOptions list is deep copied.

                                  type ResolveEndpoint

                                  type ResolveEndpoint struct {
                                  	Resolver EndpointResolver
                                  	Options  EndpointResolverOptions
                                  }

                                  func (*ResolveEndpoint) HandleSerialize

                                  func (*ResolveEndpoint) ID

                                  func (*ResolveEndpoint) ID() string

                                  type StartSupportDataExportInput

                                  type StartSupportDataExportInput struct {
                                  
                                  	// 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
                                  	//
                                  	// This member is required.
                                  	DataSetType types.SupportDataSetType
                                  
                                  	// The name (friendly name, not ARN) of the destination S3 bucket.
                                  	//
                                  	// This member is required.
                                  	DestinationS3BucketName *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.
                                  	//
                                  	// This member is required.
                                  	FromDate *time.Time
                                  
                                  	// The Amazon Resource Name (ARN) of the Role with an attached permissions policy
                                  	// to interact with the provided AWS services.
                                  	//
                                  	// This member is required.
                                  	RoleNameArn *string
                                  
                                  	// 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.
                                  	//
                                  	// This member is required.
                                  	SnsTopicArn *string
                                  
                                  	// (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
                                  
                                  	// (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
                                  }

                                    Container for the parameters to the StartSupportDataExport operation.

                                    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
                                    
                                    	// Metadata pertaining to the operation's result.
                                    	ResultMetadata middleware.Metadata
                                    }

                                      Container for the result of the StartSupportDataExport operation.

                                      Directories

                                      Path Synopsis
                                      internal