SDK for PHP 3.x

AWS Marketplace Reporting Service 2018-05-10

Client: Aws\MarketplaceReporting\MarketplaceReportingClient
Service ID: marketplace-reporting
Version: 2018-05-10

This page describes the parameters and results for the operations of the AWS Marketplace Reporting Service (2018-05-10), and shows how to use the Aws\MarketplaceReporting\MarketplaceReportingClient object to call the described operations. This documentation is specific to the 2018-05-10 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

GetBuyerDashboard ( array $params = [] )
Generates an embedding URL for an Amazon QuickSight dashboard for an anonymous user.

Operations

GetBuyerDashboard 

$result = $client->getBuyerDashboard([/* ... */]);
$promise = $client->getBuyerDashboardAsync([/* ... */]);

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

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.

Parameter Syntax

$result = $client->getBuyerDashboard([
    'dashboardIdentifier' => '<string>', // REQUIRED
    'embeddingDomains' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
dashboardIdentifier
Required: Yes
Type: string

The ARN of the requested dashboard.

embeddingDomains
Required: Yes
Type: Array of strings

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.

Result Syntax

[
    'dashboardIdentifier' => '<string>',
    'embedUrl' => '<string>',
    'embeddingDomains' => ['<string>', ...],
]

Result Details

Members
dashboardIdentifier
Required: Yes
Type: string

The ARN of the returned dashboard.

embedUrl
Required: Yes
Type: string

The dashboard's embedding URL.

embeddingDomains
Required: Yes
Type: Array of strings

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.

Errors

InternalServerException:

The operation failed due to a server error.

AccessDeniedException:

You do not have sufficient access to perform this action.

BadRequestException:

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

UnauthorizedException:

You do not have permission to perform this action.

Examples

Example 1: Getting an agreements dashboard

The following example shows how to obtain a dashboard for active agreements

$result = $client->getBuyerDashboard([
    'dashboardIdentifier' => 'arn:aws:aws-marketplace::123456789012:AWSMarketplace/ReportingData/Agreement_V1/Dashboard/AgreementSummary_V1',
    'embeddingDomains' => [
        'https://*.amazon.com',
    ],
]);

Result syntax:

[
    'dashboardIdentifier' => 'arn:aws:aws-marketplace::123456789012:AWSMarketplace/ReportingData/Agreement_V1/Dashboard/AgreementSummary_V1',
    'embedUrl' => 'https://us-east-1.quicksight.aws.amazon.com/embed/1235asdbffffbbasdf123/dashboards/8a66afa6-f316-4e71-a1ed-0a5bea07a314?code=abcdefghijklmn&identityprovider=quicksight&isauthcode=true',
    'embeddingDomains' => [
        'https://*.amazon.com',
    ],
]
Example 2: Getting a cost-analysis dashboard

The following example shows how to obtain a dashboard for cost analysis

$result = $client->getBuyerDashboard([
    'dashboardIdentifier' => 'arn:aws:aws-marketplace::123456789012:AWSMarketplace/ReportingData/BillingEvent_V1/Dashboard/CostAnalysis_V1',
    'embeddingDomains' => [
        'https://*.amazon.com',
    ],
]);

Result syntax:

[
    'dashboardIdentifier' => 'arn:aws:aws-marketplace::123456789012:AWSMarketplace/ReportingData/BillingEvent_V1/Dashboard/CostAnalysis_V1',
    'embedUrl' => 'https://us-east-1.quicksight.aws.amazon.com/embed/1235asdbffffbbasdf123/dashboards/8a66afa6-f316-4e71-a1ed-0a5bea07a314?code=abcdefghijklmn&identityprovider=quicksight&isauthcode=true',
    'embeddingDomains' => [
        'https://*.amazon.com',
    ],
]

Shapes

AccessDeniedException

Description

You do not have sufficient access to perform this action.

Members
message
Type: string

BadRequestException

Description

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

Members
message
Type: string

InternalServerException

Description

The operation failed due to a server error.

Members
message
Type: string

UnauthorizedException

Description

You do not have permission to perform this action.

Members
message
Type: string