GenerateDataSetRequest

import type { GenerateDataSetRequest } from "https://aws-api.deno.dev/v0.4/services/marketplacecommerceanalytics.ts?docs=full";

Container for the parameters to the GenerateDataSet operation.

interface GenerateDataSetRequest {

customerDefinedValues?: {

[key: string]: string | null | undefined;

} | null;

dataSetPublicationDate: Date | number;

dataSetType: DataSetType;

destinationS3BucketName: string;

destinationS3Prefix?: string | null;

roleNameArn: string;

snsTopicArn: string;

}

§Properties

customerDefinedValues?: {

[key: string]: string | null | undefined;

} | null

[src]

(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.

dataSetPublicationDate: Date | number

[src]

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

dataSetType: DataSetType

[src]

TODO: Failed to render documentation: unhandled top level doc tag strong

destinationS3BucketName: string

[src]

The name (friendly name, not ARN) of the destination S3 bucket.

destinationS3Prefix?: string | null

[src]

(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.

roleNameArn: string

[src]

The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services.

snsTopicArn: string

[src]

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.