AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Invokes the GenerateDataSet operation against AWS Marketplace Commerce Analytics.

Syntax

New-MCADataSet
-DestinationS3BucketName <String>
-RoleNameArn <String>
-SnsTopicArn <String>
-CustomerDefinedValue <Hashtable>
-DataSetPublicationDate <DateTime>
-DataSetType <DataSetType>
-DestinationS3Prefix <String>

Description

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.

Parameters

-CustomerDefinedValue <Hashtable>
(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.
Required?False
Position?Named
Accept pipeline input?False
-DataSetPublicationDate <DateTime>
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).
Required?False
Position?Named
Accept pipeline input?False
-DataSetType <DataSetType>
The desired data set type.
  • customer_subscriber_hourly_monthly_subscriptionsFrom 2014-07-21 to present: Available daily by 5:00 PM Pacific Time.
  • customer_subscriber_annual_subscriptionsFrom 2014-07-21 to present: Available daily by 5:00 PM Pacific Time.
  • daily_business_usage_by_instance_typeFrom 2015-01-26 to present: Available daily by 5:00 PM Pacific Time.
  • daily_business_feesFrom 2015-01-26 to present: Available daily by 5:00 PM Pacific Time.
  • daily_business_free_trial_conversionsFrom 2015-01-26 to present: Available daily by 5:00 PM Pacific Time.
  • daily_business_new_instancesFrom 2015-01-26 to present: Available daily by 5:00 PM Pacific Time.
  • daily_business_new_product_subscribersFrom 2015-01-26 to present: Available daily by 5:00 PM Pacific Time.
  • daily_business_canceled_product_subscribersFrom 2015-01-26 to present: Available daily by 5:00 PM Pacific Time.
  • monthly_revenue_billing_and_revenue_dataFrom 2015-02 to 2017-06: Available monthly on the 4th day of the month by 5:00pm Pacific Time. 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 5:00pm Pacific Time. Data includes metered transactions (e.g. hourly) from one month prior.
  • monthly_revenue_annual_subscriptionsFrom 2015-02 to 2017-06: Available monthly on the 4th day of the month by 5:00pm Pacific Time. 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 5:00pm Pacific Time. Data includes up-front software charges (e.g. annual) from one month prior.
  • disbursed_amount_by_productFrom 2015-01-26 to present: Available every 30 days by 5:00 PM Pacific Time.
  • disbursed_amount_by_product_with_uncollected_fundsFrom 2012-04-19 to 2015-01-25: Available every 30 days by 5:00 PM Pacific Time.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_hoursFrom 2012-09-04 to present: Available every 30 days by 5:00 PM Pacific Time.
  • disbursed_amount_by_customer_geoFrom 2012-04-19 to present: Available every 30 days by 5:00 PM Pacific Time.
  • disbursed_amount_by_age_of_uncollected_fundsFrom 2015-01-26 to present: Available every 30 days by 5:00 PM Pacific Time.
  • disbursed_amount_by_age_of_disbursed_fundsFrom 2015-01-26 to present: Available every 30 days by 5:00 PM Pacific Time.
  • customer_profile_by_industryFrom 2015-10-01 to 2017-06-29: Available daily by 5:00 PM Pacific Time.From 2017-06-30 to present: This data set is no longer available.
  • customer_profile_by_revenueFrom 2015-10-01 to 2017-06-29: Available daily by 5:00 PM Pacific Time.From 2017-06-30 to present: This data set is no longer available.
  • customer_profile_by_geographyFrom 2015-10-01 to 2017-06-29: Available daily by 5:00 PM Pacific Time.From 2017-06-30 to present: This data set is no longer available.
  • sales_compensation_billed_revenueFrom 2016-12 to 2017-06: Available monthly on the 4th day of the month by 5:00pm Pacific Time. 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 5:00pm Pacific Time. 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_recordsFrom 2017-02-15 to present: Available monthly on the 15th day of the month by 5:00 PM Pacific Time.
Required?False
Position?Named
Accept pipeline input?False
-DestinationS3BucketName <String>
The name (friendly name, not ARN) of the destination S3 bucket.
Required?False
Position?2
Accept pipeline input?False
-DestinationS3Prefix <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.
Required?False
Position?Named
Accept pipeline input?False
-RoleNameArn <String>
The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services.
Required?False
Position?3
Accept pipeline input?False
-SnsTopicArn <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.
Required?False
Position?4
Accept pipeline input?False

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-ProfileLocation <String>

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)

If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.

As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

Required? False
Position? Named
Accept pipeline input? False
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required? False
Position? Named
Accept pipeline input? False
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required? False
Position? Named
Accept pipeline input? False
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-EndpointUrl <String>

The endpoint to make the call against.

Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Required? False
Position? Named
Accept pipeline input? False

Inputs

This cmdlet does not accept pipeline input.

Outputs

This cmdlet returns a String object. The service call response (type Amazon.AWSMarketplaceCommerceAnalytics.Model.GenerateDataSetResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z