Skip to main content

data_sets

Creates, updates, deletes, gets or lists a data_sets resource.

Overview​

Namedata_sets
TypeResource
Idaws.marketplacecommerceanalytics.data_sets

Fields​

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
generate_data_setexecregion, dataSetType, dataSetPublicationDate, roleNameArn, destinationS3BucketName, snsTopicArnGiven 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​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

Lifecycle Methods​

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.

EXEC aws.marketplacecommerceanalytics.data_sets.generate_data_set
@region='{{ region }}' --required
@@json=
'{
"dataSetType": "{{ dataSetType }}",
"dataSetPublicationDate": "{{ dataSetPublicationDate }}",
"roleNameArn": "{{ roleNameArn }}",
"destinationS3BucketName": "{{ destinationS3BucketName }}",
"destinationS3Prefix": "{{ destinationS3Prefix }}",
"snsTopicArn": "{{ snsTopicArn }}",
"customerDefinedValues": "{{ customerDefinedValues }}"
}'
;