MarketplaceReportingService / Client / get_buyer_dashboard

get_buyer_dashboard#

MarketplaceReportingService.Client.get_buyer_dashboard(**kwargs)#

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

Note

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.

See also: AWS API Documentation

Request Syntax

response = client.get_buyer_dashboard(
    dashboardIdentifier='string',
    embeddingDomains=[
        'string',
    ]
)
Parameters:

  • dashboardIdentifier (string) –

    [REQUIRED]

    The ARN of the requested dashboard.

  • embeddingDomains (list) –

    [REQUIRED]

    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.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'embedUrl': 'string',
    'dashboardIdentifier': 'string',
    'embeddingDomains': [
        'string',
    ]
}

Response Structure

  • (dict) –

    • embedUrl (string) –

      The dashboard’s embedding URL.

    • dashboardIdentifier (string) –

      The ARN of the returned dashboard.

    • embeddingDomains (list) –

      The fully qualified domains specified in the request. The domains enable 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.

      • (string) –

Exceptions

  • MarketplaceReportingService.Client.exceptions.InternalServerException

  • MarketplaceReportingService.Client.exceptions.AccessDeniedException

  • MarketplaceReportingService.Client.exceptions.BadRequestException

  • MarketplaceReportingService.Client.exceptions.UnauthorizedException