Skip to content

Commit

Permalink
docs(client-organizations): Documentation updates for permissions and…
Browse files Browse the repository at this point in the history
… links.
  • Loading branch information
awstools committed Aug 28, 2023
1 parent f4042f6 commit 26c3994
Show file tree
Hide file tree
Showing 62 changed files with 2,164 additions and 1,937 deletions.
6 changes: 3 additions & 3 deletions clients/client-organizations/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,9 @@ Amazon Web Services account and delivers log files to an Amazon S3 bucket. By us
by CloudTrail, you can determine which requests the Organizations service received, who made the
request and when, and so on. For more about Organizations and its support for CloudTrail, see
<a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_incident-response.html#orgs_cloudtrail-integration">Logging
Organizations Events with CloudTrail</a> in the <i>Organizations User Guide</i>.
To learn more about CloudTrail, including how to turn it on and find your log files, see the
<a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html">CloudTrail User Guide</a>.</p>
Organizations API calls with CloudTrail</a> in the
<i>Organizations User Guide</i>. To learn more about CloudTrail, including how to turn it
on and find your log files, see the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html">CloudTrail User Guide</a>.</p>

## Installing

Expand Down
6 changes: 3 additions & 3 deletions clients/client-organizations/src/Organizations.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1227,9 +1227,9 @@ export interface Organizations {
* by CloudTrail, you can determine which requests the Organizations service received, who made the
* request and when, and so on. For more about Organizations and its support for CloudTrail, see
* <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_incident-response.html#orgs_cloudtrail-integration">Logging
* Organizations Events with CloudTrail</a> in the <i>Organizations User Guide</i>.
* To learn more about CloudTrail, including how to turn it on and find your log files, see the
* <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html">CloudTrail User Guide</a>.</p>
* Organizations API calls with CloudTrail</a> in the
* <i>Organizations User Guide</i>. To learn more about CloudTrail, including how to turn it
* on and find your log files, see the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html">CloudTrail User Guide</a>.</p>
*/
export class Organizations extends OrganizationsClient implements Organizations {}
createAggregatedClient(commands, Organizations);
6 changes: 3 additions & 3 deletions clients/client-organizations/src/OrganizationsClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -556,9 +556,9 @@ export interface OrganizationsClientResolvedConfig extends OrganizationsClientRe
* by CloudTrail, you can determine which requests the Organizations service received, who made the
* request and when, and so on. For more about Organizations and its support for CloudTrail, see
* <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_incident-response.html#orgs_cloudtrail-integration">Logging
* Organizations Events with CloudTrail</a> in the <i>Organizations User Guide</i>.
* To learn more about CloudTrail, including how to turn it on and find your log files, see the
* <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html">CloudTrail User Guide</a>.</p>
* Organizations API calls with CloudTrail</a> in the
* <i>Organizations User Guide</i>. To learn more about CloudTrail, including how to turn it
* on and find your log files, see the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html">CloudTrail User Guide</a>.</p>
*/
export class OrganizationsClient extends __Client<
__HttpHandlerOptions,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ export interface AcceptHandshakeCommandOutput extends AcceptHandshakeResponse, _
* features in the organization, the user must also have the
* <code>iam:CreateServiceLinkedRole</code> permission so that Organizations can
* create the required service-linked role named <code>AWSServiceRoleForOrganizations</code>. For
* more information, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integration_services.html#orgs_integration_service-linked-roles">Organizations and Service-Linked Roles</a> in the
* more information, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integration_services.html#orgs_integrate_services-using_slrs">Organizations and service-linked roles</a> in the
* <i>Organizations User Guide</i>.</p>
* </li>
* <li>
Expand All @@ -63,10 +63,9 @@ export interface AcceptHandshakeCommandOutput extends AcceptHandshakeResponse, _
* handshake: only a principal from the management account.</p>
* <p>For more information about invitations, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_invites.html">Inviting an
* Amazon Web Services account to join your organization</a> in the
* <i>Organizations User Guide.</i> For more information about requests to
* <i>Organizations User Guide</i>. For more information about requests to
* enable all features in the organization, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html">Enabling all features in your organization</a> in
* the <i>Organizations User Guide.</i>
* </p>
* the <i>Organizations User Guide</i>.</p>
* </li>
* </ul>
* <p>After you accept a handshake, it continues to appear in the results of relevant APIs
Expand Down Expand Up @@ -124,8 +123,7 @@ export interface AcceptHandshakeCommandOutput extends AcceptHandshakeResponse, _
* <p>You don't have permissions to perform the requested operation. The user or role that
* is making the request must have at least one IAM permissions policy attached that
* grants the required permissions. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access Management</a> in the
* <i>IAM User Guide.</i>
* </p>
* <i>IAM User Guide</i>.</p>
*
* @throws {@link AccessDeniedForDependencyException} (client fault)
* <p>The operation that you attempted requires you to have the
Expand Down Expand Up @@ -160,7 +158,8 @@ export interface AcceptHandshakeCommandOutput extends AcceptHandshakeResponse, _
* <important>
* <p>If you get this exception immediately after creating the organization,
* wait one hour and try again. If after an hour it continues to fail with this
* error, contact <a href="https://docs.aws.amazon.com/support/home#/">Amazon Web Services Support</a>.</p>
* error, contact <a href="https://console.aws.amazon.com/support/home#/">Amazon Web Services
* Support</a>.</p>
* </important>
* </li>
* <li>
Expand Down Expand Up @@ -323,9 +322,8 @@ export interface AcceptHandshakeCommandOutput extends AcceptHandshakeResponse, _
* @throws {@link TooManyRequestsException} (client fault)
* <p>You have sent too many requests in too short a period of time. The quota helps protect
* against denial-of-service attacks. Try again later.</p>
* <p>For information about quotas that affect Organizations, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_limits.html">Quotas for Organizations</a>in the
* <i>Organizations User Guide.</i>
* </p>
* <p>For information about quotas that affect Organizations, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_limits.html">Quotas for Organizations</a> in the
* <i>Organizations User Guide</i>.</p>
*
* @throws {@link OrganizationsServiceException}
* <p>Base exception class for all service exceptions from Organizations service.</p>
Expand Down
45 changes: 22 additions & 23 deletions clients/client-organizations/src/commands/AttachPolicyCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,8 @@ export interface AttachPolicyCommandOutput extends __MetadataBearer {}
* </p>
* </li>
* </ul>
* <p>This operation can be called only from the organization's management account.</p>
* <p>This operation can be called only from the organization's
* management account or by a member account that is a delegated administrator for an Amazon Web Services service.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand All @@ -88,8 +89,7 @@ export interface AttachPolicyCommandOutput extends __MetadataBearer {}
* <p>You don't have permissions to perform the requested operation. The user or role that
* is making the request must have at least one IAM permissions policy attached that
* grants the required permissions. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access Management</a> in the
* <i>IAM User Guide.</i>
* </p>
* <i>IAM User Guide</i>.</p>
*
* @throws {@link AWSOrganizationsNotInUseException} (client fault)
* <p>Your account isn't a member of an organization. To make this request, you must use the
Expand Down Expand Up @@ -120,19 +120,20 @@ export interface AttachPolicyCommandOutput extends __MetadataBearer {}
* account from the organization that doesn't yet have enough information to exist
* as a standalone account. This account requires you to first complete phone
* verification. Follow the steps at <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#orgs_manage_accounts_remove-from-master">Removing a member account from your organization</a> in the
* <i>Organizations User Guide.</i>
* </p>
* <i>Organizations User Guide</i>.</p>
* </li>
* <li>
* <p>ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of
* accounts that you can create in one day.</p>
* </li>
* <li>
* <p>ACCOUNT_CREATION_NOT_COMPLETE: Your account setup isn't complete or your account isn't fully active. You must complete the account setup before you create an organization.</p>
* <p>ACCOUNT_CREATION_NOT_COMPLETE: Your account setup isn't complete or your
* account isn't fully active. You must complete the account setup before you
* create an organization.</p>
* </li>
* <li>
* <p>ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number
* of accounts in an organization. If you need more accounts, contact <a href="https://docs.aws.amazon.com/support/home#/">Amazon Web Services Support</a> to
* of accounts in an organization. If you need more accounts, contact <a href="https://console.aws.amazon.com/support/home#/">Amazon Web Services Support</a> to
* request an increase in your limit. </p>
* <p>Or the number of invitations that you tried to send would cause you to exceed
* the limit of accounts in your organization. Send fewer invitations or contact
Expand All @@ -143,11 +144,14 @@ export interface AttachPolicyCommandOutput extends __MetadataBearer {}
* <important>
* <p>If you get this exception when running a command immediately after
* creating the organization, wait one hour and try again. After an hour, if
* the command continues to fail with this error, contact <a href="https://docs.aws.amazon.com/support/home#/">Amazon Web Services
* Support</a>.</p>
* the command continues to fail with this error, contact <a href="https://console.aws.amazon.com/support/home#/">Amazon Web Services Support</a>.</p>
* </important>
* </li>
* <li>
* <p>CANNOT_REGISTER_SUSPENDED_ACCOUNT_AS_DELEGATED_ADMINISTRATOR: You cannot
* register a suspended account as a delegated administrator.</p>
* </li>
* <li>
* <p>CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You attempted to register
* the management account of the organization as a delegated administrator for an
* Amazon Web Services service integrated with Organizations. You can designate only a member account as a
Expand Down Expand Up @@ -222,15 +226,13 @@ export interface AttachPolicyCommandOutput extends __MetadataBearer {}
* management account must have an associated account in the Amazon Web Services GovCloud
* (US-West) Region. For more information, see <a href="https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/govcloud-organizations.html">Organizations</a>
* in the
* <i>Amazon Web Services GovCloud User Guide.</i>
* </p>
* <i>Amazon Web Services GovCloud User Guide</i>.</p>
* </li>
* <li>
* <p>MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with
* this management account, you first must associate a valid payment instrument,
* such as a credit card, with the account. Follow the steps at <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info">To leave an organization when all required account information has not yet
* been provided</a> in the <i>Organizations User Guide.</i>
* </p>
* such as a credit card, with the account. For more information, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_account-before-remove.html">Considerations before removing an account from an organization</a> in
* the <i>Organizations User Guide</i>.</p>
* </li>
* <li>
* <p>MAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to
Expand All @@ -249,9 +251,8 @@ export interface AttachPolicyCommandOutput extends __MetadataBearer {}
* <li>
* <p>MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with
* this member account, you first must associate a valid payment instrument, such
* as a credit card, with the account. Follow the steps at <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info">To leave an organization when all required account information has not yet
* been provided</a> in the <i>Organizations User Guide.</i>
* </p>
* as a credit card, with the account. For more information, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_account-before-remove.html">Considerations before removing an account from an organization</a> in
* the <i>Organizations User Guide</i>.</p>
* </li>
* <li>
* <p>MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy
Expand Down Expand Up @@ -413,9 +414,8 @@ export interface AttachPolicyCommandOutput extends __MetadataBearer {}
* @throws {@link PolicyTypeNotEnabledException} (client fault)
* <p>The specified policy type isn't currently enabled in this root. You can't attach
* policies of the specified type to entities in a root until you enable that type in the
* root. For more information, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html">Enabling All Features
* in Your Organization</a> in the <i>Organizations User Guide.</i>
* </p>
* root. For more information, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html">Enabling all features
* in your organization</a> in the <i>Organizations User Guide</i>.</p>
*
* @throws {@link ServiceException} (server fault)
* <p>Organizations can't complete your request because of an internal service error. Try again
Expand All @@ -428,9 +428,8 @@ export interface AttachPolicyCommandOutput extends __MetadataBearer {}
* @throws {@link TooManyRequestsException} (client fault)
* <p>You have sent too many requests in too short a period of time. The quota helps protect
* against denial-of-service attacks. Try again later.</p>
* <p>For information about quotas that affect Organizations, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_limits.html">Quotas for Organizations</a>in the
* <i>Organizations User Guide.</i>
* </p>
* <p>For information about quotas that affect Organizations, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_limits.html">Quotas for Organizations</a> in the
* <i>Organizations User Guide</i>.</p>
*
* @throws {@link UnsupportedAPIEndpointException} (client fault)
* <p>This action isn't available in the current Amazon Web Services Region.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,7 @@ export interface CancelHandshakeCommandOutput extends CancelHandshakeResponse, _
* <p>You don't have permissions to perform the requested operation. The user or role that
* is making the request must have at least one IAM permissions policy attached that
* grants the required permissions. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access Management</a> in the
* <i>IAM User Guide.</i>
* </p>
* <i>IAM User Guide</i>.</p>
*
* @throws {@link ConcurrentModificationException} (client fault)
* <p>The target of the operation is currently being modified by a different request. Try
Expand Down Expand Up @@ -229,9 +228,8 @@ export interface CancelHandshakeCommandOutput extends CancelHandshakeResponse, _
* @throws {@link TooManyRequestsException} (client fault)
* <p>You have sent too many requests in too short a period of time. The quota helps protect
* against denial-of-service attacks. Try again later.</p>
* <p>For information about quotas that affect Organizations, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_limits.html">Quotas for Organizations</a>in the
* <i>Organizations User Guide.</i>
* </p>
* <p>For information about quotas that affect Organizations, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_limits.html">Quotas for Organizations</a> in the
* <i>Organizations User Guide</i>.</p>
*
* @throws {@link OrganizationsServiceException}
* <p>Base exception class for all service exceptions from Organizations service.</p>
Expand Down
Loading

0 comments on commit 26c3994

Please sign in to comment.