Interface MarketplaceReportingClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface MarketplaceReportingClient
extends AwsClient

Service client for accessing AWS Marketplace Reporting Service. This can be created using the static builder() method.

The Amazon Web Services Marketplace GetBuyerDashboard API enables you to get a procurement insights dashboard programmatically. The API gets the agreement and cost analysis dashboards with data for all of the Amazon Web Services accounts in your Amazon Web Services Organization.

To use the Amazon Web Services Marketplace Reporting API, you must complete the following prerequisites:

• Enable all features for your organization. For more information, see Enabling all features for an organization with Organizations, in the Organizations User Guide.

• Call the service as the Organizations management account or an account registered as a delegated administrator for the procurement insights service.

  For more information about management accounts, see Tutorial: Creating and configuring an organization and Managing the management account with Organizations, both in the Organizations User Guide.

  For more information about delegated administrators, see Using delegated administrators, in the Amazon Web Services Marketplace Buyer Guide.

• Create an IAM policy that enables the aws-marketplace:GetBuyerDashboard and organizations:DescribeOrganization permissions. In addition, the management account requires the organizations:EnableAWSServiceAccess and iam:CreateServiceLinkedRole permissions to create. For more information about creating the policy, see Policies and permissions in Identity and Access Management, in the IAM User Guide.

  Access can be shared only by registering the desired linked account as a delegated administrator. That requires organizations:RegisterDelegatedAdministrator organizations:ListDelegatedAdministrators and organizations:DeregisterDelegatedAdministrator permissions.

• Use the Amazon Web Services Marketplace console to create the AWSServiceRoleForProcurementInsightsPolicy service-linked role. The role enables Amazon Web Services Marketplace procurement visibility integration. The management account requires an IAM policy with the organizations:EnableAWSServiceAccess and iam:CreateServiceLinkedRole permissions to create the service-linked role and enable the service access. For more information, see Granting access to Organizations and Service-linked role to share procurement data in the Amazon Web Services Marketplace Buyer Guide.

• After creating the service-linked role, you must enable trusted access that grants Amazon Web Services Marketplace permission to access data from your Organizations. For more information, see Granting access to Organizations in the Amazon Web Services Marketplace Buyer Guide.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static MarketplaceReportingClientBuilder	builder()	Create a builder that can be used to configure and create a MarketplaceReportingClient.
static MarketplaceReportingClient	create()	Create a MarketplaceReportingClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default GetBuyerDashboardResponse	getBuyerDashboard(Consumer<GetBuyerDashboardRequest.Builder> getBuyerDashboardRequest)	Generates an embedding URL for an Amazon QuickSight dashboard for an anonymous user.
default GetBuyerDashboardResponse	getBuyerDashboard(GetBuyerDashboardRequest getBuyerDashboardRequest)	Generates an embedding URL for an Amazon QuickSight dashboard for an anonymous user.
default MarketplaceReportingServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

getBuyerDashboard

default GetBuyerDashboardResponse getBuyerDashboard(GetBuyerDashboardRequest getBuyerDashboardRequest)
                                             throws InternalServerException,
AccessDeniedException,
BadRequestException,
UnauthorizedException,
AwsServiceException,
SdkClientException,
MarketplaceReportingException

Generates an embedding URL for an Amazon QuickSight dashboard for an anonymous user.

This API is available only to Amazon Web Services Organization management accounts or delegated administrators registered for the procurement insights (procurement-insights.marketplace.amazonaws.com) feature.

The following rules apply to a generated URL:

• It contains a temporary bearer token, valid for 5 minutes after it is generated. Once redeemed within that period, it cannot be re-used again.

• It has a session lifetime of one hour. The 5-minute validity period runs separately from the session lifetime.

Parameters:

getBuyerDashboardRequest -

Returns:

Result of the GetBuyerDashboard operation returned by the service.

See Also:

• AWS API Documentation

getBuyerDashboard

default GetBuyerDashboardResponse getBuyerDashboard(Consumer<GetBuyerDashboardRequest.Builder> getBuyerDashboardRequest)
                                             throws InternalServerException,
AccessDeniedException,
BadRequestException,
UnauthorizedException,
AwsServiceException,
SdkClientException,
MarketplaceReportingException

Generates an embedding URL for an Amazon QuickSight dashboard for an anonymous user.

This API is available only to Amazon Web Services Organization management accounts or delegated administrators registered for the procurement insights (procurement-insights.marketplace.amazonaws.com) feature.

The following rules apply to a generated URL:

• It contains a temporary bearer token, valid for 5 minutes after it is generated. Once redeemed within that period, it cannot be re-used again.

• It has a session lifetime of one hour. The 5-minute validity period runs separately from the session lifetime.

This is a convenience which creates an instance of the GetBuyerDashboardRequest.Builder avoiding the need to create one manually via GetBuyerDashboardRequest.builder()

Parameters:

getBuyerDashboardRequest - A Consumer that will call methods on GetBuyerDashboardRequest.Builder to create a request.

Returns:

Result of the GetBuyerDashboard operation returned by the service.

See Also:

• AWS API Documentation

create

static MarketplaceReportingClient create()

Create a MarketplaceReportingClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static MarketplaceReportingClientBuilder builder()

Create a builder that can be used to configure and create a MarketplaceReportingClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default MarketplaceReportingServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration