Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetBuyerDashboard

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

Note

This API is available only to AWS 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.

Request Syntax


POST /getBuyerDashboard HTTP/1.1
Content-type: application/json

{
   "dashboardIdentifier": "string",
   "embeddingDomains": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

dashboardIdentifier

The ARN of the requested dashboard.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1023.

Pattern: arn:aws:aws-marketplace::[0-9]{12}:AWSMarketplace/ReportingData/(Agreement_V1/Dashboard/AgreementSummary_V1|BillingEvent_V1/Dashboard/CostAnalysis_V1)

Required: Yes

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.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 2 items.

Length Constraints: Minimum length of 1. Maximum length of 2000.

Pattern: (https://[a-zA-Z\.\*0-9\-_]+[\.]{1}[a-zA-Z]{1,}[a-zA-Z0-9&?/-_=]*[a-zA-Z\*0-9/]+|http[s]*://localhost(:[0-9]{1,5})?)

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

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

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

dashboardIdentifier

The ARN of the returned dashboard.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1023.

Pattern: arn:aws:aws-marketplace::[0-9]{12}:AWSMarketplace/ReportingData/(Agreement_V1/Dashboard/AgreementSummary_V1|BillingEvent_V1/Dashboard/CostAnalysis_V1)

embeddingDomains

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.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 2 items.

Length Constraints: Minimum length of 1. Maximum length of 2000.

Pattern: (https://[a-zA-Z\.\*0-9\-_]+[\.]{1}[a-zA-Z]{1,}[a-zA-Z0-9&?/-_=]*[a-zA-Z\*0-9/]+|http[s]*://localhost(:[0-9]{1,5})?)

embedUrl

The dashboard's embedding URL.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

BadRequestException

The request is malformed, or it contains an error such as an invalid parameter. Ensure the request has all required parameters.

HTTP Status Code: 400

InternalServerException

The operation failed due to a server error.

HTTP Status Code: 500

UnauthorizedException

You do not have permission to perform this action.

HTTP Status Code: 401