@aws-sdk/client-iam 3.262.0 → 3.264.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-types/IAM.d.ts +384 -351
- package/dist-types/commands/AddClientIDToOpenIDConnectProviderCommand.d.ts +1 -1
- package/dist-types/commands/AddRoleToInstanceProfileCommand.d.ts +3 -3
- package/dist-types/commands/AttachGroupPolicyCommand.d.ts +3 -3
- package/dist-types/commands/AttachRolePolicyCommand.d.ts +4 -4
- package/dist-types/commands/AttachUserPolicyCommand.d.ts +3 -3
- package/dist-types/commands/ChangePasswordCommand.d.ts +1 -1
- package/dist-types/commands/CreateAccessKeyCommand.d.ts +4 -4
- package/dist-types/commands/CreateGroupCommand.d.ts +1 -1
- package/dist-types/commands/CreateInstanceProfileCommand.d.ts +1 -1
- package/dist-types/commands/CreateLoginProfileCommand.d.ts +2 -2
- package/dist-types/commands/CreateOpenIDConnectProviderCommand.d.ts +15 -14
- package/dist-types/commands/CreatePolicyCommand.d.ts +3 -3
- package/dist-types/commands/CreatePolicyVersionCommand.d.ts +2 -2
- package/dist-types/commands/CreateSAMLProviderCommand.d.ts +5 -5
- package/dist-types/commands/CreateServiceLinkedRoleCommand.d.ts +1 -1
- package/dist-types/commands/CreateServiceSpecificCredentialCommand.d.ts +4 -4
- package/dist-types/commands/CreateUserCommand.d.ts +1 -1
- package/dist-types/commands/CreateVirtualMFADeviceCommand.d.ts +3 -3
- package/dist-types/commands/DeactivateMFADeviceCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAccessKeyCommand.d.ts +1 -1
- package/dist-types/commands/DeleteGroupPolicyCommand.d.ts +1 -1
- package/dist-types/commands/DeleteInstanceProfileCommand.d.ts +3 -3
- package/dist-types/commands/DeleteLoginProfileCommand.d.ts +3 -3
- package/dist-types/commands/DeleteOpenIDConnectProviderCommand.d.ts +2 -2
- package/dist-types/commands/DeletePolicyCommand.d.ts +6 -6
- package/dist-types/commands/DeletePolicyVersionCommand.d.ts +2 -2
- package/dist-types/commands/DeleteRoleCommand.d.ts +21 -4
- package/dist-types/commands/DeleteRolePermissionsBoundaryCommand.d.ts +2 -2
- package/dist-types/commands/DeleteRolePolicyCommand.d.ts +1 -1
- package/dist-types/commands/DeleteSAMLProviderCommand.d.ts +3 -3
- package/dist-types/commands/DeleteSSHPublicKeyCommand.d.ts +1 -1
- package/dist-types/commands/DeleteServerCertificateCommand.d.ts +3 -3
- package/dist-types/commands/DeleteServiceLinkedRoleCommand.d.ts +2 -2
- package/dist-types/commands/DeleteSigningCertificateCommand.d.ts +1 -1
- package/dist-types/commands/DeleteUserCommand.d.ts +10 -10
- package/dist-types/commands/DeleteUserPermissionsBoundaryCommand.d.ts +2 -2
- package/dist-types/commands/DeleteUserPolicyCommand.d.ts +1 -1
- package/dist-types/commands/DeleteVirtualMFADeviceCommand.d.ts +2 -2
- package/dist-types/commands/DetachGroupPolicyCommand.d.ts +1 -1
- package/dist-types/commands/DetachRolePolicyCommand.d.ts +1 -1
- package/dist-types/commands/DetachUserPolicyCommand.d.ts +1 -1
- package/dist-types/commands/GenerateOrganizationsAccessReportCommand.d.ts +22 -22
- package/dist-types/commands/GenerateServiceLastAccessedDetailsCommand.d.ts +12 -12
- package/dist-types/commands/GetAccountAuthorizationDetailsCommand.d.ts +2 -2
- package/dist-types/commands/GetAccountSummaryCommand.d.ts +1 -1
- package/dist-types/commands/GetContextKeysForCustomPolicyCommand.d.ts +1 -1
- package/dist-types/commands/GetContextKeysForPrincipalPolicyCommand.d.ts +3 -3
- package/dist-types/commands/GetGroupPolicyCommand.d.ts +3 -3
- package/dist-types/commands/GetLoginProfileCommand.d.ts +2 -2
- package/dist-types/commands/GetOrganizationsAccessReportCommand.d.ts +4 -4
- package/dist-types/commands/GetPolicyCommand.d.ts +2 -2
- package/dist-types/commands/GetPolicyVersionCommand.d.ts +5 -5
- package/dist-types/commands/GetRoleCommand.d.ts +1 -1
- package/dist-types/commands/GetRolePolicyCommand.d.ts +4 -4
- package/dist-types/commands/GetSAMLProviderCommand.d.ts +2 -2
- package/dist-types/commands/GetSSHPublicKeyCommand.d.ts +1 -1
- package/dist-types/commands/GetServerCertificateCommand.d.ts +1 -1
- package/dist-types/commands/GetServiceLastAccessedDetailsCommand.d.ts +12 -12
- package/dist-types/commands/GetServiceLastAccessedDetailsWithEntitiesCommand.d.ts +6 -6
- package/dist-types/commands/GetUserCommand.d.ts +1 -1
- package/dist-types/commands/GetUserPolicyCommand.d.ts +3 -3
- package/dist-types/commands/ListAccessKeysCommand.d.ts +4 -4
- package/dist-types/commands/ListAttachedGroupPoliciesCommand.d.ts +2 -2
- package/dist-types/commands/ListAttachedRolePoliciesCommand.d.ts +2 -2
- package/dist-types/commands/ListAttachedUserPoliciesCommand.d.ts +2 -2
- package/dist-types/commands/ListEntitiesForPolicyCommand.d.ts +2 -2
- package/dist-types/commands/ListGroupPoliciesCommand.d.ts +2 -2
- package/dist-types/commands/ListGroupsCommand.d.ts +1 -1
- package/dist-types/commands/ListGroupsForUserCommand.d.ts +1 -1
- package/dist-types/commands/ListInstanceProfilesCommand.d.ts +3 -3
- package/dist-types/commands/ListInstanceProfilesForRoleCommand.d.ts +1 -1
- package/dist-types/commands/ListMFADevicesCommand.d.ts +1 -1
- package/dist-types/commands/ListOpenIDConnectProvidersCommand.d.ts +2 -2
- package/dist-types/commands/ListPoliciesCommand.d.ts +5 -5
- package/dist-types/commands/ListPoliciesGrantingServiceAccessCommand.d.ts +9 -9
- package/dist-types/commands/ListPolicyVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListRolePoliciesCommand.d.ts +2 -2
- package/dist-types/commands/ListRolesCommand.d.ts +3 -3
- package/dist-types/commands/ListSAMLProvidersCommand.d.ts +2 -2
- package/dist-types/commands/ListSSHPublicKeysCommand.d.ts +2 -2
- package/dist-types/commands/ListServerCertificatesCommand.d.ts +4 -4
- package/dist-types/commands/ListSigningCertificatesCommand.d.ts +2 -2
- package/dist-types/commands/ListUserPoliciesCommand.d.ts +2 -2
- package/dist-types/commands/ListUsersCommand.d.ts +3 -3
- package/dist-types/commands/ListVirtualMFADevicesCommand.d.ts +3 -3
- package/dist-types/commands/PutGroupPolicyCommand.d.ts +4 -4
- package/dist-types/commands/PutRolePermissionsBoundaryCommand.d.ts +3 -3
- package/dist-types/commands/PutRolePolicyCommand.d.ts +5 -5
- package/dist-types/commands/PutUserPermissionsBoundaryCommand.d.ts +2 -2
- package/dist-types/commands/PutUserPolicyCommand.d.ts +4 -4
- package/dist-types/commands/RemoveClientIDFromOpenIDConnectProviderCommand.d.ts +1 -1
- package/dist-types/commands/RemoveRoleFromInstanceProfileCommand.d.ts +3 -3
- package/dist-types/commands/ResyncMFADeviceCommand.d.ts +1 -1
- package/dist-types/commands/SetDefaultPolicyVersionCommand.d.ts +2 -2
- package/dist-types/commands/SetSecurityTokenServicePreferencesCommand.d.ts +3 -3
- package/dist-types/commands/SimulateCustomPolicyCommand.d.ts +14 -7
- package/dist-types/commands/SimulatePrincipalPolicyCommand.d.ts +17 -10
- package/dist-types/commands/UpdateAccessKeyCommand.d.ts +2 -2
- package/dist-types/commands/UpdateAccountPasswordPolicyCommand.d.ts +3 -3
- package/dist-types/commands/UpdateGroupCommand.d.ts +4 -4
- package/dist-types/commands/UpdateLoginProfileCommand.d.ts +6 -6
- package/dist-types/commands/UpdateOpenIDConnectProviderThumbprintCommand.d.ts +9 -8
- package/dist-types/commands/UpdateRoleDescriptionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateSAMLProviderCommand.d.ts +2 -2
- package/dist-types/commands/UpdateSSHPublicKeyCommand.d.ts +1 -1
- package/dist-types/commands/UpdateServerCertificateCommand.d.ts +5 -5
- package/dist-types/commands/UpdateSigningCertificateCommand.d.ts +1 -1
- package/dist-types/commands/UpdateUserCommand.d.ts +4 -4
- package/dist-types/commands/UploadSSHPublicKeyCommand.d.ts +1 -1
- package/dist-types/commands/UploadServerCertificateCommand.d.ts +5 -5
- package/dist-types/commands/UploadSigningCertificateCommand.d.ts +4 -4
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +319 -282
- package/dist-types/models/models_1.d.ts +51 -51
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/package.json +4 -4
package/dist-types/IAM.d.ts
CHANGED
|
@@ -169,7 +169,7 @@ export declare class IAM extends IAMClient {
|
|
|
169
169
|
/**
|
|
170
170
|
* <p>Adds a new client ID (also known as audience) to the list of client IDs already
|
|
171
171
|
* registered for the specified IAM OpenID Connect (OIDC) provider resource.</p>
|
|
172
|
-
*
|
|
172
|
+
* <p>This operation is idempotent; it does not fail or return an error if you add an
|
|
173
173
|
* existing client ID to the provider.</p>
|
|
174
174
|
*/
|
|
175
175
|
addClientIDToOpenIDConnectProvider(args: AddClientIDToOpenIDConnectProviderCommandInput, options?: __HttpHandlerOptions): Promise<AddClientIDToOpenIDConnectProviderCommandOutput>;
|
|
@@ -182,11 +182,11 @@ export declare class IAM extends IAMClient {
|
|
|
182
182
|
* for the change to appear across all of Amazon Web Services because of <a href="https://en.wikipedia.org/wiki/Eventual_consistency">eventual
|
|
183
183
|
* consistency</a>. To force the change, you must <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DisassociateIamInstanceProfile.html">disassociate the instance profile</a> and then <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_AssociateIamInstanceProfile.html">associate the
|
|
184
184
|
* instance profile</a>, or you can stop your instance and then restart it.</p>
|
|
185
|
-
*
|
|
185
|
+
* <note>
|
|
186
186
|
* <p>The caller of this operation must be granted the <code>PassRole</code> permission
|
|
187
187
|
* on the IAM role by a permissions policy.</p>
|
|
188
|
-
*
|
|
189
|
-
*
|
|
188
|
+
* </note>
|
|
189
|
+
* <p>For more information about roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with roles</a>. For more
|
|
190
190
|
* information about instance profiles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About instance
|
|
191
191
|
* profiles</a>.</p>
|
|
192
192
|
*/
|
|
@@ -201,12 +201,12 @@ export declare class IAM extends IAMClient {
|
|
|
201
201
|
addUserToGroup(args: AddUserToGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddUserToGroupCommandOutput) => void): void;
|
|
202
202
|
/**
|
|
203
203
|
* <p>Attaches the specified managed policy to the specified IAM group.</p>
|
|
204
|
-
*
|
|
204
|
+
* <p>You use this operation to attach a managed policy to a group. To embed an inline
|
|
205
205
|
* policy in a group, use <a>PutGroupPolicy</a>.</p>
|
|
206
|
-
*
|
|
206
|
+
* <p>As a best practice, you can validate your IAM policies.
|
|
207
207
|
* To learn more, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html">Validating IAM policies</a>
|
|
208
208
|
* in the <i>IAM User Guide</i>.</p>
|
|
209
|
-
*
|
|
209
|
+
* <p>For more information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline
|
|
210
210
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
211
211
|
*/
|
|
212
212
|
attachGroupPolicy(args: AttachGroupPolicyCommandInput, options?: __HttpHandlerOptions): Promise<AttachGroupPolicyCommandOutput>;
|
|
@@ -216,16 +216,16 @@ export declare class IAM extends IAMClient {
|
|
|
216
216
|
* <p>Attaches the specified managed policy to the specified IAM role. When you attach a
|
|
217
217
|
* managed policy to a role, the managed policy becomes part of the role's permission
|
|
218
218
|
* (access) policy.</p>
|
|
219
|
-
*
|
|
219
|
+
* <note>
|
|
220
220
|
* <p>You cannot use a managed policy as the role's trust policy. The role's trust
|
|
221
221
|
* policy is created at the same time as the role, using <a>CreateRole</a>.
|
|
222
222
|
* You can update a role's trust policy using <a>UpdateAssumeRolePolicy</a>.</p>
|
|
223
|
-
*
|
|
224
|
-
*
|
|
223
|
+
* </note>
|
|
224
|
+
* <p>Use this operation to attach a <i>managed</i> policy to a role. To embed
|
|
225
225
|
* an inline policy in a role, use <a>PutRolePolicy</a>. For more information
|
|
226
226
|
* about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline
|
|
227
227
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
228
|
-
*
|
|
228
|
+
* <p>As a best practice, you can validate your IAM policies.
|
|
229
229
|
* To learn more, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html">Validating IAM policies</a>
|
|
230
230
|
* in the <i>IAM User Guide</i>.</p>
|
|
231
231
|
*/
|
|
@@ -234,12 +234,12 @@ export declare class IAM extends IAMClient {
|
|
|
234
234
|
attachRolePolicy(args: AttachRolePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachRolePolicyCommandOutput) => void): void;
|
|
235
235
|
/**
|
|
236
236
|
* <p>Attaches the specified managed policy to the specified user.</p>
|
|
237
|
-
*
|
|
237
|
+
* <p>You use this operation to attach a <i>managed</i> policy to a user. To
|
|
238
238
|
* embed an inline policy in a user, use <a>PutUserPolicy</a>.</p>
|
|
239
|
-
*
|
|
239
|
+
* <p>As a best practice, you can validate your IAM policies.
|
|
240
240
|
* To learn more, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html">Validating IAM policies</a>
|
|
241
241
|
* in the <i>IAM User Guide</i>.</p>
|
|
242
|
-
*
|
|
242
|
+
* <p>For more information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline
|
|
243
243
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
244
244
|
*/
|
|
245
245
|
attachUserPolicy(args: AttachUserPolicyCommandInput, options?: __HttpHandlerOptions): Promise<AttachUserPolicyCommandOutput>;
|
|
@@ -250,7 +250,7 @@ export declare class IAM extends IAMClient {
|
|
|
250
250
|
* can be performed using the CLI, the Amazon Web Services API, or the <b>My
|
|
251
251
|
* Security Credentials</b> page in the Amazon Web Services Management Console. The Amazon Web Services account root user
|
|
252
252
|
* password is not affected by this operation.</p>
|
|
253
|
-
*
|
|
253
|
+
* <p>Use <a>UpdateLoginProfile</a> to use the CLI, the Amazon Web Services API, or the
|
|
254
254
|
* <b>Users</b> page in the IAM console to change the
|
|
255
255
|
* password for any IAM user. For more information about modifying passwords, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html">Managing
|
|
256
256
|
* passwords</a> in the <i>IAM User Guide</i>.</p>
|
|
@@ -261,18 +261,18 @@ export declare class IAM extends IAMClient {
|
|
|
261
261
|
/**
|
|
262
262
|
* <p> Creates a new Amazon Web Services secret access key and corresponding Amazon Web Services access key ID for the
|
|
263
263
|
* specified user. The default status for new keys is <code>Active</code>.</p>
|
|
264
|
-
*
|
|
264
|
+
* <p>If you do not specify a user name, IAM determines the user name implicitly based on
|
|
265
265
|
* the Amazon Web Services access key ID signing the request. This operation works for access keys under
|
|
266
266
|
* the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root
|
|
267
267
|
* user credentials. This is true even if the Amazon Web Services account has no associated users.</p>
|
|
268
|
-
*
|
|
268
|
+
* <p> For information about quotas on the number of keys you can create, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS
|
|
269
269
|
* quotas</a> in the <i>IAM User Guide</i>.</p>
|
|
270
|
-
*
|
|
270
|
+
* <important>
|
|
271
271
|
* <p>To ensure the security of your Amazon Web Services account, the secret access key is accessible
|
|
272
272
|
* only during key and user creation. You must save the key (for example, in a text
|
|
273
273
|
* file) if you want to be able to access it again. If a secret key is lost, you can
|
|
274
274
|
* delete the access keys for the associated user and then create new keys.</p>
|
|
275
|
-
*
|
|
275
|
+
* </important>
|
|
276
276
|
*/
|
|
277
277
|
createAccessKey(args: CreateAccessKeyCommandInput, options?: __HttpHandlerOptions): Promise<CreateAccessKeyCommandOutput>;
|
|
278
278
|
createAccessKey(args: CreateAccessKeyCommandInput, cb: (err: any, data?: CreateAccessKeyCommandOutput) => void): void;
|
|
@@ -288,7 +288,7 @@ export declare class IAM extends IAMClient {
|
|
|
288
288
|
createAccountAlias(args: CreateAccountAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccountAliasCommandOutput) => void): void;
|
|
289
289
|
/**
|
|
290
290
|
* <p>Creates a new group.</p>
|
|
291
|
-
*
|
|
291
|
+
* <p> For information about the number of groups you can create, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS
|
|
292
292
|
* quotas</a> in the <i>IAM User Guide</i>.</p>
|
|
293
293
|
*/
|
|
294
294
|
createGroup(args: CreateGroupCommandInput, options?: __HttpHandlerOptions): Promise<CreateGroupCommandOutput>;
|
|
@@ -298,7 +298,7 @@ export declare class IAM extends IAMClient {
|
|
|
298
298
|
* <p> Creates a new instance profile. For information about instance profiles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html">Using
|
|
299
299
|
* roles for applications on Amazon EC2</a> in the
|
|
300
300
|
* <i>IAM User Guide</i>, and <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html#ec2-instance-profile">Instance profiles</a> in the <i>Amazon EC2 User Guide</i>.</p>
|
|
301
|
-
*
|
|
301
|
+
* <p> For information about the number of instance profiles you can create, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM object
|
|
302
302
|
* quotas</a> in the <i>IAM User Guide</i>.</p>
|
|
303
303
|
*/
|
|
304
304
|
createInstanceProfile(args: CreateInstanceProfileCommandInput, options?: __HttpHandlerOptions): Promise<CreateInstanceProfileCommandOutput>;
|
|
@@ -307,9 +307,9 @@ export declare class IAM extends IAMClient {
|
|
|
307
307
|
/**
|
|
308
308
|
* <p>Creates a password for the specified IAM user. A password allows an IAM user to
|
|
309
309
|
* access Amazon Web Services services through the Amazon Web Services Management Console.</p>
|
|
310
|
-
*
|
|
310
|
+
* <p>You can use the CLI, the Amazon Web Services API, or the <b>Users</b>
|
|
311
311
|
* page in the IAM console to create a password for any IAM user. Use <a>ChangePassword</a> to update your own existing password in the <b>My Security Credentials</b> page in the Amazon Web Services Management Console.</p>
|
|
312
|
-
*
|
|
312
|
+
* <p>For more information about managing passwords, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html">Managing passwords</a> in the
|
|
313
313
|
* <i>IAM User Guide</i>.</p>
|
|
314
314
|
*/
|
|
315
315
|
createLoginProfile(args: CreateLoginProfileCommandInput, options?: __HttpHandlerOptions): Promise<CreateLoginProfileCommandOutput>;
|
|
@@ -317,57 +317,58 @@ export declare class IAM extends IAMClient {
|
|
|
317
317
|
createLoginProfile(args: CreateLoginProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLoginProfileCommandOutput) => void): void;
|
|
318
318
|
/**
|
|
319
319
|
* <p>Creates an IAM entity to describe an identity provider (IdP) that supports <a href="http://openid.net/connect/">OpenID Connect (OIDC)</a>.</p>
|
|
320
|
-
*
|
|
320
|
+
* <p>The OIDC provider that you create with this operation can be used as a principal in a
|
|
321
321
|
* role's trust policy. Such a policy establishes a trust relationship between Amazon Web Services and
|
|
322
322
|
* the OIDC provider.</p>
|
|
323
|
-
*
|
|
323
|
+
* <p>If you are using an OIDC identity provider from Google, Facebook, or Amazon Cognito, you don't
|
|
324
324
|
* need to create a separate IAM identity provider. These OIDC identity providers are
|
|
325
325
|
* already built-in to Amazon Web Services and are available for your use. Instead, you can move directly
|
|
326
326
|
* to creating new roles using your identity provider. To learn more, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-idp_oidc.html">Creating
|
|
327
327
|
* a role for web identity or OpenID connect federation</a> in the <i>IAM
|
|
328
328
|
* User Guide</i>.</p>
|
|
329
|
-
*
|
|
330
|
-
*
|
|
329
|
+
* <p>When you create the IAM OIDC provider, you specify the following:</p>
|
|
330
|
+
* <ul>
|
|
331
331
|
* <li>
|
|
332
|
-
*
|
|
332
|
+
* <p>The URL of the OIDC identity provider (IdP) to trust</p>
|
|
333
333
|
* </li>
|
|
334
334
|
* <li>
|
|
335
|
-
*
|
|
335
|
+
* <p>A list of client IDs (also known as audiences) that identify the application
|
|
336
336
|
* or applications allowed to authenticate using the OIDC provider</p>
|
|
337
337
|
* </li>
|
|
338
338
|
* <li>
|
|
339
|
-
*
|
|
339
|
+
* <p>A list of thumbprints of one or more server certificates that the IdP
|
|
340
340
|
* uses</p>
|
|
341
341
|
* </li>
|
|
342
342
|
* </ul>
|
|
343
|
-
*
|
|
343
|
+
* <p>You get all of this information from the OIDC IdP you want to use to access
|
|
344
344
|
* Amazon Web Services.</p>
|
|
345
|
-
*
|
|
345
|
+
* <note>
|
|
346
346
|
* <p>Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our
|
|
347
347
|
* library of trusted certificate authorities (CAs) instead of using a certificate
|
|
348
|
-
* thumbprint to verify your IdP server certificate. These OIDC IdPs include Google,
|
|
349
|
-
* those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these
|
|
350
|
-
* cases, your legacy thumbprint remains in your configuration, but is no longer used for
|
|
348
|
+
* thumbprint to verify your IdP server certificate. These OIDC IdPs include Google, Auth0,
|
|
349
|
+
* and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these
|
|
350
|
+
* cases, your legacy thumbprint remains in your configuration, but is no longer used for
|
|
351
|
+
* validation.</p>
|
|
351
352
|
* </note>
|
|
352
|
-
*
|
|
353
|
+
* <note>
|
|
353
354
|
* <p>The trust for the OIDC provider is derived from the IAM provider that this
|
|
354
355
|
* operation creates. Therefore, it is best to limit access to the <a>CreateOpenIDConnectProvider</a> operation to highly privileged
|
|
355
356
|
* users.</p>
|
|
356
|
-
*
|
|
357
|
+
* </note>
|
|
357
358
|
*/
|
|
358
359
|
createOpenIDConnectProvider(args: CreateOpenIDConnectProviderCommandInput, options?: __HttpHandlerOptions): Promise<CreateOpenIDConnectProviderCommandOutput>;
|
|
359
360
|
createOpenIDConnectProvider(args: CreateOpenIDConnectProviderCommandInput, cb: (err: any, data?: CreateOpenIDConnectProviderCommandOutput) => void): void;
|
|
360
361
|
createOpenIDConnectProvider(args: CreateOpenIDConnectProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateOpenIDConnectProviderCommandOutput) => void): void;
|
|
361
362
|
/**
|
|
362
363
|
* <p>Creates a new managed policy for your Amazon Web Services account.</p>
|
|
363
|
-
*
|
|
364
|
+
* <p>This operation creates a policy version with a version identifier of <code>v1</code>
|
|
364
365
|
* and sets v1 as the policy's default version. For more information about policy versions,
|
|
365
366
|
* see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html">Versioning for managed policies</a> in the
|
|
366
367
|
* <i>IAM User Guide</i>.</p>
|
|
367
|
-
*
|
|
368
|
+
* <p>As a best practice, you can validate your IAM policies.
|
|
368
369
|
* To learn more, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html">Validating IAM policies</a>
|
|
369
370
|
* in the <i>IAM User Guide</i>.</p>
|
|
370
|
-
*
|
|
371
|
+
* <p>For more information about managed policies in general, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed
|
|
371
372
|
* policies and inline policies</a> in the
|
|
372
373
|
* <i>IAM User Guide</i>.</p>
|
|
373
374
|
*/
|
|
@@ -378,10 +379,10 @@ export declare class IAM extends IAMClient {
|
|
|
378
379
|
* <p>Creates a new version of the specified managed policy. To update a managed policy, you
|
|
379
380
|
* create a new policy version. A managed policy can have up to five versions. If the
|
|
380
381
|
* policy has five versions, you must delete an existing version using <a>DeletePolicyVersion</a> before you create a new version.</p>
|
|
381
|
-
*
|
|
382
|
+
* <p>Optionally, you can set the new version as the policy's default version. The default
|
|
382
383
|
* version is the version that is in effect for the IAM users, groups, and roles to which
|
|
383
384
|
* the policy is attached.</p>
|
|
384
|
-
*
|
|
385
|
+
* <p>For more information about managed policy versions, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html">Versioning for managed
|
|
385
386
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
386
387
|
*/
|
|
387
388
|
createPolicyVersion(args: CreatePolicyVersionCommandInput, options?: __HttpHandlerOptions): Promise<CreatePolicyVersionCommandOutput>;
|
|
@@ -400,20 +401,20 @@ export declare class IAM extends IAMClient {
|
|
|
400
401
|
/**
|
|
401
402
|
* <p>Creates an IAM resource that describes an identity provider (IdP) that supports SAML
|
|
402
403
|
* 2.0.</p>
|
|
403
|
-
*
|
|
404
|
+
* <p>The SAML provider resource that you create with this operation can be used as a
|
|
404
405
|
* principal in an IAM role's trust policy. Such a policy can enable federated users who
|
|
405
406
|
* sign in using the SAML IdP to assume the role. You can create an IAM role that
|
|
406
407
|
* supports Web-based single sign-on (SSO) to the Amazon Web Services Management Console or one that supports API access
|
|
407
408
|
* to Amazon Web Services.</p>
|
|
408
|
-
*
|
|
409
|
+
* <p>When you create the SAML provider resource, you upload a SAML metadata document that
|
|
409
410
|
* you get from your IdP. That document includes the issuer's name, expiration information,
|
|
410
411
|
* and keys that can be used to validate the SAML authentication response (assertions) that
|
|
411
412
|
* the IdP sends. You must generate the metadata document using the identity management
|
|
412
413
|
* software that is used as your organization's IdP.</p>
|
|
413
|
-
*
|
|
414
|
+
* <note>
|
|
414
415
|
* <p> This operation requires <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>.</p>
|
|
415
|
-
*
|
|
416
|
-
*
|
|
416
|
+
* </note>
|
|
417
|
+
* <p> For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-saml.html">Enabling SAML 2.0
|
|
417
418
|
* federated users to access the Amazon Web Services Management Console</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html">About SAML 2.0-based
|
|
418
419
|
* federation</a> in the <i>IAM User Guide</i>.</p>
|
|
419
420
|
*/
|
|
@@ -428,7 +429,7 @@ export declare class IAM extends IAMClient {
|
|
|
428
429
|
* improve service stability and proper cleanup when a service and its role are no longer
|
|
429
430
|
* needed. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html">Using service-linked
|
|
430
431
|
* roles</a> in the <i>IAM User Guide</i>. </p>
|
|
431
|
-
*
|
|
432
|
+
* <p>To attach a policy to this service-linked role, you must make the request using the
|
|
432
433
|
* Amazon Web Services service that depends on this role.</p>
|
|
433
434
|
*/
|
|
434
435
|
createServiceLinkedRole(args: CreateServiceLinkedRoleCommandInput, options?: __HttpHandlerOptions): Promise<CreateServiceLinkedRoleCommandOutput>;
|
|
@@ -438,12 +439,12 @@ export declare class IAM extends IAMClient {
|
|
|
438
439
|
* <p>Generates a set of credentials consisting of a user name and password that can be used
|
|
439
440
|
* to access the service specified in the request. These credentials are generated by
|
|
440
441
|
* IAM, and can be used only for the specified service. </p>
|
|
441
|
-
*
|
|
442
|
+
* <p>You can have a maximum of two sets of service-specific credentials for each supported
|
|
442
443
|
* service per user.</p>
|
|
443
|
-
*
|
|
444
|
+
* <p>You can create service-specific credentials for CodeCommit and Amazon Keyspaces (for Apache
|
|
444
445
|
* Cassandra).</p>
|
|
445
|
-
*
|
|
446
|
-
*
|
|
446
|
+
* <p>You can reset the password to a new service-generated value by calling <a>ResetServiceSpecificCredential</a>.</p>
|
|
447
|
+
* <p>For more information about service-specific credentials, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_ssh-keys.html">Using IAM
|
|
447
448
|
* with CodeCommit: Git credentials, SSH keys, and Amazon Web Services access keys</a> in the
|
|
448
449
|
* <i>IAM User Guide</i>.</p>
|
|
449
450
|
*/
|
|
@@ -452,7 +453,7 @@ export declare class IAM extends IAMClient {
|
|
|
452
453
|
createServiceSpecificCredential(args: CreateServiceSpecificCredentialCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateServiceSpecificCredentialCommandOutput) => void): void;
|
|
453
454
|
/**
|
|
454
455
|
* <p>Creates a new IAM user for your Amazon Web Services account.</p>
|
|
455
|
-
*
|
|
456
|
+
* <p> For information about quotas for the number of IAM users you can create, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS
|
|
456
457
|
* quotas</a> in the <i>IAM User Guide</i>.</p>
|
|
457
458
|
*/
|
|
458
459
|
createUser(args: CreateUserCommandInput, options?: __HttpHandlerOptions): Promise<CreateUserCommandOutput>;
|
|
@@ -463,15 +464,15 @@ export declare class IAM extends IAMClient {
|
|
|
463
464
|
* MFA, use <a>EnableMFADevice</a> to attach the MFA device to an IAM user.
|
|
464
465
|
* For more information about creating and working with virtual MFA devices, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html">Using a virtual MFA
|
|
465
466
|
* device</a> in the <i>IAM User Guide</i>.</p>
|
|
466
|
-
*
|
|
467
|
+
* <p>For information about the maximum number of MFA devices you can create, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS
|
|
467
468
|
* quotas</a> in the <i>IAM User Guide</i>.</p>
|
|
468
|
-
*
|
|
469
|
+
* <important>
|
|
469
470
|
* <p>The seed information contained in the QR code and the Base32 string should be
|
|
470
471
|
* treated like any other secret access information. In other words, protect the seed
|
|
471
472
|
* information as you would your Amazon Web Services access keys or your passwords. After you
|
|
472
473
|
* provision your virtual device, you should ensure that the information is destroyed
|
|
473
474
|
* following secure procedures.</p>
|
|
474
|
-
*
|
|
475
|
+
* </important>
|
|
475
476
|
*/
|
|
476
477
|
createVirtualMFADevice(args: CreateVirtualMFADeviceCommandInput, options?: __HttpHandlerOptions): Promise<CreateVirtualMFADeviceCommandOutput>;
|
|
477
478
|
createVirtualMFADevice(args: CreateVirtualMFADeviceCommandInput, cb: (err: any, data?: CreateVirtualMFADeviceCommandOutput) => void): void;
|
|
@@ -479,7 +480,7 @@ export declare class IAM extends IAMClient {
|
|
|
479
480
|
/**
|
|
480
481
|
* <p>Deactivates the specified MFA device and removes it from association with the user
|
|
481
482
|
* name for which it was originally enabled.</p>
|
|
482
|
-
*
|
|
483
|
+
* <p>For more information about creating and working with virtual MFA devices, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html">Enabling a virtual
|
|
483
484
|
* multi-factor authentication (MFA) device</a> in the
|
|
484
485
|
* <i>IAM User Guide</i>.</p>
|
|
485
486
|
*/
|
|
@@ -488,7 +489,7 @@ export declare class IAM extends IAMClient {
|
|
|
488
489
|
deactivateMFADevice(args: DeactivateMFADeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeactivateMFADeviceCommandOutput) => void): void;
|
|
489
490
|
/**
|
|
490
491
|
* <p>Deletes the access key pair associated with the specified IAM user.</p>
|
|
491
|
-
*
|
|
492
|
+
* <p>If you do not specify a user name, IAM determines the user name implicitly based on
|
|
492
493
|
* the Amazon Web Services access key ID signing the request. This operation works for access keys under
|
|
493
494
|
* the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root
|
|
494
495
|
* user credentials even if the Amazon Web Services account has no associated users.</p>
|
|
@@ -520,7 +521,7 @@ export declare class IAM extends IAMClient {
|
|
|
520
521
|
/**
|
|
521
522
|
* <p>Deletes the specified inline policy that is embedded in the specified IAM
|
|
522
523
|
* group.</p>
|
|
523
|
-
*
|
|
524
|
+
* <p>A group can also have managed policies attached to it. To detach a managed policy from
|
|
524
525
|
* a group, use <a>DetachGroupPolicy</a>. For more information about policies,
|
|
525
526
|
* refer to <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline
|
|
526
527
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
@@ -531,13 +532,13 @@ export declare class IAM extends IAMClient {
|
|
|
531
532
|
/**
|
|
532
533
|
* <p>Deletes the specified instance profile. The instance profile must not have an
|
|
533
534
|
* associated role.</p>
|
|
534
|
-
*
|
|
535
|
+
* <important>
|
|
535
536
|
* <p>Make sure that you do not have any Amazon EC2 instances running with the instance
|
|
536
537
|
* profile you are about to delete. Deleting a role or instance profile that is
|
|
537
538
|
* associated with a running instance will break any applications running on the
|
|
538
539
|
* instance.</p>
|
|
539
|
-
*
|
|
540
|
-
*
|
|
540
|
+
* </important>
|
|
541
|
+
* <p>For more information about instance profiles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About instance
|
|
541
542
|
* profiles</a>.</p>
|
|
542
543
|
*/
|
|
543
544
|
deleteInstanceProfile(args: DeleteInstanceProfileCommandInput, options?: __HttpHandlerOptions): Promise<DeleteInstanceProfileCommandOutput>;
|
|
@@ -546,27 +547,27 @@ export declare class IAM extends IAMClient {
|
|
|
546
547
|
/**
|
|
547
548
|
* <p>Deletes the password for the specified IAM user, For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_passwords_admin-change-user.html">Managing
|
|
548
549
|
* passwords for IAM users</a>.</p>
|
|
549
|
-
*
|
|
550
|
+
* <p>You can use the CLI, the Amazon Web Services API, or the <b>Users</b>
|
|
550
551
|
* page in the IAM console to delete a password for any IAM user. You can use <a>ChangePassword</a> to update, but not delete, your own password in the
|
|
551
552
|
* <b>My Security Credentials</b> page in the
|
|
552
553
|
* Amazon Web Services Management Console.</p>
|
|
553
|
-
*
|
|
554
|
+
* <important>
|
|
554
555
|
* <p>Deleting a user's password does not prevent a user from accessing Amazon Web Services through
|
|
555
556
|
* the command line interface or the API. To prevent all user access, you must also
|
|
556
557
|
* either make any access keys inactive or delete them. For more information about
|
|
557
558
|
* making keys inactive or deleting them, see <a>UpdateAccessKey</a> and
|
|
558
559
|
* <a>DeleteAccessKey</a>.</p>
|
|
559
|
-
*
|
|
560
|
+
* </important>
|
|
560
561
|
*/
|
|
561
562
|
deleteLoginProfile(args: DeleteLoginProfileCommandInput, options?: __HttpHandlerOptions): Promise<DeleteLoginProfileCommandOutput>;
|
|
562
563
|
deleteLoginProfile(args: DeleteLoginProfileCommandInput, cb: (err: any, data?: DeleteLoginProfileCommandOutput) => void): void;
|
|
563
564
|
deleteLoginProfile(args: DeleteLoginProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLoginProfileCommandOutput) => void): void;
|
|
564
565
|
/**
|
|
565
566
|
* <p>Deletes an OpenID Connect identity provider (IdP) resource object in IAM.</p>
|
|
566
|
-
*
|
|
567
|
+
* <p>Deleting an IAM OIDC provider resource does not update any roles that reference the
|
|
567
568
|
* provider as a principal in their trust policies. Any attempt to assume a role that
|
|
568
569
|
* references a deleted provider fails.</p>
|
|
569
|
-
*
|
|
570
|
+
* <p>This operation is idempotent; it does not fail or return an error if you call the
|
|
570
571
|
* operation for a provider that does not exist.</p>
|
|
571
572
|
*/
|
|
572
573
|
deleteOpenIDConnectProvider(args: DeleteOpenIDConnectProviderCommandInput, options?: __HttpHandlerOptions): Promise<DeleteOpenIDConnectProviderCommandOutput>;
|
|
@@ -574,29 +575,29 @@ export declare class IAM extends IAMClient {
|
|
|
574
575
|
deleteOpenIDConnectProvider(args: DeleteOpenIDConnectProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteOpenIDConnectProviderCommandOutput) => void): void;
|
|
575
576
|
/**
|
|
576
577
|
* <p>Deletes the specified managed policy.</p>
|
|
577
|
-
*
|
|
578
|
+
* <p>Before you can delete a managed policy, you must first detach the policy from all
|
|
578
579
|
* users, groups, and roles that it is attached to. In addition, you must delete all the
|
|
579
580
|
* policy's versions. The following steps describe the process for deleting a managed
|
|
580
581
|
* policy:</p>
|
|
581
|
-
*
|
|
582
|
+
* <ul>
|
|
582
583
|
* <li>
|
|
583
|
-
*
|
|
584
|
+
* <p>Detach the policy from all users, groups, and roles that the policy is
|
|
584
585
|
* attached to, using <a>DetachUserPolicy</a>, <a>DetachGroupPolicy</a>, or <a>DetachRolePolicy</a>. To
|
|
585
586
|
* list all the users, groups, and roles that a policy is attached to, use <a>ListEntitiesForPolicy</a>.</p>
|
|
586
587
|
* </li>
|
|
587
588
|
* <li>
|
|
588
|
-
*
|
|
589
|
+
* <p>Delete all versions of the policy using <a>DeletePolicyVersion</a>.
|
|
589
590
|
* To list the policy's versions, use <a>ListPolicyVersions</a>. You
|
|
590
591
|
* cannot use <a>DeletePolicyVersion</a> to delete the version that is
|
|
591
592
|
* marked as the default version. You delete the policy's default version in the
|
|
592
593
|
* next step of the process.</p>
|
|
593
594
|
* </li>
|
|
594
595
|
* <li>
|
|
595
|
-
*
|
|
596
|
+
* <p>Delete the policy (this automatically deletes the policy's default version)
|
|
596
597
|
* using this operation.</p>
|
|
597
598
|
* </li>
|
|
598
599
|
* </ul>
|
|
599
|
-
*
|
|
600
|
+
* <p>For information about managed policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline
|
|
600
601
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
601
602
|
*/
|
|
602
603
|
deletePolicy(args: DeletePolicyCommandInput, options?: __HttpHandlerOptions): Promise<DeletePolicyCommandOutput>;
|
|
@@ -604,34 +605,51 @@ export declare class IAM extends IAMClient {
|
|
|
604
605
|
deletePolicy(args: DeletePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePolicyCommandOutput) => void): void;
|
|
605
606
|
/**
|
|
606
607
|
* <p>Deletes the specified version from the specified managed policy.</p>
|
|
607
|
-
*
|
|
608
|
+
* <p>You cannot delete the default version from a policy using this operation. To delete
|
|
608
609
|
* the default version from a policy, use <a>DeletePolicy</a>. To find out which
|
|
609
610
|
* version of a policy is marked as the default version, use <a>ListPolicyVersions</a>.</p>
|
|
610
|
-
*
|
|
611
|
+
* <p>For information about versions for managed policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html">Versioning for managed
|
|
611
612
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
612
613
|
*/
|
|
613
614
|
deletePolicyVersion(args: DeletePolicyVersionCommandInput, options?: __HttpHandlerOptions): Promise<DeletePolicyVersionCommandOutput>;
|
|
614
615
|
deletePolicyVersion(args: DeletePolicyVersionCommandInput, cb: (err: any, data?: DeletePolicyVersionCommandOutput) => void): void;
|
|
615
616
|
deletePolicyVersion(args: DeletePolicyVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePolicyVersionCommandOutput) => void): void;
|
|
616
617
|
/**
|
|
617
|
-
* <p>Deletes the specified role.
|
|
618
|
-
*
|
|
619
|
-
*
|
|
618
|
+
* <p>Deletes the specified role. Unlike the Amazon Web Services Management Console, when you delete a role
|
|
619
|
+
* programmatically, you must delete the items attached to the role manually, or the
|
|
620
|
+
* deletion fails. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage_delete.html#roles-managingrole-deleting-cli">Deleting an IAM role</a>. Before attempting to delete a role, remove the
|
|
621
|
+
* following attached items: </p>
|
|
622
|
+
* <ul>
|
|
623
|
+
* <li>
|
|
624
|
+
* <p>Inline policies (<a>DeleteRolePolicy</a>)</p>
|
|
625
|
+
* </li>
|
|
626
|
+
* <li>
|
|
627
|
+
* <p>Attached managed policies (<a>DetachRolePolicy</a>)</p>
|
|
628
|
+
* </li>
|
|
629
|
+
* <li>
|
|
630
|
+
* <p>Instance profile (<a>RemoveRoleFromInstanceProfile</a>)</p>
|
|
631
|
+
* </li>
|
|
632
|
+
* <li>
|
|
633
|
+
* <p>Optional – Delete instance profile after detaching from role for
|
|
634
|
+
* resource clean up (<a>DeleteInstanceProfile</a>)</p>
|
|
635
|
+
* </li>
|
|
636
|
+
* </ul>
|
|
637
|
+
* <important>
|
|
620
638
|
* <p>Make sure that you do not have any Amazon EC2 instances running with the role you
|
|
621
639
|
* are about to delete. Deleting a role or instance profile that is associated with a
|
|
622
640
|
* running instance will break any applications running on the instance.</p>
|
|
623
|
-
*
|
|
641
|
+
* </important>
|
|
624
642
|
*/
|
|
625
643
|
deleteRole(args: DeleteRoleCommandInput, options?: __HttpHandlerOptions): Promise<DeleteRoleCommandOutput>;
|
|
626
644
|
deleteRole(args: DeleteRoleCommandInput, cb: (err: any, data?: DeleteRoleCommandOutput) => void): void;
|
|
627
645
|
deleteRole(args: DeleteRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRoleCommandOutput) => void): void;
|
|
628
646
|
/**
|
|
629
647
|
* <p>Deletes the permissions boundary for the specified IAM role. </p>
|
|
630
|
-
*
|
|
648
|
+
* <important>
|
|
631
649
|
* <p>Deleting the permissions boundary for a role might increase its permissions. For
|
|
632
650
|
* example, it might allow anyone who assumes the role to perform all the actions
|
|
633
651
|
* granted in its permissions policies. </p>
|
|
634
|
-
*
|
|
652
|
+
* </important>
|
|
635
653
|
*/
|
|
636
654
|
deleteRolePermissionsBoundary(args: DeleteRolePermissionsBoundaryCommandInput, options?: __HttpHandlerOptions): Promise<DeleteRolePermissionsBoundaryCommandOutput>;
|
|
637
655
|
deleteRolePermissionsBoundary(args: DeleteRolePermissionsBoundaryCommandInput, cb: (err: any, data?: DeleteRolePermissionsBoundaryCommandOutput) => void): void;
|
|
@@ -639,7 +657,7 @@ export declare class IAM extends IAMClient {
|
|
|
639
657
|
/**
|
|
640
658
|
* <p>Deletes the specified inline policy that is embedded in the specified IAM
|
|
641
659
|
* role.</p>
|
|
642
|
-
*
|
|
660
|
+
* <p>A role can also have managed policies attached to it. To detach a managed policy from
|
|
643
661
|
* a role, use <a>DetachRolePolicy</a>. For more information about policies,
|
|
644
662
|
* refer to <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline
|
|
645
663
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
@@ -649,23 +667,23 @@ export declare class IAM extends IAMClient {
|
|
|
649
667
|
deleteRolePolicy(args: DeleteRolePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRolePolicyCommandOutput) => void): void;
|
|
650
668
|
/**
|
|
651
669
|
* <p>Deletes a SAML provider resource in IAM.</p>
|
|
652
|
-
*
|
|
670
|
+
* <p>Deleting the provider resource from IAM does not update any roles that reference the
|
|
653
671
|
* SAML provider resource's ARN as a principal in their trust policies. Any attempt to
|
|
654
672
|
* assume a role that references a non-existent provider resource ARN fails.</p>
|
|
655
|
-
*
|
|
673
|
+
* <note>
|
|
656
674
|
* <p> This operation requires <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>.</p>
|
|
657
|
-
*
|
|
675
|
+
* </note>
|
|
658
676
|
*/
|
|
659
677
|
deleteSAMLProvider(args: DeleteSAMLProviderCommandInput, options?: __HttpHandlerOptions): Promise<DeleteSAMLProviderCommandOutput>;
|
|
660
678
|
deleteSAMLProvider(args: DeleteSAMLProviderCommandInput, cb: (err: any, data?: DeleteSAMLProviderCommandOutput) => void): void;
|
|
661
679
|
deleteSAMLProvider(args: DeleteSAMLProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSAMLProviderCommandOutput) => void): void;
|
|
662
680
|
/**
|
|
663
681
|
* <p>Deletes the specified server certificate.</p>
|
|
664
|
-
*
|
|
682
|
+
* <p>For more information about working with server certificates, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Working
|
|
665
683
|
* with server certificates</a> in the <i>IAM User Guide</i>. This
|
|
666
684
|
* topic also includes a list of Amazon Web Services services that can use the server certificates that
|
|
667
685
|
* you manage with IAM.</p>
|
|
668
|
-
*
|
|
686
|
+
* <important>
|
|
669
687
|
* <p> If you are using a server certificate with Elastic Load Balancing, deleting the
|
|
670
688
|
* certificate could have implications for your application. If Elastic Load Balancing
|
|
671
689
|
* doesn't detect the deletion of bound certificates, it may continue to use the
|
|
@@ -674,7 +692,7 @@ export declare class IAM extends IAMClient {
|
|
|
674
692
|
* Balancing before using this command to delete the certificate. For more information,
|
|
675
693
|
* see <a href="https://docs.aws.amazon.com/ElasticLoadBalancing/latest/APIReference/API_DeleteLoadBalancerListeners.html">DeleteLoadBalancerListeners</a> in the <i>Elastic Load Balancing API
|
|
676
694
|
* Reference</i>.</p>
|
|
677
|
-
*
|
|
695
|
+
* </important>
|
|
678
696
|
*/
|
|
679
697
|
deleteServerCertificate(args: DeleteServerCertificateCommandInput, options?: __HttpHandlerOptions): Promise<DeleteServerCertificateCommandOutput>;
|
|
680
698
|
deleteServerCertificate(args: DeleteServerCertificateCommandInput, cb: (err: any, data?: DeleteServerCertificateCommandOutput) => void): void;
|
|
@@ -687,7 +705,7 @@ export declare class IAM extends IAMClient {
|
|
|
687
705
|
* operation more than once for the same service-linked role and an earlier deletion task
|
|
688
706
|
* is not complete, then the <code>DeletionTaskId</code> of the earlier request is
|
|
689
707
|
* returned.</p>
|
|
690
|
-
*
|
|
708
|
+
* <p>If you submit a deletion request for a service-linked role whose linked service is
|
|
691
709
|
* still accessing a resource, then the deletion task fails. If it fails, the <a>GetServiceLinkedRoleDeletionStatus</a> operation returns the reason for the
|
|
692
710
|
* failure, usually including the resources that must be deleted. To delete the
|
|
693
711
|
* service-linked role, you must first remove those resources from the linked service and
|
|
@@ -695,7 +713,7 @@ export declare class IAM extends IAMClient {
|
|
|
695
713
|
* linked to the role. For more information about removing resources from a service, see
|
|
696
714
|
* the <a href="http://docs.aws.amazon.com/">Amazon Web Services documentation</a> for your
|
|
697
715
|
* service.</p>
|
|
698
|
-
*
|
|
716
|
+
* <p>For more information about service-linked roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role">Roles terms and concepts: Amazon Web Services service-linked role</a> in the
|
|
699
717
|
* <i>IAM User Guide</i>.</p>
|
|
700
718
|
*/
|
|
701
719
|
deleteServiceLinkedRole(args: DeleteServiceLinkedRoleCommandInput, options?: __HttpHandlerOptions): Promise<DeleteServiceLinkedRoleCommandOutput>;
|
|
@@ -709,7 +727,7 @@ export declare class IAM extends IAMClient {
|
|
|
709
727
|
deleteServiceSpecificCredential(args: DeleteServiceSpecificCredentialCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteServiceSpecificCredentialCommandOutput) => void): void;
|
|
710
728
|
/**
|
|
711
729
|
* <p>Deletes a signing certificate associated with the specified IAM user.</p>
|
|
712
|
-
*
|
|
730
|
+
* <p>If you do not specify a user name, IAM determines the user name implicitly based on
|
|
713
731
|
* the Amazon Web Services access key ID signing the request. This operation works for access keys under
|
|
714
732
|
* the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root
|
|
715
733
|
* user credentials even if the Amazon Web Services account has no associated IAM users.</p>
|
|
@@ -719,7 +737,7 @@ export declare class IAM extends IAMClient {
|
|
|
719
737
|
deleteSigningCertificate(args: DeleteSigningCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSigningCertificateCommandOutput) => void): void;
|
|
720
738
|
/**
|
|
721
739
|
* <p>Deletes the specified SSH public key.</p>
|
|
722
|
-
*
|
|
740
|
+
* <p>The SSH public key deleted by this operation is used only for authenticating the
|
|
723
741
|
* associated IAM user to an CodeCommit repository. For more information about using SSH keys
|
|
724
742
|
* to authenticate to an CodeCommit repository, see <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html">Set up CodeCommit for
|
|
725
743
|
* SSH connections</a> in the <i>CodeCommit User Guide</i>.</p>
|
|
@@ -732,33 +750,33 @@ export declare class IAM extends IAMClient {
|
|
|
732
750
|
* programmatically, you must delete the items attached to the user manually, or the
|
|
733
751
|
* deletion fails. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_manage.html#id_users_deleting_cli">Deleting an IAM
|
|
734
752
|
* user</a>. Before attempting to delete a user, remove the following items:</p>
|
|
735
|
-
*
|
|
753
|
+
* <ul>
|
|
736
754
|
* <li>
|
|
737
|
-
*
|
|
755
|
+
* <p>Password (<a>DeleteLoginProfile</a>)</p>
|
|
738
756
|
* </li>
|
|
739
757
|
* <li>
|
|
740
|
-
*
|
|
758
|
+
* <p>Access keys (<a>DeleteAccessKey</a>)</p>
|
|
741
759
|
* </li>
|
|
742
760
|
* <li>
|
|
743
|
-
*
|
|
761
|
+
* <p>Signing certificate (<a>DeleteSigningCertificate</a>)</p>
|
|
744
762
|
* </li>
|
|
745
763
|
* <li>
|
|
746
|
-
*
|
|
764
|
+
* <p>SSH public key (<a>DeleteSSHPublicKey</a>)</p>
|
|
747
765
|
* </li>
|
|
748
766
|
* <li>
|
|
749
|
-
*
|
|
767
|
+
* <p>Git credentials (<a>DeleteServiceSpecificCredential</a>)</p>
|
|
750
768
|
* </li>
|
|
751
769
|
* <li>
|
|
752
|
-
*
|
|
770
|
+
* <p>Multi-factor authentication (MFA) device (<a>DeactivateMFADevice</a>, <a>DeleteVirtualMFADevice</a>)</p>
|
|
753
771
|
* </li>
|
|
754
772
|
* <li>
|
|
755
|
-
*
|
|
773
|
+
* <p>Inline policies (<a>DeleteUserPolicy</a>)</p>
|
|
756
774
|
* </li>
|
|
757
775
|
* <li>
|
|
758
|
-
*
|
|
776
|
+
* <p>Attached managed policies (<a>DetachUserPolicy</a>)</p>
|
|
759
777
|
* </li>
|
|
760
778
|
* <li>
|
|
761
|
-
*
|
|
779
|
+
* <p>Group memberships (<a>RemoveUserFromGroup</a>)</p>
|
|
762
780
|
* </li>
|
|
763
781
|
* </ul>
|
|
764
782
|
*/
|
|
@@ -767,11 +785,11 @@ export declare class IAM extends IAMClient {
|
|
|
767
785
|
deleteUser(args: DeleteUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserCommandOutput) => void): void;
|
|
768
786
|
/**
|
|
769
787
|
* <p>Deletes the permissions boundary for the specified IAM user.</p>
|
|
770
|
-
*
|
|
788
|
+
* <important>
|
|
771
789
|
* <p>Deleting the permissions boundary for a user might increase its permissions by
|
|
772
790
|
* allowing the user to perform all the actions granted in its permissions policies.
|
|
773
791
|
* </p>
|
|
774
|
-
*
|
|
792
|
+
* </important>
|
|
775
793
|
*/
|
|
776
794
|
deleteUserPermissionsBoundary(args: DeleteUserPermissionsBoundaryCommandInput, options?: __HttpHandlerOptions): Promise<DeleteUserPermissionsBoundaryCommandOutput>;
|
|
777
795
|
deleteUserPermissionsBoundary(args: DeleteUserPermissionsBoundaryCommandInput, cb: (err: any, data?: DeleteUserPermissionsBoundaryCommandOutput) => void): void;
|
|
@@ -779,7 +797,7 @@ export declare class IAM extends IAMClient {
|
|
|
779
797
|
/**
|
|
780
798
|
* <p>Deletes the specified inline policy that is embedded in the specified IAM
|
|
781
799
|
* user.</p>
|
|
782
|
-
*
|
|
800
|
+
* <p>A user can also have managed policies attached to it. To detach a managed policy from
|
|
783
801
|
* a user, use <a>DetachUserPolicy</a>. For more information about policies,
|
|
784
802
|
* refer to <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline
|
|
785
803
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
@@ -789,17 +807,17 @@ export declare class IAM extends IAMClient {
|
|
|
789
807
|
deleteUserPolicy(args: DeleteUserPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserPolicyCommandOutput) => void): void;
|
|
790
808
|
/**
|
|
791
809
|
* <p>Deletes a virtual MFA device.</p>
|
|
792
|
-
*
|
|
810
|
+
* <note>
|
|
793
811
|
* <p> You must deactivate a user's virtual MFA device before you can delete it. For
|
|
794
812
|
* information about deactivating MFA devices, see <a>DeactivateMFADevice</a>. </p>
|
|
795
|
-
*
|
|
813
|
+
* </note>
|
|
796
814
|
*/
|
|
797
815
|
deleteVirtualMFADevice(args: DeleteVirtualMFADeviceCommandInput, options?: __HttpHandlerOptions): Promise<DeleteVirtualMFADeviceCommandOutput>;
|
|
798
816
|
deleteVirtualMFADevice(args: DeleteVirtualMFADeviceCommandInput, cb: (err: any, data?: DeleteVirtualMFADeviceCommandOutput) => void): void;
|
|
799
817
|
deleteVirtualMFADevice(args: DeleteVirtualMFADeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVirtualMFADeviceCommandOutput) => void): void;
|
|
800
818
|
/**
|
|
801
819
|
* <p>Removes the specified managed policy from the specified IAM group.</p>
|
|
802
|
-
*
|
|
820
|
+
* <p>A group can also have inline policies embedded with it. To delete an inline policy,
|
|
803
821
|
* use <a>DeleteGroupPolicy</a>. For information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed
|
|
804
822
|
* policies and inline policies</a> in the
|
|
805
823
|
* <i>IAM User Guide</i>.</p>
|
|
@@ -809,7 +827,7 @@ export declare class IAM extends IAMClient {
|
|
|
809
827
|
detachGroupPolicy(args: DetachGroupPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachGroupPolicyCommandOutput) => void): void;
|
|
810
828
|
/**
|
|
811
829
|
* <p>Removes the specified managed policy from the specified role.</p>
|
|
812
|
-
*
|
|
830
|
+
* <p>A role can also have inline policies embedded with it. To delete an inline policy, use
|
|
813
831
|
* <a>DeleteRolePolicy</a>. For information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed
|
|
814
832
|
* policies and inline policies</a> in the
|
|
815
833
|
* <i>IAM User Guide</i>.</p>
|
|
@@ -819,7 +837,7 @@ export declare class IAM extends IAMClient {
|
|
|
819
837
|
detachRolePolicy(args: DetachRolePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachRolePolicyCommandOutput) => void): void;
|
|
820
838
|
/**
|
|
821
839
|
* <p>Removes the specified managed policy from the specified user.</p>
|
|
822
|
-
*
|
|
840
|
+
* <p>A user can also have inline policies embedded with it. To delete an inline policy, use
|
|
823
841
|
* <a>DeleteUserPolicy</a>. For information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed
|
|
824
842
|
* policies and inline policies</a> in the
|
|
825
843
|
* <i>IAM User Guide</i>.</p>
|
|
@@ -847,26 +865,26 @@ export declare class IAM extends IAMClient {
|
|
|
847
865
|
* <p>Generates a report for service last accessed data for Organizations. You can generate a
|
|
848
866
|
* report for any entities (organization root, organizational unit, or account) or policies
|
|
849
867
|
* in your organization.</p>
|
|
850
|
-
*
|
|
868
|
+
* <p>To call this operation, you must be signed in using your Organizations management account
|
|
851
869
|
* credentials. You can use your long-term IAM user or root user credentials, or
|
|
852
870
|
* temporary credentials from assuming an IAM role. SCPs must be enabled for your
|
|
853
871
|
* organization root. You must have the required IAM and Organizations permissions. For more
|
|
854
872
|
* information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html">Refining permissions using
|
|
855
873
|
* service last accessed data</a> in the
|
|
856
874
|
* <i>IAM User Guide</i>.</p>
|
|
857
|
-
*
|
|
875
|
+
* <p>You can generate a service last accessed data report for entities by specifying only
|
|
858
876
|
* the entity's path. This data includes a list of services that are allowed by any service
|
|
859
877
|
* control policies (SCPs) that apply to the entity.</p>
|
|
860
|
-
*
|
|
878
|
+
* <p>You can generate a service last accessed data report for a policy by specifying an
|
|
861
879
|
* entity's path and an optional Organizations policy ID. This data includes a list of services that
|
|
862
880
|
* are allowed by the specified SCP.</p>
|
|
863
|
-
*
|
|
881
|
+
* <p>For each service in both report types, the data includes the most recent account
|
|
864
882
|
* activity that the policy allows to account principals in the entity or the entity's
|
|
865
883
|
* children. For important information about the data, reporting period, permissions
|
|
866
884
|
* required, troubleshooting, and supported Regions see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html">Reducing permissions using
|
|
867
885
|
* service last accessed data</a> in the
|
|
868
886
|
* <i>IAM User Guide</i>.</p>
|
|
869
|
-
*
|
|
887
|
+
* <important>
|
|
870
888
|
* <p>The data includes all attempts to access Amazon Web Services, not just the successful ones. This
|
|
871
889
|
* includes all attempts that were made using the Amazon Web Services Management Console, the Amazon Web Services API through any
|
|
872
890
|
* of the SDKs, or any of the command line tools. An unexpected entry in the service
|
|
@@ -875,8 +893,8 @@ export declare class IAM extends IAMClient {
|
|
|
875
893
|
* source for information about all API calls and whether they were successful or
|
|
876
894
|
* denied access. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/cloudtrail-integration.html">Logging IAM events with
|
|
877
895
|
* CloudTrail</a> in the <i>IAM User Guide</i>.</p>
|
|
878
|
-
*
|
|
879
|
-
*
|
|
896
|
+
* </important>
|
|
897
|
+
* <p>This operation returns a <code>JobId</code>. Use this parameter in the <code>
|
|
880
898
|
* <a>GetOrganizationsAccessReport</a>
|
|
881
899
|
* </code> operation to check the status of
|
|
882
900
|
* the report generation. To check the status of this request, use the <code>JobId</code>
|
|
@@ -885,12 +903,12 @@ export declare class IAM extends IAMClient {
|
|
|
885
903
|
* </code> operation
|
|
886
904
|
* and test the <code>JobStatus</code> response parameter. When the job is complete, you
|
|
887
905
|
* can retrieve the report.</p>
|
|
888
|
-
*
|
|
906
|
+
* <p>To generate a service last accessed data report for entities, specify an entity path
|
|
889
907
|
* without specifying the optional Organizations policy ID. The type of entity that you specify
|
|
890
908
|
* determines the data returned in the report.</p>
|
|
891
|
-
*
|
|
909
|
+
* <ul>
|
|
892
910
|
* <li>
|
|
893
|
-
*
|
|
911
|
+
* <p>
|
|
894
912
|
* <b>Root</b> – When you specify the
|
|
895
913
|
* organizations root as the entity, the resulting report lists all of the services
|
|
896
914
|
* allowed by SCPs that are attached to your root. For each service, the report
|
|
@@ -898,7 +916,7 @@ export declare class IAM extends IAMClient {
|
|
|
898
916
|
* management account, because the management account is not limited by SCPs.</p>
|
|
899
917
|
* </li>
|
|
900
918
|
* <li>
|
|
901
|
-
*
|
|
919
|
+
* <p>
|
|
902
920
|
* <b>OU</b> – When you specify an
|
|
903
921
|
* organizational unit (OU) as the entity, the resulting report lists all of the
|
|
904
922
|
* services allowed by SCPs that are attached to the OU and its parents. For each
|
|
@@ -907,26 +925,26 @@ export declare class IAM extends IAMClient {
|
|
|
907
925
|
* limited by SCPs.</p>
|
|
908
926
|
* </li>
|
|
909
927
|
* <li>
|
|
910
|
-
*
|
|
928
|
+
* <p>
|
|
911
929
|
* <b>management account</b> – When you specify the
|
|
912
930
|
* management account, the resulting report lists all Amazon Web Services services, because the
|
|
913
931
|
* management account is not limited by SCPs. For each service, the report includes
|
|
914
932
|
* data for only the management account.</p>
|
|
915
933
|
* </li>
|
|
916
934
|
* <li>
|
|
917
|
-
*
|
|
935
|
+
* <p>
|
|
918
936
|
* <b>Account</b> – When you specify another
|
|
919
937
|
* account as the entity, the resulting report lists all of the services allowed by
|
|
920
938
|
* SCPs that are attached to the account and its parents. For each service, the
|
|
921
939
|
* report includes data for only the specified account.</p>
|
|
922
940
|
* </li>
|
|
923
941
|
* </ul>
|
|
924
|
-
*
|
|
942
|
+
* <p>To generate a service last accessed data report for policies, specify an entity path
|
|
925
943
|
* and the optional Organizations policy ID. The type of entity that you specify determines the data
|
|
926
944
|
* returned for each service.</p>
|
|
927
|
-
*
|
|
945
|
+
* <ul>
|
|
928
946
|
* <li>
|
|
929
|
-
*
|
|
947
|
+
* <p>
|
|
930
948
|
* <b>Root</b> – When you specify the root
|
|
931
949
|
* entity and a policy ID, the resulting report lists all of the services that are
|
|
932
950
|
* allowed by the specified SCP. For each service, the report includes data for all
|
|
@@ -936,7 +954,7 @@ export declare class IAM extends IAMClient {
|
|
|
936
954
|
* return a list of services with no data.</p>
|
|
937
955
|
* </li>
|
|
938
956
|
* <li>
|
|
939
|
-
*
|
|
957
|
+
* <p>
|
|
940
958
|
* <b>OU</b> – When you specify an OU entity and
|
|
941
959
|
* a policy ID, the resulting report lists all of the services that are allowed by
|
|
942
960
|
* the specified SCP. For each service, the report includes data for all accounts
|
|
@@ -948,7 +966,7 @@ export declare class IAM extends IAMClient {
|
|
|
948
966
|
* data.</p>
|
|
949
967
|
* </li>
|
|
950
968
|
* <li>
|
|
951
|
-
*
|
|
969
|
+
* <p>
|
|
952
970
|
* <b>management account</b> – When you specify the
|
|
953
971
|
* management account, the resulting report lists all Amazon Web Services services, because the
|
|
954
972
|
* management account is not limited by SCPs. If you specify a policy ID in the CLI
|
|
@@ -956,7 +974,7 @@ export declare class IAM extends IAMClient {
|
|
|
956
974
|
* only the management account.</p>
|
|
957
975
|
* </li>
|
|
958
976
|
* <li>
|
|
959
|
-
*
|
|
977
|
+
* <p>
|
|
960
978
|
* <b>Account</b> – When you specify another
|
|
961
979
|
* account entity and a policy ID, the resulting report lists all of the services
|
|
962
980
|
* that are allowed by the specified SCP. For each service, the report includes
|
|
@@ -966,15 +984,15 @@ export declare class IAM extends IAMClient {
|
|
|
966
984
|
* services with no data.</p>
|
|
967
985
|
* </li>
|
|
968
986
|
* </ul>
|
|
969
|
-
*
|
|
987
|
+
* <note>
|
|
970
988
|
* <p>Service last accessed data does not use other policy types when determining
|
|
971
989
|
* whether a principal could access a service. These other policy types include
|
|
972
990
|
* identity-based policies, resource-based policies, access control lists, IAM
|
|
973
991
|
* permissions boundaries, and STS assume role policies. It only applies SCP logic.
|
|
974
992
|
* For more about the evaluation of policy types, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics">Evaluating policies</a> in the
|
|
975
993
|
* <i>IAM User Guide</i>.</p>
|
|
976
|
-
*
|
|
977
|
-
*
|
|
994
|
+
* </note>
|
|
995
|
+
* <p>For more information about service last accessed data, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html">Reducing policy scope by
|
|
978
996
|
* viewing user activity</a> in the <i>IAM User Guide</i>.</p>
|
|
979
997
|
*/
|
|
980
998
|
generateOrganizationsAccessReport(args: GenerateOrganizationsAccessReportCommandInput, options?: __HttpHandlerOptions): Promise<GenerateOrganizationsAccessReportCommandOutput>;
|
|
@@ -986,7 +1004,7 @@ export declare class IAM extends IAMClient {
|
|
|
986
1004
|
* usually appears within four hours. IAM reports activity for at least the last 400
|
|
987
1005
|
* days, or less if your Region began supporting this feature within the last year. For
|
|
988
1006
|
* more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#access-advisor_tracking-period">Regions where data is tracked</a>.</p>
|
|
989
|
-
*
|
|
1007
|
+
* <important>
|
|
990
1008
|
* <p>The service last accessed data includes all attempts to access an Amazon Web Services API, not
|
|
991
1009
|
* just the successful ones. This includes all attempts that were made using the
|
|
992
1010
|
* Amazon Web Services Management Console, the Amazon Web Services API through any of the SDKs, or any of the command line tools.
|
|
@@ -996,44 +1014,44 @@ export declare class IAM extends IAMClient {
|
|
|
996
1014
|
* and whether they were successful or denied access. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/cloudtrail-integration.html">Logging
|
|
997
1015
|
* IAM events with CloudTrail</a> in the
|
|
998
1016
|
* <i>IAM User Guide</i>.</p>
|
|
999
|
-
*
|
|
1000
|
-
*
|
|
1017
|
+
* </important>
|
|
1018
|
+
* <p>The <code>GenerateServiceLastAccessedDetails</code> operation returns a
|
|
1001
1019
|
* <code>JobId</code>. Use this parameter in the following operations to retrieve the
|
|
1002
1020
|
* following details from your report: </p>
|
|
1003
|
-
*
|
|
1021
|
+
* <ul>
|
|
1004
1022
|
* <li>
|
|
1005
|
-
*
|
|
1023
|
+
* <p>
|
|
1006
1024
|
* <a>GetServiceLastAccessedDetails</a> – Use this operation
|
|
1007
1025
|
* for users, groups, roles, or policies to list every Amazon Web Services service that the
|
|
1008
1026
|
* resource could access using permissions policies. For each service, the response
|
|
1009
1027
|
* includes information about the most recent access attempt.</p>
|
|
1010
|
-
*
|
|
1028
|
+
* <p>The <code>JobId</code> returned by
|
|
1011
1029
|
* <code>GenerateServiceLastAccessedDetail</code> must be used by the same role
|
|
1012
1030
|
* within a session, or by the same user when used to call
|
|
1013
1031
|
* <code>GetServiceLastAccessedDetail</code>.</p>
|
|
1014
1032
|
* </li>
|
|
1015
1033
|
* <li>
|
|
1016
|
-
*
|
|
1034
|
+
* <p>
|
|
1017
1035
|
* <a>GetServiceLastAccessedDetailsWithEntities</a> – Use this
|
|
1018
1036
|
* operation for groups and policies to list information about the associated
|
|
1019
1037
|
* entities (users or roles) that attempted to access a specific Amazon Web Services service.
|
|
1020
1038
|
* </p>
|
|
1021
1039
|
* </li>
|
|
1022
1040
|
* </ul>
|
|
1023
|
-
*
|
|
1041
|
+
* <p>To check the status of the <code>GenerateServiceLastAccessedDetails</code> request,
|
|
1024
1042
|
* use the <code>JobId</code> parameter in the same operations and test the
|
|
1025
1043
|
* <code>JobStatus</code> response parameter.</p>
|
|
1026
|
-
*
|
|
1044
|
+
* <p>For additional information about the permissions policies that allow an identity
|
|
1027
1045
|
* (user, group, or role) to access specific services, use the <a>ListPoliciesGrantingServiceAccess</a> operation.</p>
|
|
1028
|
-
*
|
|
1046
|
+
* <note>
|
|
1029
1047
|
* <p>Service last accessed data does not use other policy types when determining
|
|
1030
1048
|
* whether a resource could access a service. These other policy types include
|
|
1031
1049
|
* resource-based policies, access control lists, Organizations policies, IAM permissions
|
|
1032
1050
|
* boundaries, and STS assume role policies. It only applies permissions policy
|
|
1033
1051
|
* logic. For more about the evaluation of policy types, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics">Evaluating policies</a> in the
|
|
1034
1052
|
* <i>IAM User Guide</i>.</p>
|
|
1035
|
-
*
|
|
1036
|
-
*
|
|
1053
|
+
* </note>
|
|
1054
|
+
* <p>For more information about service and action last accessed data, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html">Reducing permissions using service last accessed data</a> in the
|
|
1037
1055
|
* <i>IAM User Guide</i>.</p>
|
|
1038
1056
|
*/
|
|
1039
1057
|
generateServiceLastAccessedDetails(args: GenerateServiceLastAccessedDetailsCommandInput, options?: __HttpHandlerOptions): Promise<GenerateServiceLastAccessedDetailsCommandOutput>;
|
|
@@ -1052,14 +1070,14 @@ export declare class IAM extends IAMClient {
|
|
|
1052
1070
|
* account, including their relationships to one another. Use this operation to obtain a
|
|
1053
1071
|
* snapshot of the configuration of IAM permissions (users, groups, roles, and policies)
|
|
1054
1072
|
* in your account.</p>
|
|
1055
|
-
*
|
|
1073
|
+
* <note>
|
|
1056
1074
|
* <p>Policies returned by this operation are URL-encoded compliant
|
|
1057
1075
|
* with <a href="https://tools.ietf.org/html/rfc3986">RFC 3986</a>. You can use a URL
|
|
1058
1076
|
* decoding method to convert the policy back to plain JSON text. For example, if you use Java, you
|
|
1059
1077
|
* can use the <code>decode</code> method of the <code>java.net.URLDecoder</code> utility class in
|
|
1060
1078
|
* the Java SDK. Other languages and SDKs provide similar functionality.</p>
|
|
1061
1079
|
* </note>
|
|
1062
|
-
*
|
|
1080
|
+
* <p>You can optionally filter the results using the <code>Filter</code> parameter. You can
|
|
1063
1081
|
* paginate the results using the <code>MaxItems</code> and <code>Marker</code>
|
|
1064
1082
|
* parameters.</p>
|
|
1065
1083
|
*/
|
|
@@ -1078,7 +1096,7 @@ export declare class IAM extends IAMClient {
|
|
|
1078
1096
|
/**
|
|
1079
1097
|
* <p>Retrieves information about IAM entity usage and IAM quotas in the Amazon Web Services
|
|
1080
1098
|
* account.</p>
|
|
1081
|
-
*
|
|
1099
|
+
* <p> For information about IAM quotas, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS quotas</a> in the
|
|
1082
1100
|
* <i>IAM User Guide</i>.</p>
|
|
1083
1101
|
*/
|
|
1084
1102
|
getAccountSummary(args: GetAccountSummaryCommandInput, options?: __HttpHandlerOptions): Promise<GetAccountSummaryCommandOutput>;
|
|
@@ -1088,7 +1106,7 @@ export declare class IAM extends IAMClient {
|
|
|
1088
1106
|
* <p>Gets a list of all of the context keys referenced in the input policies. The policies
|
|
1089
1107
|
* are supplied as a list of one or more strings. To get the context keys from policies
|
|
1090
1108
|
* associated with an IAM user, group, or role, use <a>GetContextKeysForPrincipalPolicy</a>.</p>
|
|
1091
|
-
*
|
|
1109
|
+
* <p>Context keys are variables maintained by Amazon Web Services and its services that provide details
|
|
1092
1110
|
* about the context of an API query request. Context keys can be evaluated by testing
|
|
1093
1111
|
* against a value specified in an IAM policy. Use
|
|
1094
1112
|
* <code>GetContextKeysForCustomPolicy</code> to understand what key names and values
|
|
@@ -1104,14 +1122,14 @@ export declare class IAM extends IAMClient {
|
|
|
1104
1122
|
* attached to the specified IAM entity. The entity can be an IAM user, group, or role.
|
|
1105
1123
|
* If you specify a user, then the request also includes all of the policies attached to
|
|
1106
1124
|
* groups that the user is a member of.</p>
|
|
1107
|
-
*
|
|
1125
|
+
* <p>You can optionally include a list of one or more additional policies, specified as
|
|
1108
1126
|
* strings. If you want to include <i>only</i> a list of policies by string,
|
|
1109
1127
|
* use <a>GetContextKeysForCustomPolicy</a> instead.</p>
|
|
1110
|
-
*
|
|
1128
|
+
* <p>
|
|
1111
1129
|
* <b>Note:</b> This operation discloses information about the
|
|
1112
1130
|
* permissions granted to other users. If you do not want users to see other user's
|
|
1113
1131
|
* permissions, then consider allowing them to use <a>GetContextKeysForCustomPolicy</a> instead.</p>
|
|
1114
|
-
*
|
|
1132
|
+
* <p>Context keys are variables maintained by Amazon Web Services and its services that provide details
|
|
1115
1133
|
* about the context of an API query request. Context keys can be evaluated by testing
|
|
1116
1134
|
* against a value in an IAM policy. Use <a>GetContextKeysForPrincipalPolicy</a> to understand what key names and values you must supply when you call <a>SimulatePrincipalPolicy</a>.</p>
|
|
1117
1135
|
*/
|
|
@@ -1136,18 +1154,18 @@ export declare class IAM extends IAMClient {
|
|
|
1136
1154
|
/**
|
|
1137
1155
|
* <p>Retrieves the specified inline policy document that is embedded in the specified IAM
|
|
1138
1156
|
* group.</p>
|
|
1139
|
-
*
|
|
1157
|
+
* <note>
|
|
1140
1158
|
* <p>Policies returned by this operation are URL-encoded compliant
|
|
1141
1159
|
* with <a href="https://tools.ietf.org/html/rfc3986">RFC 3986</a>. You can use a URL
|
|
1142
1160
|
* decoding method to convert the policy back to plain JSON text. For example, if you use Java, you
|
|
1143
1161
|
* can use the <code>decode</code> method of the <code>java.net.URLDecoder</code> utility class in
|
|
1144
1162
|
* the Java SDK. Other languages and SDKs provide similar functionality.</p>
|
|
1145
1163
|
* </note>
|
|
1146
|
-
*
|
|
1164
|
+
* <p>An IAM group can also have managed policies attached to it. To retrieve a managed
|
|
1147
1165
|
* policy document that is attached to a group, use <a>GetPolicy</a> to
|
|
1148
1166
|
* determine the policy's default version, then use <a>GetPolicyVersion</a> to
|
|
1149
1167
|
* retrieve the policy document.</p>
|
|
1150
|
-
*
|
|
1168
|
+
* <p>For more information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline
|
|
1151
1169
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
1152
1170
|
*/
|
|
1153
1171
|
getGroupPolicy(args: GetGroupPolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetGroupPolicyCommandOutput>;
|
|
@@ -1167,9 +1185,9 @@ export declare class IAM extends IAMClient {
|
|
|
1167
1185
|
* you create a password for the user to access the Amazon Web Services Management Console. If the user does not exist
|
|
1168
1186
|
* or does not have a password, the operation returns a 404 (<code>NoSuchEntity</code>)
|
|
1169
1187
|
* error.</p>
|
|
1170
|
-
*
|
|
1188
|
+
* <p>If you create an IAM user with access to the console, the <code>CreateDate</code>
|
|
1171
1189
|
* reflects the date you created the initial password for the user.</p>
|
|
1172
|
-
*
|
|
1190
|
+
* <p>If you create an IAM user with programmatic access, and then later add a password
|
|
1173
1191
|
* for the user to access the Amazon Web Services Management Console, the <code>CreateDate</code> reflects the initial
|
|
1174
1192
|
* password creation date. A user with programmatic access does not have a login profile
|
|
1175
1193
|
* unless you create a password for the user to access the Amazon Web Services Management Console.</p>
|
|
@@ -1191,19 +1209,19 @@ export declare class IAM extends IAMClient {
|
|
|
1191
1209
|
* </code>
|
|
1192
1210
|
* operation. This operation retrieves the status of your report job and the report
|
|
1193
1211
|
* contents.</p>
|
|
1194
|
-
*
|
|
1212
|
+
* <p>Depending on the parameters that you passed when you generated the report, the data
|
|
1195
1213
|
* returned could include different information. For details, see <a>GenerateOrganizationsAccessReport</a>.</p>
|
|
1196
|
-
*
|
|
1214
|
+
* <p>To call this operation, you must be signed in to the management account in your
|
|
1197
1215
|
* organization. SCPs must be enabled for your organization root. You must have permissions
|
|
1198
1216
|
* to perform this operation. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html">Refining permissions using
|
|
1199
1217
|
* service last accessed data</a> in the
|
|
1200
1218
|
* <i>IAM User Guide</i>.</p>
|
|
1201
|
-
*
|
|
1219
|
+
* <p>For each service that principals in an account (root users, IAM users, or IAM
|
|
1202
1220
|
* roles) could access using SCPs, the operation returns details about the most recent
|
|
1203
1221
|
* access attempt. If there was no attempt, the service is listed without details about the
|
|
1204
1222
|
* most recent attempt to access the service. If the operation fails, it returns the reason
|
|
1205
1223
|
* that it failed.</p>
|
|
1206
|
-
*
|
|
1224
|
+
* <p>By default, the list is sorted by service namespace.</p>
|
|
1207
1225
|
*/
|
|
1208
1226
|
getOrganizationsAccessReport(args: GetOrganizationsAccessReportCommandInput, options?: __HttpHandlerOptions): Promise<GetOrganizationsAccessReportCommandOutput>;
|
|
1209
1227
|
getOrganizationsAccessReport(args: GetOrganizationsAccessReportCommandInput, cb: (err: any, data?: GetOrganizationsAccessReportCommandOutput) => void): void;
|
|
@@ -1215,9 +1233,9 @@ export declare class IAM extends IAMClient {
|
|
|
1215
1233
|
* the policy is attached to, use <a>ListEntitiesForPolicy</a>. This operation
|
|
1216
1234
|
* returns metadata about the policy. To retrieve the actual policy document for a specific
|
|
1217
1235
|
* version of the policy, use <a>GetPolicyVersion</a>.</p>
|
|
1218
|
-
*
|
|
1236
|
+
* <p>This operation retrieves information about managed policies. To retrieve information
|
|
1219
1237
|
* about an inline policy that is embedded with an IAM user, group, or role, use <a>GetUserPolicy</a>, <a>GetGroupPolicy</a>, or <a>GetRolePolicy</a>.</p>
|
|
1220
|
-
*
|
|
1238
|
+
* <p>For more information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline
|
|
1221
1239
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
1222
1240
|
*/
|
|
1223
1241
|
getPolicy(args: GetPolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetPolicyCommandOutput>;
|
|
@@ -1226,19 +1244,19 @@ export declare class IAM extends IAMClient {
|
|
|
1226
1244
|
/**
|
|
1227
1245
|
* <p>Retrieves information about the specified version of the specified managed policy,
|
|
1228
1246
|
* including the policy document.</p>
|
|
1229
|
-
*
|
|
1247
|
+
* <note>
|
|
1230
1248
|
* <p>Policies returned by this operation are URL-encoded compliant
|
|
1231
1249
|
* with <a href="https://tools.ietf.org/html/rfc3986">RFC 3986</a>. You can use a URL
|
|
1232
1250
|
* decoding method to convert the policy back to plain JSON text. For example, if you use Java, you
|
|
1233
1251
|
* can use the <code>decode</code> method of the <code>java.net.URLDecoder</code> utility class in
|
|
1234
1252
|
* the Java SDK. Other languages and SDKs provide similar functionality.</p>
|
|
1235
1253
|
* </note>
|
|
1236
|
-
*
|
|
1237
|
-
*
|
|
1254
|
+
* <p>To list the available versions for a policy, use <a>ListPolicyVersions</a>.</p>
|
|
1255
|
+
* <p>This operation retrieves information about managed policies. To retrieve information
|
|
1238
1256
|
* about an inline policy that is embedded in a user, group, or role, use <a>GetUserPolicy</a>, <a>GetGroupPolicy</a>, or <a>GetRolePolicy</a>.</p>
|
|
1239
|
-
*
|
|
1257
|
+
* <p>For more information about the types of policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline
|
|
1240
1258
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
1241
|
-
*
|
|
1259
|
+
* <p>For more information about managed policy versions, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html">Versioning for managed
|
|
1242
1260
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
1243
1261
|
*/
|
|
1244
1262
|
getPolicyVersion(args: GetPolicyVersionCommandInput, options?: __HttpHandlerOptions): Promise<GetPolicyVersionCommandOutput>;
|
|
@@ -1248,7 +1266,7 @@ export declare class IAM extends IAMClient {
|
|
|
1248
1266
|
* <p>Retrieves information about the specified role, including the role's path, GUID, ARN,
|
|
1249
1267
|
* and the role's trust policy that grants permission to assume the role. For more
|
|
1250
1268
|
* information about roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with roles</a>.</p>
|
|
1251
|
-
*
|
|
1269
|
+
* <note>
|
|
1252
1270
|
* <p>Policies returned by this operation are URL-encoded compliant
|
|
1253
1271
|
* with <a href="https://tools.ietf.org/html/rfc3986">RFC 3986</a>. You can use a URL
|
|
1254
1272
|
* decoding method to convert the policy back to plain JSON text. For example, if you use Java, you
|
|
@@ -1262,20 +1280,20 @@ export declare class IAM extends IAMClient {
|
|
|
1262
1280
|
/**
|
|
1263
1281
|
* <p>Retrieves the specified inline policy document that is embedded with the specified
|
|
1264
1282
|
* IAM role.</p>
|
|
1265
|
-
*
|
|
1283
|
+
* <note>
|
|
1266
1284
|
* <p>Policies returned by this operation are URL-encoded compliant
|
|
1267
1285
|
* with <a href="https://tools.ietf.org/html/rfc3986">RFC 3986</a>. You can use a URL
|
|
1268
1286
|
* decoding method to convert the policy back to plain JSON text. For example, if you use Java, you
|
|
1269
1287
|
* can use the <code>decode</code> method of the <code>java.net.URLDecoder</code> utility class in
|
|
1270
1288
|
* the Java SDK. Other languages and SDKs provide similar functionality.</p>
|
|
1271
1289
|
* </note>
|
|
1272
|
-
*
|
|
1290
|
+
* <p>An IAM role can also have managed policies attached to it. To retrieve a managed
|
|
1273
1291
|
* policy document that is attached to a role, use <a>GetPolicy</a> to determine
|
|
1274
1292
|
* the policy's default version, then use <a>GetPolicyVersion</a> to retrieve
|
|
1275
1293
|
* the policy document.</p>
|
|
1276
|
-
*
|
|
1294
|
+
* <p>For more information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline
|
|
1277
1295
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
1278
|
-
*
|
|
1296
|
+
* <p>For more information about roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html">Using roles to delegate permissions and
|
|
1279
1297
|
* federate identities</a>.</p>
|
|
1280
1298
|
*/
|
|
1281
1299
|
getRolePolicy(args: GetRolePolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetRolePolicyCommandOutput>;
|
|
@@ -1284,16 +1302,16 @@ export declare class IAM extends IAMClient {
|
|
|
1284
1302
|
/**
|
|
1285
1303
|
* <p>Returns the SAML provider metadocument that was uploaded when the IAM SAML provider
|
|
1286
1304
|
* resource object was created or updated.</p>
|
|
1287
|
-
*
|
|
1305
|
+
* <note>
|
|
1288
1306
|
* <p>This operation requires <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>.</p>
|
|
1289
|
-
*
|
|
1307
|
+
* </note>
|
|
1290
1308
|
*/
|
|
1291
1309
|
getSAMLProvider(args: GetSAMLProviderCommandInput, options?: __HttpHandlerOptions): Promise<GetSAMLProviderCommandOutput>;
|
|
1292
1310
|
getSAMLProvider(args: GetSAMLProviderCommandInput, cb: (err: any, data?: GetSAMLProviderCommandOutput) => void): void;
|
|
1293
1311
|
getSAMLProvider(args: GetSAMLProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSAMLProviderCommandOutput) => void): void;
|
|
1294
1312
|
/**
|
|
1295
1313
|
* <p>Retrieves information about the specified server certificate stored in IAM.</p>
|
|
1296
|
-
*
|
|
1314
|
+
* <p>For more information about working with server certificates, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Working
|
|
1297
1315
|
* with server certificates</a> in the <i>IAM User Guide</i>. This
|
|
1298
1316
|
* topic includes a list of Amazon Web Services services that can use the server certificates that you
|
|
1299
1317
|
* manage with IAM.</p>
|
|
@@ -1308,51 +1326,51 @@ export declare class IAM extends IAMClient {
|
|
|
1308
1326
|
* retrieve the status of your report job. When the report is complete, you can retrieve
|
|
1309
1327
|
* the generated report. The report includes a list of Amazon Web Services services that the resource
|
|
1310
1328
|
* (user, group, role, or managed policy) can access.</p>
|
|
1311
|
-
*
|
|
1329
|
+
* <note>
|
|
1312
1330
|
* <p>Service last accessed data does not use other policy types when determining
|
|
1313
1331
|
* whether a resource could access a service. These other policy types include
|
|
1314
1332
|
* resource-based policies, access control lists, Organizations policies, IAM permissions
|
|
1315
1333
|
* boundaries, and STS assume role policies. It only applies permissions policy
|
|
1316
1334
|
* logic. For more about the evaluation of policy types, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics">Evaluating policies</a> in the
|
|
1317
1335
|
* <i>IAM User Guide</i>.</p>
|
|
1318
|
-
*
|
|
1319
|
-
*
|
|
1336
|
+
* </note>
|
|
1337
|
+
* <p>For each service that the resource could access using permissions policies, the
|
|
1320
1338
|
* operation returns details about the most recent access attempt. If there was no attempt,
|
|
1321
1339
|
* the service is listed without details about the most recent attempt to access the
|
|
1322
1340
|
* service. If the operation fails, the <code>GetServiceLastAccessedDetails</code>
|
|
1323
1341
|
* operation returns the reason that it failed.</p>
|
|
1324
|
-
*
|
|
1342
|
+
* <p>The <code>GetServiceLastAccessedDetails</code> operation returns a list of services.
|
|
1325
1343
|
* This list includes the number of entities that have attempted to access the service and
|
|
1326
1344
|
* the date and time of the last attempt. It also returns the ARN of the following entity,
|
|
1327
1345
|
* depending on the resource ARN that you used to generate the report:</p>
|
|
1328
|
-
*
|
|
1346
|
+
* <ul>
|
|
1329
1347
|
* <li>
|
|
1330
|
-
*
|
|
1348
|
+
* <p>
|
|
1331
1349
|
* <b>User</b> – Returns the user ARN that you
|
|
1332
1350
|
* used to generate the report</p>
|
|
1333
1351
|
* </li>
|
|
1334
1352
|
* <li>
|
|
1335
|
-
*
|
|
1353
|
+
* <p>
|
|
1336
1354
|
* <b>Group</b> – Returns the ARN of the group
|
|
1337
1355
|
* member (user) that last attempted to access the service</p>
|
|
1338
1356
|
* </li>
|
|
1339
1357
|
* <li>
|
|
1340
|
-
*
|
|
1358
|
+
* <p>
|
|
1341
1359
|
* <b>Role</b> – Returns the role ARN that you
|
|
1342
1360
|
* used to generate the report</p>
|
|
1343
1361
|
* </li>
|
|
1344
1362
|
* <li>
|
|
1345
|
-
*
|
|
1363
|
+
* <p>
|
|
1346
1364
|
* <b>Policy</b> – Returns the ARN of the user
|
|
1347
1365
|
* or role that last used the policy to attempt to access the service</p>
|
|
1348
1366
|
* </li>
|
|
1349
1367
|
* </ul>
|
|
1350
|
-
*
|
|
1351
|
-
*
|
|
1368
|
+
* <p>By default, the list is sorted by service namespace.</p>
|
|
1369
|
+
* <p>If you specified <code>ACTION_LEVEL</code> granularity when you generated the report,
|
|
1352
1370
|
* this operation returns service and action last accessed data. This includes the most
|
|
1353
1371
|
* recent access attempt for each tracked action within a service. Otherwise, this
|
|
1354
1372
|
* operation returns only service data.</p>
|
|
1355
|
-
*
|
|
1373
|
+
* <p>For more information about service and action last accessed data, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html">Reducing permissions using service last accessed data</a> in the
|
|
1356
1374
|
* <i>IAM User Guide</i>.</p>
|
|
1357
1375
|
*/
|
|
1358
1376
|
getServiceLastAccessedDetails(args: GetServiceLastAccessedDetailsCommandInput, options?: __HttpHandlerOptions): Promise<GetServiceLastAccessedDetailsCommandOutput>;
|
|
@@ -1365,25 +1383,25 @@ export declare class IAM extends IAMClient {
|
|
|
1365
1383
|
* <code>GetServiceLastAccessedDetailsWithEntities</code>. This operation retrieves the
|
|
1366
1384
|
* status of your report job and a list of entities that could have used group or policy
|
|
1367
1385
|
* permissions to access the specified service.</p>
|
|
1368
|
-
*
|
|
1386
|
+
* <ul>
|
|
1369
1387
|
* <li>
|
|
1370
|
-
*
|
|
1388
|
+
* <p>
|
|
1371
1389
|
* <b>Group</b> – For a group report, this
|
|
1372
1390
|
* operation returns a list of users in the group that could have used the group’s
|
|
1373
1391
|
* policies in an attempt to access the service.</p>
|
|
1374
1392
|
* </li>
|
|
1375
1393
|
* <li>
|
|
1376
|
-
*
|
|
1394
|
+
* <p>
|
|
1377
1395
|
* <b>Policy</b> – For a policy report, this
|
|
1378
1396
|
* operation returns a list of entities (users or roles) that could have used the
|
|
1379
1397
|
* policy in an attempt to access the service.</p>
|
|
1380
1398
|
* </li>
|
|
1381
1399
|
* </ul>
|
|
1382
|
-
*
|
|
1400
|
+
* <p>You can also use this operation for user or role reports to retrieve details about
|
|
1383
1401
|
* those entities.</p>
|
|
1384
|
-
*
|
|
1402
|
+
* <p>If the operation fails, the <code>GetServiceLastAccessedDetailsWithEntities</code>
|
|
1385
1403
|
* operation returns the reason that it failed.</p>
|
|
1386
|
-
*
|
|
1404
|
+
* <p>By default, the list of associated entities is sorted by date, with the most recent
|
|
1387
1405
|
* access listed first.</p>
|
|
1388
1406
|
*/
|
|
1389
1407
|
getServiceLastAccessedDetailsWithEntities(args: GetServiceLastAccessedDetailsWithEntitiesCommandInput, options?: __HttpHandlerOptions): Promise<GetServiceLastAccessedDetailsWithEntitiesCommandOutput>;
|
|
@@ -1401,7 +1419,7 @@ export declare class IAM extends IAMClient {
|
|
|
1401
1419
|
getServiceLinkedRoleDeletionStatus(args: GetServiceLinkedRoleDeletionStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceLinkedRoleDeletionStatusCommandOutput) => void): void;
|
|
1402
1420
|
/**
|
|
1403
1421
|
* <p>Retrieves the specified SSH public key, including metadata about the key.</p>
|
|
1404
|
-
*
|
|
1422
|
+
* <p>The SSH public key retrieved by this operation is used only for authenticating the
|
|
1405
1423
|
* associated IAM user to an CodeCommit repository. For more information about using SSH keys
|
|
1406
1424
|
* to authenticate to an CodeCommit repository, see <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html">Set up CodeCommit for SSH
|
|
1407
1425
|
* connections</a> in the <i>CodeCommit User Guide</i>.</p>
|
|
@@ -1412,7 +1430,7 @@ export declare class IAM extends IAMClient {
|
|
|
1412
1430
|
/**
|
|
1413
1431
|
* <p>Retrieves information about the specified IAM user, including the user's creation
|
|
1414
1432
|
* date, path, unique ID, and ARN.</p>
|
|
1415
|
-
*
|
|
1433
|
+
* <p>If you do not specify a user name, IAM determines the user name implicitly based on
|
|
1416
1434
|
* the Amazon Web Services access key ID used to sign the request to this operation.</p>
|
|
1417
1435
|
*/
|
|
1418
1436
|
getUser(args: GetUserCommandInput, options?: __HttpHandlerOptions): Promise<GetUserCommandOutput>;
|
|
@@ -1421,18 +1439,18 @@ export declare class IAM extends IAMClient {
|
|
|
1421
1439
|
/**
|
|
1422
1440
|
* <p>Retrieves the specified inline policy document that is embedded in the specified IAM
|
|
1423
1441
|
* user.</p>
|
|
1424
|
-
*
|
|
1442
|
+
* <note>
|
|
1425
1443
|
* <p>Policies returned by this operation are URL-encoded compliant
|
|
1426
1444
|
* with <a href="https://tools.ietf.org/html/rfc3986">RFC 3986</a>. You can use a URL
|
|
1427
1445
|
* decoding method to convert the policy back to plain JSON text. For example, if you use Java, you
|
|
1428
1446
|
* can use the <code>decode</code> method of the <code>java.net.URLDecoder</code> utility class in
|
|
1429
1447
|
* the Java SDK. Other languages and SDKs provide similar functionality.</p>
|
|
1430
1448
|
* </note>
|
|
1431
|
-
*
|
|
1449
|
+
* <p>An IAM user can also have managed policies attached to it. To retrieve a managed
|
|
1432
1450
|
* policy document that is attached to a user, use <a>GetPolicy</a> to determine
|
|
1433
1451
|
* the policy's default version. Then use <a>GetPolicyVersion</a> to retrieve
|
|
1434
1452
|
* the policy document.</p>
|
|
1435
|
-
*
|
|
1453
|
+
* <p>For more information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline
|
|
1436
1454
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
1437
1455
|
*/
|
|
1438
1456
|
getUserPolicy(args: GetUserPolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetUserPolicyCommandOutput>;
|
|
@@ -1441,19 +1459,19 @@ export declare class IAM extends IAMClient {
|
|
|
1441
1459
|
/**
|
|
1442
1460
|
* <p>Returns information about the access key IDs associated with the specified IAM user.
|
|
1443
1461
|
* If there is none, the operation returns an empty list.</p>
|
|
1444
|
-
*
|
|
1462
|
+
* <p>Although each user is limited to a small number of keys, you can still paginate the
|
|
1445
1463
|
* results using the <code>MaxItems</code> and <code>Marker</code> parameters.</p>
|
|
1446
|
-
*
|
|
1464
|
+
* <p>If the <code>UserName</code> is not specified, the user name is determined implicitly
|
|
1447
1465
|
* based on the Amazon Web Services access key ID used to sign the request. If a temporary access key is
|
|
1448
1466
|
* used, then <code>UserName</code> is required. If a long-term key is assigned to the
|
|
1449
1467
|
* user, then <code>UserName</code> is not required. This operation works for access keys
|
|
1450
1468
|
* under the Amazon Web Services account. Consequently, you can use this operation to manage
|
|
1451
1469
|
* Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated
|
|
1452
1470
|
* users.</p>
|
|
1453
|
-
*
|
|
1471
|
+
* <note>
|
|
1454
1472
|
* <p>To ensure the security of your Amazon Web Services account, the secret access key is accessible
|
|
1455
1473
|
* only during key and user creation.</p>
|
|
1456
|
-
*
|
|
1474
|
+
* </note>
|
|
1457
1475
|
*/
|
|
1458
1476
|
listAccessKeys(args: ListAccessKeysCommandInput, options?: __HttpHandlerOptions): Promise<ListAccessKeysCommandOutput>;
|
|
1459
1477
|
listAccessKeys(args: ListAccessKeysCommandInput, cb: (err: any, data?: ListAccessKeysCommandOutput) => void): void;
|
|
@@ -1468,11 +1486,11 @@ export declare class IAM extends IAMClient {
|
|
|
1468
1486
|
listAccountAliases(args: ListAccountAliasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccountAliasesCommandOutput) => void): void;
|
|
1469
1487
|
/**
|
|
1470
1488
|
* <p>Lists all managed policies that are attached to the specified IAM group.</p>
|
|
1471
|
-
*
|
|
1489
|
+
* <p>An IAM group can also have inline policies embedded with it. To list the inline
|
|
1472
1490
|
* policies for a group, use <a>ListGroupPolicies</a>. For information about
|
|
1473
1491
|
* policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline
|
|
1474
1492
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
1475
|
-
*
|
|
1493
|
+
* <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code>
|
|
1476
1494
|
* parameters. You can use the <code>PathPrefix</code> parameter to limit the list of
|
|
1477
1495
|
* policies to only those matching the specified path prefix. If there are no policies
|
|
1478
1496
|
* attached to the specified group (or none that match the specified path prefix), the
|
|
@@ -1483,11 +1501,11 @@ export declare class IAM extends IAMClient {
|
|
|
1483
1501
|
listAttachedGroupPolicies(args: ListAttachedGroupPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAttachedGroupPoliciesCommandOutput) => void): void;
|
|
1484
1502
|
/**
|
|
1485
1503
|
* <p>Lists all managed policies that are attached to the specified IAM role.</p>
|
|
1486
|
-
*
|
|
1504
|
+
* <p>An IAM role can also have inline policies embedded with it. To list the inline
|
|
1487
1505
|
* policies for a role, use <a>ListRolePolicies</a>. For information about
|
|
1488
1506
|
* policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline
|
|
1489
1507
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
1490
|
-
*
|
|
1508
|
+
* <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code>
|
|
1491
1509
|
* parameters. You can use the <code>PathPrefix</code> parameter to limit the list of
|
|
1492
1510
|
* policies to only those matching the specified path prefix. If there are no policies
|
|
1493
1511
|
* attached to the specified role (or none that match the specified path prefix), the
|
|
@@ -1498,11 +1516,11 @@ export declare class IAM extends IAMClient {
|
|
|
1498
1516
|
listAttachedRolePolicies(args: ListAttachedRolePoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAttachedRolePoliciesCommandOutput) => void): void;
|
|
1499
1517
|
/**
|
|
1500
1518
|
* <p>Lists all managed policies that are attached to the specified IAM user.</p>
|
|
1501
|
-
*
|
|
1519
|
+
* <p>An IAM user can also have inline policies embedded with it. To list the inline
|
|
1502
1520
|
* policies for a user, use <a>ListUserPolicies</a>. For information about
|
|
1503
1521
|
* policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline
|
|
1504
1522
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
1505
|
-
*
|
|
1523
|
+
* <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code>
|
|
1506
1524
|
* parameters. You can use the <code>PathPrefix</code> parameter to limit the list of
|
|
1507
1525
|
* policies to only those matching the specified path prefix. If there are no policies
|
|
1508
1526
|
* attached to the specified group (or none that match the specified path prefix), the
|
|
@@ -1514,11 +1532,11 @@ export declare class IAM extends IAMClient {
|
|
|
1514
1532
|
/**
|
|
1515
1533
|
* <p>Lists all IAM users, groups, and roles that the specified managed policy is attached
|
|
1516
1534
|
* to.</p>
|
|
1517
|
-
*
|
|
1535
|
+
* <p>You can use the optional <code>EntityFilter</code> parameter to limit the results to a
|
|
1518
1536
|
* particular type of entity (users, groups, or roles). For example, to list only the roles
|
|
1519
1537
|
* that are attached to the specified policy, set <code>EntityFilter</code> to
|
|
1520
1538
|
* <code>Role</code>.</p>
|
|
1521
|
-
*
|
|
1539
|
+
* <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code>
|
|
1522
1540
|
* parameters.</p>
|
|
1523
1541
|
*/
|
|
1524
1542
|
listEntitiesForPolicy(args: ListEntitiesForPolicyCommandInput, options?: __HttpHandlerOptions): Promise<ListEntitiesForPolicyCommandOutput>;
|
|
@@ -1527,11 +1545,11 @@ export declare class IAM extends IAMClient {
|
|
|
1527
1545
|
/**
|
|
1528
1546
|
* <p>Lists the names of the inline policies that are embedded in the specified IAM
|
|
1529
1547
|
* group.</p>
|
|
1530
|
-
*
|
|
1548
|
+
* <p>An IAM group can also have managed policies attached to it. To list the managed
|
|
1531
1549
|
* policies that are attached to a group, use <a>ListAttachedGroupPolicies</a>.
|
|
1532
1550
|
* For more information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline
|
|
1533
1551
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
1534
|
-
*
|
|
1552
|
+
* <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code>
|
|
1535
1553
|
* parameters. If there are no inline policies embedded with the specified group, the
|
|
1536
1554
|
* operation returns an empty list.</p>
|
|
1537
1555
|
*/
|
|
@@ -1540,7 +1558,7 @@ export declare class IAM extends IAMClient {
|
|
|
1540
1558
|
listGroupPolicies(args: ListGroupPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupPoliciesCommandOutput) => void): void;
|
|
1541
1559
|
/**
|
|
1542
1560
|
* <p>Lists the IAM groups that have the specified path prefix.</p>
|
|
1543
|
-
*
|
|
1561
|
+
* <p> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code>
|
|
1544
1562
|
* parameters.</p>
|
|
1545
1563
|
*/
|
|
1546
1564
|
listGroups(args: ListGroupsCommandInput, options?: __HttpHandlerOptions): Promise<ListGroupsCommandOutput>;
|
|
@@ -1548,7 +1566,7 @@ export declare class IAM extends IAMClient {
|
|
|
1548
1566
|
listGroups(args: ListGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupsCommandOutput) => void): void;
|
|
1549
1567
|
/**
|
|
1550
1568
|
* <p>Lists the IAM groups that the specified IAM user belongs to.</p>
|
|
1551
|
-
*
|
|
1569
|
+
* <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code>
|
|
1552
1570
|
* parameters.</p>
|
|
1553
1571
|
*/
|
|
1554
1572
|
listGroupsForUser(args: ListGroupsForUserCommandInput, options?: __HttpHandlerOptions): Promise<ListGroupsForUserCommandOutput>;
|
|
@@ -1559,11 +1577,11 @@ export declare class IAM extends IAMClient {
|
|
|
1559
1577
|
* the operation returns an empty list. For more information about instance profiles, see
|
|
1560
1578
|
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About
|
|
1561
1579
|
* instance profiles</a>.</p>
|
|
1562
|
-
*
|
|
1580
|
+
* <note>
|
|
1563
1581
|
* <p>IAM resource-listing operations return a subset of the available
|
|
1564
1582
|
* attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an instance profile, see <a>GetInstanceProfile</a>.</p>
|
|
1565
|
-
*
|
|
1566
|
-
*
|
|
1583
|
+
* </note>
|
|
1584
|
+
* <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code>
|
|
1567
1585
|
* parameters.</p>
|
|
1568
1586
|
*/
|
|
1569
1587
|
listInstanceProfiles(args: ListInstanceProfilesCommandInput, options?: __HttpHandlerOptions): Promise<ListInstanceProfilesCommandOutput>;
|
|
@@ -1574,7 +1592,7 @@ export declare class IAM extends IAMClient {
|
|
|
1574
1592
|
* are none, the operation returns an empty list. For more information about instance
|
|
1575
1593
|
* profiles, go to <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About instance
|
|
1576
1594
|
* profiles</a>.</p>
|
|
1577
|
-
*
|
|
1595
|
+
* <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code>
|
|
1578
1596
|
* parameters.</p>
|
|
1579
1597
|
*/
|
|
1580
1598
|
listInstanceProfilesForRole(args: ListInstanceProfilesForRoleCommandInput, options?: __HttpHandlerOptions): Promise<ListInstanceProfilesForRoleCommandOutput>;
|
|
@@ -1593,7 +1611,7 @@ export declare class IAM extends IAMClient {
|
|
|
1593
1611
|
* then this operation lists all the MFA devices associated with the specified user. If you
|
|
1594
1612
|
* do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services
|
|
1595
1613
|
* access key ID signing the request for this operation.</p>
|
|
1596
|
-
*
|
|
1614
|
+
* <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code>
|
|
1597
1615
|
* parameters.</p>
|
|
1598
1616
|
*/
|
|
1599
1617
|
listMFADevices(args: ListMFADevicesCommandInput, options?: __HttpHandlerOptions): Promise<ListMFADevicesCommandOutput>;
|
|
@@ -1610,10 +1628,10 @@ export declare class IAM extends IAMClient {
|
|
|
1610
1628
|
/**
|
|
1611
1629
|
* <p>Lists information about the IAM OpenID Connect (OIDC) provider resource objects
|
|
1612
1630
|
* defined in the Amazon Web Services account.</p>
|
|
1613
|
-
*
|
|
1631
|
+
* <note>
|
|
1614
1632
|
* <p>IAM resource-listing operations return a subset of the available
|
|
1615
1633
|
* attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an OIDC provider, see <a>GetOpenIDConnectProvider</a>.</p>
|
|
1616
|
-
*
|
|
1634
|
+
* </note>
|
|
1617
1635
|
*/
|
|
1618
1636
|
listOpenIDConnectProviders(args: ListOpenIDConnectProvidersCommandInput, options?: __HttpHandlerOptions): Promise<ListOpenIDConnectProvidersCommandOutput>;
|
|
1619
1637
|
listOpenIDConnectProviders(args: ListOpenIDConnectProvidersCommandInput, cb: (err: any, data?: ListOpenIDConnectProvidersCommandOutput) => void): void;
|
|
@@ -1631,20 +1649,20 @@ export declare class IAM extends IAMClient {
|
|
|
1631
1649
|
/**
|
|
1632
1650
|
* <p>Lists all the managed policies that are available in your Amazon Web Services account, including
|
|
1633
1651
|
* your own customer-defined managed policies and all Amazon Web Services managed policies.</p>
|
|
1634
|
-
*
|
|
1652
|
+
* <p>You can filter the list of policies that is returned using the optional
|
|
1635
1653
|
* <code>OnlyAttached</code>, <code>Scope</code>, and <code>PathPrefix</code>
|
|
1636
1654
|
* parameters. For example, to list only the customer managed policies in your Amazon Web Services
|
|
1637
1655
|
* account, set <code>Scope</code> to <code>Local</code>. To list only Amazon Web Services managed
|
|
1638
1656
|
* policies, set <code>Scope</code> to <code>AWS</code>.</p>
|
|
1639
|
-
*
|
|
1657
|
+
* <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code>
|
|
1640
1658
|
* parameters.</p>
|
|
1641
|
-
*
|
|
1659
|
+
* <p>For more information about managed policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline
|
|
1642
1660
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
1643
|
-
*
|
|
1661
|
+
* <note>
|
|
1644
1662
|
* <p>IAM resource-listing operations return a subset of the available
|
|
1645
1663
|
* attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a customer manged policy, see
|
|
1646
1664
|
* <a>GetPolicy</a>.</p>
|
|
1647
|
-
*
|
|
1665
|
+
* </note>
|
|
1648
1666
|
*/
|
|
1649
1667
|
listPolicies(args: ListPoliciesCommandInput, options?: __HttpHandlerOptions): Promise<ListPoliciesCommandOutput>;
|
|
1650
1668
|
listPolicies(args: ListPoliciesCommandInput, cb: (err: any, data?: ListPoliciesCommandOutput) => void): void;
|
|
@@ -1652,41 +1670,41 @@ export declare class IAM extends IAMClient {
|
|
|
1652
1670
|
/**
|
|
1653
1671
|
* <p>Retrieves a list of policies that the IAM identity (user, group, or role) can use to
|
|
1654
1672
|
* access each specified service.</p>
|
|
1655
|
-
*
|
|
1673
|
+
* <note>
|
|
1656
1674
|
* <p>This operation does not use other policy types when determining whether a resource
|
|
1657
1675
|
* could access a service. These other policy types include resource-based policies,
|
|
1658
1676
|
* access control lists, Organizations policies, IAM permissions boundaries, and STS
|
|
1659
1677
|
* assume role policies. It only applies permissions policy logic. For more about the
|
|
1660
1678
|
* evaluation of policy types, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics">Evaluating policies</a> in the
|
|
1661
1679
|
* <i>IAM User Guide</i>.</p>
|
|
1662
|
-
*
|
|
1663
|
-
*
|
|
1680
|
+
* </note>
|
|
1681
|
+
* <p>The list of policies returned by the operation depends on the ARN of the identity that
|
|
1664
1682
|
* you provide.</p>
|
|
1665
|
-
*
|
|
1683
|
+
* <ul>
|
|
1666
1684
|
* <li>
|
|
1667
|
-
*
|
|
1685
|
+
* <p>
|
|
1668
1686
|
* <b>User</b> – The list of policies includes
|
|
1669
1687
|
* the managed and inline policies that are attached to the user directly. The list
|
|
1670
1688
|
* also includes any additional managed and inline policies that are attached to
|
|
1671
1689
|
* the group to which the user belongs. </p>
|
|
1672
1690
|
* </li>
|
|
1673
1691
|
* <li>
|
|
1674
|
-
*
|
|
1692
|
+
* <p>
|
|
1675
1693
|
* <b>Group</b> – The list of policies includes
|
|
1676
1694
|
* only the managed and inline policies that are attached to the group directly.
|
|
1677
1695
|
* Policies that are attached to the group’s user are not included.</p>
|
|
1678
1696
|
* </li>
|
|
1679
1697
|
* <li>
|
|
1680
|
-
*
|
|
1698
|
+
* <p>
|
|
1681
1699
|
* <b>Role</b> – The list of policies includes
|
|
1682
1700
|
* only the managed and inline policies that are attached to the role.</p>
|
|
1683
1701
|
* </li>
|
|
1684
1702
|
* </ul>
|
|
1685
|
-
*
|
|
1703
|
+
* <p>For each managed policy, this operation returns the ARN and policy name. For each
|
|
1686
1704
|
* inline policy, it returns the policy name and the entity to which it is attached. Inline
|
|
1687
1705
|
* policies do not have an ARN. For more information about these policy types, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html">Managed policies and inline policies</a> in the
|
|
1688
1706
|
* <i>IAM User Guide</i>.</p>
|
|
1689
|
-
*
|
|
1707
|
+
* <p>Policies that are attached to users and roles as permissions boundaries are not
|
|
1690
1708
|
* returned. To view which managed policy is currently used to set the permissions boundary
|
|
1691
1709
|
* for a user or role, use the <a>GetUser</a> or <a>GetRole</a>
|
|
1692
1710
|
* operations.</p>
|
|
@@ -1705,7 +1723,7 @@ export declare class IAM extends IAMClient {
|
|
|
1705
1723
|
/**
|
|
1706
1724
|
* <p>Lists information about the versions of the specified managed policy, including the
|
|
1707
1725
|
* version that is currently set as the policy's default version.</p>
|
|
1708
|
-
*
|
|
1726
|
+
* <p>For more information about managed policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline
|
|
1709
1727
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
1710
1728
|
*/
|
|
1711
1729
|
listPolicyVersions(args: ListPolicyVersionsCommandInput, options?: __HttpHandlerOptions): Promise<ListPolicyVersionsCommandOutput>;
|
|
@@ -1714,11 +1732,11 @@ export declare class IAM extends IAMClient {
|
|
|
1714
1732
|
/**
|
|
1715
1733
|
* <p>Lists the names of the inline policies that are embedded in the specified IAM
|
|
1716
1734
|
* role.</p>
|
|
1717
|
-
*
|
|
1735
|
+
* <p>An IAM role can also have managed policies attached to it. To list the managed
|
|
1718
1736
|
* policies that are attached to a role, use <a>ListAttachedRolePolicies</a>.
|
|
1719
1737
|
* For more information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline
|
|
1720
1738
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
1721
|
-
*
|
|
1739
|
+
* <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code>
|
|
1722
1740
|
* parameters. If there are no inline policies embedded with the specified role, the
|
|
1723
1741
|
* operation returns an empty list.</p>
|
|
1724
1742
|
*/
|
|
@@ -1729,11 +1747,11 @@ export declare class IAM extends IAMClient {
|
|
|
1729
1747
|
* <p>Lists the IAM roles that have the specified path prefix. If there are none, the
|
|
1730
1748
|
* operation returns an empty list. For more information about roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with
|
|
1731
1749
|
* roles</a>.</p>
|
|
1732
|
-
*
|
|
1750
|
+
* <note>
|
|
1733
1751
|
* <p>IAM resource-listing operations return a subset of the available
|
|
1734
1752
|
* attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a role, see <a>GetRole</a>.</p>
|
|
1735
|
-
*
|
|
1736
|
-
*
|
|
1753
|
+
* </note>
|
|
1754
|
+
* <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code>
|
|
1737
1755
|
* parameters.</p>
|
|
1738
1756
|
*/
|
|
1739
1757
|
listRoles(args: ListRolesCommandInput, options?: __HttpHandlerOptions): Promise<ListRolesCommandOutput>;
|
|
@@ -1751,9 +1769,9 @@ export declare class IAM extends IAMClient {
|
|
|
1751
1769
|
* <p>Lists the SAML provider resource objects defined in IAM in the account.
|
|
1752
1770
|
* IAM resource-listing operations return a subset of the available
|
|
1753
1771
|
* attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a SAML provider, see <a>GetSAMLProvider</a>.</p>
|
|
1754
|
-
*
|
|
1772
|
+
* <important>
|
|
1755
1773
|
* <p> This operation requires <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>.</p>
|
|
1756
|
-
*
|
|
1774
|
+
* </important>
|
|
1757
1775
|
*/
|
|
1758
1776
|
listSAMLProviders(args: ListSAMLProvidersCommandInput, options?: __HttpHandlerOptions): Promise<ListSAMLProvidersCommandOutput>;
|
|
1759
1777
|
listSAMLProviders(args: ListSAMLProvidersCommandInput, cb: (err: any, data?: ListSAMLProvidersCommandOutput) => void): void;
|
|
@@ -1771,16 +1789,16 @@ export declare class IAM extends IAMClient {
|
|
|
1771
1789
|
/**
|
|
1772
1790
|
* <p>Lists the server certificates stored in IAM that have the specified path prefix. If
|
|
1773
1791
|
* none exist, the operation returns an empty list.</p>
|
|
1774
|
-
*
|
|
1792
|
+
* <p> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code>
|
|
1775
1793
|
* parameters.</p>
|
|
1776
|
-
*
|
|
1794
|
+
* <p>For more information about working with server certificates, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Working
|
|
1777
1795
|
* with server certificates</a> in the <i>IAM User Guide</i>. This
|
|
1778
1796
|
* topic also includes a list of Amazon Web Services services that can use the server certificates that
|
|
1779
1797
|
* you manage with IAM.</p>
|
|
1780
|
-
*
|
|
1798
|
+
* <note>
|
|
1781
1799
|
* <p>IAM resource-listing operations return a subset of the available
|
|
1782
1800
|
* attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a servercertificate, see <a>GetServerCertificate</a>.</p>
|
|
1783
|
-
*
|
|
1801
|
+
* </note>
|
|
1784
1802
|
*/
|
|
1785
1803
|
listServerCertificates(args: ListServerCertificatesCommandInput, options?: __HttpHandlerOptions): Promise<ListServerCertificatesCommandOutput>;
|
|
1786
1804
|
listServerCertificates(args: ListServerCertificatesCommandInput, cb: (err: any, data?: ListServerCertificatesCommandOutput) => void): void;
|
|
@@ -1814,10 +1832,10 @@ export declare class IAM extends IAMClient {
|
|
|
1814
1832
|
/**
|
|
1815
1833
|
* <p>Returns information about the signing certificates associated with the specified IAM
|
|
1816
1834
|
* user. If none exists, the operation returns an empty list.</p>
|
|
1817
|
-
*
|
|
1835
|
+
* <p>Although each user is limited to a small number of signing certificates, you can still
|
|
1818
1836
|
* paginate the results using the <code>MaxItems</code> and <code>Marker</code>
|
|
1819
1837
|
* parameters.</p>
|
|
1820
|
-
*
|
|
1838
|
+
* <p>If the <code>UserName</code> field is not specified, the user name is determined
|
|
1821
1839
|
* implicitly based on the Amazon Web Services access key ID used to sign the request for this operation.
|
|
1822
1840
|
* This operation works for access keys under the Amazon Web Services account. Consequently, you can use
|
|
1823
1841
|
* this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account
|
|
@@ -1829,11 +1847,11 @@ export declare class IAM extends IAMClient {
|
|
|
1829
1847
|
/**
|
|
1830
1848
|
* <p>Returns information about the SSH public keys associated with the specified IAM
|
|
1831
1849
|
* user. If none exists, the operation returns an empty list.</p>
|
|
1832
|
-
*
|
|
1850
|
+
* <p>The SSH public keys returned by this operation are used only for authenticating the
|
|
1833
1851
|
* IAM user to an CodeCommit repository. For more information about using SSH keys to
|
|
1834
1852
|
* authenticate to an CodeCommit repository, see <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html">Set up CodeCommit for
|
|
1835
1853
|
* SSH connections</a> in the <i>CodeCommit User Guide</i>.</p>
|
|
1836
|
-
*
|
|
1854
|
+
* <p>Although each user is limited to a small number of keys, you can still paginate the
|
|
1837
1855
|
* results using the <code>MaxItems</code> and <code>Marker</code> parameters.</p>
|
|
1838
1856
|
*/
|
|
1839
1857
|
listSSHPublicKeys(args: ListSSHPublicKeysCommandInput, options?: __HttpHandlerOptions): Promise<ListSSHPublicKeysCommandOutput>;
|
|
@@ -1841,11 +1859,11 @@ export declare class IAM extends IAMClient {
|
|
|
1841
1859
|
listSSHPublicKeys(args: ListSSHPublicKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSSHPublicKeysCommandOutput) => void): void;
|
|
1842
1860
|
/**
|
|
1843
1861
|
* <p>Lists the names of the inline policies embedded in the specified IAM user.</p>
|
|
1844
|
-
*
|
|
1862
|
+
* <p>An IAM user can also have managed policies attached to it. To list the managed
|
|
1845
1863
|
* policies that are attached to a user, use <a>ListAttachedUserPolicies</a>.
|
|
1846
1864
|
* For more information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline
|
|
1847
1865
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
1848
|
-
*
|
|
1866
|
+
* <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code>
|
|
1849
1867
|
* parameters. If there are no inline policies embedded with the specified user, the
|
|
1850
1868
|
* operation returns an empty list.</p>
|
|
1851
1869
|
*/
|
|
@@ -1856,11 +1874,11 @@ export declare class IAM extends IAMClient {
|
|
|
1856
1874
|
* <p>Lists the IAM users that have the specified path prefix. If no path prefix is
|
|
1857
1875
|
* specified, the operation returns all users in the Amazon Web Services account. If there are none, the
|
|
1858
1876
|
* operation returns an empty list.</p>
|
|
1859
|
-
*
|
|
1877
|
+
* <note>
|
|
1860
1878
|
* <p>IAM resource-listing operations return a subset of the available
|
|
1861
1879
|
* attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a user, see <a>GetUser</a>.</p>
|
|
1862
|
-
*
|
|
1863
|
-
*
|
|
1880
|
+
* </note>
|
|
1881
|
+
* <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code>
|
|
1864
1882
|
* parameters.</p>
|
|
1865
1883
|
*/
|
|
1866
1884
|
listUsers(args: ListUsersCommandInput, options?: __HttpHandlerOptions): Promise<ListUsersCommandOutput>;
|
|
@@ -1878,11 +1896,11 @@ export declare class IAM extends IAMClient {
|
|
|
1878
1896
|
* you do not specify an assignment status, the operation returns a list of all virtual MFA
|
|
1879
1897
|
* devices. Assignment status can be <code>Assigned</code>, <code>Unassigned</code>, or
|
|
1880
1898
|
* <code>Any</code>.</p>
|
|
1881
|
-
*
|
|
1899
|
+
* <note>
|
|
1882
1900
|
* <p>IAM resource-listing operations return a subset of the available
|
|
1883
1901
|
* attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view tag information for a virtual MFA device, see <a>ListMFADeviceTags</a>.</p>
|
|
1884
|
-
*
|
|
1885
|
-
*
|
|
1902
|
+
* </note>
|
|
1903
|
+
* <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code>
|
|
1886
1904
|
* parameters.</p>
|
|
1887
1905
|
*/
|
|
1888
1906
|
listVirtualMFADevices(args: ListVirtualMFADevicesCommandInput, options?: __HttpHandlerOptions): Promise<ListVirtualMFADevicesCommandOutput>;
|
|
@@ -1891,19 +1909,19 @@ export declare class IAM extends IAMClient {
|
|
|
1891
1909
|
/**
|
|
1892
1910
|
* <p>Adds or updates an inline policy document that is embedded in the specified IAM
|
|
1893
1911
|
* group.</p>
|
|
1894
|
-
*
|
|
1912
|
+
* <p>A user can also have managed policies attached to it. To attach a managed policy to a
|
|
1895
1913
|
* group, use <a>AttachGroupPolicy</a>. To create a new managed policy, use
|
|
1896
1914
|
* <a>CreatePolicy</a>. For information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed
|
|
1897
1915
|
* policies and inline policies</a> in the
|
|
1898
1916
|
* <i>IAM User Guide</i>.</p>
|
|
1899
|
-
*
|
|
1917
|
+
* <p>For information about the maximum number of inline policies that you can embed in a
|
|
1900
1918
|
* group, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS quotas</a> in the <i>IAM User Guide</i>.</p>
|
|
1901
|
-
*
|
|
1919
|
+
* <note>
|
|
1902
1920
|
* <p>Because policy documents can be large, you should use POST rather than GET when
|
|
1903
1921
|
* calling <code>PutGroupPolicy</code>. For general information about using the Query
|
|
1904
1922
|
* API with IAM, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html">Making query requests</a> in the
|
|
1905
1923
|
* <i>IAM User Guide</i>.</p>
|
|
1906
|
-
*
|
|
1924
|
+
* </note>
|
|
1907
1925
|
*/
|
|
1908
1926
|
putGroupPolicy(args: PutGroupPolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutGroupPolicyCommandOutput>;
|
|
1909
1927
|
putGroupPolicy(args: PutGroupPolicyCommandInput, cb: (err: any, data?: PutGroupPolicyCommandOutput) => void): void;
|
|
@@ -1914,13 +1932,13 @@ export declare class IAM extends IAMClient {
|
|
|
1914
1932
|
* a role. Use the boundary to control the maximum permissions that the role can have.
|
|
1915
1933
|
* Setting a permissions boundary is an advanced feature that can affect the permissions
|
|
1916
1934
|
* for the role.</p>
|
|
1917
|
-
*
|
|
1918
|
-
*
|
|
1935
|
+
* <p>You cannot set the boundary for a service-linked role. </p>
|
|
1936
|
+
* <important>
|
|
1919
1937
|
* <p>Policies used as permissions boundaries do not provide permissions. You must also
|
|
1920
1938
|
* attach a permissions policy to the role. To learn how the effective permissions for
|
|
1921
1939
|
* a role are evaluated, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html">IAM JSON policy
|
|
1922
1940
|
* evaluation logic</a> in the IAM User Guide. </p>
|
|
1923
|
-
*
|
|
1941
|
+
* </important>
|
|
1924
1942
|
*/
|
|
1925
1943
|
putRolePermissionsBoundary(args: PutRolePermissionsBoundaryCommandInput, options?: __HttpHandlerOptions): Promise<PutRolePermissionsBoundaryCommandOutput>;
|
|
1926
1944
|
putRolePermissionsBoundary(args: PutRolePermissionsBoundaryCommandInput, cb: (err: any, data?: PutRolePermissionsBoundaryCommandOutput) => void): void;
|
|
@@ -1928,24 +1946,24 @@ export declare class IAM extends IAMClient {
|
|
|
1928
1946
|
/**
|
|
1929
1947
|
* <p>Adds or updates an inline policy document that is embedded in the specified IAM
|
|
1930
1948
|
* role.</p>
|
|
1931
|
-
*
|
|
1949
|
+
* <p>When you embed an inline policy in a role, the inline policy is used as part of the
|
|
1932
1950
|
* role's access (permissions) policy. The role's trust policy is created at the same time
|
|
1933
1951
|
* as the role, using <a>CreateRole</a>. You can update a role's trust policy
|
|
1934
1952
|
* using <a>UpdateAssumeRolePolicy</a>. For more information about IAM roles,
|
|
1935
1953
|
* see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html">Using roles to
|
|
1936
1954
|
* delegate permissions and federate identities</a>.</p>
|
|
1937
|
-
*
|
|
1955
|
+
* <p>A role can also have a managed policy attached to it. To attach a managed policy to a
|
|
1938
1956
|
* role, use <a>AttachRolePolicy</a>. To create a new managed policy, use <a>CreatePolicy</a>. For information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed
|
|
1939
1957
|
* policies and inline policies</a> in the
|
|
1940
1958
|
* <i>IAM User Guide</i>.</p>
|
|
1941
|
-
*
|
|
1959
|
+
* <p>For information about the maximum number of inline policies that you can embed with a
|
|
1942
1960
|
* role, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS quotas</a> in the <i>IAM User Guide</i>.</p>
|
|
1943
|
-
*
|
|
1961
|
+
* <note>
|
|
1944
1962
|
* <p>Because policy documents can be large, you should use POST rather than GET when
|
|
1945
1963
|
* calling <code>PutRolePolicy</code>. For general information about using the Query
|
|
1946
1964
|
* API with IAM, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html">Making query requests</a> in the
|
|
1947
1965
|
* <i>IAM User Guide</i>.</p>
|
|
1948
|
-
*
|
|
1966
|
+
* </note>
|
|
1949
1967
|
*/
|
|
1950
1968
|
putRolePolicy(args: PutRolePolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutRolePolicyCommandOutput>;
|
|
1951
1969
|
putRolePolicy(args: PutRolePolicyCommandInput, cb: (err: any, data?: PutRolePolicyCommandOutput) => void): void;
|
|
@@ -1956,12 +1974,12 @@ export declare class IAM extends IAMClient {
|
|
|
1956
1974
|
* a user. Use the boundary to control the maximum permissions that the user can have.
|
|
1957
1975
|
* Setting a permissions boundary is an advanced feature that can affect the permissions
|
|
1958
1976
|
* for the user.</p>
|
|
1959
|
-
*
|
|
1977
|
+
* <important>
|
|
1960
1978
|
* <p>Policies that are used as permissions boundaries do not provide permissions. You
|
|
1961
1979
|
* must also attach a permissions policy to the user. To learn how the effective
|
|
1962
1980
|
* permissions for a user are evaluated, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html">IAM JSON policy
|
|
1963
1981
|
* evaluation logic</a> in the IAM User Guide. </p>
|
|
1964
|
-
*
|
|
1982
|
+
* </important>
|
|
1965
1983
|
*/
|
|
1966
1984
|
putUserPermissionsBoundary(args: PutUserPermissionsBoundaryCommandInput, options?: __HttpHandlerOptions): Promise<PutUserPermissionsBoundaryCommandOutput>;
|
|
1967
1985
|
putUserPermissionsBoundary(args: PutUserPermissionsBoundaryCommandInput, cb: (err: any, data?: PutUserPermissionsBoundaryCommandOutput) => void): void;
|
|
@@ -1969,19 +1987,19 @@ export declare class IAM extends IAMClient {
|
|
|
1969
1987
|
/**
|
|
1970
1988
|
* <p>Adds or updates an inline policy document that is embedded in the specified IAM
|
|
1971
1989
|
* user.</p>
|
|
1972
|
-
*
|
|
1990
|
+
* <p>An IAM user can also have a managed policy attached to it. To attach a managed
|
|
1973
1991
|
* policy to a user, use <a>AttachUserPolicy</a>. To create a new managed
|
|
1974
1992
|
* policy, use <a>CreatePolicy</a>. For information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed
|
|
1975
1993
|
* policies and inline policies</a> in the
|
|
1976
1994
|
* <i>IAM User Guide</i>.</p>
|
|
1977
|
-
*
|
|
1995
|
+
* <p>For information about the maximum number of inline policies that you can embed in a
|
|
1978
1996
|
* user, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS quotas</a> in the <i>IAM User Guide</i>.</p>
|
|
1979
|
-
*
|
|
1997
|
+
* <note>
|
|
1980
1998
|
* <p>Because policy documents can be large, you should use POST rather than GET when
|
|
1981
1999
|
* calling <code>PutUserPolicy</code>. For general information about using the Query
|
|
1982
2000
|
* API with IAM, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html">Making query requests</a> in the
|
|
1983
2001
|
* <i>IAM User Guide</i>.</p>
|
|
1984
|
-
*
|
|
2002
|
+
* </note>
|
|
1985
2003
|
*/
|
|
1986
2004
|
putUserPolicy(args: PutUserPolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutUserPolicyCommandOutput>;
|
|
1987
2005
|
putUserPolicy(args: PutUserPolicyCommandInput, cb: (err: any, data?: PutUserPolicyCommandOutput) => void): void;
|
|
@@ -1990,7 +2008,7 @@ export declare class IAM extends IAMClient {
|
|
|
1990
2008
|
* <p>Removes the specified client ID (also known as audience) from the list of client IDs
|
|
1991
2009
|
* registered for the specified IAM OpenID Connect (OIDC) provider resource
|
|
1992
2010
|
* object.</p>
|
|
1993
|
-
*
|
|
2011
|
+
* <p>This operation is idempotent; it does not fail or return an error if you try to remove
|
|
1994
2012
|
* a client ID that does not exist.</p>
|
|
1995
2013
|
*/
|
|
1996
2014
|
removeClientIDFromOpenIDConnectProvider(args: RemoveClientIDFromOpenIDConnectProviderCommandInput, options?: __HttpHandlerOptions): Promise<RemoveClientIDFromOpenIDConnectProviderCommandOutput>;
|
|
@@ -1998,13 +2016,13 @@ export declare class IAM extends IAMClient {
|
|
|
1998
2016
|
removeClientIDFromOpenIDConnectProvider(args: RemoveClientIDFromOpenIDConnectProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveClientIDFromOpenIDConnectProviderCommandOutput) => void): void;
|
|
1999
2017
|
/**
|
|
2000
2018
|
* <p>Removes the specified IAM role from the specified EC2 instance profile.</p>
|
|
2001
|
-
*
|
|
2019
|
+
* <important>
|
|
2002
2020
|
* <p>Make sure that you do not have any Amazon EC2 instances running with the role you
|
|
2003
2021
|
* are about to remove from the instance profile. Removing a role from an instance
|
|
2004
2022
|
* profile that is associated with a running instance might break any applications
|
|
2005
2023
|
* running on the instance.</p>
|
|
2006
|
-
*
|
|
2007
|
-
*
|
|
2024
|
+
* </important>
|
|
2025
|
+
* <p> For more information about IAM roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with roles</a>. For more
|
|
2008
2026
|
* information about instance profiles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About instance
|
|
2009
2027
|
* profiles</a>.</p>
|
|
2010
2028
|
*/
|
|
@@ -2029,7 +2047,7 @@ export declare class IAM extends IAMClient {
|
|
|
2029
2047
|
/**
|
|
2030
2048
|
* <p>Synchronizes the specified MFA device with its IAM resource object on the Amazon Web Services
|
|
2031
2049
|
* servers.</p>
|
|
2032
|
-
*
|
|
2050
|
+
* <p>For more information about creating and working with virtual MFA devices, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html">Using a virtual MFA
|
|
2033
2051
|
* device</a> in the <i>IAM User Guide</i>.</p>
|
|
2034
2052
|
*/
|
|
2035
2053
|
resyncMFADevice(args: ResyncMFADeviceCommandInput, options?: __HttpHandlerOptions): Promise<ResyncMFADeviceCommandOutput>;
|
|
@@ -2038,9 +2056,9 @@ export declare class IAM extends IAMClient {
|
|
|
2038
2056
|
/**
|
|
2039
2057
|
* <p>Sets the specified version of the specified policy as the policy's default (operative)
|
|
2040
2058
|
* version.</p>
|
|
2041
|
-
*
|
|
2059
|
+
* <p>This operation affects all users, groups, and roles that the policy is attached to. To
|
|
2042
2060
|
* list the users, groups, and roles that the policy is attached to, use <a>ListEntitiesForPolicy</a>.</p>
|
|
2043
|
-
*
|
|
2061
|
+
* <p>For information about managed policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline
|
|
2044
2062
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
2045
2063
|
*/
|
|
2046
2064
|
setDefaultPolicyVersion(args: SetDefaultPolicyVersionCommandInput, options?: __HttpHandlerOptions): Promise<SetDefaultPolicyVersionCommandOutput>;
|
|
@@ -2049,13 +2067,13 @@ export declare class IAM extends IAMClient {
|
|
|
2049
2067
|
/**
|
|
2050
2068
|
* <p>Sets the specified version of the global endpoint token as the token version used for
|
|
2051
2069
|
* the Amazon Web Services account.</p>
|
|
2052
|
-
*
|
|
2070
|
+
* <p>By default, Security Token Service (STS) is available as a global service, and all STS requests
|
|
2053
2071
|
* go to a single endpoint at <code>https://sts.amazonaws.com</code>. Amazon Web Services recommends
|
|
2054
2072
|
* using Regional STS endpoints to reduce latency, build in redundancy, and increase
|
|
2055
2073
|
* session token availability. For information about Regional endpoints for STS, see
|
|
2056
2074
|
* <a href="https://docs.aws.amazon.com/general/latest/gr/sts.html">Security Token Service
|
|
2057
2075
|
* endpoints and quotas</a> in the <i>Amazon Web Services General Reference</i>.</p>
|
|
2058
|
-
*
|
|
2076
|
+
* <p>If you make an STS call to the global endpoint, the resulting session tokens might
|
|
2059
2077
|
* be valid in some Regions but not others. It depends on the version that is set in this
|
|
2060
2078
|
* operation. Version 1 tokens are valid only in Amazon Web Services Regions that are
|
|
2061
2079
|
* available by default. These tokens do not work in manually enabled Regions, such as Asia
|
|
@@ -2064,7 +2082,7 @@ export declare class IAM extends IAMClient {
|
|
|
2064
2082
|
* information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and
|
|
2065
2083
|
* deactivating STS in an Amazon Web Services Region</a> in the
|
|
2066
2084
|
* <i>IAM User Guide</i>.</p>
|
|
2067
|
-
*
|
|
2085
|
+
* <p>To view the current session token version, see the
|
|
2068
2086
|
* <code>GlobalEndpointTokenVersion</code> entry in the response of the <a>GetAccountSummary</a> operation.</p>
|
|
2069
2087
|
*/
|
|
2070
2088
|
setSecurityTokenServicePreferences(args: SetSecurityTokenServicePreferencesCommandInput, options?: __HttpHandlerOptions): Promise<SetSecurityTokenServicePreferencesCommandOutput>;
|
|
@@ -2074,20 +2092,27 @@ export declare class IAM extends IAMClient {
|
|
|
2074
2092
|
* <p>Simulate how a set of IAM policies and optionally a resource-based policy works with
|
|
2075
2093
|
* a list of API operations and Amazon Web Services resources to determine the policies' effective
|
|
2076
2094
|
* permissions. The policies are provided as strings.</p>
|
|
2077
|
-
*
|
|
2095
|
+
* <p>The simulation does not perform the API operations; it only checks the authorization
|
|
2078
2096
|
* to determine if the simulated policies allow or deny the operations. You can simulate
|
|
2079
2097
|
* resources that don't exist in your account.</p>
|
|
2080
|
-
*
|
|
2098
|
+
* <p>If you want to simulate existing policies that are attached to an IAM user, group,
|
|
2081
2099
|
* or role, use <a>SimulatePrincipalPolicy</a> instead.</p>
|
|
2082
|
-
*
|
|
2100
|
+
* <p>Context keys are variables that are maintained by Amazon Web Services and its services and which
|
|
2083
2101
|
* provide details about the context of an API query request. You can use the
|
|
2084
2102
|
* <code>Condition</code> element of an IAM policy to evaluate context keys. To get
|
|
2085
2103
|
* the list of context keys that the policies require for correct simulation, use <a>GetContextKeysForCustomPolicy</a>.</p>
|
|
2086
|
-
*
|
|
2104
|
+
* <p>If the output is long, you can use <code>MaxItems</code> and <code>Marker</code>
|
|
2087
2105
|
* parameters to paginate the results.</p>
|
|
2088
|
-
*
|
|
2089
|
-
*
|
|
2090
|
-
*
|
|
2106
|
+
* <note>
|
|
2107
|
+
* <p>The IAM policy simulator evaluates statements in the identity-based policy and
|
|
2108
|
+
* the inputs that you provide during simulation. The policy simulator results can
|
|
2109
|
+
* differ from your live Amazon Web Services environment. We recommend that you check your policies
|
|
2110
|
+
* against your live Amazon Web Services environment after testing using the policy simulator to
|
|
2111
|
+
* confirm that you have the desired results. For more information about using the
|
|
2112
|
+
* policy simulator, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_testing-policies.html">Testing IAM
|
|
2113
|
+
* policies with the IAM policy simulator </a>in the
|
|
2114
|
+
* <i>IAM User Guide</i>.</p>
|
|
2115
|
+
* </note>
|
|
2091
2116
|
*/
|
|
2092
2117
|
simulateCustomPolicy(args: SimulateCustomPolicyCommandInput, options?: __HttpHandlerOptions): Promise<SimulateCustomPolicyCommandOutput>;
|
|
2093
2118
|
simulateCustomPolicy(args: SimulateCustomPolicyCommandInput, cb: (err: any, data?: SimulateCustomPolicyCommandOutput) => void): void;
|
|
@@ -2098,27 +2123,34 @@ export declare class IAM extends IAMClient {
|
|
|
2098
2123
|
* entity can be an IAM user, group, or role. If you specify a user, then the simulation
|
|
2099
2124
|
* also includes all of the policies that are attached to groups that the user belongs to.
|
|
2100
2125
|
* You can simulate resources that don't exist in your account.</p>
|
|
2101
|
-
*
|
|
2126
|
+
* <p>You can optionally include a list of one or more additional policies specified as
|
|
2102
2127
|
* strings to include in the simulation. If you want to simulate only policies specified as
|
|
2103
2128
|
* strings, use <a>SimulateCustomPolicy</a> instead.</p>
|
|
2104
|
-
*
|
|
2105
|
-
* the resources included in the simulation.</p>
|
|
2106
|
-
*
|
|
2129
|
+
* <p>You can also optionally include one resource-based policy to be evaluated with each of
|
|
2130
|
+
* the resources included in the simulation for IAM users only.</p>
|
|
2131
|
+
* <p>The simulation does not perform the API operations; it only checks the authorization
|
|
2107
2132
|
* to determine if the simulated policies allow or deny the operations.</p>
|
|
2108
|
-
*
|
|
2133
|
+
* <p>
|
|
2109
2134
|
* <b>Note:</b> This operation discloses information about the
|
|
2110
2135
|
* permissions granted to other users. If you do not want users to see other user's
|
|
2111
2136
|
* permissions, then consider allowing them to use <a>SimulateCustomPolicy</a>
|
|
2112
2137
|
* instead.</p>
|
|
2113
|
-
*
|
|
2138
|
+
* <p>Context keys are variables maintained by Amazon Web Services and its services that provide details
|
|
2114
2139
|
* about the context of an API query request. You can use the <code>Condition</code>
|
|
2115
2140
|
* element of an IAM policy to evaluate context keys. To get the list of context keys
|
|
2116
2141
|
* that the policies require for correct simulation, use <a>GetContextKeysForPrincipalPolicy</a>.</p>
|
|
2117
|
-
*
|
|
2142
|
+
* <p>If the output is long, you can use the <code>MaxItems</code> and <code>Marker</code>
|
|
2118
2143
|
* parameters to paginate the results.</p>
|
|
2119
|
-
*
|
|
2120
|
-
*
|
|
2121
|
-
*
|
|
2144
|
+
* <note>
|
|
2145
|
+
* <p>The IAM policy simulator evaluates statements in the identity-based policy and
|
|
2146
|
+
* the inputs that you provide during simulation. The policy simulator results can
|
|
2147
|
+
* differ from your live Amazon Web Services environment. We recommend that you check your policies
|
|
2148
|
+
* against your live Amazon Web Services environment after testing using the policy simulator to
|
|
2149
|
+
* confirm that you have the desired results. For more information about using the
|
|
2150
|
+
* policy simulator, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_testing-policies.html">Testing IAM
|
|
2151
|
+
* policies with the IAM policy simulator </a>in the
|
|
2152
|
+
* <i>IAM User Guide</i>.</p>
|
|
2153
|
+
* </note>
|
|
2122
2154
|
*/
|
|
2123
2155
|
simulatePrincipalPolicy(args: SimulatePrincipalPolicyCommandInput, options?: __HttpHandlerOptions): Promise<SimulatePrincipalPolicyCommandOutput>;
|
|
2124
2156
|
simulatePrincipalPolicy(args: SimulatePrincipalPolicyCommandInput, cb: (err: any, data?: SimulatePrincipalPolicyCommandOutput) => void): void;
|
|
@@ -2558,14 +2590,14 @@ export declare class IAM extends IAMClient {
|
|
|
2558
2590
|
* <p>Changes the status of the specified access key from Active to Inactive, or vice versa.
|
|
2559
2591
|
* This operation can be used to disable a user's key as part of a key rotation
|
|
2560
2592
|
* workflow.</p>
|
|
2561
|
-
*
|
|
2593
|
+
* <p>If the <code>UserName</code> is not specified, the user name is determined implicitly
|
|
2562
2594
|
* based on the Amazon Web Services access key ID used to sign the request. If a temporary access key is
|
|
2563
2595
|
* used, then <code>UserName</code> is required. If a long-term key is assigned to the
|
|
2564
2596
|
* user, then <code>UserName</code> is not required. This operation works for access keys
|
|
2565
2597
|
* under the Amazon Web Services account. Consequently, you can use this operation to manage
|
|
2566
2598
|
* Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated
|
|
2567
2599
|
* users.</p>
|
|
2568
|
-
*
|
|
2600
|
+
* <p>For information about rotating keys, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/ManagingCredentials.html">Managing keys and certificates</a>
|
|
2569
2601
|
* in the <i>IAM User Guide</i>.</p>
|
|
2570
2602
|
*/
|
|
2571
2603
|
updateAccessKey(args: UpdateAccessKeyCommandInput, options?: __HttpHandlerOptions): Promise<UpdateAccessKeyCommandOutput>;
|
|
@@ -2573,15 +2605,15 @@ export declare class IAM extends IAMClient {
|
|
|
2573
2605
|
updateAccessKey(args: UpdateAccessKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAccessKeyCommandOutput) => void): void;
|
|
2574
2606
|
/**
|
|
2575
2607
|
* <p>Updates the password policy settings for the Amazon Web Services account.</p>
|
|
2576
|
-
*
|
|
2608
|
+
* <note>
|
|
2577
2609
|
* <p>This operation does not support partial updates. No parameters are required, but
|
|
2578
2610
|
* if you do not specify a parameter, that parameter's value reverts to its default
|
|
2579
2611
|
* value. See the <b>Request Parameters</b> section for each
|
|
2580
2612
|
* parameter's default value. Also note that some parameters do not allow the default
|
|
2581
2613
|
* parameter to be explicitly set. Instead, to invoke the default value, do not include
|
|
2582
2614
|
* that parameter when you invoke the operation.</p>
|
|
2583
|
-
*
|
|
2584
|
-
*
|
|
2615
|
+
* </note>
|
|
2616
|
+
* <p> For more information about using a password policy, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html">Managing an IAM password
|
|
2585
2617
|
* policy</a> in the <i>IAM User Guide</i>.</p>
|
|
2586
2618
|
*/
|
|
2587
2619
|
updateAccountPasswordPolicy(args: UpdateAccountPasswordPolicyCommandInput, options?: __HttpHandlerOptions): Promise<UpdateAccountPasswordPolicyCommandOutput>;
|
|
@@ -2598,12 +2630,12 @@ export declare class IAM extends IAMClient {
|
|
|
2598
2630
|
updateAssumeRolePolicy(args: UpdateAssumeRolePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAssumeRolePolicyCommandOutput) => void): void;
|
|
2599
2631
|
/**
|
|
2600
2632
|
* <p>Updates the name and/or the path of the specified IAM group.</p>
|
|
2601
|
-
*
|
|
2633
|
+
* <important>
|
|
2602
2634
|
* <p> You should understand the implications of changing a group's path or name. For
|
|
2603
2635
|
* more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_WorkingWithGroupsAndUsers.html">Renaming users and
|
|
2604
2636
|
* groups</a> in the <i>IAM User Guide</i>.</p>
|
|
2605
|
-
*
|
|
2606
|
-
*
|
|
2637
|
+
* </important>
|
|
2638
|
+
* <note>
|
|
2607
2639
|
* <p>The person making the request (the principal), must have permission to change the
|
|
2608
2640
|
* role group with the old name and the new name. For example, to change the group
|
|
2609
2641
|
* named <code>Managers</code> to <code>MGRs</code>, the principal must have a policy
|
|
@@ -2611,18 +2643,18 @@ export declare class IAM extends IAMClient {
|
|
|
2611
2643
|
* the <code>Managers</code> group, but not the <code>MGRs</code> group, then the
|
|
2612
2644
|
* update fails. For more information about permissions, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access management</a>.
|
|
2613
2645
|
* </p>
|
|
2614
|
-
*
|
|
2646
|
+
* </note>
|
|
2615
2647
|
*/
|
|
2616
2648
|
updateGroup(args: UpdateGroupCommandInput, options?: __HttpHandlerOptions): Promise<UpdateGroupCommandOutput>;
|
|
2617
2649
|
updateGroup(args: UpdateGroupCommandInput, cb: (err: any, data?: UpdateGroupCommandOutput) => void): void;
|
|
2618
2650
|
updateGroup(args: UpdateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGroupCommandOutput) => void): void;
|
|
2619
2651
|
/**
|
|
2620
|
-
* <p>Changes the password for the specified IAM user. You can use the CLI,
|
|
2621
|
-
*
|
|
2622
|
-
*
|
|
2623
|
-
*
|
|
2624
|
-
*
|
|
2625
|
-
*
|
|
2652
|
+
* <p>Changes the password for the specified IAM user. You can use the CLI, the Amazon Web Services
|
|
2653
|
+
* API, or the <b>Users</b> page in the IAM console to change
|
|
2654
|
+
* the password for any IAM user. Use <a>ChangePassword</a> to change your own
|
|
2655
|
+
* password in the <b>My Security Credentials</b> page in the
|
|
2656
|
+
* Amazon Web Services Management Console.</p>
|
|
2657
|
+
* <p>For more information about modifying passwords, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html">Managing passwords</a> in the
|
|
2626
2658
|
* <i>IAM User Guide</i>.</p>
|
|
2627
2659
|
*/
|
|
2628
2660
|
updateLoginProfile(args: UpdateLoginProfileCommandInput, options?: __HttpHandlerOptions): Promise<UpdateLoginProfileCommandOutput>;
|
|
@@ -2631,26 +2663,27 @@ export declare class IAM extends IAMClient {
|
|
|
2631
2663
|
/**
|
|
2632
2664
|
* <p>Replaces the existing list of server certificate thumbprints associated with an OpenID
|
|
2633
2665
|
* Connect (OIDC) provider resource object with a new list of thumbprints.</p>
|
|
2634
|
-
*
|
|
2666
|
+
* <p>The list that you pass with this operation completely replaces the existing list of
|
|
2635
2667
|
* thumbprints. (The lists are not merged.)</p>
|
|
2636
|
-
*
|
|
2668
|
+
* <p>Typically, you need to update a thumbprint only when the identity provider certificate
|
|
2637
2669
|
* changes, which occurs rarely. However, if the provider's certificate
|
|
2638
2670
|
* <i>does</i> change, any attempt to assume an IAM role that specifies
|
|
2639
2671
|
* the OIDC provider as a principal fails until the certificate thumbprint is
|
|
2640
2672
|
* updated.</p>
|
|
2641
|
-
*
|
|
2673
|
+
* <note>
|
|
2642
2674
|
* <p>Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our
|
|
2643
2675
|
* library of trusted certificate authorities (CAs) instead of using a certificate
|
|
2644
|
-
* thumbprint to verify your IdP server certificate. These OIDC IdPs include Google,
|
|
2645
|
-
* those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these
|
|
2646
|
-
* cases, your legacy thumbprint remains in your configuration, but is no longer used for
|
|
2676
|
+
* thumbprint to verify your IdP server certificate. These OIDC IdPs include Google, Auth0,
|
|
2677
|
+
* and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these
|
|
2678
|
+
* cases, your legacy thumbprint remains in your configuration, but is no longer used for
|
|
2679
|
+
* validation.</p>
|
|
2647
2680
|
* </note>
|
|
2648
|
-
*
|
|
2681
|
+
* <note>
|
|
2649
2682
|
* <p>Trust for the OIDC provider is derived from the provider certificate and is
|
|
2650
2683
|
* validated by the thumbprint. Therefore, it is best to limit access to the
|
|
2651
2684
|
* <code>UpdateOpenIDConnectProviderThumbprint</code> operation to highly
|
|
2652
2685
|
* privileged users.</p>
|
|
2653
|
-
*
|
|
2686
|
+
* </note>
|
|
2654
2687
|
*/
|
|
2655
2688
|
updateOpenIDConnectProviderThumbprint(args: UpdateOpenIDConnectProviderThumbprintCommandInput, options?: __HttpHandlerOptions): Promise<UpdateOpenIDConnectProviderThumbprintCommandOutput>;
|
|
2656
2689
|
updateOpenIDConnectProviderThumbprint(args: UpdateOpenIDConnectProviderThumbprintCommandInput, cb: (err: any, data?: UpdateOpenIDConnectProviderThumbprintCommandOutput) => void): void;
|
|
@@ -2663,7 +2696,7 @@ export declare class IAM extends IAMClient {
|
|
|
2663
2696
|
updateRole(args: UpdateRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRoleCommandOutput) => void): void;
|
|
2664
2697
|
/**
|
|
2665
2698
|
* <p>Use <a>UpdateRole</a> instead.</p>
|
|
2666
|
-
*
|
|
2699
|
+
* <p>Modifies only the description of a role. This operation performs the same function as
|
|
2667
2700
|
* the <code>Description</code> parameter in the <code>UpdateRole</code> operation.</p>
|
|
2668
2701
|
*/
|
|
2669
2702
|
updateRoleDescription(args: UpdateRoleDescriptionCommandInput, options?: __HttpHandlerOptions): Promise<UpdateRoleDescriptionCommandOutput>;
|
|
@@ -2671,9 +2704,9 @@ export declare class IAM extends IAMClient {
|
|
|
2671
2704
|
updateRoleDescription(args: UpdateRoleDescriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRoleDescriptionCommandOutput) => void): void;
|
|
2672
2705
|
/**
|
|
2673
2706
|
* <p>Updates the metadata document for an existing SAML provider resource object.</p>
|
|
2674
|
-
*
|
|
2707
|
+
* <note>
|
|
2675
2708
|
* <p>This operation requires <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>.</p>
|
|
2676
|
-
*
|
|
2709
|
+
* </note>
|
|
2677
2710
|
*/
|
|
2678
2711
|
updateSAMLProvider(args: UpdateSAMLProviderCommandInput, options?: __HttpHandlerOptions): Promise<UpdateSAMLProviderCommandOutput>;
|
|
2679
2712
|
updateSAMLProvider(args: UpdateSAMLProviderCommandInput, cb: (err: any, data?: UpdateSAMLProviderCommandOutput) => void): void;
|
|
@@ -2681,16 +2714,16 @@ export declare class IAM extends IAMClient {
|
|
|
2681
2714
|
/**
|
|
2682
2715
|
* <p>Updates the name and/or the path of the specified server certificate stored in
|
|
2683
2716
|
* IAM.</p>
|
|
2684
|
-
*
|
|
2717
|
+
* <p>For more information about working with server certificates, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Working
|
|
2685
2718
|
* with server certificates</a> in the <i>IAM User Guide</i>. This
|
|
2686
2719
|
* topic also includes a list of Amazon Web Services services that can use the server certificates that
|
|
2687
2720
|
* you manage with IAM.</p>
|
|
2688
|
-
*
|
|
2721
|
+
* <important>
|
|
2689
2722
|
* <p>You should understand the implications of changing a server certificate's path or
|
|
2690
2723
|
* name. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs_manage.html#RenamingServerCerts">Renaming a server certificate</a> in the
|
|
2691
2724
|
* <i>IAM User Guide</i>.</p>
|
|
2692
|
-
*
|
|
2693
|
-
*
|
|
2725
|
+
* </important>
|
|
2726
|
+
* <note>
|
|
2694
2727
|
* <p>The person making the request (the principal), must have permission to change the
|
|
2695
2728
|
* server certificate with the old name and the new name. For example, to change the
|
|
2696
2729
|
* certificate named <code>ProductionCert</code> to <code>ProdCert</code>, the
|
|
@@ -2698,7 +2731,7 @@ export declare class IAM extends IAMClient {
|
|
|
2698
2731
|
* principal has permission to update the <code>ProductionCert</code> group, but not
|
|
2699
2732
|
* the <code>ProdCert</code> certificate, then the update fails. For more information
|
|
2700
2733
|
* about permissions, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access management</a> in the <i>IAM User Guide</i>.</p>
|
|
2701
|
-
*
|
|
2734
|
+
* </note>
|
|
2702
2735
|
*/
|
|
2703
2736
|
updateServerCertificate(args: UpdateServerCertificateCommandInput, options?: __HttpHandlerOptions): Promise<UpdateServerCertificateCommandOutput>;
|
|
2704
2737
|
updateServerCertificate(args: UpdateServerCertificateCommandInput, cb: (err: any, data?: UpdateServerCertificateCommandOutput) => void): void;
|
|
@@ -2716,7 +2749,7 @@ export declare class IAM extends IAMClient {
|
|
|
2716
2749
|
* <p>Changes the status of the specified user signing certificate from active to disabled,
|
|
2717
2750
|
* or vice versa. This operation can be used to disable an IAM user's signing certificate
|
|
2718
2751
|
* as part of a certificate rotation work flow.</p>
|
|
2719
|
-
*
|
|
2752
|
+
* <p>If the <code>UserName</code> field is not specified, the user name is determined
|
|
2720
2753
|
* implicitly based on the Amazon Web Services access key ID used to sign the request. This operation
|
|
2721
2754
|
* works for access keys under the Amazon Web Services account. Consequently, you can use this operation
|
|
2722
2755
|
* to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no
|
|
@@ -2729,7 +2762,7 @@ export declare class IAM extends IAMClient {
|
|
|
2729
2762
|
* <p>Sets the status of an IAM user's SSH public key to active or inactive. SSH public
|
|
2730
2763
|
* keys that are inactive cannot be used for authentication. This operation can be used to
|
|
2731
2764
|
* disable a user's SSH public key as part of a key rotation work flow.</p>
|
|
2732
|
-
*
|
|
2765
|
+
* <p>The SSH public key affected by this operation is used only for authenticating the
|
|
2733
2766
|
* associated IAM user to an CodeCommit repository. For more information about using SSH keys
|
|
2734
2767
|
* to authenticate to an CodeCommit repository, see <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html">Set up CodeCommit for
|
|
2735
2768
|
* SSH connections</a> in the <i>CodeCommit User Guide</i>.</p>
|
|
@@ -2739,18 +2772,18 @@ export declare class IAM extends IAMClient {
|
|
|
2739
2772
|
updateSSHPublicKey(args: UpdateSSHPublicKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSSHPublicKeyCommandOutput) => void): void;
|
|
2740
2773
|
/**
|
|
2741
2774
|
* <p>Updates the name and/or the path of the specified IAM user.</p>
|
|
2742
|
-
*
|
|
2775
|
+
* <important>
|
|
2743
2776
|
* <p> You should understand the implications of changing an IAM user's path or name.
|
|
2744
2777
|
* For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_manage.html#id_users_renaming">Renaming an IAM
|
|
2745
2778
|
* user</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups_manage_rename.html">Renaming an IAM
|
|
2746
2779
|
* group</a> in the <i>IAM User Guide</i>.</p>
|
|
2747
|
-
*
|
|
2748
|
-
*
|
|
2780
|
+
* </important>
|
|
2781
|
+
* <note>
|
|
2749
2782
|
* <p> To change a user name, the requester must have appropriate permissions on both
|
|
2750
2783
|
* the source object and the target object. For example, to change Bob to Robert, the
|
|
2751
2784
|
* entity making the request must have permission on Bob and Robert, or must have
|
|
2752
2785
|
* permission on all (*). For more information about permissions, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/PermissionsAndPolicies.html">Permissions and policies</a>. </p>
|
|
2753
|
-
*
|
|
2786
|
+
* </note>
|
|
2754
2787
|
*/
|
|
2755
2788
|
updateUser(args: UpdateUserCommandInput, options?: __HttpHandlerOptions): Promise<UpdateUserCommandOutput>;
|
|
2756
2789
|
updateUser(args: UpdateUserCommandInput, cb: (err: any, data?: UpdateUserCommandOutput) => void): void;
|
|
@@ -2759,19 +2792,19 @@ export declare class IAM extends IAMClient {
|
|
|
2759
2792
|
* <p>Uploads a server certificate entity for the Amazon Web Services account. The server certificate
|
|
2760
2793
|
* entity includes a public key certificate, a private key, and an optional certificate
|
|
2761
2794
|
* chain, which should all be PEM-encoded.</p>
|
|
2762
|
-
*
|
|
2795
|
+
* <p>We recommend that you use <a href="https://docs.aws.amazon.com/acm/">Certificate Manager</a> to
|
|
2763
2796
|
* provision, manage, and deploy your server certificates. With ACM you can request a
|
|
2764
2797
|
* certificate, deploy it to Amazon Web Services resources, and let ACM handle certificate renewals for
|
|
2765
2798
|
* you. Certificates provided by ACM are free. For more information about using ACM,
|
|
2766
2799
|
* see the <a href="https://docs.aws.amazon.com/acm/latest/userguide/">Certificate Manager User
|
|
2767
2800
|
* Guide</a>.</p>
|
|
2768
|
-
*
|
|
2801
|
+
* <p>For more information about working with server certificates, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Working
|
|
2769
2802
|
* with server certificates</a> in the <i>IAM User Guide</i>. This
|
|
2770
2803
|
* topic includes a list of Amazon Web Services services that can use the server certificates that you
|
|
2771
2804
|
* manage with IAM.</p>
|
|
2772
|
-
*
|
|
2805
|
+
* <p>For information about the number of server certificates you can upload, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS
|
|
2773
2806
|
* quotas</a> in the <i>IAM User Guide</i>.</p>
|
|
2774
|
-
*
|
|
2807
|
+
* <note>
|
|
2775
2808
|
* <p>Because the body of the public key certificate, private key, and the certificate
|
|
2776
2809
|
* chain can be large, you should use POST rather than GET when calling
|
|
2777
2810
|
* <code>UploadServerCertificate</code>. For information about setting up
|
|
@@ -2779,7 +2812,7 @@ export declare class IAM extends IAMClient {
|
|
|
2779
2812
|
* requests</a> in the <i>Amazon Web Services General Reference</i>. For general
|
|
2780
2813
|
* information about using the Query API with IAM, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/programming.html">Calling the API by making HTTP query
|
|
2781
2814
|
* requests</a> in the <i>IAM User Guide</i>.</p>
|
|
2782
|
-
*
|
|
2815
|
+
* </note>
|
|
2783
2816
|
*/
|
|
2784
2817
|
uploadServerCertificate(args: UploadServerCertificateCommandInput, options?: __HttpHandlerOptions): Promise<UploadServerCertificateCommandOutput>;
|
|
2785
2818
|
uploadServerCertificate(args: UploadServerCertificateCommandInput, cb: (err: any, data?: UploadServerCertificateCommandOutput) => void): void;
|
|
@@ -2789,29 +2822,29 @@ export declare class IAM extends IAMClient {
|
|
|
2789
2822
|
* Some Amazon Web Services services require you to use certificates to validate requests that are signed
|
|
2790
2823
|
* with a corresponding private key. When you upload the certificate, its default status is
|
|
2791
2824
|
* <code>Active</code>.</p>
|
|
2792
|
-
*
|
|
2825
|
+
* <p>For information about when you would use an X.509 signing certificate, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Managing
|
|
2793
2826
|
* server certificates in IAM</a> in the
|
|
2794
2827
|
* <i>IAM User Guide</i>.</p>
|
|
2795
|
-
*
|
|
2828
|
+
* <p>If the <code>UserName</code> is not specified, the IAM user name is determined
|
|
2796
2829
|
* implicitly based on the Amazon Web Services access key ID used to sign the request. This operation
|
|
2797
2830
|
* works for access keys under the Amazon Web Services account. Consequently, you can use this operation
|
|
2798
2831
|
* to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no
|
|
2799
2832
|
* associated users.</p>
|
|
2800
|
-
*
|
|
2833
|
+
* <note>
|
|
2801
2834
|
* <p>Because the body of an X.509 certificate can be large, you should use POST rather
|
|
2802
2835
|
* than GET when calling <code>UploadSigningCertificate</code>. For information about
|
|
2803
2836
|
* setting up signatures and authorization through the API, see <a href="https://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html">Signing
|
|
2804
2837
|
* Amazon Web Services API requests</a> in the <i>Amazon Web Services General Reference</i>. For
|
|
2805
2838
|
* general information about using the Query API with IAM, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html">Making query
|
|
2806
2839
|
* requests</a> in the <i>IAM User Guide</i>.</p>
|
|
2807
|
-
*
|
|
2840
|
+
* </note>
|
|
2808
2841
|
*/
|
|
2809
2842
|
uploadSigningCertificate(args: UploadSigningCertificateCommandInput, options?: __HttpHandlerOptions): Promise<UploadSigningCertificateCommandOutput>;
|
|
2810
2843
|
uploadSigningCertificate(args: UploadSigningCertificateCommandInput, cb: (err: any, data?: UploadSigningCertificateCommandOutput) => void): void;
|
|
2811
2844
|
uploadSigningCertificate(args: UploadSigningCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UploadSigningCertificateCommandOutput) => void): void;
|
|
2812
2845
|
/**
|
|
2813
2846
|
* <p>Uploads an SSH public key and associates it with the specified IAM user.</p>
|
|
2814
|
-
*
|
|
2847
|
+
* <p>The SSH public key uploaded by this operation can be used only for authenticating the
|
|
2815
2848
|
* associated IAM user to an CodeCommit repository. For more information about using SSH keys
|
|
2816
2849
|
* to authenticate to an CodeCommit repository, see <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html">Set up CodeCommit for
|
|
2817
2850
|
* SSH connections</a> in the <i>CodeCommit User Guide</i>.</p>
|