AWS Marketplace Reporting Service
The Amazon Web Services Marketplace GetBuyerDashboard API enables you to get a procurement insights dashboard programmatically. The API gets the agreement and…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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 .
Endpoints 1
Dashboard
- POSTGet buyer dashboard
/getBuyerDashboardGenerates an embedding URL for an Amazon QuickSight dashboard for an anonymous user. This API is available only to Amazon Web Services Organization management…
API details
- Base URL
https://reporting-marketplace.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 1 operation on 1 pathPOST 1
- Main resources
- Dashboard 1
- Description format
- AWS Smithy model, API version
2018-05-10 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS Marketplace Reporting Service in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Marketplace Reporting Service collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get buyer dashboard” (POST /getBuyerDashboard), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS Marketplace Reporting Service?
The Amazon Web Services Marketplace GetBuyerDashboard API enables you to get a procurement insights dashboard programmatically. The API gets the agreement and… It is listed under E-commerce and has 1 endpoint.
Who publishes the AWS Marketplace Reporting Service?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS Marketplace Reporting Service?
Requests go to https://reporting-marketplace.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS Marketplace Reporting Service?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS Marketplace Reporting Service have?
1 operation on 1 path (1 POST). The largest groups are Dashboard.
Is forking the AWS Marketplace Reporting Service free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.