@aws-sdk/client-iam 3.775.0 → 3.777.0

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

@@ -105,29 +105,29 @@ declare const CreateUserCommand_base: {
  * @throws {@link IAMServiceException}
  * <p>Base exception class for all service exceptions from IAM service.</p>
  *
- * @public
+ *
  * @example To create an IAM user
  * ```javascript
  * // The following create-user command creates an IAM user named Bob in the current account.
  * const input = {
- *   "UserName": "Bob"
+ *   UserName: "Bob"
  * };
  * const command = new CreateUserCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "User": {
- *     "Arn": "arn:aws:iam::123456789012:user/Bob",
- *     "CreateDate": "2013-06-08T03:20:41.270Z",
- *     "Path": "/",
- *     "UserId": "AKIAIOSFODNN7EXAMPLE",
- *     "UserName": "Bob"
+ *   User: {
+ *     Arn: "arn:aws:iam::123456789012:user/Bob",
+ *     CreateDate: "2013-06-08T03:20:41.270Z",
+ *     Path: "/",
+ *     UserId: "AKIAIOSFODNN7EXAMPLE",
+ *     UserName: "Bob"
  *   }
  * }
  * *\/
- * // example id: eb15f90b-e5f5-4af8-a594-e4e82b181a62
  * ```
  *
+ * @public
  */
 export declare class CreateUserCommand extends CreateUserCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -122,6 +122,7 @@ declare const CreateVirtualMFADeviceCommand_base: {
  * @throws {@link IAMServiceException}
  * <p>Base exception class for all service exceptions from IAM service.</p>
  *
+ *
  * @public
  */
 export declare class CreateVirtualMFADeviceCommand extends CreateVirtualMFADeviceCommand_base {

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

@@ -79,6 +79,7 @@ declare const DeactivateMFADeviceCommand_base: {
  * @throws {@link IAMServiceException}
  * <p>Base exception class for all service exceptions from IAM service.</p>
  *
+ *
  * @public
  */
 export declare class DeactivateMFADeviceCommand extends DeactivateMFADeviceCommand_base {

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

@@ -69,19 +69,22 @@ declare const DeleteAccessKeyCommand_base: {
  * @throws {@link IAMServiceException}
  * <p>Base exception class for all service exceptions from IAM service.</p>
  *
- * @public
+ *
  * @example To delete an access key for an IAM user
  * ```javascript
  * // The following command deletes one access key (access key ID and secret access key) assigned to the IAM user named Bob.
  * const input = {
- *   "AccessKeyId": "AKIDPMS9RO4H3FEXAMPLE",
- *   "UserName": "Bob"
+ *   AccessKeyId: "AKIDPMS9RO4H3FEXAMPLE",
+ *   UserName: "Bob"
  * };
  * const command = new DeleteAccessKeyCommand(input);
- * await client.send(command);
- * // example id: 61a785a7-d30a-415a-ae18-ab9236e56871
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeleteAccessKeyCommand extends DeleteAccessKeyCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -71,18 +71,21 @@ declare const DeleteAccountAliasCommand_base: {
  * @throws {@link IAMServiceException}
  * <p>Base exception class for all service exceptions from IAM service.</p>
  *
- * @public
+ *
  * @example To delete an account alias
  * ```javascript
  * // The following command removes the alias mycompany from the current AWS account:
  * const input = {
- *   "AccountAlias": "mycompany"
+ *   AccountAlias: "mycompany"
  * };
  * const command = new DeleteAccountAliasCommand(input);
- * await client.send(command);
- * // example id: 7abeca65-04a8-4500-a890-47f1092bf766
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeleteAccountAliasCommand extends DeleteAccountAliasCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -61,16 +61,19 @@ declare const DeleteAccountPasswordPolicyCommand_base: {
  * @throws {@link IAMServiceException}
  * <p>Base exception class for all service exceptions from IAM service.</p>
  *
- * @public
+ *
  * @example To delete the current account password policy
  * ```javascript
  * // The following command removes the password policy from the current AWS account:
- * const input = {};
+ * const input = { /* empty *\/ };
  * const command = new DeleteAccountPasswordPolicyCommand(input);
- * await client.send(command);
- * // example id: 9ddf755e-495c-49bc-ae3b-ea6cc9b8ebcf
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeleteAccountPasswordPolicyCommand extends DeleteAccountPasswordPolicyCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -69,6 +69,7 @@ declare const DeleteGroupCommand_base: {
  * @throws {@link IAMServiceException}
  * <p>Base exception class for all service exceptions from IAM service.</p>
  *
+ *
  * @public
  */
 export declare class DeleteGroupCommand extends DeleteGroupCommand_base {

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

@@ -70,19 +70,22 @@ declare const DeleteGroupPolicyCommand_base: {
  * @throws {@link IAMServiceException}
  * <p>Base exception class for all service exceptions from IAM service.</p>
  *
- * @public
+ *
  * @example To delete a policy from an IAM group
  * ```javascript
  * // The following command deletes the policy named ExamplePolicy from the group named Admins:
  * const input = {
- *   "GroupName": "Admins",
- *   "PolicyName": "ExamplePolicy"
+ *   GroupName: "Admins",
+ *   PolicyName: "ExamplePolicy"
  * };
  * const command = new DeleteGroupPolicyCommand(input);
- * await client.send(command);
- * // example id: e683f2bd-98a4-4fe0-bb66-33169c692d4a
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeleteGroupPolicyCommand extends DeleteGroupPolicyCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -77,18 +77,21 @@ declare const DeleteInstanceProfileCommand_base: {
  * @throws {@link IAMServiceException}
  * <p>Base exception class for all service exceptions from IAM service.</p>
  *
- * @public
+ *
  * @example To delete an instance profile
  * ```javascript
  * // The following command deletes the instance profile named ExampleInstanceProfile
  * const input = {
- *   "InstanceProfileName": "ExampleInstanceProfile"
+ *   InstanceProfileName: "ExampleInstanceProfile"
  * };
  * const command = new DeleteInstanceProfileCommand(input);
- * await client.send(command);
- * // example id: 12d74fb8-3433-49db-8171-a1fc764e354d
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeleteInstanceProfileCommand extends DeleteInstanceProfileCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -82,18 +82,21 @@ declare const DeleteLoginProfileCommand_base: {
  * @throws {@link IAMServiceException}
  * <p>Base exception class for all service exceptions from IAM service.</p>
  *
- * @public
+ *
  * @example To delete a password for an IAM user
  * ```javascript
  * // The following command deletes the password for the IAM user named Bob.
  * const input = {
- *   "UserName": "Bob"
+ *   UserName: "Bob"
  * };
  * const command = new DeleteLoginProfileCommand(input);
- * await client.send(command);
- * // example id: 1fe57059-fc73-42e2-b992-517b7d573b5c
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeleteLoginProfileCommand extends DeleteLoginProfileCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -69,6 +69,7 @@ declare const DeleteOpenIDConnectProviderCommand_base: {
  * @throws {@link IAMServiceException}
  * <p>Base exception class for all service exceptions from IAM service.</p>
  *
+ *
  * @public
  */
 export declare class DeleteOpenIDConnectProviderCommand extends DeleteOpenIDConnectProviderCommand_base {

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

@@ -96,6 +96,7 @@ declare const DeletePolicyCommand_base: {
  * @throws {@link IAMServiceException}
  * <p>Base exception class for all service exceptions from IAM service.</p>
  *
+ *
  * @public
  */
 export declare class DeletePolicyCommand extends DeletePolicyCommand_base {

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

@@ -78,6 +78,7 @@ declare const DeletePolicyVersionCommand_base: {
  * @throws {@link IAMServiceException}
  * <p>Base exception class for all service exceptions from IAM service.</p>
  *
+ *
  * @public
  */
 export declare class DeletePolicyVersionCommand extends DeletePolicyVersionCommand_base {

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

@@ -101,18 +101,21 @@ declare const DeleteRoleCommand_base: {
  * @throws {@link IAMServiceException}
  * <p>Base exception class for all service exceptions from IAM service.</p>
  *
- * @public
+ *
  * @example To delete an IAM role
  * ```javascript
  * // The following command removes the role named Test-Role.
  * const input = {
- *   "RoleName": "Test-Role"
+ *   RoleName: "Test-Role"
  * };
  * const command = new DeleteRoleCommand(input);
- * await client.send(command);
- * // example id: 053cdf74-9bda-44b8-bdbb-140fd5a32603
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeleteRoleCommand extends DeleteRoleCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -72,6 +72,7 @@ declare const DeleteRolePermissionsBoundaryCommand_base: {
  * @throws {@link IAMServiceException}
  * <p>Base exception class for all service exceptions from IAM service.</p>
  *
+ *
  * @public
  */
 export declare class DeleteRolePermissionsBoundaryCommand extends DeleteRolePermissionsBoundaryCommand_base {

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

@@ -76,19 +76,22 @@ declare const DeleteRolePolicyCommand_base: {
  * @throws {@link IAMServiceException}
  * <p>Base exception class for all service exceptions from IAM service.</p>
  *
- * @public
+ *
  * @example To remove a policy from an IAM role
  * ```javascript
  * // The following command removes the policy named ExamplePolicy from the role named Test-Role.
  * const input = {
- *   "PolicyName": "ExamplePolicy",
- *   "RoleName": "Test-Role"
+ *   PolicyName: "ExamplePolicy",
+ *   RoleName: "Test-Role"
  * };
  * const command = new DeleteRolePolicyCommand(input);
- * await client.send(command);
- * // example id: 9c667336-fde3-462c-b8f3-950800821e27
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeleteRolePolicyCommand extends DeleteRolePolicyCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -74,6 +74,7 @@ declare const DeleteSAMLProviderCommand_base: {
  * @throws {@link IAMServiceException}
  * <p>Base exception class for all service exceptions from IAM service.</p>
  *
+ *
  * @public
  */
 export declare class DeleteSAMLProviderCommand extends DeleteSAMLProviderCommand_base {

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

@@ -61,6 +61,7 @@ declare const DeleteSSHPublicKeyCommand_base: {
  * @throws {@link IAMServiceException}
  * <p>Base exception class for all service exceptions from IAM service.</p>
  *
+ *
  * @public
  */
 export declare class DeleteSSHPublicKeyCommand extends DeleteSSHPublicKeyCommand_base {

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

@@ -82,6 +82,7 @@ declare const DeleteServerCertificateCommand_base: {
  * @throws {@link IAMServiceException}
  * <p>Base exception class for all service exceptions from IAM service.</p>
  *
+ *
  * @public
  */
 export declare class DeleteServerCertificateCommand extends DeleteServerCertificateCommand_base {

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

@@ -82,6 +82,7 @@ declare const DeleteServiceLinkedRoleCommand_base: {
  * @throws {@link IAMServiceException}
  * <p>Base exception class for all service exceptions from IAM service.</p>
  *
+ *
  * @public
  */
 export declare class DeleteServiceLinkedRoleCommand extends DeleteServiceLinkedRoleCommand_base {

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

@@ -57,6 +57,7 @@ declare const DeleteServiceSpecificCredentialCommand_base: {
  * @throws {@link IAMServiceException}
  * <p>Base exception class for all service exceptions from IAM service.</p>
  *
+ *
  * @public
  */
 export declare class DeleteServiceSpecificCredentialCommand extends DeleteServiceSpecificCredentialCommand_base {

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

@@ -73,19 +73,22 @@ declare const DeleteSigningCertificateCommand_base: {
  * @throws {@link IAMServiceException}
  * <p>Base exception class for all service exceptions from IAM service.</p>
  *
- * @public
+ *
  * @example To delete a signing certificate for an IAM user
  * ```javascript
  * // The following command deletes the specified signing certificate for the IAM user named Anika.
  * const input = {
- *   "CertificateId": "TA7SMP42TDN5Z26OBPJE7EXAMPLE",
- *   "UserName": "Anika"
+ *   CertificateId: "TA7SMP42TDN5Z26OBPJE7EXAMPLE",
+ *   UserName: "Anika"
  * };
  * const command = new DeleteSigningCertificateCommand(input);
- * await client.send(command);
- * // example id: e3357586-ba9c-4070-b35b-d1a899b71987
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeleteSigningCertificateCommand extends DeleteSigningCertificateCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -104,18 +104,21 @@ declare const DeleteUserCommand_base: {
  * @throws {@link IAMServiceException}
  * <p>Base exception class for all service exceptions from IAM service.</p>
  *
- * @public
+ *
  * @example To delete an IAM user
  * ```javascript
  * // The following command removes the IAM user named Bob from the current account.
  * const input = {
- *   "UserName": "Bob"
+ *   UserName: "Bob"
  * };
  * const command = new DeleteUserCommand(input);
- * await client.send(command);
- * // example id: a13dc3f9-59fe-42d9-abbb-fb98b204fdf0
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeleteUserCommand extends DeleteUserCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -65,6 +65,7 @@ declare const DeleteUserPermissionsBoundaryCommand_base: {
  * @throws {@link IAMServiceException}
  * <p>Base exception class for all service exceptions from IAM service.</p>
  *
+ *
  * @public
  */
 export declare class DeleteUserPermissionsBoundaryCommand extends DeleteUserPermissionsBoundaryCommand_base {

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

@@ -70,19 +70,22 @@ declare const DeleteUserPolicyCommand_base: {
  * @throws {@link IAMServiceException}
  * <p>Base exception class for all service exceptions from IAM service.</p>
  *
- * @public
+ *
  * @example To remove a policy from an IAM user
  * ```javascript
  * // The following delete-user-policy command removes the specified policy from the IAM user named Juan:
  * const input = {
- *   "PolicyName": "ExamplePolicy",
- *   "UserName": "Juan"
+ *   PolicyName: "ExamplePolicy",
+ *   UserName: "Juan"
  * };
  * const command = new DeleteUserPolicyCommand(input);
- * await client.send(command);
- * // example id: 34f07ddc-9bc1-4f52-bc59-cd0a3ccd06c8
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeleteUserPolicyCommand extends DeleteUserPolicyCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -76,18 +76,21 @@ declare const DeleteVirtualMFADeviceCommand_base: {
  * @throws {@link IAMServiceException}
  * <p>Base exception class for all service exceptions from IAM service.</p>
  *
- * @public
+ *
  * @example To remove a virtual MFA device
  * ```javascript
  * // The following delete-virtual-mfa-device command removes the specified MFA device from the current AWS account.
  * const input = {
- *   "SerialNumber": "arn:aws:iam::123456789012:mfa/ExampleName"
+ *   SerialNumber: "arn:aws:iam::123456789012:mfa/ExampleName"
  * };
  * const command = new DeleteVirtualMFADeviceCommand(input);
- * await client.send(command);
- * // example id: 2933b08b-dbe7-4b89-b8c1-fdf75feea1ee
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeleteVirtualMFADeviceCommand extends DeleteVirtualMFADeviceCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -73,6 +73,7 @@ declare const DetachGroupPolicyCommand_base: {
  * @throws {@link IAMServiceException}
  * <p>Base exception class for all service exceptions from IAM service.</p>
  *
+ *
  * @public
  */
 export declare class DetachGroupPolicyCommand extends DetachGroupPolicyCommand_base {

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

@@ -79,6 +79,7 @@ declare const DetachRolePolicyCommand_base: {
  * @throws {@link IAMServiceException}
  * <p>Base exception class for all service exceptions from IAM service.</p>
  *
+ *
  * @public
  */
 export declare class DetachRolePolicyCommand extends DetachRolePolicyCommand_base {

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

@@ -73,6 +73,7 @@ declare const DetachUserPolicyCommand_base: {
  * @throws {@link IAMServiceException}
  * <p>Base exception class for all service exceptions from IAM service.</p>
  *
+ *
  * @public
  */
 export declare class DetachUserPolicyCommand extends DetachUserPolicyCommand_base {

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

@@ -74,24 +74,24 @@ declare const DisableOrganizationsRootCredentialsManagementCommand_base: {
  * @throws {@link IAMServiceException}
  * <p>Base exception class for all service exceptions from IAM service.</p>
  *
- * @public
+ *
  * @example To disable the RootCredentialsManagement feature in your organization
  * ```javascript
  * // The following command disables the management of privileged root user credentials across member accounts in your organization.
- * const input = {};
+ * const input = { /* empty *\/ };
  * const command = new DisableOrganizationsRootCredentialsManagementCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "EnabledFeatures": [
+ *   EnabledFeatures: [
  *     "RootSessions"
  *   ],
- *   "OrganizationId": "o-aa111bb222"
+ *   OrganizationId: "o-aa111bb222"
  * }
  * *\/
- * // example id: to-disable-the-rootcredentialsmanagement-feature-in-your-organization-1730908292211
  * ```
  *
+ * @public
  */
 export declare class DisableOrganizationsRootCredentialsManagementCommand extends DisableOrganizationsRootCredentialsManagementCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -74,24 +74,24 @@ declare const DisableOrganizationsRootSessionsCommand_base: {
  * @throws {@link IAMServiceException}
  * <p>Base exception class for all service exceptions from IAM service.</p>
  *
- * @public
+ *
  * @example To disable the RootSessions feature in your organization
  * ```javascript
  * // The following command disables root user sessions for privileged tasks across member accounts in your organization.
- * const input = {};
+ * const input = { /* empty *\/ };
  * const command = new DisableOrganizationsRootSessionsCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "EnabledFeatures": [
+ *   EnabledFeatures: [
  *     "RootCredentialsManagement"
  *   ],
- *   "OrganizationId": "o-aa111bb222"
+ *   OrganizationId: "o-aa111bb222"
  * }
  * *\/
- * // example id: to-disable-the-rootsessions-feature-in-your-organization-1730908495962
  * ```
  *
+ * @public
  */
 export declare class DisableOrganizationsRootSessionsCommand extends DisableOrganizationsRootSessionsCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -87,6 +87,7 @@ declare const EnableMFADeviceCommand_base: {
  * @throws {@link IAMServiceException}
  * <p>Base exception class for all service exceptions from IAM service.</p>
  *
+ *
  * @public
  */
 export declare class EnableMFADeviceCommand extends EnableMFADeviceCommand_base {

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

@@ -90,24 +90,24 @@ declare const EnableOrganizationsRootCredentialsManagementCommand_base: {
  * @throws {@link IAMServiceException}
  * <p>Base exception class for all service exceptions from IAM service.</p>
  *
- * @public
+ *
  * @example To enable the RootCredentialsManagement feature in your organization
  * ```javascript
  * // The following command enables the management of privileged root user credentials across member accounts in your organization.
- * const input = {};
+ * const input = { /* empty *\/ };
  * const command = new EnableOrganizationsRootCredentialsManagementCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "EnabledFeatures": [
+ *   EnabledFeatures: [
  *     "RootCredentialsManagement"
  *   ],
- *   "OrganizationId": "o-aa111bb222"
+ *   OrganizationId: "o-aa111bb222"
  * }
  * *\/
- * // example id: to-enable-the-rootcredentialsmanagement-feature-in-your-organization-1730908602395
  * ```
  *
+ * @public
  */
 export declare class EnableOrganizationsRootCredentialsManagementCommand extends EnableOrganizationsRootCredentialsManagementCommand_base {
     /** @internal type navigation helper, not in runtime. */