@aws-sdk/client-marketplace-reporting 3.664.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (83) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +248 -0
  3. package/dist-cjs/MarketplaceReporting.js +13 -0
  4. package/dist-cjs/MarketplaceReportingClient.js +50 -0
  5. package/dist-cjs/auth/httpAuthExtensionConfiguration.js +43 -0
  6. package/dist-cjs/auth/httpAuthSchemeProvider.js +47 -0
  7. package/dist-cjs/commands/GetBuyerDashboardCommand.js +26 -0
  8. package/dist-cjs/commands/index.js +4 -0
  9. package/dist-cjs/endpoint/EndpointParameters.js +18 -0
  10. package/dist-cjs/endpoint/endpointResolver.js +18 -0
  11. package/dist-cjs/endpoint/ruleset.js +7 -0
  12. package/dist-cjs/extensionConfiguration.js +2 -0
  13. package/dist-cjs/index.js +10 -0
  14. package/dist-cjs/models/MarketplaceReportingServiceException.js +12 -0
  15. package/dist-cjs/models/index.js +4 -0
  16. package/dist-cjs/models/models_0.js +56 -0
  17. package/dist-cjs/protocols/Aws_restJson1.js +128 -0
  18. package/dist-cjs/runtimeConfig.browser.js +39 -0
  19. package/dist-cjs/runtimeConfig.js +50 -0
  20. package/dist-cjs/runtimeConfig.native.js +15 -0
  21. package/dist-cjs/runtimeConfig.shared.js +34 -0
  22. package/dist-cjs/runtimeExtensions.js +25 -0
  23. package/dist-es/MarketplaceReporting.js +9 -0
  24. package/dist-es/MarketplaceReportingClient.js +46 -0
  25. package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
  26. package/dist-es/auth/httpAuthSchemeProvider.js +41 -0
  27. package/dist-es/commands/GetBuyerDashboardCommand.js +22 -0
  28. package/dist-es/commands/index.js +1 -0
  29. package/dist-es/endpoint/EndpointParameters.js +14 -0
  30. package/dist-es/endpoint/endpointResolver.js +14 -0
  31. package/dist-es/endpoint/ruleset.js +4 -0
  32. package/dist-es/extensionConfiguration.js +1 -0
  33. package/dist-es/index.js +5 -0
  34. package/dist-es/models/MarketplaceReportingServiceException.js +8 -0
  35. package/dist-es/models/index.js +1 -0
  36. package/dist-es/models/models_0.js +49 -0
  37. package/dist-es/protocols/Aws_restJson1.js +123 -0
  38. package/dist-es/runtimeConfig.browser.js +34 -0
  39. package/dist-es/runtimeConfig.js +45 -0
  40. package/dist-es/runtimeConfig.native.js +11 -0
  41. package/dist-es/runtimeConfig.shared.js +30 -0
  42. package/dist-es/runtimeExtensions.js +21 -0
  43. package/dist-types/MarketplaceReporting.d.ts +52 -0
  44. package/dist-types/MarketplaceReportingClient.d.ts +205 -0
  45. package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
  46. package/dist-types/auth/httpAuthSchemeProvider.d.ts +61 -0
  47. package/dist-types/commands/GetBuyerDashboardCommand.d.ts +145 -0
  48. package/dist-types/commands/index.d.ts +1 -0
  49. package/dist-types/endpoint/EndpointParameters.d.ts +40 -0
  50. package/dist-types/endpoint/endpointResolver.d.ts +5 -0
  51. package/dist-types/endpoint/ruleset.d.ts +2 -0
  52. package/dist-types/extensionConfiguration.d.ts +9 -0
  53. package/dist-types/index.d.ts +48 -0
  54. package/dist-types/models/MarketplaceReportingServiceException.d.ts +14 -0
  55. package/dist-types/models/index.d.ts +1 -0
  56. package/dist-types/models/models_0.d.ts +89 -0
  57. package/dist-types/protocols/Aws_restJson1.d.ts +11 -0
  58. package/dist-types/runtimeConfig.browser.d.ts +48 -0
  59. package/dist-types/runtimeConfig.d.ts +48 -0
  60. package/dist-types/runtimeConfig.native.d.ts +47 -0
  61. package/dist-types/runtimeConfig.shared.d.ts +21 -0
  62. package/dist-types/runtimeExtensions.d.ts +17 -0
  63. package/dist-types/ts3.4/MarketplaceReporting.d.ts +24 -0
  64. package/dist-types/ts3.4/MarketplaceReportingClient.d.ts +125 -0
  65. package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
  66. package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +44 -0
  67. package/dist-types/ts3.4/commands/GetBuyerDashboardCommand.d.ts +46 -0
  68. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  69. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +51 -0
  70. package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
  71. package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
  72. package/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
  73. package/dist-types/ts3.4/index.d.ts +8 -0
  74. package/dist-types/ts3.4/models/MarketplaceReportingServiceException.d.ts +9 -0
  75. package/dist-types/ts3.4/models/index.d.ts +1 -0
  76. package/dist-types/ts3.4/models/models_0.d.ts +39 -0
  77. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +17 -0
  78. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +93 -0
  79. package/dist-types/ts3.4/runtimeConfig.d.ts +96 -0
  80. package/dist-types/ts3.4/runtimeConfig.native.d.ts +87 -0
  81. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +23 -0
  82. package/dist-types/ts3.4/runtimeExtensions.d.ts +13 -0
  83. package/package.json +101 -0
