Skip to content

Commit d7a31d8

Browse files
author
awstools
committed
docs(client-marketplace-reporting): Documentation-only update for AWS Marketplace Reporting API.
1 parent dfda129 commit d7a31d8

File tree

7 files changed

+193
-108
lines changed

7 files changed

+193
-108
lines changed

‎clients/client-marketplace-reporting/README.md

+45-25
Original file line numberDiff line numberDiff line change
@@ -6,40 +6,60 @@
66

77
AWS SDK for JavaScript MarketplaceReporting Client for Node.js, Browser and React Native.
88

9-
<p>The AWS Marketplace <code>GetBuyerDashboard</code> API enables you to get a procurement insights dashboard
10-
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>
11-
<p>To use the API, you must complete the following prerequisites:</p>
9+
<p>The Amazon Web Services Marketplace <code>GetBuyerDashboard</code> API enables you to get a procurement insights
10+
dashboard programmatically. The API gets the agreement and cost analysis dashboards with
11+
data for all of the Amazon Web Services accounts in your Amazon Web Services Organization. </p>
12+
<p>To use the Amazon Web Services Marketplace Reporting API, you must complete the following prerequisites:</p>
1213
<ul>
1314
<li>
14-
<p>Enable all features for your organization. For more information, see
15-
<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>,
16-
in the <i>Amazon Web Services Organizations User Guide</i>.</p>
15+
<p>Enable all features for your organization. For more information, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html">Enabling all features for an organization with Organizations</a>, in the
16+
<i>Organizations User Guide</i>.</p>
1717
</li>
1818
<li>
19-
<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.
20-
Users without management or delegated administrator accounts can use the dashboard, but they only see data for their accounts.</p>
21-
<p>For more information about management accounts, see
22-
<a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tutorials_basic.html">Tutorial: Creating and configuring an organization</a>
23-
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>,
24-
both in the <i>Amazon Web Services Organizations User Guide</i>.</p>
25-
<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>,
26-
in the <i>AWS Marketplace Buyer Guide</i>.</p>
19+
<p>Call the service as the Organizations management account or an account registered
20+
as a delegated administrator for the procurement insights service.</p>
21+
<p>For more information about management accounts, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tutorials_basic.html">Tutorial:
22+
Creating and configuring an organization</a> and <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs-manage_accounts_management.html">Managing the management account with Organizations</a>, both in the
23+
<i>Organizations User Guide</i>.</p>
24+
<p>For more information about delegated administrators, see <a href="https://docs.aws.amazon.com/marketplace/latest/buyerguide/management-delegates.html">Using
25+
delegated administrators</a>, in the <i>Amazon Web Services Marketplace Buyer
26+
Guide</i>.</p>
2727
</li>
2828
<li>
29-
<p>Create an IAM policy that enables the <code>aws-marketplace:GetBuyerDashboard</code> and <code>organizations:DescribeOrganization</code> permissions. In addition,
30-
the management account requires the <code>organizations:EnableAWSServiceAccess</code> and <code>iam:CreateServiceLinkedRole</code> permissions to create
31-
For more information about creating the policy, see
32-
<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>,
33-
in the <i>IAM User Guide</i>.</p>
29+
<p>Create an IAM policy that enables the
30+
<code>aws-marketplace:GetBuyerDashboard</code> and
31+
<code>organizations:DescribeOrganization</code> permissions. In addition,
32+
the management account requires the
33+
<code>organizations:EnableAWSServiceAccess</code> and
34+
<code>iam:CreateServiceLinkedRole</code> permissions to create. For more
35+
information about creating the policy, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html">Policies and permissions in
36+
Identity and Access Management</a>, in the <i>IAM User Guide</i>.</p>
37+
<note>
38+
<p>Access can be shared only by registering the desired linked account as a
39+
delegated administrator. That requires
40+
<code>organizations:RegisterDelegatedAdministrator</code>
41+
<code>organizations:ListDelegatedAdministrators</code> and
42+
<code>organizations:DeregisterDelegatedAdministrator</code>
43+
permissions.</p>
44+
</note>
3445
</li>
3546
<li>
36-
<p>Use the Amazon Web Services Marketplace console to create the <code>AWSServiceRoleForProcurementInsightsPolicy</code> service-linked role.
37-
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
38-
to create the service-linked role and enable the service access. For more information, see
47+
<p>Use the Amazon Web Services Marketplace console to create the
48+
<code>AWSServiceRoleForProcurementInsightsPolicy</code> service-linked role.
49+
The role enables Amazon Web Services Marketplace procurement visibility integration. The management
50+
account requires an IAM policy with the
51+
<code>organizations:EnableAWSServiceAccess</code> and
52+
<code>iam:CreateServiceLinkedRole</code> permissions to create the
53+
service-linked role and enable the service access. For more information, see
3954
<a href="https://docs.aws.amazon.com/marketplace/latest/buyerguide/orgs-access-slr.html">Granting access to
40-
Amazon Web Services Organizations</a>, and
41-
<a href="https://docs.aws.amazon.com/marketplace/latest/buyerguide/buyer-service-linked-role-procurement.html">Service-linked role to share procurement data</a>,
42-
in the <i>Amazon Web Services Marketplace Buyer Guide</i>.</p>
55+
Organizations</a> and <a href="https://docs.aws.amazon.com/marketplace/latest/buyerguide/buyer-service-linked-role-procurement.html">Service-linked role to share procurement data</a> in the
56+
<i>Amazon Web Services Marketplace Buyer Guide</i>.</p>
57+
</li>
58+
<li>
59+
<p>After creating the service-linked role, you must enable trusted access that
60+
grants Amazon Web Services Marketplace permission to access data from your Organizations. For more information,
61+
see <a href="https://docs.aws.amazon.com/marketplace/latest/buyerguide/orgs-access-slr.html">Granting access to
62+
Organizations</a> in the <i>Amazon Web Services Marketplace Buyer Guide</i>.</p>
4363
</li>
4464
</ul>
4565

