Interface MarketplaceReportingAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface MarketplaceReportingAsyncClient extends AwsClient
Service client for accessing AWS Marketplace Reporting Service asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

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 Details

  • Method Details

    • getBuyerDashboard

      default CompletableFuture<GetBuyerDashboardResponse> getBuyerDashboard(GetBuyerDashboardRequest getBuyerDashboardRequest)

      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:
      A Java Future containing the result of the GetBuyerDashboard operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException The operation failed due to a server error.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • BadRequestException The request is malformed, or it contains an error such as an invalid parameter. Ensure the request has all required parameters.
      • UnauthorizedException You do not have permission to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MarketplaceReportingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBuyerDashboard

      default CompletableFuture<GetBuyerDashboardResponse> getBuyerDashboard(Consumer<GetBuyerDashboardRequest.Builder> getBuyerDashboardRequest)

      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:
      A Java Future containing the result of the GetBuyerDashboard operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException The operation failed due to a server error.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • BadRequestException The request is malformed, or it contains an error such as an invalid parameter. Ensure the request has all required parameters.
      • UnauthorizedException You do not have permission to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MarketplaceReportingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • 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

    • create

      static MarketplaceReportingAsyncClient create()
      Create a MarketplaceReportingAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static MarketplaceReportingAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a MarketplaceReportingAsyncClient.