To use the Amazon Web Services Marketplace Reporting API, you must complete the following prerequisites:
\n\n- \n
Enable all features for your organization. For more information, see Enabling all features for an organization with Organizations, in the\nOrganizations User Guide.
\n \n- \n
Call the service as the Organizations management account or an account registered\nas a delegated administrator for the procurement insights service.
\nFor more information about management accounts, see Tutorial:\nCreating and configuring an organization and Managing the management account with Organizations, both in the\nOrganizations User Guide.
\nFor more information about delegated administrators, see Using\ndelegated administrators, in the Amazon Web Services Marketplace Buyer\nGuide.
\n \n- \n
Create an IAM policy that enables the\naws-marketplace:GetBuyerDashboard and\norganizations:DescribeOrganization permissions. In addition,\nthe management account requires the\norganizations:EnableAWSServiceAccess and\niam:CreateServiceLinkedRole permissions to create. For more\ninformation about creating the policy, see Policies and permissions in\nIdentity and Access Management, in the IAM User Guide.
\n\nAccess can be shared only by registering the desired linked account as a\ndelegated administrator. That requires\norganizations:RegisterDelegatedAdministrator\norganizations:ListDelegatedAdministrators and\norganizations:DeregisterDelegatedAdministrator\npermissions.
\n\n \n- \n
Use the Amazon Web Services Marketplace console to create the\nAWSServiceRoleForProcurementInsightsPolicy service-linked role.\nThe role enables Amazon Web Services Marketplace procurement visibility integration. The management\naccount requires an IAM policy with the\norganizations:EnableAWSServiceAccess and\niam:CreateServiceLinkedRole permissions to create the\nservice-linked role and enable the service access. For more information, see\nGranting access to\nOrganizations and Service-linked role to share procurement data in the\nAmazon Web Services Marketplace Buyer Guide.
\n \n- \n
After creating the service-linked role, you must enable trusted access that\ngrants Amazon Web Services Marketplace permission to access data from your Organizations. For more information,\nsee Granting access to\nOrganizations in the Amazon Web Services Marketplace Buyer Guide.
\n \n
\n\n## Installing\n\nTo install this package, use the CLI of your favorite package manager:\n\n- `npm install @aws-sdk/client-marketplace-reporting`\n- `yarn add @aws-sdk/client-marketplace-reporting`\n- `pnpm add @aws-sdk/client-marketplace-reporting`\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands.\nTo send a request, you only need to import the `MarketplaceReportingClient` and\nthe commands you need, for example `GetBuyerDashboardCommand`:\n\n```js\n// ES5 example\nconst { MarketplaceReportingClient, GetBuyerDashboardCommand } = require(\"@aws-sdk/client-marketplace-reporting\");\n```\n\n```ts\n// ES6+ example\nimport { MarketplaceReportingClient, GetBuyerDashboardCommand } from \"@aws-sdk/client-marketplace-reporting\";\n```\n\n### Usage\n\nTo send a request:\n\n- Instantiate a client with configuration (e.g. credentials, region).\n - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.\n - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.\n- Instantiate a command with input parameters.\n- Call the `send` operation on the client, providing the command object as input.\n\n```js\nconst client = new MarketplaceReportingClient({ region: \"REGION\" });\n\nconst params = { /** input parameters */ };\nconst command = new GetBuyerDashboardCommand(params);\n```\n\n#### Async/await\n\nWe recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)\noperator to wait for the promise returned by send operation as follows:\n\n```js\n// async/await.\ntry {\n const data = await client.send(command);\n // process data.\n} catch (error) {\n // error handling.\n} finally {\n // finally.\n}\n```\n\n#### Promises\n\nYou can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).\n\n```js\nclient\n .send(command)\n .then((data) => {\n // process data.\n })\n .catch((error) => {\n // error handling.\n })\n .finally(() => {\n // finally.\n });\n```\n\n#### Aggregated client\n\nThe aggregated client class is exported from the same package, but without the \"Client\" suffix.\n\n`MarketplaceReporting` extends `MarketplaceReportingClient` and additionally supports all operations, waiters, and paginators as methods.\nThis style may be familiar to you from the AWS SDK for JavaScript v2.\n\nIf you are bundling the AWS SDK, we recommend using only the bare-bones client (`MarketplaceReportingClient`).\nMore details are in the blog post on\n[modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).\n\n```ts\nimport { MarketplaceReporting } from \"@aws-sdk/client-marketplace-reporting\";\n\nconst client = new MarketplaceReporting({ region: \"REGION\" });\n\n// async/await.\ntry {\n const data = await client.getBuyerDashboard(params);\n // process data.\n} catch (error) {\n // error handling.\n}\n\n// Promises.\nclient\n .getBuyerDashboard(params)\n .then((data) => {\n // process data.\n })\n .catch((error) => {\n // error handling.\n });\n\n// callbacks (not recommended).\nclient.getBuyerDashboard(params, (err, data) => {\n // process err and data.\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information,\nas well as response metadata (e.g. request id).\n\n```js\ntry {\n const data = await client.send(command);\n // process data.\n} catch (error) {\n const { requestId, cfId, extendedRequestId } = error.$metadata;\n console.log({ requestId, cfId, extendedRequestId });\n /**\n * The keys within exceptions are also parsed.\n * You can access them by specifying exception names:\n * if (error.name === 'SomeServiceException') {\n * const value = error.specialKeyInException;\n * }\n */\n}\n```\n\nSee also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).\n\n## Getting Help\n\nPlease use these community resources for getting help.\nWe use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.\n\n- Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)\n or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).\n- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)\n on AWS Developer Blog.\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`.\n- Join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3).\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues/new/choose).\n\nTo test your universal JavaScript code in Node.js, browser and react-native environments,\nvisit our [code samples repo](https://github.com/aws-samples/aws-sdk-js-tests).\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/client-marketplace-reporting` package is updated.\nTo contribute to client you can check our [generate clients scripts](https://github.com/aws/aws-sdk-js-v3/tree/main/scripts/generate-clients).\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n## Client Commands (Operations List)\n\n