@aws-sdk/client-iam 3.287.0 → 3.289.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-types/commands/AddClientIDToOpenIDConnectProviderCommand.d.ts +12 -0
- package/dist-types/commands/AddRoleToInstanceProfileCommand.d.ts +12 -0
- package/dist-types/commands/AddUserToGroupCommand.d.ts +12 -0
- package/dist-types/commands/AttachGroupPolicyCommand.d.ts +12 -0
- package/dist-types/commands/AttachRolePolicyCommand.d.ts +12 -0
- package/dist-types/commands/AttachUserPolicyCommand.d.ts +12 -0
- package/dist-types/commands/ChangePasswordCommand.d.ts +12 -0
- package/dist-types/commands/CreateAccessKeyCommand.d.ts +22 -0
- package/dist-types/commands/CreateAccountAliasCommand.d.ts +11 -0
- package/dist-types/commands/CreateGroupCommand.d.ts +22 -0
- package/dist-types/commands/CreateInstanceProfileCommand.d.ts +23 -0
- package/dist-types/commands/CreateLoginProfileCommand.d.ts +22 -0
- package/dist-types/commands/CreateOpenIDConnectProviderCommand.d.ts +22 -0
- package/dist-types/commands/CreateRoleCommand.d.ts +25 -0
- package/dist-types/commands/CreateUserCommand.d.ts +22 -0
- package/dist-types/commands/DeleteAccessKeyCommand.d.ts +12 -0
- package/dist-types/commands/DeleteAccountAliasCommand.d.ts +11 -0
- package/dist-types/commands/DeleteAccountPasswordPolicyCommand.d.ts +9 -0
- package/dist-types/commands/DeleteGroupPolicyCommand.d.ts +12 -0
- package/dist-types/commands/DeleteInstanceProfileCommand.d.ts +11 -0
- package/dist-types/commands/DeleteLoginProfileCommand.d.ts +11 -0
- package/dist-types/commands/DeleteRoleCommand.d.ts +11 -0
- package/dist-types/commands/DeleteRolePolicyCommand.d.ts +12 -0
- package/dist-types/commands/DeleteSigningCertificateCommand.d.ts +12 -0
- package/dist-types/commands/DeleteUserCommand.d.ts +11 -0
- package/dist-types/commands/DeleteUserPolicyCommand.d.ts +12 -0
- package/dist-types/commands/DeleteVirtualMFADeviceCommand.d.ts +11 -0
- package/dist-types/commands/GenerateOrganizationsAccessReportCommand.d.ts +16 -0
- package/dist-types/commands/GenerateServiceLastAccessedDetailsCommand.d.ts +16 -0
- package/dist-types/commands/GetAccountPasswordPolicyCommand.d.ts +25 -0
- package/dist-types/commands/GetAccountSummaryCommand.d.ts +41 -0
- package/dist-types/commands/GetInstanceProfileCommand.d.ts +32 -0
- package/dist-types/commands/GetLoginProfileCommand.d.ts +19 -0
- package/dist-types/commands/GetOrganizationsAccessReportCommand.d.ts +44 -0
- package/dist-types/commands/GetRoleCommand.d.ts +28 -0
- package/dist-types/commands/GetServiceLastAccessedDetailsCommand.d.ts +33 -0
- package/dist-types/commands/GetServiceLastAccessedDetailsWithEntitiesCommand.d.ts +41 -0
- package/dist-types/commands/GetUserCommand.d.ts +22 -0
- package/dist-types/commands/ListAccessKeysCommand.d.ts +29 -0
- package/dist-types/commands/ListAccountAliasesCommand.d.ts +16 -0
- package/dist-types/commands/ListGroupPoliciesCommand.d.ts +19 -0
- package/dist-types/commands/ListGroupsCommand.d.ts +36 -0
- package/dist-types/commands/ListGroupsForUserCommand.d.ts +31 -0
- package/dist-types/commands/ListPoliciesGrantingServiceAccessCommand.d.ts +48 -0
- package/dist-types/commands/ListRoleTagsCommand.d.ts +26 -0
- package/dist-types/commands/ListSigningCertificatesCommand.d.ts +24 -0
- package/dist-types/commands/ListUserTagsCommand.d.ts +26 -0
- package/dist-types/commands/ListUsersCommand.d.ts +31 -0
- package/dist-types/commands/ListVirtualMFADevicesCommand.d.ts +21 -0
- package/dist-types/commands/PutGroupPolicyCommand.d.ts +13 -0
- package/dist-types/commands/PutRolePolicyCommand.d.ts +13 -0
- package/dist-types/commands/PutUserPolicyCommand.d.ts +13 -0
- package/dist-types/commands/RemoveRoleFromInstanceProfileCommand.d.ts +12 -0
- package/dist-types/commands/RemoveUserFromGroupCommand.d.ts +12 -0
- package/dist-types/commands/SetSecurityTokenServicePreferencesCommand.d.ts +11 -0
- package/dist-types/commands/TagRoleCommand.d.ts +21 -0
- package/dist-types/commands/TagUserCommand.d.ts +21 -0
- package/dist-types/commands/UntagRoleCommand.d.ts +14 -0
- package/dist-types/commands/UntagUserCommand.d.ts +14 -0
- package/dist-types/commands/UpdateAccessKeyCommand.d.ts +13 -0
- package/dist-types/commands/UpdateAccountPasswordPolicyCommand.d.ts +12 -0
- package/dist-types/commands/UpdateAssumeRolePolicyCommand.d.ts +12 -0
- package/dist-types/commands/UpdateGroupCommand.d.ts +12 -0
- package/dist-types/commands/UpdateLoginProfileCommand.d.ts +12 -0
- package/dist-types/commands/UpdateSigningCertificateCommand.d.ts +13 -0
- package/dist-types/commands/UpdateUserCommand.d.ts +12 -0
- package/dist-types/commands/UploadServerCertificateCommand.d.ts +26 -0
- package/dist-types/commands/UploadSigningCertificateCommand.d.ts +23 -0
- package/package.json +30 -30
|
@@ -30,6 +30,32 @@ export interface ListUserTagsCommandOutput extends ListUserTagsResponse, __Metad
|
|
|
30
30
|
* @see {@link ListUserTagsCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @example To list the tags attached to an IAM user
|
|
34
|
+
* ```javascript
|
|
35
|
+
* // The following example shows how to list the tags attached to a user.
|
|
36
|
+
* const input = {
|
|
37
|
+
* "UserName": "anika"
|
|
38
|
+
* };
|
|
39
|
+
* const command = new ListUserTagsCommand(input);
|
|
40
|
+
* const response = await client.send(command);
|
|
41
|
+
* /* response ==
|
|
42
|
+
* {
|
|
43
|
+
* "IsTruncated": false,
|
|
44
|
+
* "Tags": [
|
|
45
|
+
* {
|
|
46
|
+
* "Key": "Dept",
|
|
47
|
+
* "Value": "12345"
|
|
48
|
+
* },
|
|
49
|
+
* {
|
|
50
|
+
* "Key": "Team",
|
|
51
|
+
* "Value": "Accounting"
|
|
52
|
+
* }
|
|
53
|
+
* ]
|
|
54
|
+
* }
|
|
55
|
+
* *\/
|
|
56
|
+
* // example id: to-list-the-tags-attached-to-an-iam-user-1506719473186
|
|
57
|
+
* ```
|
|
58
|
+
*
|
|
33
59
|
*/
|
|
34
60
|
export declare class ListUserTagsCommand extends $Command<ListUserTagsCommandInput, ListUserTagsCommandOutput, IAMClientResolvedConfig> {
|
|
35
61
|
readonly input: ListUserTagsCommandInput;
|
|
@@ -37,6 +37,37 @@ export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBea
|
|
|
37
37
|
* @see {@link ListUsersCommandOutput} for command's `response` shape.
|
|
38
38
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
39
39
|
*
|
|
40
|
+
* @example To list IAM users
|
|
41
|
+
* ```javascript
|
|
42
|
+
* // The following command lists the IAM users in the current account.
|
|
43
|
+
* const input = {};
|
|
44
|
+
* const command = new ListUsersCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* /* response ==
|
|
47
|
+
* {
|
|
48
|
+
* "Users": [
|
|
49
|
+
* {
|
|
50
|
+
* "Arn": "arn:aws:iam::123456789012:user/division_abc/subdivision_xyz/engineering/Juan",
|
|
51
|
+
* "CreateDate": "2012-09-05T19:38:48Z",
|
|
52
|
+
* "PasswordLastUsed": "2016-09-08T21:47:36Z",
|
|
53
|
+
* "Path": "/division_abc/subdivision_xyz/engineering/",
|
|
54
|
+
* "UserId": "AID2MAB8DPLSRHEXAMPLE",
|
|
55
|
+
* "UserName": "Juan"
|
|
56
|
+
* },
|
|
57
|
+
* {
|
|
58
|
+
* "Arn": "arn:aws:iam::123456789012:user/division_abc/subdivision_xyz/engineering/Anika",
|
|
59
|
+
* "CreateDate": "2014-04-09T15:43:45Z",
|
|
60
|
+
* "PasswordLastUsed": "2016-09-24T16:18:07Z",
|
|
61
|
+
* "Path": "/division_abc/subdivision_xyz/engineering/",
|
|
62
|
+
* "UserId": "AIDIODR4TAW7CSEXAMPLE",
|
|
63
|
+
* "UserName": "Anika"
|
|
64
|
+
* }
|
|
65
|
+
* ]
|
|
66
|
+
* }
|
|
67
|
+
* *\/
|
|
68
|
+
* // example id: 9edfbd73-03d8-4d8a-9a79-76c85e8c8298
|
|
69
|
+
* ```
|
|
70
|
+
*
|
|
40
71
|
*/
|
|
41
72
|
export declare class ListUsersCommand extends $Command<ListUsersCommandInput, ListUsersCommandOutput, IAMClientResolvedConfig> {
|
|
42
73
|
readonly input: ListUsersCommandInput;
|
|
@@ -38,6 +38,27 @@ export interface ListVirtualMFADevicesCommandOutput extends ListVirtualMFADevice
|
|
|
38
38
|
* @see {@link ListVirtualMFADevicesCommandOutput} for command's `response` shape.
|
|
39
39
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
40
40
|
*
|
|
41
|
+
* @example To list virtual MFA devices
|
|
42
|
+
* ```javascript
|
|
43
|
+
* // The following command lists the virtual MFA devices that have been configured for the current account.
|
|
44
|
+
* const input = {};
|
|
45
|
+
* const command = new ListVirtualMFADevicesCommand(input);
|
|
46
|
+
* const response = await client.send(command);
|
|
47
|
+
* /* response ==
|
|
48
|
+
* {
|
|
49
|
+
* "VirtualMFADevices": [
|
|
50
|
+
* {
|
|
51
|
+
* "SerialNumber": "arn:aws:iam::123456789012:mfa/ExampleMFADevice"
|
|
52
|
+
* },
|
|
53
|
+
* {
|
|
54
|
+
* "SerialNumber": "arn:aws:iam::123456789012:mfa/Juan"
|
|
55
|
+
* }
|
|
56
|
+
* ]
|
|
57
|
+
* }
|
|
58
|
+
* *\/
|
|
59
|
+
* // example id: 54f9ac18-5100-4070-bec4-fe5f612710d5
|
|
60
|
+
* ```
|
|
61
|
+
*
|
|
41
62
|
*/
|
|
42
63
|
export declare class ListVirtualMFADevicesCommand extends $Command<ListVirtualMFADevicesCommandInput, ListVirtualMFADevicesCommandOutput, IAMClientResolvedConfig> {
|
|
43
64
|
readonly input: ListVirtualMFADevicesCommandInput;
|
|
@@ -43,6 +43,19 @@ export interface PutGroupPolicyCommandOutput extends __MetadataBearer {
|
|
|
43
43
|
* @see {@link PutGroupPolicyCommandOutput} for command's `response` shape.
|
|
44
44
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
45
45
|
*
|
|
46
|
+
* @example To add a policy to a group
|
|
47
|
+
* ```javascript
|
|
48
|
+
* // The following command adds a policy named AllPerms to the IAM group named Admins.
|
|
49
|
+
* const input = {
|
|
50
|
+
* "GroupName": "Admins",
|
|
51
|
+
* "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"*\",\"Resource\":\"*\"}}",
|
|
52
|
+
* "PolicyName": "AllPerms"
|
|
53
|
+
* };
|
|
54
|
+
* const command = new PutGroupPolicyCommand(input);
|
|
55
|
+
* await client.send(command);
|
|
56
|
+
* // example id: 4bc17418-758f-4d0f-ab0c-4d00265fec2e
|
|
57
|
+
* ```
|
|
58
|
+
*
|
|
46
59
|
*/
|
|
47
60
|
export declare class PutGroupPolicyCommand extends $Command<PutGroupPolicyCommandInput, PutGroupPolicyCommandOutput, IAMClientResolvedConfig> {
|
|
48
61
|
readonly input: PutGroupPolicyCommandInput;
|
|
@@ -48,6 +48,19 @@ export interface PutRolePolicyCommandOutput extends __MetadataBearer {
|
|
|
48
48
|
* @see {@link PutRolePolicyCommandOutput} for command's `response` shape.
|
|
49
49
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
50
50
|
*
|
|
51
|
+
* @example To attach a permissions policy to an IAM role
|
|
52
|
+
* ```javascript
|
|
53
|
+
* // The following command adds a permissions policy to the role named Test-Role.
|
|
54
|
+
* const input = {
|
|
55
|
+
* "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"s3:*\",\"Resource\":\"*\"}}",
|
|
56
|
+
* "PolicyName": "S3AccessPolicy",
|
|
57
|
+
* "RoleName": "S3Access"
|
|
58
|
+
* };
|
|
59
|
+
* const command = new PutRolePolicyCommand(input);
|
|
60
|
+
* await client.send(command);
|
|
61
|
+
* // example id: de62fd00-46c7-4601-9e0d-71d5fbb11ecb
|
|
62
|
+
* ```
|
|
63
|
+
*
|
|
51
64
|
*/
|
|
52
65
|
export declare class PutRolePolicyCommand extends $Command<PutRolePolicyCommandInput, PutRolePolicyCommandOutput, IAMClientResolvedConfig> {
|
|
53
66
|
readonly input: PutRolePolicyCommandInput;
|
|
@@ -43,6 +43,19 @@ export interface PutUserPolicyCommandOutput extends __MetadataBearer {
|
|
|
43
43
|
* @see {@link PutUserPolicyCommandOutput} for command's `response` shape.
|
|
44
44
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
45
45
|
*
|
|
46
|
+
* @example To attach a policy to an IAM user
|
|
47
|
+
* ```javascript
|
|
48
|
+
* // The following command attaches a policy to the IAM user named Bob.
|
|
49
|
+
* const input = {
|
|
50
|
+
* "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"*\",\"Resource\":\"*\"}}",
|
|
51
|
+
* "PolicyName": "AllAccessPolicy",
|
|
52
|
+
* "UserName": "Bob"
|
|
53
|
+
* };
|
|
54
|
+
* const command = new PutUserPolicyCommand(input);
|
|
55
|
+
* await client.send(command);
|
|
56
|
+
* // example id: 2551ffc6-3576-4d39-823f-30b60bffc2c7
|
|
57
|
+
* ```
|
|
58
|
+
*
|
|
46
59
|
*/
|
|
47
60
|
export declare class PutUserPolicyCommand extends $Command<PutUserPolicyCommandInput, PutUserPolicyCommandOutput, IAMClientResolvedConfig> {
|
|
48
61
|
readonly input: PutUserPolicyCommandInput;
|
|
@@ -38,6 +38,18 @@ export interface RemoveRoleFromInstanceProfileCommandOutput extends __MetadataBe
|
|
|
38
38
|
* @see {@link RemoveRoleFromInstanceProfileCommandOutput} for command's `response` shape.
|
|
39
39
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
40
40
|
*
|
|
41
|
+
* @example To remove a role from an instance profile
|
|
42
|
+
* ```javascript
|
|
43
|
+
* // The following command removes the role named Test-Role from the instance profile named ExampleInstanceProfile.
|
|
44
|
+
* const input = {
|
|
45
|
+
* "InstanceProfileName": "ExampleInstanceProfile",
|
|
46
|
+
* "RoleName": "Test-Role"
|
|
47
|
+
* };
|
|
48
|
+
* const command = new RemoveRoleFromInstanceProfileCommand(input);
|
|
49
|
+
* await client.send(command);
|
|
50
|
+
* // example id: 6d9f46f1-9f4a-4873-b403-51a85c5c627c
|
|
51
|
+
* ```
|
|
52
|
+
*
|
|
41
53
|
*/
|
|
42
54
|
export declare class RemoveRoleFromInstanceProfileCommand extends $Command<RemoveRoleFromInstanceProfileCommandInput, RemoveRoleFromInstanceProfileCommandOutput, IAMClientResolvedConfig> {
|
|
43
55
|
readonly input: RemoveRoleFromInstanceProfileCommandInput;
|
|
@@ -29,6 +29,18 @@ export interface RemoveUserFromGroupCommandOutput extends __MetadataBearer {
|
|
|
29
29
|
* @see {@link RemoveUserFromGroupCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @example To remove a user from an IAM group
|
|
33
|
+
* ```javascript
|
|
34
|
+
* // The following command removes the user named Bob from the IAM group named Admins.
|
|
35
|
+
* const input = {
|
|
36
|
+
* "GroupName": "Admins",
|
|
37
|
+
* "UserName": "Bob"
|
|
38
|
+
* };
|
|
39
|
+
* const command = new RemoveUserFromGroupCommand(input);
|
|
40
|
+
* await client.send(command);
|
|
41
|
+
* // example id: fb54d5b4-0caf-41d8-af0e-10a84413f174
|
|
42
|
+
* ```
|
|
43
|
+
*
|
|
32
44
|
*/
|
|
33
45
|
export declare class RemoveUserFromGroupCommand extends $Command<RemoveUserFromGroupCommandInput, RemoveUserFromGroupCommandOutput, IAMClientResolvedConfig> {
|
|
34
46
|
readonly input: RemoveUserFromGroupCommandInput;
|
|
@@ -47,6 +47,17 @@ export interface SetSecurityTokenServicePreferencesCommandOutput extends __Metad
|
|
|
47
47
|
* @see {@link SetSecurityTokenServicePreferencesCommandOutput} for command's `response` shape.
|
|
48
48
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
49
49
|
*
|
|
50
|
+
* @example To delete an access key for an IAM user
|
|
51
|
+
* ```javascript
|
|
52
|
+
* // The following command sets the STS global endpoint token to version 2. Version 2 tokens are valid in all Regions.
|
|
53
|
+
* const input = {
|
|
54
|
+
* "GlobalEndpointTokenVersion": "v2Token"
|
|
55
|
+
* };
|
|
56
|
+
* const command = new SetSecurityTokenServicePreferencesCommand(input);
|
|
57
|
+
* await client.send(command);
|
|
58
|
+
* // example id: 61a785a7-d30a-415a-ae18-ab9236e56871
|
|
59
|
+
* ```
|
|
60
|
+
*
|
|
50
61
|
*/
|
|
51
62
|
export declare class SetSecurityTokenServicePreferencesCommand extends $Command<SetSecurityTokenServicePreferencesCommandInput, SetSecurityTokenServicePreferencesCommandOutput, IAMClientResolvedConfig> {
|
|
52
63
|
readonly input: SetSecurityTokenServicePreferencesCommandInput;
|
|
@@ -73,6 +73,27 @@ export interface TagRoleCommandOutput extends __MetadataBearer {
|
|
|
73
73
|
* @see {@link TagRoleCommandOutput} for command's `response` shape.
|
|
74
74
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
75
75
|
*
|
|
76
|
+
* @example To add a tag key and value to an IAM role
|
|
77
|
+
* ```javascript
|
|
78
|
+
* // The following example shows how to add tags to an existing role.
|
|
79
|
+
* const input = {
|
|
80
|
+
* "RoleName": "taggedrole",
|
|
81
|
+
* "Tags": [
|
|
82
|
+
* {
|
|
83
|
+
* "Key": "Dept",
|
|
84
|
+
* "Value": "Accounting"
|
|
85
|
+
* },
|
|
86
|
+
* {
|
|
87
|
+
* "Key": "CostCenter",
|
|
88
|
+
* "Value": "12345"
|
|
89
|
+
* }
|
|
90
|
+
* ]
|
|
91
|
+
* };
|
|
92
|
+
* const command = new TagRoleCommand(input);
|
|
93
|
+
* await client.send(command);
|
|
94
|
+
* // example id: to-add-a-tag-key-and-value-to-an-iam-role-1506718791513
|
|
95
|
+
* ```
|
|
96
|
+
*
|
|
76
97
|
*/
|
|
77
98
|
export declare class TagRoleCommand extends $Command<TagRoleCommandInput, TagRoleCommandOutput, IAMClientResolvedConfig> {
|
|
78
99
|
readonly input: TagRoleCommandInput;
|
|
@@ -72,6 +72,27 @@ export interface TagUserCommandOutput extends __MetadataBearer {
|
|
|
72
72
|
* @see {@link TagUserCommandOutput} for command's `response` shape.
|
|
73
73
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
74
74
|
*
|
|
75
|
+
* @example To add a tag key and value to an IAM user
|
|
76
|
+
* ```javascript
|
|
77
|
+
* // The following example shows how to add tags to an existing user.
|
|
78
|
+
* const input = {
|
|
79
|
+
* "Tags": [
|
|
80
|
+
* {
|
|
81
|
+
* "Key": "Dept",
|
|
82
|
+
* "Value": "Accounting"
|
|
83
|
+
* },
|
|
84
|
+
* {
|
|
85
|
+
* "Key": "CostCenter",
|
|
86
|
+
* "Value": "12345"
|
|
87
|
+
* }
|
|
88
|
+
* ],
|
|
89
|
+
* "UserName": "anika"
|
|
90
|
+
* };
|
|
91
|
+
* const command = new TagUserCommand(input);
|
|
92
|
+
* await client.send(command);
|
|
93
|
+
* // example id: to-add-a-tag-key-and-value-to-an-iam-user-1506719044227
|
|
94
|
+
* ```
|
|
95
|
+
*
|
|
75
96
|
*/
|
|
76
97
|
export declare class TagUserCommand extends $Command<TagUserCommandInput, TagUserCommandOutput, IAMClientResolvedConfig> {
|
|
77
98
|
readonly input: TagUserCommandInput;
|
|
@@ -30,6 +30,20 @@ export interface UntagRoleCommandOutput extends __MetadataBearer {
|
|
|
30
30
|
* @see {@link UntagRoleCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @example To remove a tag from an IAM role
|
|
34
|
+
* ```javascript
|
|
35
|
+
* // The following example shows how to remove a tag with the key 'Dept' from a role named 'taggedrole'.
|
|
36
|
+
* const input = {
|
|
37
|
+
* "RoleName": "taggedrole",
|
|
38
|
+
* "TagKeys": [
|
|
39
|
+
* "Dept"
|
|
40
|
+
* ]
|
|
41
|
+
* };
|
|
42
|
+
* const command = new UntagRoleCommand(input);
|
|
43
|
+
* await client.send(command);
|
|
44
|
+
* // example id: to-remove-a-tag-from-an-iam-role-1506719589943
|
|
45
|
+
* ```
|
|
46
|
+
*
|
|
33
47
|
*/
|
|
34
48
|
export declare class UntagRoleCommand extends $Command<UntagRoleCommandInput, UntagRoleCommandOutput, IAMClientResolvedConfig> {
|
|
35
49
|
readonly input: UntagRoleCommandInput;
|
|
@@ -30,6 +30,20 @@ export interface UntagUserCommandOutput extends __MetadataBearer {
|
|
|
30
30
|
* @see {@link UntagUserCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @example To remove a tag from an IAM user
|
|
34
|
+
* ```javascript
|
|
35
|
+
* // The following example shows how to remove tags that are attached to a user named 'anika'.
|
|
36
|
+
* const input = {
|
|
37
|
+
* "TagKeys": [
|
|
38
|
+
* "Dept"
|
|
39
|
+
* ],
|
|
40
|
+
* "UserName": "anika"
|
|
41
|
+
* };
|
|
42
|
+
* const command = new UntagUserCommand(input);
|
|
43
|
+
* await client.send(command);
|
|
44
|
+
* // example id: to-remove-a-tag-from-an-iam-user-1506719725554
|
|
45
|
+
* ```
|
|
46
|
+
*
|
|
33
47
|
*/
|
|
34
48
|
export declare class UntagUserCommand extends $Command<UntagUserCommandInput, UntagUserCommandOutput, IAMClientResolvedConfig> {
|
|
35
49
|
readonly input: UntagUserCommandInput;
|
|
@@ -40,6 +40,19 @@ export interface UpdateAccessKeyCommandOutput extends __MetadataBearer {
|
|
|
40
40
|
* @see {@link UpdateAccessKeyCommandOutput} for command's `response` shape.
|
|
41
41
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
42
42
|
*
|
|
43
|
+
* @example To activate or deactivate an access key for an IAM user
|
|
44
|
+
* ```javascript
|
|
45
|
+
* // The following command deactivates the specified access key (access key ID and secret access key) for the IAM user named Bob.
|
|
46
|
+
* const input = {
|
|
47
|
+
* "AccessKeyId": "AKIAIOSFODNN7EXAMPLE",
|
|
48
|
+
* "Status": "Inactive",
|
|
49
|
+
* "UserName": "Bob"
|
|
50
|
+
* };
|
|
51
|
+
* const command = new UpdateAccessKeyCommand(input);
|
|
52
|
+
* await client.send(command);
|
|
53
|
+
* // example id: 02b556fd-e673-49b7-ab6b-f2f9035967d0
|
|
54
|
+
* ```
|
|
55
|
+
*
|
|
43
56
|
*/
|
|
44
57
|
export declare class UpdateAccessKeyCommand extends $Command<UpdateAccessKeyCommandInput, UpdateAccessKeyCommandOutput, IAMClientResolvedConfig> {
|
|
45
58
|
readonly input: UpdateAccessKeyCommandInput;
|
|
@@ -39,6 +39,18 @@ export interface UpdateAccountPasswordPolicyCommandOutput extends __MetadataBear
|
|
|
39
39
|
* @see {@link UpdateAccountPasswordPolicyCommandOutput} for command's `response` shape.
|
|
40
40
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
41
41
|
*
|
|
42
|
+
* @example To set or change the current account password policy
|
|
43
|
+
* ```javascript
|
|
44
|
+
* // The following command sets the password policy to require a minimum length of eight characters and to require one or more numbers in the password:
|
|
45
|
+
* const input = {
|
|
46
|
+
* "MinimumPasswordLength": 8,
|
|
47
|
+
* "RequireNumbers": true
|
|
48
|
+
* };
|
|
49
|
+
* const command = new UpdateAccountPasswordPolicyCommand(input);
|
|
50
|
+
* await client.send(command);
|
|
51
|
+
* // example id: c263a1af-37dc-4423-8dba-9790284ef5e0
|
|
52
|
+
* ```
|
|
53
|
+
*
|
|
42
54
|
*/
|
|
43
55
|
export declare class UpdateAccountPasswordPolicyCommand extends $Command<UpdateAccountPasswordPolicyCommandInput, UpdateAccountPasswordPolicyCommandOutput, IAMClientResolvedConfig> {
|
|
44
56
|
readonly input: UpdateAccountPasswordPolicyCommandInput;
|
|
@@ -32,6 +32,18 @@ export interface UpdateAssumeRolePolicyCommandOutput extends __MetadataBearer {
|
|
|
32
32
|
* @see {@link UpdateAssumeRolePolicyCommandOutput} for command's `response` shape.
|
|
33
33
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
34
34
|
*
|
|
35
|
+
* @example To update the trust policy for an IAM role
|
|
36
|
+
* ```javascript
|
|
37
|
+
* // The following command updates the role trust policy for the role named Test-Role:
|
|
38
|
+
* const input = {
|
|
39
|
+
* "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":[\"ec2.amazonaws.com\"]},\"Action\":[\"sts:AssumeRole\"]}]}",
|
|
40
|
+
* "RoleName": "S3AccessForEC2Instances"
|
|
41
|
+
* };
|
|
42
|
+
* const command = new UpdateAssumeRolePolicyCommand(input);
|
|
43
|
+
* await client.send(command);
|
|
44
|
+
* // example id: c9150063-d953-4e99-9576-9685872006c6
|
|
45
|
+
* ```
|
|
46
|
+
*
|
|
35
47
|
*/
|
|
36
48
|
export declare class UpdateAssumeRolePolicyCommand extends $Command<UpdateAssumeRolePolicyCommandInput, UpdateAssumeRolePolicyCommandOutput, IAMClientResolvedConfig> {
|
|
37
49
|
readonly input: UpdateAssumeRolePolicyCommandInput;
|
|
@@ -43,6 +43,18 @@ export interface UpdateGroupCommandOutput extends __MetadataBearer {
|
|
|
43
43
|
* @see {@link UpdateGroupCommandOutput} for command's `response` shape.
|
|
44
44
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
45
45
|
*
|
|
46
|
+
* @example To rename an IAM group
|
|
47
|
+
* ```javascript
|
|
48
|
+
* // The following command changes the name of the IAM group Test to Test-1.
|
|
49
|
+
* const input = {
|
|
50
|
+
* "GroupName": "Test",
|
|
51
|
+
* "NewGroupName": "Test-1"
|
|
52
|
+
* };
|
|
53
|
+
* const command = new UpdateGroupCommand(input);
|
|
54
|
+
* await client.send(command);
|
|
55
|
+
* // example id: f0cf1662-91ae-4278-a80e-7db54256ccba
|
|
56
|
+
* ```
|
|
57
|
+
*
|
|
46
58
|
*/
|
|
47
59
|
export declare class UpdateGroupCommand extends $Command<UpdateGroupCommandInput, UpdateGroupCommandOutput, IAMClientResolvedConfig> {
|
|
48
60
|
readonly input: UpdateGroupCommandInput;
|
|
@@ -35,6 +35,18 @@ export interface UpdateLoginProfileCommandOutput extends __MetadataBearer {
|
|
|
35
35
|
* @see {@link UpdateLoginProfileCommandOutput} for command's `response` shape.
|
|
36
36
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
37
37
|
*
|
|
38
|
+
* @example To change the password for an IAM user
|
|
39
|
+
* ```javascript
|
|
40
|
+
* // The following command creates or changes the password for the IAM user named Bob.
|
|
41
|
+
* const input = {
|
|
42
|
+
* "Password": "SomeKindOfPassword123!@#",
|
|
43
|
+
* "UserName": "Bob"
|
|
44
|
+
* };
|
|
45
|
+
* const command = new UpdateLoginProfileCommand(input);
|
|
46
|
+
* await client.send(command);
|
|
47
|
+
* // example id: 036d9498-ecdb-4ed6-a8d8-366c383d1487
|
|
48
|
+
* ```
|
|
49
|
+
*
|
|
38
50
|
*/
|
|
39
51
|
export declare class UpdateLoginProfileCommand extends $Command<UpdateLoginProfileCommandInput, UpdateLoginProfileCommandOutput, IAMClientResolvedConfig> {
|
|
40
52
|
readonly input: UpdateLoginProfileCommandInput;
|
|
@@ -36,6 +36,19 @@ export interface UpdateSigningCertificateCommandOutput extends __MetadataBearer
|
|
|
36
36
|
* @see {@link UpdateSigningCertificateCommandOutput} for command's `response` shape.
|
|
37
37
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
38
38
|
*
|
|
39
|
+
* @example To change the active status of a signing certificate for an IAM user
|
|
40
|
+
* ```javascript
|
|
41
|
+
* // The following command changes the status of a signing certificate for a user named Bob to Inactive.
|
|
42
|
+
* const input = {
|
|
43
|
+
* "CertificateId": "TA7SMP42TDN5Z26OBPJE7EXAMPLE",
|
|
44
|
+
* "Status": "Inactive",
|
|
45
|
+
* "UserName": "Bob"
|
|
46
|
+
* };
|
|
47
|
+
* const command = new UpdateSigningCertificateCommand(input);
|
|
48
|
+
* await client.send(command);
|
|
49
|
+
* // example id: 829aee7b-efc5-4b3b-84a5-7f899b38018d
|
|
50
|
+
* ```
|
|
51
|
+
*
|
|
39
52
|
*/
|
|
40
53
|
export declare class UpdateSigningCertificateCommand extends $Command<UpdateSigningCertificateCommandInput, UpdateSigningCertificateCommandOutput, IAMClientResolvedConfig> {
|
|
41
54
|
readonly input: UpdateSigningCertificateCommandInput;
|
|
@@ -41,6 +41,18 @@ export interface UpdateUserCommandOutput extends __MetadataBearer {
|
|
|
41
41
|
* @see {@link UpdateUserCommandOutput} for command's `response` shape.
|
|
42
42
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
43
43
|
*
|
|
44
|
+
* @example To change an IAM user's name
|
|
45
|
+
* ```javascript
|
|
46
|
+
* // The following command changes the name of the IAM user Bob to Robert. It does not change the user's path.
|
|
47
|
+
* const input = {
|
|
48
|
+
* "NewUserName": "Robert",
|
|
49
|
+
* "UserName": "Bob"
|
|
50
|
+
* };
|
|
51
|
+
* const command = new UpdateUserCommand(input);
|
|
52
|
+
* await client.send(command);
|
|
53
|
+
* // example id: 275d53ed-347a-44e6-b7d0-a96276154352
|
|
54
|
+
* ```
|
|
55
|
+
*
|
|
44
56
|
*/
|
|
45
57
|
export declare class UpdateUserCommand extends $Command<UpdateUserCommandInput, UpdateUserCommandOutput, IAMClientResolvedConfig> {
|
|
46
58
|
readonly input: UpdateUserCommandInput;
|
|
@@ -52,6 +52,32 @@ export interface UploadServerCertificateCommandOutput extends UploadServerCertif
|
|
|
52
52
|
* @see {@link UploadServerCertificateCommandOutput} for command's `response` shape.
|
|
53
53
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
54
54
|
*
|
|
55
|
+
* @example To upload a server certificate to your AWS account
|
|
56
|
+
* ```javascript
|
|
57
|
+
* // The following upload-server-certificate command uploads a server certificate to your AWS account:
|
|
58
|
+
* const input = {
|
|
59
|
+
* "CertificateBody": "-----BEGIN CERTIFICATE-----<a very long certificate text string>-----END CERTIFICATE-----",
|
|
60
|
+
* "Path": "/company/servercerts/",
|
|
61
|
+
* "PrivateKey": "-----BEGIN DSA PRIVATE KEY-----<a very long private key string>-----END DSA PRIVATE KEY-----",
|
|
62
|
+
* "ServerCertificateName": "ProdServerCert"
|
|
63
|
+
* };
|
|
64
|
+
* const command = new UploadServerCertificateCommand(input);
|
|
65
|
+
* const response = await client.send(command);
|
|
66
|
+
* /* response ==
|
|
67
|
+
* {
|
|
68
|
+
* "ServerCertificateMetadata": {
|
|
69
|
+
* "Arn": "arn:aws:iam::123456789012:server-certificate/company/servercerts/ProdServerCert",
|
|
70
|
+
* "Expiration": "2012-05-08T01:02:03.004Z",
|
|
71
|
+
* "Path": "/company/servercerts/",
|
|
72
|
+
* "ServerCertificateId": "ASCA1111111111EXAMPLE",
|
|
73
|
+
* "ServerCertificateName": "ProdServerCert",
|
|
74
|
+
* "UploadDate": "2010-05-08T01:02:03.004Z"
|
|
75
|
+
* }
|
|
76
|
+
* }
|
|
77
|
+
* *\/
|
|
78
|
+
* // example id: 06eab6d1-ebf2-4bd9-839d-f7508b9a38b6
|
|
79
|
+
* ```
|
|
80
|
+
*
|
|
55
81
|
*/
|
|
56
82
|
export declare class UploadServerCertificateCommand extends $Command<UploadServerCertificateCommandInput, UploadServerCertificateCommandOutput, IAMClientResolvedConfig> {
|
|
57
83
|
readonly input: UploadServerCertificateCommandInput;
|
|
@@ -48,6 +48,29 @@ export interface UploadSigningCertificateCommandOutput extends UploadSigningCert
|
|
|
48
48
|
* @see {@link UploadSigningCertificateCommandOutput} for command's `response` shape.
|
|
49
49
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
50
50
|
*
|
|
51
|
+
* @example To upload a signing certificate for an IAM user
|
|
52
|
+
* ```javascript
|
|
53
|
+
* // The following command uploads a signing certificate for the IAM user named Bob.
|
|
54
|
+
* const input = {
|
|
55
|
+
* "CertificateBody": "-----BEGIN CERTIFICATE-----<certificate-body>-----END CERTIFICATE-----",
|
|
56
|
+
* "UserName": "Bob"
|
|
57
|
+
* };
|
|
58
|
+
* const command = new UploadSigningCertificateCommand(input);
|
|
59
|
+
* const response = await client.send(command);
|
|
60
|
+
* /* response ==
|
|
61
|
+
* {
|
|
62
|
+
* "Certificate": {
|
|
63
|
+
* "CertificateBody": "-----BEGIN CERTIFICATE-----<certificate-body>-----END CERTIFICATE-----",
|
|
64
|
+
* "CertificateId": "ID123456789012345EXAMPLE",
|
|
65
|
+
* "Status": "Active",
|
|
66
|
+
* "UploadDate": "2015-06-06T21:40:08.121Z",
|
|
67
|
+
* "UserName": "Bob"
|
|
68
|
+
* }
|
|
69
|
+
* }
|
|
70
|
+
* *\/
|
|
71
|
+
* // example id: e67489b6-7b73-4e30-9ed3-9a9e0231e458
|
|
72
|
+
* ```
|
|
73
|
+
*
|
|
51
74
|
*/
|
|
52
75
|
export declare class UploadSigningCertificateCommand extends $Command<UploadSigningCertificateCommandInput, UploadSigningCertificateCommandOutput, IAMClientResolvedConfig> {
|
|
53
76
|
readonly input: UploadSigningCertificateCommandInput;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-iam",
|
|
3
3
|
"description": "AWS SDK for JavaScript Iam Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.289.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -20,39 +20,39 @@
|
|
|
20
20
|
"dependencies": {
|
|
21
21
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
22
22
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
23
|
-
"@aws-sdk/client-sts": "3.
|
|
24
|
-
"@aws-sdk/config-resolver": "3.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
26
|
-
"@aws-sdk/fetch-http-handler": "3.
|
|
27
|
-
"@aws-sdk/hash-node": "3.
|
|
28
|
-
"@aws-sdk/invalid-dependency": "3.
|
|
29
|
-
"@aws-sdk/middleware-content-length": "3.
|
|
30
|
-
"@aws-sdk/middleware-endpoint": "3.
|
|
31
|
-
"@aws-sdk/middleware-host-header": "3.
|
|
32
|
-
"@aws-sdk/middleware-logger": "3.
|
|
33
|
-
"@aws-sdk/middleware-recursion-detection": "3.
|
|
34
|
-
"@aws-sdk/middleware-retry": "3.
|
|
35
|
-
"@aws-sdk/middleware-serde": "3.
|
|
36
|
-
"@aws-sdk/middleware-signing": "3.
|
|
37
|
-
"@aws-sdk/middleware-stack": "3.
|
|
38
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
39
|
-
"@aws-sdk/node-config-provider": "3.
|
|
40
|
-
"@aws-sdk/node-http-handler": "3.
|
|
41
|
-
"@aws-sdk/protocol-http": "3.
|
|
42
|
-
"@aws-sdk/smithy-client": "3.
|
|
43
|
-
"@aws-sdk/types": "3.
|
|
44
|
-
"@aws-sdk/url-parser": "3.
|
|
23
|
+
"@aws-sdk/client-sts": "3.289.0",
|
|
24
|
+
"@aws-sdk/config-resolver": "3.289.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.289.0",
|
|
26
|
+
"@aws-sdk/fetch-http-handler": "3.289.0",
|
|
27
|
+
"@aws-sdk/hash-node": "3.289.0",
|
|
28
|
+
"@aws-sdk/invalid-dependency": "3.289.0",
|
|
29
|
+
"@aws-sdk/middleware-content-length": "3.289.0",
|
|
30
|
+
"@aws-sdk/middleware-endpoint": "3.289.0",
|
|
31
|
+
"@aws-sdk/middleware-host-header": "3.289.0",
|
|
32
|
+
"@aws-sdk/middleware-logger": "3.289.0",
|
|
33
|
+
"@aws-sdk/middleware-recursion-detection": "3.289.0",
|
|
34
|
+
"@aws-sdk/middleware-retry": "3.289.0",
|
|
35
|
+
"@aws-sdk/middleware-serde": "3.289.0",
|
|
36
|
+
"@aws-sdk/middleware-signing": "3.289.0",
|
|
37
|
+
"@aws-sdk/middleware-stack": "3.289.0",
|
|
38
|
+
"@aws-sdk/middleware-user-agent": "3.289.0",
|
|
39
|
+
"@aws-sdk/node-config-provider": "3.289.0",
|
|
40
|
+
"@aws-sdk/node-http-handler": "3.289.0",
|
|
41
|
+
"@aws-sdk/protocol-http": "3.289.0",
|
|
42
|
+
"@aws-sdk/smithy-client": "3.289.0",
|
|
43
|
+
"@aws-sdk/types": "3.289.0",
|
|
44
|
+
"@aws-sdk/url-parser": "3.289.0",
|
|
45
45
|
"@aws-sdk/util-base64": "3.208.0",
|
|
46
46
|
"@aws-sdk/util-body-length-browser": "3.188.0",
|
|
47
47
|
"@aws-sdk/util-body-length-node": "3.208.0",
|
|
48
|
-
"@aws-sdk/util-defaults-mode-browser": "3.
|
|
49
|
-
"@aws-sdk/util-defaults-mode-node": "3.
|
|
50
|
-
"@aws-sdk/util-endpoints": "3.
|
|
51
|
-
"@aws-sdk/util-retry": "3.
|
|
52
|
-
"@aws-sdk/util-user-agent-browser": "3.
|
|
53
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
48
|
+
"@aws-sdk/util-defaults-mode-browser": "3.289.0",
|
|
49
|
+
"@aws-sdk/util-defaults-mode-node": "3.289.0",
|
|
50
|
+
"@aws-sdk/util-endpoints": "3.289.0",
|
|
51
|
+
"@aws-sdk/util-retry": "3.289.0",
|
|
52
|
+
"@aws-sdk/util-user-agent-browser": "3.289.0",
|
|
53
|
+
"@aws-sdk/util-user-agent-node": "3.289.0",
|
|
54
54
|
"@aws-sdk/util-utf8": "3.254.0",
|
|
55
|
-
"@aws-sdk/util-waiter": "3.
|
|
55
|
+
"@aws-sdk/util-waiter": "3.289.0",
|
|
56
56
|
"fast-xml-parser": "4.1.2",
|
|
57
57
|
"tslib": "^2.3.1"
|
|
58
58
|
},
|