‎clients/client-marketplace-reporting/src/MarketplaceReporting.ts

+45-25
Original file line numberDiff line numberDiff line change
@@ -33,40 +33,60 @@ export interface MarketplaceReporting {
3333
}
3434

3535
/**
36-
* <p>The AWS Marketplace <code>GetBuyerDashboard</code> API enables you to get a procurement insights dashboard
37-
* 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>
38-
* <p>To use the API, you must complete the following prerequisites:</p>
36+
* <p>The Amazon Web Services Marketplace <code>GetBuyerDashboard</code> API enables you to get a procurement insights
37+
* dashboard programmatically. The API gets the agreement and cost analysis dashboards with
38+
* data for all of the Amazon Web Services accounts in your Amazon Web Services Organization. </p>
39+
* <p>To use the Amazon Web Services Marketplace Reporting API, you must complete the following prerequisites:</p>
3940
* <ul>
4041
* <li>
41-
* <p>Enable all features for your organization. For more information, see
42-
* <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>,
43-
* in the <i>Amazon Web Services Organizations User Guide</i>.</p>
42+
* <p>Enable all features for your organization. For more information, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html">Enabling all features for an organization with Organizations</a>, in the
43+
* <i>Organizations User Guide</i>.</p>
4444
* </li>
4545
* <li>
46-
* <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.
47-
* Users without management or delegated administrator accounts can use the dashboard, but they only see data for their accounts.</p>
48-
* <p>For more information about management accounts, see
49-
* <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tutorials_basic.html">Tutorial: Creating and configuring an organization</a>
50-
* 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>,
51-
* both in the <i>Amazon Web Services Organizations User Guide</i>.</p>
52-
* <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>,
53-
* in the <i>AWS Marketplace Buyer Guide</i>.</p>
46+
* <p>Call the service as the Organizations management account or an account registered
47+
* as a delegated administrator for the procurement insights service.</p>
48+
* <p>For more information about management accounts, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tutorials_basic.html">Tutorial:
49+
* Creating and configuring an organization</a> and <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs-manage_accounts_management.html">Managing the management account with Organizations</a>, both in the
50+
* <i>Organizations User Guide</i>.</p>
51+
* <p>For more information about delegated administrators, see <a href="https://docs.aws.amazon.com/marketplace/latest/buyerguide/management-delegates.html">Using
52+
* delegated administrators</a>, in the <i>Amazon Web Services Marketplace Buyer
53+
* Guide</i>.</p>
5454
* </li>
5555
* <li>
56-
* <p>Create an IAM policy that enables the <code>aws-marketplace:GetBuyerDashboard</code> and <code>organizations:DescribeOrganization</code> permissions. In addition,
57-
* the management account requires the <code>organizations:EnableAWSServiceAccess</code> and <code>iam:CreateServiceLinkedRole</code> permissions to create
58-
* For more information about creating the policy, see
59-
* <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>,
60-
* in the <i>IAM User Guide</i>.</p>
56+
* <p>Create an IAM policy that enables the
57+
* <code>aws-marketplace:GetBuyerDashboard</code> and
58+
* <code>organizations:DescribeOrganization</code> permissions. In addition,
59+
* the management account requires the
60+
* <code>organizations:EnableAWSServiceAccess</code> and
61+
* <code>iam:CreateServiceLinkedRole</code> permissions to create. For more
62+
* information about creating the policy, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html">Policies and permissions in
63+
* Identity and Access Management</a>, in the <i>IAM User Guide</i>.</p>
64+
* <note>
65+
* <p>Access can be shared only by registering the desired linked account as a
66+
* delegated administrator. That requires
67+
* <code>organizations:RegisterDelegatedAdministrator</code>
68+
* <code>organizations:ListDelegatedAdministrators</code> and
69+
* <code>organizations:DeregisterDelegatedAdministrator</code>
70+
* permissions.</p>
71+
* </note>
6172
* </li>
6273
* <li>
63-
* <p>Use the Amazon Web Services Marketplace console to create the <code>AWSServiceRoleForProcurementInsightsPolicy</code> service-linked role.
64-
* 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
65-
* to create the service-linked role and enable the service access. For more information, see
74+
* <p>Use the Amazon Web Services Marketplace console to create the
75+
* <code>AWSServiceRoleForProcurementInsightsPolicy</code> service-linked role.
76+
* The role enables Amazon Web Services Marketplace procurement visibility integration. The management
77+
* account requires an IAM policy with the
78+
* <code>organizations:EnableAWSServiceAccess</code> and
79+
* <code>iam:CreateServiceLinkedRole</code> permissions to create the
80+
* service-linked role and enable the service access. For more information, see
6681
* <a href="https://docs.aws.amazon.com/marketplace/latest/buyerguide/orgs-access-slr.html">Granting access to
67-
* Amazon Web Services Organizations</a>, and
68-
* <a href="https://docs.aws.amazon.com/marketplace/latest/buyerguide/buyer-service-linked-role-procurement.html">Service-linked role to share procurement data</a>,
69-
* in the <i>Amazon Web Services Marketplace Buyer Guide</i>.</p>
82+
* Organizations</a> and <a href="https://docs.aws.amazon.com/marketplace/latest/buyerguide/buyer-service-linked-role-procurement.html">Service-linked role to share procurement data</a> in the
83+
* <i>Amazon Web Services Marketplace Buyer Guide</i>.</p>
84+
* </li>
85+
* <li>
86+
* <p>After creating the service-linked role, you must enable trusted access that
87+
* grants Amazon Web Services Marketplace permission to access data from your Organizations. For more information,
88+
* see <a href="https://docs.aws.amazon.com/marketplace/latest/buyerguide/orgs-access-slr.html">Granting access to
89+
* Organizations</a> in the <i>Amazon Web Services Marketplace Buyer Guide</i>.</p>
7090
* </li>
7191
* </ul>
7292
* @public

0 commit comments

Comments
 (0)