{ "smithy": "2.0", "shapes": { "com.amazonaws.marketplacereporting#AWSMarketplaceReporting": { "type": "service", "version": "2018-05-10", "resources": [ { "target": "com.amazonaws.marketplacereporting#Dashboard" } ], "traits": { "aws.api#service": { "sdkId": "Marketplace Reporting", "cloudTrailEventSource": "reporting-marketplace.amazonaws.com", "arnNamespace": "aws-marketplace", "endpointPrefix": "reporting-marketplace" }, "aws.auth#sigv4": { "name": "aws-marketplace" }, "aws.protocols#restJson1": {}, "smithy.api#cors": { "additionalExposedHeaders": [ "x-amzn-requestid", "x-amzn-errortype", "x-amzn-errormessage", "date" ] }, "smithy.api#documentation": "
The Amazon Web Services Marketplace GetBuyerDashboard API enables you to get a procurement insights\n dashboard programmatically. The API gets the agreement and cost analysis dashboards with\n 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:
\nEnable all features for your organization. For more information, see Enabling all features for an organization with Organizations, in the\n Organizations User Guide.
\nCall the service as the Organizations management account or an account registered\n as a delegated administrator for the procurement insights service.
\nFor more information about management accounts, see Tutorial:\n Creating and configuring an organization and Managing the management account with Organizations, both in the\n Organizations User Guide.
\nFor more information about delegated administrators, see Using\n delegated administrators, in the Amazon Web Services Marketplace Buyer\n Guide.
\nCreate an IAM policy that enables the\n aws-marketplace:GetBuyerDashboard and\n organizations:DescribeOrganization permissions. In addition,\n the management account requires the\n organizations:EnableAWSServiceAccess and\n iam:CreateServiceLinkedRole permissions to create. For more\n information about creating the policy, see Policies and permissions in\n Identity and Access Management, in the IAM User Guide.
Access can be shared only by registering the desired linked account as a\n delegated administrator. That requires\n organizations:RegisterDelegatedAdministrator\n organizations:ListDelegatedAdministrators and\n organizations:DeregisterDelegatedAdministrator\n permissions.
Use the Amazon Web Services Marketplace console to create the\n AWSServiceRoleForProcurementInsightsPolicy service-linked role.\n The role enables Amazon Web Services Marketplace procurement visibility integration. The management\n account requires an IAM policy with the\n organizations:EnableAWSServiceAccess and\n iam:CreateServiceLinkedRole permissions to create the\n service-linked role and enable the service access. For more information, see\n Granting access to\n Organizations and Service-linked role to share procurement data in the\n Amazon Web Services Marketplace Buyer Guide.
After creating the service-linked role, you must enable trusted access that\n grants Amazon Web Services Marketplace permission to access data from your Organizations. For more information,\n see Granting access to\n Organizations in the Amazon Web Services Marketplace Buyer Guide.
\nYou do not have sufficient access to perform this action.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.marketplacereporting#BadRequestException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "The request is malformed, or it contains an error such as an invalid parameter. Ensure the request has all required parameters.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.marketplacereporting#Dashboard": { "type": "resource", "identifiers": { "dashboardIdentifier": { "target": "com.amazonaws.marketplacereporting#DashboardIdentifier" } }, "operations": [ { "target": "com.amazonaws.marketplacereporting#GetBuyerDashboard" } ], "traits": { "aws.api#arn": { "template": "{dashboardIdentifier}", "absolute": true, "noRegion": true } } }, "com.amazonaws.marketplacereporting#DashboardIdentifier": { "type": "string", "traits": { "aws.api#arnReference": { "service": "com.amazonaws.marketplacereporting#AWSMarketplaceReporting", "resource": "com.amazonaws.marketplacereporting#Dashboard", "type": "AWS::Service::Resource" }, "smithy.api#length": { "min": 1, "max": 1023 }, "smithy.api#pattern": "^arn:aws:aws-marketplace::[0-9]{12}:AWSMarketplace/ReportingData/(Agreement_V1/Dashboard/AgreementSummary_V1|BillingEvent_V1/Dashboard/CostAnalysis_V1)$" } }, "com.amazonaws.marketplacereporting#EmbeddingDomain": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2000 }, "smithy.api#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})?)$" } }, "com.amazonaws.marketplacereporting#EmbeddingDomains": { "type": "list", "member": { "target": "com.amazonaws.marketplacereporting#EmbeddingDomain" }, "traits": { "smithy.api#length": { "min": 1, "max": 2 } } }, "com.amazonaws.marketplacereporting#GetBuyerDashboard": { "type": "operation", "input": { "target": "com.amazonaws.marketplacereporting#GetBuyerDashboardInput" }, "output": { "target": "com.amazonaws.marketplacereporting#GetBuyerDashboardOutput" }, "errors": [ { "target": "com.amazonaws.marketplacereporting#AccessDeniedException" }, { "target": "com.amazonaws.marketplacereporting#BadRequestException" }, { "target": "com.amazonaws.marketplacereporting#InternalServerException" }, { "target": "com.amazonaws.marketplacereporting#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Generates an embedding URL for an Amazon QuickSight dashboard for an anonymous user.
\nThis API is available only to Amazon Web Services Organization management accounts or\n delegated administrators registered for the procurement insights\n (procurement-insights.marketplace.amazonaws.com) feature.
The following rules apply to a generated URL:
\nIt contains a temporary bearer token, valid for 5 minutes after it is generated. Once redeemed within that period, it cannot be re-used again.
\nIt has a session lifetime of one hour. The 5-minute validity period runs separately from the session lifetime.
\nThe ARN of the requested dashboard.
", "smithy.api#required": {} } }, "embeddingDomains": { "target": "com.amazonaws.marketplacereporting#EmbeddingDomains", "traits": { "smithy.api#documentation": "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.\n To include all subdomains under a specific domain, use *. For example, https://*.amazon.com includes all subdomains under \n https://aws.amazon.com.
The dashboard's embedding URL.
", "smithy.api#required": {} } }, "dashboardIdentifier": { "target": "com.amazonaws.marketplacereporting#DashboardIdentifier", "traits": { "smithy.api#documentation": "The ARN of the returned dashboard.
", "smithy.api#required": {} } }, "embeddingDomains": { "target": "com.amazonaws.marketplacereporting#EmbeddingDomains", "traits": { "smithy.api#documentation": "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.\n To include all subdomains under a specific domain, use *. For example, https://*.amazon.com includes all subdomains under \n https://aws.amazon.com.
The operation failed due to a server error.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.marketplacereporting#UnauthorizedException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "You do not have permission to perform this action.
", "smithy.api#error": "client", "smithy.api#httpError": 401 } } } }