getBuyerDashboard method

Future<GetBuyerDashboardOutput> getBuyerDashboard({
  1. required String dashboardIdentifier,
  2. required List<String> embeddingDomains,
})

Generates an embedding URL for an Amazon QuickSight dashboard for an anonymous user. 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.

May throw AccessDeniedException. May throw BadRequestException. May throw InternalServerException. May throw UnauthorizedException.

Parameter dashboardIdentifier : The ARN of the requested dashboard.

Parameter embeddingDomains : Fully qualified domains that you add to the allow list for access to the generated URL that is then embedded. You can list up to two domains or subdomains in each API call. To include all subdomains under a specific domain, use . For example, https://.amazon.com includes all subdomains under https://aws.amazon.com.

Implementation

Future<GetBuyerDashboardOutput> getBuyerDashboard({
  required String dashboardIdentifier,
  required List<String> embeddingDomains,
}) async {
  final $payload = <String, dynamic>{
    'dashboardIdentifier': dashboardIdentifier,
    'embeddingDomains': embeddingDomains,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/getBuyerDashboard',
    exceptionFnMap: _exceptionFns,
  );
  return GetBuyerDashboardOutput.fromJson(response);
}