buyer_dashboards
Creates, updates, deletes, gets or lists a buyer_dashboards resource.
Overview
| Name | buyer_dashboards |
| Type | Resource |
| Id | aws.marketplace_reporting.buyer_dashboards |
Fields
The following fields are returned by SELECT queries:
- get_buyer_dashboard
| Name | Datatype | Description |
|---|---|---|
dashboard_identifier | string | The ARN of the returned dashboard. (pattern: <code>arn:aws:aws-marketplace::[0-9]{12}:AWSMarketplace/ReportingData/(Agreement_V1/Dashboard/AgreementSummary_V1|BillingEvent_V1/Dashboard/CostAnalysis_V1)</code>) |
embed_url | string | The dashboard's embedding URL. |
embedding_domains | array | 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. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_buyer_dashboard | select | region | 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
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_buyer_dashboard
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.
SELECT
dashboard_identifier,
embed_url,
embedding_domains
FROM aws.marketplace_reporting.buyer_dashboards
WHERE region = '{{ region }}' -- required
;