@@ -0,0 +1,61 @@
1
+ import { AwsSdkSigV4AuthInputConfig, AwsSdkSigV4AuthResolvedConfig, AwsSdkSigV4PreviouslyResolved } from "@aws-sdk/core";
2
+ import { HandlerExecutionContext, HttpAuthScheme, HttpAuthSchemeParameters, HttpAuthSchemeParametersProvider, HttpAuthSchemeProvider } from "@smithy/types";
3
+ import { MarketplaceReportingClientResolvedConfig } from "../MarketplaceReportingClient";
4
+ /**
5
+ * @internal
6
+ */
7
+ export interface MarketplaceReportingHttpAuthSchemeParameters extends HttpAuthSchemeParameters {
8
+ region?: string;
9
+ }
10
+ /**
11
+ * @internal
12
+ */
13
+ export interface MarketplaceReportingHttpAuthSchemeParametersProvider extends HttpAuthSchemeParametersProvider<MarketplaceReportingClientResolvedConfig, HandlerExecutionContext, MarketplaceReportingHttpAuthSchemeParameters, object> {
14
+ }
15
+ /**
16
+ * @internal
17
+ */
18
+ export declare const defaultMarketplaceReportingHttpAuthSchemeParametersProvider: (config: MarketplaceReportingClientResolvedConfig, context: HandlerExecutionContext, input: object) => Promise<MarketplaceReportingHttpAuthSchemeParameters>;
19
+ /**
20
+ * @internal
21
+ */
22
+ export interface MarketplaceReportingHttpAuthSchemeProvider extends HttpAuthSchemeProvider<MarketplaceReportingHttpAuthSchemeParameters> {
23
+ }
24
+ /**
25
+ * @internal
26
+ */
27
+ export declare const defaultMarketplaceReportingHttpAuthSchemeProvider: MarketplaceReportingHttpAuthSchemeProvider;
28
+ /**
29
+ * @internal
30
+ */
31
+ export interface HttpAuthSchemeInputConfig extends AwsSdkSigV4AuthInputConfig {
32
+ /**
33
+ * Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.
34
+ * @internal
35
+ */
36
+ httpAuthSchemes?: HttpAuthScheme[];
37
+ /**
38
+ * Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.
39
+ * @internal
40
+ */
41
+ httpAuthSchemeProvider?: MarketplaceReportingHttpAuthSchemeProvider;
42
+ }
43
+ /**
44
+ * @internal
45
+ */
46
+ export interface HttpAuthSchemeResolvedConfig extends AwsSdkSigV4AuthResolvedConfig {
47
+ /**
48
+ * Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.
49
+ * @internal
50
+ */
51
+ readonly httpAuthSchemes: HttpAuthScheme[];
52
+ /**
53
+ * Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.
54
+ * @internal
55
+ */
56
+ readonly httpAuthSchemeProvider: MarketplaceReportingHttpAuthSchemeProvider;
57
+ }
58
+ /**
59
+ * @internal
60
+ */
61
+ export declare const resolveHttpAuthSchemeConfig: <T>(config: T & HttpAuthSchemeInputConfig & AwsSdkSigV4PreviouslyResolved) => T & HttpAuthSchemeResolvedConfig;
@@ -0,0 +1,145 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { MarketplaceReportingClientResolvedConfig } from "../MarketplaceReportingClient";
4
+ import { GetBuyerDashboardInput, GetBuyerDashboardOutput } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetBuyerDashboardCommand}.
14
+ */
15
+ export interface GetBuyerDashboardCommandInput extends GetBuyerDashboardInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetBuyerDashboardCommand}.
21
+ */
22
+ export interface GetBuyerDashboardCommandOutput extends GetBuyerDashboardOutput, __MetadataBearer {
23
+ }
24
+ declare const GetBuyerDashboardCommand_base: {
25
+ new (input: GetBuyerDashboardCommandInput): import("@smithy/smithy-client").CommandImpl<GetBuyerDashboardCommandInput, GetBuyerDashboardCommandOutput, MarketplaceReportingClientResolvedConfig, GetBuyerDashboardCommandInput, GetBuyerDashboardCommandOutput>;
26
+ new (__0_0: GetBuyerDashboardCommandInput): import("@smithy/smithy-client").CommandImpl<GetBuyerDashboardCommandInput, GetBuyerDashboardCommandOutput, MarketplaceReportingClientResolvedConfig, GetBuyerDashboardCommandInput, GetBuyerDashboardCommandOutput>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Generates an embedding URL for an Amazon QuickSight dashboard for an anonymous user.</p>
31
+ * <p>The following rules apply to a generated URL:</p>
32
+ * <ul>
33
+ * <li>
34
+ * <p>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.</p>
35
+ * </li>
36
+ * <li>
37
+ * <p>It has a session lifetime of one hour. The 5-minute validity period runs separately from the session lifetime.</p>
38
+ * </li>
39
+ * </ul>
40
+ * @example
41
+ * Use a bare-bones client and the command you need to make an API call.
42
+ * ```javascript
43
+ * import { MarketplaceReportingClient, GetBuyerDashboardCommand } from "@aws-sdk/client-marketplace-reporting"; // ES Modules import
44
+ * // const { MarketplaceReportingClient, GetBuyerDashboardCommand } = require("@aws-sdk/client-marketplace-reporting"); // CommonJS import
45
+ * const client = new MarketplaceReportingClient(config);
46
+ * const input = { // GetBuyerDashboardInput
47
+ * dashboardIdentifier: "STRING_VALUE", // required
48
+ * embeddingDomains: [ // EmbeddingDomains // required
49
+ * "STRING_VALUE",
50
+ * ],
51
+ * };
52
+ * const command = new GetBuyerDashboardCommand(input);
53
+ * const response = await client.send(command);
54
+ * // { // GetBuyerDashboardOutput
55
+ * // embedUrl: "STRING_VALUE", // required
56
+ * // dashboardIdentifier: "STRING_VALUE", // required
57
+ * // embeddingDomains: [ // EmbeddingDomains // required
58
+ * // "STRING_VALUE",
59
+ * // ],
60
+ * // };
61
+ *
62
+ * ```
63
+ *
64
+ * @param GetBuyerDashboardCommandInput - {@link GetBuyerDashboardCommandInput}
65
+ * @returns {@link GetBuyerDashboardCommandOutput}
66
+ * @see {@link GetBuyerDashboardCommandInput} for command's `input` shape.
67
+ * @see {@link GetBuyerDashboardCommandOutput} for command's `response` shape.
68
+ * @see {@link MarketplaceReportingClientResolvedConfig | config} for MarketplaceReportingClient's `config` shape.
69
+ *
70
+ * @throws {@link AccessDeniedException} (client fault)
71
+ * <p>You do not have sufficient access to perform this action.</p>
72
+ *
73
+ * @throws {@link BadRequestException} (client fault)
74
+ * <p>The request is malformed, or it contains an error such as an invalid parameter. Ensure the request has all required parameters.</p>
75
+ *
76
+ * @throws {@link InternalServerException} (server fault)
77
+ * <p>The operation failed due to a server error.</p>
78
+ *
79
+ * @throws {@link UnauthorizedException} (client fault)
80
+ * <p>You do not have permission to perform this action.</p>
81
+ *
82
+ * @throws {@link MarketplaceReportingServiceException}
83
+ * <p>Base exception class for all service exceptions from MarketplaceReporting service.</p>
84
+ *
85
+ * @public
86
+ * @example Getting an agreements dashboard
87
+ * ```javascript
88
+ * // The following example shows how to obtain a dashboard for active agreements
89
+ * const input = {
90
+ * "dashboardIdentifier": "arn:aws:aws-marketplace::123456789012:AWSMarketplace/ReportingData/Agreement_V1/Dashboard/AgreementSummary_V1",
91
+ * "embeddingDomains": [
92
+ * "https://*.amazon.com"
93
+ * ]
94
+ * };
95
+ * const command = new GetBuyerDashboardCommand(input);
96
+ * const response = await client.send(command);
97
+ * /* response ==
98
+ * {
99
+ * "dashboardIdentifier": "arn:aws:aws-marketplace::123456789012:AWSMarketplace/ReportingData/Agreement_V1/Dashboard/AgreementSummary_V1",
100
+ * "embedUrl": "https://us-east-1.quicksight.aws.amazon.com/embed/1235asdbffffbbasdf123/dashboards/8a66afa6-f316-4e71-a1ed-0a5bea07a314?code=abcdefghijklmn&identityprovider=quicksight&isauthcode=true",
101
+ * "embeddingDomains": [
102
+ * "https://*.amazon.com"
103
+ * ]
104
+ * }
105
+ * *\/
106
+ * // example id: example-1
107
+ * ```
108
+ *
109
+ * @example Getting a cost-analysis dashboard
110
+ * ```javascript
111
+ * // The following example shows how to obtain a dashboard for cost analysis
112
+ * const input = {
113
+ * "dashboardIdentifier": "arn:aws:aws-marketplace::123456789012:AWSMarketplace/ReportingData/BillingEvent_V1/Dashboard/CostAnalysis_V1",
114
+ * "embeddingDomains": [
115
+ * "https://*.amazon.com"
116
+ * ]
117
+ * };
118
+ * const command = new GetBuyerDashboardCommand(input);
119
+ * const response = await client.send(command);
120
+ * /* response ==
121
+ * {
122
+ * "dashboardIdentifier": "arn:aws:aws-marketplace::123456789012:AWSMarketplace/ReportingData/BillingEvent_V1/Dashboard/CostAnalysis_V1",
123
+ * "embedUrl": "https://us-east-1.quicksight.aws.amazon.com/embed/1235asdbffffbbasdf123/dashboards/8a66afa6-f316-4e71-a1ed-0a5bea07a314?code=abcdefghijklmn&identityprovider=quicksight&isauthcode=true",
124
+ * "embeddingDomains": [
125
+ * "https://*.amazon.com"
126
+ * ]
127
+ * }
128
+ * *\/
129
+ * // example id: example-2
130
+ * ```
131
+ *
132
+ */
133
+ export declare class GetBuyerDashboardCommand extends GetBuyerDashboardCommand_base {
134
+ /** @internal type navigation helper, not in runtime. */
135
+ protected static __types: {
136
+ api: {
137
+ input: GetBuyerDashboardInput;
138
+ output: GetBuyerDashboardOutput;
139
+ };
140
+ sdk: {
141
+ input: GetBuyerDashboardCommandInput;
142
+ output: GetBuyerDashboardCommandOutput;
143
+ };
144
+ };
145
+ }
@@ -0,0 +1 @@
1
+ export * from "./GetBuyerDashboardCommand";
@@ -0,0 +1,40 @@
1
+ import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
2
+ /**
3
+ * @public
4
+ */
5
+ export interface ClientInputEndpointParameters {
6
+ region?: string | Provider<string>;
7
+ useDualstackEndpoint?: boolean | Provider<boolean>;
8
+ useFipsEndpoint?: boolean | Provider<boolean>;
9
+ endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
10
+ }
11
+ export type ClientResolvedEndpointParameters = ClientInputEndpointParameters & {
12
+ defaultSigningName: string;
13
+ };
14
+ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientInputEndpointParameters & {
15
+ defaultSigningName: string;
16
+ };
17
+ export declare const commonParams: {
18
+ readonly UseFIPS: {
19
+ readonly type: "builtInParams";
20
+ readonly name: "useFipsEndpoint";
21
+ };
22
+ readonly Endpoint: {
23
+ readonly type: "builtInParams";
24
+ readonly name: "endpoint";
25
+ };
26
+ readonly Region: {
27
+ readonly type: "builtInParams";
28
+ readonly name: "region";
29
+ };
30
+ readonly UseDualStack: {
31
+ readonly type: "builtInParams";
32
+ readonly name: "useDualstackEndpoint";
33
+ };
34
+ };
35
+ export interface EndpointParameters extends __EndpointParameters {
36
+ Region?: string;
37
+ UseDualStack?: boolean;
38
+ UseFIPS?: boolean;
39
+ Endpoint?: string;
40
+ }
@@ -0,0 +1,5 @@
1
+ import { EndpointV2, Logger } from "@smithy/types";
2
+ import { EndpointParameters } from "./EndpointParameters";
3
+ export declare const defaultEndpointResolver: (endpointParams: EndpointParameters, context?: {
4
+ logger?: Logger;
5
+ }) => EndpointV2;
@@ -0,0 +1,2 @@
1
+ import { RuleSetObject } from "@smithy/types";
2
+ export declare const ruleSet: RuleSetObject;
@@ -0,0 +1,9 @@
1
+ import { AwsRegionExtensionConfiguration } from "@aws-sdk/types";
2
+ import { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
3
+ import { DefaultExtensionConfiguration } from "@smithy/types";
4
+ import { HttpAuthExtensionConfiguration } from "./auth/httpAuthExtensionConfiguration";
5
+ /**
6
+ * @internal
7
+ */
8
+ export interface MarketplaceReportingExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, AwsRegionExtensionConfiguration, HttpAuthExtensionConfiguration {
9
+ }
@@ -0,0 +1,48 @@
1
+ /**
2
+ * <p>The AWS Marketplace <code>GetBuyerDashboard</code> API enables you to get a procurement insights dashboard
3
+ * 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. </p>
4
+ * <p>To use the API, you must complete the following prerequisites:</p>
5
+ * <ul>
6
+ * <li>
7
+ * <p>Enable all features for your organization. For more information, see
8
+ * <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html">Enabling all features for an organization with Amazon Web Services Organizations</a>,
9
+ * in the <i>Amazon Web Services Organizations User Guide</i>.</p>
10
+ * </li>
11
+ * <li>
12
+ * <p>Call the service as the Amazon Web Services Organizations management account or an account registered as a delegated administrator for the procurement insights service.
13
+ * Users without management or delegated administrator accounts can use the dashboard, but they only see data for their accounts.</p>
14
+ * <p>For more information about management accounts, see
15
+ * <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tutorials_basic.html">Tutorial: Creating and configuring an organization</a>
16
+ * and <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs-manage_accounts_management.html">Managing the management account with Amazon Web Services Organizations</a>,
17
+ * both in the <i>Amazon Web Services Organizations User Guide</i>.</p>
18
+ * <p>For more information about delegated administrators, see <a href="https://docs.aws.amazon.com/marketplace/latest/buyerguide/management-delegates.html">Using delegated administrators</a>,
19
+ * in the <i>AWS Marketplace Buyer Guide</i>.</p>
20
+ * </li>
21
+ * <li>
22
+ * <p>Create an IAM policy that enables the <code>aws-marketplace:GetBuyerDashboard</code> and <code>organizations:DescribeOrganization</code> permissions. In addition,
23
+ * the management account requires the <code>organizations:EnableAWSServiceAccess</code> and <code>iam:CreateServiceLinkedRole</code> permissions to create
24
+ * For more information about creating the policy, see
25
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html">Policies and permissions in Amazon Web Services Identity and Access Management</a>,
26
+ * in the <i>IAM User Guide</i>.</p>
27
+ * </li>
28
+ * <li>
29
+ * <p>Use the Amazon Web Services Marketplace console to create the <code>AWSServiceRoleForProcurementInsightsPolicy</code> service-linked role.
30
+ * The role enables AWS Marketplace procurement visibility integration. The management account requires an IAM policy with the <code>organizations:EnableAWSServiceAccess</code> and <code>iam:CreateServiceLinkedRole</code> permissions
31
+ * to create the service-linked role and enable the service access. For more information, see
32
+ * <a href="https://docs.aws.amazon.com/marketplace/latest/buyerguide/orgs-access-slr.html">Granting access to
33
+ * Amazon Web Services Organizations</a>, and
34
+ * <a href="https://docs.aws.amazon.com/marketplace/latest/buyerguide/buyer-service-linked-role-procurement.html">Service-linked role to share procurement data</a>,
35
+ * in the <i>Amazon Web Services Marketplace Buyer Guide</i>.</p>
36
+ * </li>
37
+ * </ul>
38
+ *
39
+ * @packageDocumentation
40
+ */
41
+ export * from "./MarketplaceReportingClient";
42
+ export * from "./MarketplaceReporting";
43
+ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
44
+ export type { RuntimeExtension } from "./runtimeExtensions";
45
+ export type { MarketplaceReportingExtensionConfiguration } from "./extensionConfiguration";
46
+ export * from "./commands";
47
+ export * from "./models";
48
+ export { MarketplaceReportingServiceException } from "./models/MarketplaceReportingServiceException";
@@ -0,0 +1,14 @@
1
+ import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@smithy/smithy-client";
2
+ export type { __ServiceExceptionOptions };
3
+ export { __ServiceException };
4
+ /**
5
+ * @public
6
+ *
7
+ * Base exception class for all service exceptions from MarketplaceReporting service.
8
+ */
9
+ export declare class MarketplaceReportingServiceException extends __ServiceException {
10
+ /**
11
+ * @internal
12
+ */
13
+ constructor(options: __ServiceExceptionOptions);
14
+ }
@@ -0,0 +1 @@
1
+ export * from "./models_0";
@@ -0,0 +1,89 @@
1
+ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
+ import { MarketplaceReportingServiceException as __BaseException } from "./MarketplaceReportingServiceException";
3
+ /**
4
+ * <p>You do not have sufficient access to perform this action.</p>
5
+ * @public
6
+ */
7
+ export declare class AccessDeniedException extends __BaseException {
8
+ readonly name: "AccessDeniedException";
9
+ readonly $fault: "client";
10
+ /**
11
+ * @internal
12
+ */
13
+ constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
14
+ }
15
+ /**
16
+ * <p>The request is malformed, or it contains an error such as an invalid parameter. Ensure the request has all required parameters.</p>
17
+ * @public
18
+ */
19
+ export declare class BadRequestException extends __BaseException {
20
+ readonly name: "BadRequestException";
21
+ readonly $fault: "client";
22
+ /**
23
+ * @internal
24
+ */
25
+ constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
26
+ }
27
+ /**
28
+ * @public
29
+ */
30
+ export interface GetBuyerDashboardInput {
31
+ /**
32
+ * <p>The ARN of the requested dashboard.</p>
33
+ * @public
34
+ */
35
+ dashboardIdentifier: string | undefined;
36
+ /**
37
+ * <p>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.
38
+ * To include all subdomains under a specific domain, use <code>*</code>. For example, <code>https://*.amazon.com</code> includes all subdomains under
39
+ * <code>https://aws.amazon.com</code>.</p>
40
+ * @public
41
+ */
42
+ embeddingDomains: string[] | undefined;
43
+ }
44
+ /**
45
+ * @public
46
+ */
47
+ export interface GetBuyerDashboardOutput {
48
+ /**
49
+ * <p>The dashboard's embedding URL.</p>
50
+ * @public
51
+ */
52
+ embedUrl: string | undefined;
53
+ /**
54
+ * <p>The ARN of the returned dashboard.</p>
55
+ * @public
56
+ */
57
+ dashboardIdentifier: string | undefined;
58
+ /**
59
+ * <p>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.
60
+ * To include all subdomains under a specific domain, use <code>*</code>. For example, <code>https://*.amazon.com</code> includes all subdomains under
61
+ * <code>https://aws.amazon.com</code>.</p>
62
+ * @public
63
+ */
64
+ embeddingDomains: string[] | undefined;
65
+ }
66
+ /**
67
+ * <p>The operation failed due to a server error.</p>
68
+ * @public
69
+ */
70
+ export declare class InternalServerException extends __BaseException {
71
+ readonly name: "InternalServerException";
72
+ readonly $fault: "server";
73
+ /**
74
+ * @internal
75
+ */
76
+ constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
77
+ }
78
+ /**
79
+ * <p>You do not have permission to perform this action.</p>
80
+ * @public
81
+ */
82
+ export declare class UnauthorizedException extends __BaseException {
83
+ readonly name: "UnauthorizedException";
84
+ readonly $fault: "client";
85
+ /**
86
+ * @internal
87
+ */
88
+ constructor(opts: __ExceptionOptionType<UnauthorizedException, __BaseException>);
89
+ }
@@ -0,0 +1,11 @@
1
+ import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
2
+ import { SerdeContext as __SerdeContext } from "@smithy/types";
3
+ import { GetBuyerDashboardCommandInput, GetBuyerDashboardCommandOutput } from "../commands/GetBuyerDashboardCommand";
4
+ /**
5
+ * serializeAws_restJson1GetBuyerDashboardCommand
6
+ */
7
+ export declare const se_GetBuyerDashboardCommand: (input: GetBuyerDashboardCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
8
+ /**
9
+ * deserializeAws_restJson1GetBuyerDashboardCommand
10
+ */
11
+ export declare const de_GetBuyerDashboardCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetBuyerDashboardCommandOutput>;
@@ -0,0 +1,48 @@
1
+ import { FetchHttpHandler as RequestHandler } from "@smithy/fetch-http-handler";
2
+ import { MarketplaceReportingClientConfig } from "./MarketplaceReportingClient";
3
+ /**
4
+ * @internal
5
+ */
6
+ export declare const getRuntimeConfig: (config: MarketplaceReportingClientConfig) => {
7
+ runtime: string;
8
+ defaultsMode: import("@smithy/types").Provider<import("@smithy/smithy-client").ResolvedDefaultsMode>;
9
+ bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
10
+ credentialDefaultProvider: (input: any) => import("@smithy/types").AwsCredentialIdentityProvider;
11
+ defaultUserAgentProvider: (config: import("@aws-sdk/util-user-agent-browser").PreviouslyResolved) => Promise<import("@smithy/types").UserAgent>;
12
+ maxAttempts: number | import("@smithy/types").Provider<number>;
13
+ region: string | import("@smithy/types").Provider<any>;
14
+ requestHandler: import("@smithy/protocol-http").HttpHandler<any> | RequestHandler;
15
+ retryMode: string | import("@smithy/types").Provider<string>;
16
+ sha256: import("@smithy/types").HashConstructor;
17
+ streamCollector: import("@smithy/types").StreamCollector;
18
+ useDualstackEndpoint: boolean | import("@smithy/types").Provider<boolean>;
19
+ useFipsEndpoint: boolean | import("@smithy/types").Provider<boolean>;
20
+ apiVersion: string;
21
+ cacheMiddleware?: boolean | undefined;
22
+ urlParser: import("@smithy/types").UrlParser;
23
+ base64Decoder: import("@smithy/types").Decoder;
24
+ base64Encoder: (_input: string | Uint8Array) => string;
25
+ utf8Decoder: import("@smithy/types").Decoder;
26
+ utf8Encoder: (input: string | Uint8Array) => string;
27
+ disableHostPrefix: boolean;
28
+ serviceId: string;
29
+ logger: import("@smithy/types").Logger;
30
+ extensions: import("./runtimeExtensions").RuntimeExtension[];
31
+ customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
32
+ userAgentAppId?: string | import("@smithy/types").Provider<string | undefined> | undefined;
33
+ retryStrategy?: import("@smithy/types").RetryStrategy | import("@smithy/types").RetryStrategyV2 | undefined;
34
+ endpoint?: ((string | import("@smithy/types").Endpoint | import("@smithy/types").Provider<import("@smithy/types").Endpoint> | import("@smithy/types").EndpointV2 | import("@smithy/types").Provider<import("@smithy/types").EndpointV2>) & (string | import("@smithy/types").Provider<string> | import("@smithy/types").Endpoint | import("@smithy/types").Provider<import("@smithy/types").Endpoint> | import("@smithy/types").EndpointV2 | import("@smithy/types").Provider<import("@smithy/types").EndpointV2>)) | undefined;
35
+ endpointProvider: (endpointParams: import("./endpoint/EndpointParameters").EndpointParameters, context?: {
36
+ logger?: import("@smithy/types").Logger | undefined;
37
+ }) => import("@smithy/types").EndpointV2;
38
+ tls?: boolean | undefined;
39
+ serviceConfiguredEndpoint?: undefined;
40
+ httpAuthSchemes: import("@smithy/types").HttpAuthScheme[];
41
+ httpAuthSchemeProvider: import("./auth/httpAuthSchemeProvider").MarketplaceReportingHttpAuthSchemeProvider;
42
+ credentials?: import("@smithy/types").AwsCredentialIdentity | import("@smithy/types").AwsCredentialIdentityProvider | undefined;
43
+ signer?: import("@smithy/types").RequestSigner | ((authScheme?: import("@smithy/types").AuthScheme | undefined) => Promise<import("@smithy/types").RequestSigner>) | undefined;
44
+ signingEscapePath?: boolean | undefined;
45
+ systemClockOffset?: number | undefined;
46
+ signingRegion?: string | undefined;
47
+ signerConstructor?: (new (options: import("@smithy/signature-v4").SignatureV4Init & import("@smithy/signature-v4").SignatureV4CryptoInit) => import("@smithy/types").RequestSigner) | undefined;
48
+ };
@@ -0,0 +1,48 @@
1
+ import { NodeHttpHandler as RequestHandler } from "@smithy/node-http-handler";
2
+ import { MarketplaceReportingClientConfig } from "./MarketplaceReportingClient";
3
+ /**
4
+ * @internal
5
+ */
6
+ export declare const getRuntimeConfig: (config: MarketplaceReportingClientConfig) => {
7
+ runtime: string;
8
+ defaultsMode: import("@smithy/types").Provider<import("@smithy/smithy-client").ResolvedDefaultsMode>;
9
+ bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
10
+ credentialDefaultProvider: (init?: import("@aws-sdk/credential-provider-node").DefaultProviderInit | undefined) => import("@smithy/types").MemoizedProvider<import("@smithy/types").AwsCredentialIdentity>;
11
+ defaultUserAgentProvider: (config?: import("@aws-sdk/util-user-agent-node").PreviouslyResolved | undefined) => Promise<import("@smithy/types").UserAgent>;
12
+ maxAttempts: number | import("@smithy/types").Provider<number>;
13
+ region: string | import("@smithy/types").Provider<string>;
14
+ requestHandler: RequestHandler | import("@smithy/protocol-http").HttpHandler<any>;
15
+ retryMode: string | import("@smithy/types").Provider<string>;
16
+ sha256: import("@smithy/types").HashConstructor;
17
+ streamCollector: import("@smithy/types").StreamCollector;
18
+ useDualstackEndpoint: boolean | import("@smithy/types").Provider<boolean>;
19
+ useFipsEndpoint: boolean | import("@smithy/types").Provider<boolean>;
20
+ userAgentAppId: string | import("@smithy/types").Provider<string | undefined>;
21
+ apiVersion: string;
22
+ cacheMiddleware?: boolean | undefined;
23
+ urlParser: import("@smithy/types").UrlParser;
24
+ base64Decoder: import("@smithy/types").Decoder;
25
+ base64Encoder: (_input: string | Uint8Array) => string;
26
+ utf8Decoder: import("@smithy/types").Decoder;
27
+ utf8Encoder: (input: string | Uint8Array) => string;
28
+ disableHostPrefix: boolean;
29
+ serviceId: string;
30
+ logger: import("@smithy/types").Logger;
31
+ extensions: import("./runtimeExtensions").RuntimeExtension[];
32
+ customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
33
+ retryStrategy?: import("@smithy/types").RetryStrategy | import("@smithy/types").RetryStrategyV2 | undefined;
34
+ endpoint?: ((string | import("@smithy/types").Endpoint | import("@smithy/types").Provider<import("@smithy/types").Endpoint> | import("@smithy/types").EndpointV2 | import("@smithy/types").Provider<import("@smithy/types").EndpointV2>) & (string | import("@smithy/types").Provider<string> | import("@smithy/types").Endpoint | import("@smithy/types").Provider<import("@smithy/types").Endpoint> | import("@smithy/types").EndpointV2 | import("@smithy/types").Provider<import("@smithy/types").EndpointV2>)) | undefined;
35
+ endpointProvider: (endpointParams: import("./endpoint/EndpointParameters").EndpointParameters, context?: {
36
+ logger?: import("@smithy/types").Logger | undefined;
37
+ }) => import("@smithy/types").EndpointV2;
38
+ tls?: boolean | undefined;
39
+ serviceConfiguredEndpoint?: undefined;
40
+ httpAuthSchemes: import("@smithy/types").HttpAuthScheme[];
41
+ httpAuthSchemeProvider: import("./auth/httpAuthSchemeProvider").MarketplaceReportingHttpAuthSchemeProvider;
42
+ credentials?: import("@smithy/types").AwsCredentialIdentity | import("@smithy/types").AwsCredentialIdentityProvider | undefined;
43
+ signer?: import("@smithy/types").RequestSigner | ((authScheme?: import("@smithy/types").AuthScheme | undefined) => Promise<import("@smithy/types").RequestSigner>) | undefined;
44
+ signingEscapePath?: boolean | undefined;
45
+ systemClockOffset?: number | undefined;
46
+ signingRegion?: string | undefined;
47
+ signerConstructor?: (new (options: import("@smithy/signature-v4").SignatureV4Init & import("@smithy/signature-v4").SignatureV4CryptoInit) => import("@smithy/types").RequestSigner) | undefined;
48
+ };
@@ -0,0 +1,47 @@
1
+ import { MarketplaceReportingClientConfig } from "./MarketplaceReportingClient";
2
+ /**
3
+ * @internal
4
+ */
5
+ export declare const getRuntimeConfig: (config: MarketplaceReportingClientConfig) => {
6
+ runtime: string;
7
+ sha256: import("@smithy/types").HashConstructor;
8
+ requestHandler: import("@smithy/types").NodeHttpHandlerOptions | import("@smithy/types").FetchHttpHandlerOptions | Record<string, unknown> | import("@smithy/protocol-http").HttpHandler<any> | import("@smithy/fetch-http-handler").FetchHttpHandler;
9
+ apiVersion: string;
10
+ cacheMiddleware?: boolean | undefined;
11
+ urlParser: import("@smithy/types").UrlParser;
12
+ bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
13
+ streamCollector: import("@smithy/types").StreamCollector;
14
+ base64Decoder: import("@smithy/types").Decoder;
15
+ base64Encoder: (_input: string | Uint8Array) => string;
16
+ utf8Decoder: import("@smithy/types").Decoder;
17
+ utf8Encoder: (input: string | Uint8Array) => string;
18
+ disableHostPrefix: boolean;
19
+ serviceId: string;
20
+ useDualstackEndpoint: boolean | import("@smithy/types").Provider<boolean>;
21
+ useFipsEndpoint: boolean | import("@smithy/types").Provider<boolean>;
22
+ region: string | import("@smithy/types").Provider<any>;
23
+ defaultUserAgentProvider: (config: import("@aws-sdk/util-user-agent-browser").PreviouslyResolved) => Promise<import("@smithy/types").UserAgent>;
24
+ credentialDefaultProvider: (input: any) => import("@smithy/types").AwsCredentialIdentityProvider;
25
+ maxAttempts: number | import("@smithy/types").Provider<number>;
26
+ retryMode: string | import("@smithy/types").Provider<string>;
27
+ logger: import("@smithy/types").Logger;
28
+ extensions: import("./runtimeExtensions").RuntimeExtension[];
29
+ defaultsMode: import("@smithy/smithy-client").DefaultsMode | import("@smithy/types").Provider<import("@smithy/smithy-client").DefaultsMode>;
30
+ customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
31
+ userAgentAppId?: string | import("@smithy/types").Provider<string | undefined> | undefined;
32
+ retryStrategy?: import("@smithy/types").RetryStrategy | import("@smithy/types").RetryStrategyV2 | undefined;
33
+ endpoint?: string | import("@smithy/types").Endpoint | import("@smithy/types").Provider<import("@smithy/types").Endpoint> | import("@smithy/types").EndpointV2 | import("@smithy/types").Provider<import("@smithy/types").EndpointV2> | undefined;
34
+ endpointProvider: (endpointParams: import("./endpoint/EndpointParameters").EndpointParameters, context?: {
35
+ logger?: import("@smithy/types").Logger | undefined;
36
+ }) => import("@smithy/types").EndpointV2;
37
+ tls?: boolean | undefined;
38
+ serviceConfiguredEndpoint?: undefined;
39
+ httpAuthSchemes: import("@smithy/types").HttpAuthScheme[];
40
+ httpAuthSchemeProvider: import("./auth/httpAuthSchemeProvider").MarketplaceReportingHttpAuthSchemeProvider;
41
+ credentials?: import("@smithy/types").AwsCredentialIdentity | import("@smithy/types").AwsCredentialIdentityProvider | undefined;
42
+ signer?: import("@smithy/types").RequestSigner | ((authScheme?: import("@smithy/types").AuthScheme | undefined) => Promise<import("@smithy/types").RequestSigner>) | undefined;
43
+ signingEscapePath?: boolean | undefined;
44
+ systemClockOffset?: number | undefined;
45
+ signingRegion?: string | undefined;
46
+ signerConstructor?: (new (options: import("@smithy/signature-v4").SignatureV4Init & import("@smithy/signature-v4").SignatureV4CryptoInit) => import("@smithy/types").RequestSigner) | undefined;
47
+ };
@@ -0,0 +1,21 @@
1
+ import { MarketplaceReportingClientConfig } from "./MarketplaceReportingClient";
2
+ /**
3
+ * @internal
4
+ */
5
+ export declare const getRuntimeConfig: (config: MarketplaceReportingClientConfig) => {
6
+ apiVersion: string;
7
+ base64Decoder: import("@smithy/types").Decoder;
8
+ base64Encoder: (_input: string | Uint8Array) => string;
9
+ disableHostPrefix: boolean;
10
+ endpointProvider: (endpointParams: import("./endpoint/EndpointParameters").EndpointParameters, context?: {
11
+ logger?: import("@smithy/types").Logger | undefined;
12
+ }) => import("@smithy/types").EndpointV2;
13
+ extensions: import("./runtimeExtensions").RuntimeExtension[];
14
+ httpAuthSchemeProvider: import("./auth/httpAuthSchemeProvider").MarketplaceReportingHttpAuthSchemeProvider;
15
+ httpAuthSchemes: import("@smithy/types").HttpAuthScheme[];
16
+ logger: import("@smithy/types").Logger;
17
+ serviceId: string;
18
+ urlParser: import("@smithy/types").UrlParser;
19
+ utf8Decoder: import("@smithy/types").Decoder;
20
+ utf8Encoder: (input: string | Uint8Array) => string;
21
+ };
@@ -0,0 +1,17 @@
1
+ import { MarketplaceReportingExtensionConfiguration } from "./extensionConfiguration";
2
+ /**
3
+ * @public
4
+ */
5
+ export interface RuntimeExtension {
6
+ configure(extensionConfiguration: MarketplaceReportingExtensionConfiguration): void;
7
+ }
8
+ /**
9
+ * @public
10
+ */
11
+ export interface RuntimeExtensionsConfig {
12
+ extensions: RuntimeExtension[];
13
+ }
14
+ /**
15
+ * @internal
16
+ */
17
+ export declare const resolveRuntimeExtensions: (runtimeConfig: any, extensions: RuntimeExtension[]) => any;