Interface MarketplaceCommerceAnalyticsClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface MarketplaceCommerceAnalyticsClient
extends AwsClient
Service client for accessing AWS Marketplace Commerce Analytics. This can be created using the static
builder()
method.
Provides AWS Marketplace business intelligence data on-demand.-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aMarketplaceCommerceAnalyticsClient
.create()
Create aMarketplaceCommerceAnalyticsClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default GenerateDataSetResponse
generateDataSet
(Consumer<GenerateDataSetRequest.Builder> generateDataSetRequest) 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.default GenerateDataSetResponse
generateDataSet
(GenerateDataSetRequest generateDataSetRequest) 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.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default StartSupportDataExportResponse
startSupportDataExport
(Consumer<StartSupportDataExportRequest.Builder> startSupportDataExportRequest) Deprecated.This target has been deprecated.default StartSupportDataExportResponse
startSupportDataExport
(StartSupportDataExportRequest startSupportDataExportRequest) Deprecated.This target has been deprecated.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
generateDataSet
default GenerateDataSetResponse generateDataSet(GenerateDataSetRequest generateDataSetRequest) throws MarketplaceCommerceAnalyticsServiceException, AwsServiceException, SdkClientException, MarketplaceCommerceAnalyticsException 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:
generateDataSetRequest
- Container for the parameters to the GenerateDataSet operation.- Returns:
- Result of the GenerateDataSet operation returned by the service.
- See Also:
-
generateDataSet
default GenerateDataSetResponse generateDataSet(Consumer<GenerateDataSetRequest.Builder> generateDataSetRequest) throws MarketplaceCommerceAnalyticsServiceException, AwsServiceException, SdkClientException, MarketplaceCommerceAnalyticsException 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.
This is a convenience which creates an instance of the
GenerateDataSetRequest.Builder
avoiding the need to create one manually viaGenerateDataSetRequest.builder()
- Parameters:
generateDataSetRequest
- AConsumer
that will call methods onGenerateDataSetRequest.Builder
to create a request. Container for the parameters to the GenerateDataSet operation.- Returns:
- Result of the GenerateDataSet operation returned by the service.
- See Also:
-
startSupportDataExport
@Deprecated default StartSupportDataExportResponse startSupportDataExport(StartSupportDataExportRequest startSupportDataExportRequest) throws MarketplaceCommerceAnalyticsServiceException, AwsServiceException, SdkClientException, MarketplaceCommerceAnalyticsException Deprecated.This target has been deprecated. As of December 2022 Product Support Connection is no longer supported.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.- Parameters:
startSupportDataExportRequest
- This target has been deprecated.- Returns:
- Result of the StartSupportDataExport operation returned by the service.
- See Also:
-
startSupportDataExport
@Deprecated default StartSupportDataExportResponse startSupportDataExport(Consumer<StartSupportDataExportRequest.Builder> startSupportDataExportRequest) throws MarketplaceCommerceAnalyticsServiceException, AwsServiceException, SdkClientException, MarketplaceCommerceAnalyticsException Deprecated.This target has been deprecated. As of December 2022 Product Support Connection is no longer supported.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.
This is a convenience which creates an instance of the
StartSupportDataExportRequest.Builder
avoiding the need to create one manually viaStartSupportDataExportRequest.builder()
- Parameters:
startSupportDataExportRequest
- AConsumer
that will call methods onStartSupportDataExportRequest.Builder
to create a request. This target has been deprecated.- Returns:
- Result of the StartSupportDataExport operation returned by the service.
- See Also:
-
create
Create aMarketplaceCommerceAnalyticsClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aMarketplaceCommerceAnalyticsClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-