@aws-sdk/client-organizations 3.288.0 → 3.290.0

package/dist-types/commands/ListAccountsForParentCommand.d.ts

@@ -43,6 +43,171 @@ export interface ListAccountsForParentCommandOutput extends ListAccountsForParen
  * @see {@link ListAccountsForParentCommandOutput} for command's `response` shape.
  * @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
  *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <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>
+ *
+ * @throws {@link AWSOrganizationsNotInUseException} (client fault)
+ *  <p>Your account isn't a member of an organization. To make this request, you must use the
+ *             credentials of an account that belongs to an organization.</p>
+ *
+ * @throws {@link InvalidInputException} (client fault)
+ *  <p>The requested operation failed because you provided invalid values for one or more of
+ *             the request parameters. This exception includes a reason that contains additional
+ *             information about the violated limit:</p>
+ *          <note>
+ *             <p>Some of the reasons in the following list might not be applicable to this specific
+ *                 API or operation.</p>
+ *          </note>
+ *          <ul>
+ *             <li>
+ *                <p>DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same
+ *                     entity.</p>
+ *             </li>
+ *             <li>
+ *                <p>IMMUTABLE_POLICY: You specified a policy that is managed by Amazon Web Services and can't be
+ *                     modified.</p>
+ *             </li>
+ *             <li>
+ *                <p>INPUT_REQUIRED: You must include a value for all required parameters.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the
+ *                     invited account owner.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_ENUM: You specified an invalid value.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid
+ *                     characters.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least
+ *                     one invalid value.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_PAGINATION_TOKEN: Get the value for the <code>NextToken</code>
+ *                     parameter from the response to a previous call of the operation.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account,
+ *                     organization, or email) as a party.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_PATTERN: You provided a value that doesn't match the required
+ *                     pattern.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match
+ *                     the required pattern.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name
+ *                     can't begin with the reserved prefix <code>AWSServiceRoleFor</code>.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name
+ *                     (ARN) for the organization.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID. </p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag.
+ *                     You can’t add, edit, or delete system tag keys because they're reserved for
+ *                     Amazon Web Services use. System tags don’t count against your tags per resource limit.</p>
+ *             </li>
+ *             <li>
+ *                <p>MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the
+ *                     operation.</p>
+ *             </li>
+ *             <li>
+ *                <p>MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than
+ *                     allowed.</p>
+ *             </li>
+ *             <li>
+ *                <p>MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value
+ *                     than allowed.</p>
+ *             </li>
+ *             <li>
+ *                <p>MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than
+ *                     allowed.</p>
+ *             </li>
+ *             <li>
+ *                <p>MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value
+ *                     than allowed.</p>
+ *             </li>
+ *             <li>
+ *                <p>MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between
+ *                     entities in the same root.</p>
+ *             </li>
+ *             <li>
+ *                <p>TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target
+ *                     entity.</p>
+ *             </li>
+ *             <li>
+ *                <p>UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't
+ *                     recognized.</p>
+ *             </li>
+ *          </ul>
+ *
+ * @throws {@link ParentNotFoundException} (client fault)
+ *  <p>We can't find a root or OU with the <code>ParentId</code> that you specified.</p>
+ *
+ * @throws {@link ServiceException} (server fault)
+ *  <p>Organizations can't complete your request because of an internal service error. Try again
+ *             later.</p>
+ *
+ * @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>
+ *
+ *
+ * @example To retrieve a list of all of the accounts in a root or OU
+ * ```javascript
+ * // The following example shows how to request a list of the accounts in an OU:/n/n
+ * const input = {
+ *   "ParentId": "ou-examplerootid111-exampleouid111"
+ * };
+ * const command = new ListAccountsForParentCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Accounts": [
+ *     {
+ *       "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333",
+ *       "Email": "juan@example.com",
+ *       "Id": "333333333333",
+ *       "JoinedMethod": "INVITED",
+ *       "JoinedTimestamp": 1481835795.536,
+ *       "Name": "Development Account",
+ *       "Status": "ACTIVE"
+ *     },
+ *     {
+ *       "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/444444444444",
+ *       "Email": "anika@example.com",
+ *       "Id": "444444444444",
+ *       "JoinedMethod": "INVITED",
+ *       "JoinedTimestamp": 1481835812.143,
+ *       "Name": "Test Account",
+ *       "Status": "ACTIVE"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-retrieve-a-list-of-all-of-the-accounts-in-a-root-or-ou-1472509590974
+ * ```
+ *
  */
 export declare class ListAccountsForParentCommand extends $Command<ListAccountsForParentCommandInput, ListAccountsForParentCommandOutput, OrganizationsClientResolvedConfig> {
     readonly input: ListAccountsForParentCommandInput;

package/dist-types/commands/ListChildrenCommand.d.ts

@@ -41,6 +41,162 @@ export interface ListChildrenCommandOutput extends ListChildrenResponse, __Metad
  * @see {@link ListChildrenCommandOutput} for command's `response` shape.
  * @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
  *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <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>
+ *
+ * @throws {@link AWSOrganizationsNotInUseException} (client fault)
+ *  <p>Your account isn't a member of an organization. To make this request, you must use the
+ *             credentials of an account that belongs to an organization.</p>
+ *
+ * @throws {@link InvalidInputException} (client fault)
+ *  <p>The requested operation failed because you provided invalid values for one or more of
+ *             the request parameters. This exception includes a reason that contains additional
+ *             information about the violated limit:</p>
+ *          <note>
+ *             <p>Some of the reasons in the following list might not be applicable to this specific
+ *                 API or operation.</p>
+ *          </note>
+ *          <ul>
+ *             <li>
+ *                <p>DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same
+ *                     entity.</p>
+ *             </li>
+ *             <li>
+ *                <p>IMMUTABLE_POLICY: You specified a policy that is managed by Amazon Web Services and can't be
+ *                     modified.</p>
+ *             </li>
+ *             <li>
+ *                <p>INPUT_REQUIRED: You must include a value for all required parameters.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the
+ *                     invited account owner.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_ENUM: You specified an invalid value.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid
+ *                     characters.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least
+ *                     one invalid value.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_PAGINATION_TOKEN: Get the value for the <code>NextToken</code>
+ *                     parameter from the response to a previous call of the operation.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account,
+ *                     organization, or email) as a party.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_PATTERN: You provided a value that doesn't match the required
+ *                     pattern.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match
+ *                     the required pattern.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name
+ *                     can't begin with the reserved prefix <code>AWSServiceRoleFor</code>.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name
+ *                     (ARN) for the organization.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID. </p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag.
+ *                     You can’t add, edit, or delete system tag keys because they're reserved for
+ *                     Amazon Web Services use. System tags don’t count against your tags per resource limit.</p>
+ *             </li>
+ *             <li>
+ *                <p>MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the
+ *                     operation.</p>
+ *             </li>
+ *             <li>
+ *                <p>MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than
+ *                     allowed.</p>
+ *             </li>
+ *             <li>
+ *                <p>MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value
+ *                     than allowed.</p>
+ *             </li>
+ *             <li>
+ *                <p>MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than
+ *                     allowed.</p>
+ *             </li>
+ *             <li>
+ *                <p>MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value
+ *                     than allowed.</p>
+ *             </li>
+ *             <li>
+ *                <p>MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between
+ *                     entities in the same root.</p>
+ *             </li>
+ *             <li>
+ *                <p>TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target
+ *                     entity.</p>
+ *             </li>
+ *             <li>
+ *                <p>UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't
+ *                     recognized.</p>
+ *             </li>
+ *          </ul>
+ *
+ * @throws {@link ParentNotFoundException} (client fault)
+ *  <p>We can't find a root or OU with the <code>ParentId</code> that you specified.</p>
+ *
+ * @throws {@link ServiceException} (server fault)
+ *  <p>Organizations can't complete your request because of an internal service error. Try again
+ *             later.</p>
+ *
+ * @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>
+ *
+ *
+ * @example To retrieve a list of all of the child accounts and OUs in a parent root or OU
+ * ```javascript
+ * // The following example shows how to request a list of the child OUs in a parent root or OU:/n/n
+ * const input = {
+ *   "ChildType": "ORGANIZATIONAL_UNIT",
+ *   "ParentId": "ou-examplerootid111-exampleouid111"
+ * };
+ * const command = new ListChildrenCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Children": [
+ *     {
+ *       "Id": "ou-examplerootid111-exampleouid111",
+ *       "Type": "ORGANIZATIONAL_UNIT"
+ *     },
+ *     {
+ *       "Id": "ou-examplerootid111-exampleouid222",
+ *       "Type": "ORGANIZATIONAL_UNIT"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-retrieve-a-list-of-all-of-the-child-accounts-and-OUs-in-a-parent-container
+ * ```
+ *
  */
 export declare class ListChildrenCommand extends $Command<ListChildrenCommandInput, ListChildrenCommandOutput, OrganizationsClientResolvedConfig> {
     readonly input: ListChildrenCommandInput;

package/dist-types/commands/ListCreateAccountStatusCommand.d.ts

@@ -40,6 +40,188 @@ export interface ListCreateAccountStatusCommandOutput extends ListCreateAccountS
  * @see {@link ListCreateAccountStatusCommandOutput} for command's `response` shape.
  * @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
  *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <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>
+ *
+ * @throws {@link AWSOrganizationsNotInUseException} (client fault)
+ *  <p>Your account isn't a member of an organization. To make this request, you must use the
+ *             credentials of an account that belongs to an organization.</p>
+ *
+ * @throws {@link InvalidInputException} (client fault)
+ *  <p>The requested operation failed because you provided invalid values for one or more of
+ *             the request parameters. This exception includes a reason that contains additional
+ *             information about the violated limit:</p>
+ *          <note>
+ *             <p>Some of the reasons in the following list might not be applicable to this specific
+ *                 API or operation.</p>
+ *          </note>
+ *          <ul>
+ *             <li>
+ *                <p>DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same
+ *                     entity.</p>
+ *             </li>
+ *             <li>
+ *                <p>IMMUTABLE_POLICY: You specified a policy that is managed by Amazon Web Services and can't be
+ *                     modified.</p>
+ *             </li>
+ *             <li>
+ *                <p>INPUT_REQUIRED: You must include a value for all required parameters.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the
+ *                     invited account owner.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_ENUM: You specified an invalid value.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid
+ *                     characters.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least
+ *                     one invalid value.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_PAGINATION_TOKEN: Get the value for the <code>NextToken</code>
+ *                     parameter from the response to a previous call of the operation.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account,
+ *                     organization, or email) as a party.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_PATTERN: You provided a value that doesn't match the required
+ *                     pattern.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match
+ *                     the required pattern.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name
+ *                     can't begin with the reserved prefix <code>AWSServiceRoleFor</code>.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name
+ *                     (ARN) for the organization.</p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID. </p>
+ *             </li>
+ *             <li>
+ *                <p>INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag.
+ *                     You can’t add, edit, or delete system tag keys because they're reserved for
+ *                     Amazon Web Services use. System tags don’t count against your tags per resource limit.</p>
+ *             </li>
+ *             <li>
+ *                <p>MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the
+ *                     operation.</p>
+ *             </li>
+ *             <li>
+ *                <p>MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than
+ *                     allowed.</p>
+ *             </li>
+ *             <li>
+ *                <p>MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value
+ *                     than allowed.</p>
+ *             </li>
+ *             <li>
+ *                <p>MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than
+ *                     allowed.</p>
+ *             </li>
+ *             <li>
+ *                <p>MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value
+ *                     than allowed.</p>
+ *             </li>
+ *             <li>
+ *                <p>MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between
+ *                     entities in the same root.</p>
+ *             </li>
+ *             <li>
+ *                <p>TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target
+ *                     entity.</p>
+ *             </li>
+ *             <li>
+ *                <p>UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't
+ *                     recognized.</p>
+ *             </li>
+ *          </ul>
+ *
+ * @throws {@link ServiceException} (server fault)
+ *  <p>Organizations can't complete your request because of an internal service error. Try again
+ *             later.</p>
+ *
+ * @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>
+ *
+ * @throws {@link UnsupportedAPIEndpointException} (client fault)
+ *  <p>This action isn't available in the current Amazon Web Services Region.</p>
+ *
+ *
+ * @example To get a list of completed account creation requests made in the organization
+ * ```javascript
+ * // The following example shows a user requesting a list of only the completed account creation requests made for the current organization:
+ * const input = {
+ *   "States": [
+ *     "SUCCEEDED"
+ *   ]
+ * };
+ * const command = new ListCreateAccountStatusCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "CreateAccountStatuses": [
+ *     {
+ *       "AccountId": "444444444444",
+ *       "AccountName": "Developer Test Account",
+ *       "CompletedTimestamp": "2017-01-15T13:45:23.6Z",
+ *       "Id": "car-exampleaccountcreationrequestid1",
+ *       "RequestedTimestamp": "2017-01-15T13:45:23.01Z",
+ *       "State": "SUCCEEDED"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-get-a-list-of-completed-account-creation-requests-made-in-the-organization
+ * ```
+ *
+ * @example To get a list of all account creation requests made in the organization
+ * ```javascript
+ * // The following example shows a user requesting a list of only the in-progress account creation requests made for the current organization:
+ * const input = {
+ *   "States": [
+ *     "IN_PROGRESS"
+ *   ]
+ * };
+ * const command = new ListCreateAccountStatusCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "CreateAccountStatuses": [
+ *     {
+ *       "AccountName": "Production Account",
+ *       "Id": "car-exampleaccountcreationrequestid2",
+ *       "RequestedTimestamp": "2017-01-15T13:45:23.01Z",
+ *       "State": "IN_PROGRESS"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-get-a-list-of-all-account-creation-requests-made-in-the-organization-1472509174532
+ * ```
+ *
  */
 export declare class ListCreateAccountStatusCommand extends $Command<ListCreateAccountStatusCommandInput, ListCreateAccountStatusCommandOutput, OrganizationsClientResolvedConfig> {
     readonly input: ListCreateAccountStatusCommandInput;