marketplacecommerceanalytics/aws.sdk.kotlin.services.marketplacecommerceanalytics/MarketplaceCommerceAnalyticsClient

MarketplaceCommerceAnalyticsClient

interface MarketplaceCommerceAnalyticsClient : SdkClient

Provides AWS Marketplace business intelligence data on-demand.

Properties

Link copied to clipboard
abstract override val config: MarketplaceCommerceAnalyticsClient.Config

MarketplaceCommerceAnalyticsClient's configuration

Functions

Link copied to clipboard
abstract suspend fun generateDataSet(input: GenerateDataSetRequest): GenerateDataSetResponse

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.

Link copied to clipboard
abstract suspend fun startSupportDataExport(input: StartSupportDataExportRequest): StartSupportDataExportResponse

This target has been deprecated. 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.

Inherited functions

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard
inline suspend fun MarketplaceCommerceAnalyticsClient.generateDataSet(crossinline block: GenerateDataSetRequest.Builder.() -> Unit): GenerateDataSetResponse

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.

Link copied to clipboard
inline suspend fun MarketplaceCommerceAnalyticsClient.startSupportDataExport(crossinline block: StartSupportDataExportRequest.Builder.() -> Unit): StartSupportDataExportResponse

This target has been deprecated. 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.

Link copied to clipboard
fun MarketplaceCommerceAnalyticsClient.withConfig(block: MarketplaceCommerceAnalyticsClient.Config.Builder.() -> Unit): MarketplaceCommerceAnalyticsClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.