@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
|
@@ -32,6 +32,31 @@ export interface GetAccountPasswordPolicyCommandOutput extends GetAccountPasswor
|
|
|
32
32
|
* @see {@link GetAccountPasswordPolicyCommandOutput} for command's `response` shape.
|
|
33
33
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
34
34
|
*
|
|
35
|
+
* @example To see the current account password policy
|
|
36
|
+
* ```javascript
|
|
37
|
+
* // The following command displays details about the password policy for the current AWS account.
|
|
38
|
+
* const input = undefined;
|
|
39
|
+
* const command = new GetAccountPasswordPolicyCommand(input);
|
|
40
|
+
* const response = await client.send(command);
|
|
41
|
+
* /* response ==
|
|
42
|
+
* {
|
|
43
|
+
* "PasswordPolicy": {
|
|
44
|
+
* "AllowUsersToChangePassword": false,
|
|
45
|
+
* "ExpirePasswords": false,
|
|
46
|
+
* "HardExpiry": false,
|
|
47
|
+
* "MaxPasswordAge": 90,
|
|
48
|
+
* "MinimumPasswordLength": 8,
|
|
49
|
+
* "PasswordReusePrevention": 12,
|
|
50
|
+
* "RequireLowercaseCharacters": false,
|
|
51
|
+
* "RequireNumbers": true,
|
|
52
|
+
* "RequireSymbols": true,
|
|
53
|
+
* "RequireUppercaseCharacters": false
|
|
54
|
+
* }
|
|
55
|
+
* }
|
|
56
|
+
* *\/
|
|
57
|
+
* // example id: 5e4598c7-c425-431f-8af1-19073b3c4a5f
|
|
58
|
+
* ```
|
|
59
|
+
*
|
|
35
60
|
*/
|
|
36
61
|
export declare class GetAccountPasswordPolicyCommand extends $Command<GetAccountPasswordPolicyCommandInput, GetAccountPasswordPolicyCommandOutput, IAMClientResolvedConfig> {
|
|
37
62
|
readonly input: GetAccountPasswordPolicyCommandInput;
|
|
@@ -32,6 +32,47 @@ export interface GetAccountSummaryCommandOutput extends GetAccountSummaryRespons
|
|
|
32
32
|
* @see {@link GetAccountSummaryCommandOutput} for command's `response` shape.
|
|
33
33
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
34
34
|
*
|
|
35
|
+
* @example To get information about IAM entity quotas and usage in the current account
|
|
36
|
+
* ```javascript
|
|
37
|
+
* // The following command returns information about the IAM entity quotas and usage in the current AWS account.
|
|
38
|
+
* const input = undefined;
|
|
39
|
+
* const command = new GetAccountSummaryCommand(input);
|
|
40
|
+
* const response = await client.send(command);
|
|
41
|
+
* /* response ==
|
|
42
|
+
* {
|
|
43
|
+
* "SummaryMap": {
|
|
44
|
+
* "AccessKeysPerUserQuota": 2,
|
|
45
|
+
* "AccountAccessKeysPresent": 1,
|
|
46
|
+
* "AccountMFAEnabled": 0,
|
|
47
|
+
* "AccountSigningCertificatesPresent": 0,
|
|
48
|
+
* "AttachedPoliciesPerGroupQuota": 10,
|
|
49
|
+
* "AttachedPoliciesPerRoleQuota": 10,
|
|
50
|
+
* "AttachedPoliciesPerUserQuota": 10,
|
|
51
|
+
* "GlobalEndpointTokenVersion": 2,
|
|
52
|
+
* "GroupPolicySizeQuota": 5120,
|
|
53
|
+
* "Groups": 15,
|
|
54
|
+
* "GroupsPerUserQuota": 10,
|
|
55
|
+
* "GroupsQuota": 100,
|
|
56
|
+
* "MFADevices": 6,
|
|
57
|
+
* "MFADevicesInUse": 3,
|
|
58
|
+
* "Policies": 8,
|
|
59
|
+
* "PoliciesQuota": 1000,
|
|
60
|
+
* "PolicySizeQuota": 5120,
|
|
61
|
+
* "PolicyVersionsInUse": 22,
|
|
62
|
+
* "PolicyVersionsInUseQuota": 10000,
|
|
63
|
+
* "ServerCertificates": 1,
|
|
64
|
+
* "ServerCertificatesQuota": 20,
|
|
65
|
+
* "SigningCertificatesPerUserQuota": 2,
|
|
66
|
+
* "UserPolicySizeQuota": 2048,
|
|
67
|
+
* "Users": 27,
|
|
68
|
+
* "UsersQuota": 5000,
|
|
69
|
+
* "VersionsPerPolicyQuota": 5
|
|
70
|
+
* }
|
|
71
|
+
* }
|
|
72
|
+
* *\/
|
|
73
|
+
* // example id: 9d8447af-f344-45de-8219-2cebc3cce7f2
|
|
74
|
+
* ```
|
|
75
|
+
*
|
|
35
76
|
*/
|
|
36
77
|
export declare class GetAccountSummaryCommand extends $Command<GetAccountSummaryCommandInput, GetAccountSummaryCommandOutput, IAMClientResolvedConfig> {
|
|
37
78
|
readonly input: GetAccountSummaryCommandInput;
|
|
@@ -32,6 +32,38 @@ export interface GetInstanceProfileCommandOutput extends GetInstanceProfileRespo
|
|
|
32
32
|
* @see {@link GetInstanceProfileCommandOutput} for command's `response` shape.
|
|
33
33
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
34
34
|
*
|
|
35
|
+
* @example To get information about an instance profile
|
|
36
|
+
* ```javascript
|
|
37
|
+
* // The following command gets information about the instance profile named ExampleInstanceProfile.
|
|
38
|
+
* const input = {
|
|
39
|
+
* "InstanceProfileName": "ExampleInstanceProfile"
|
|
40
|
+
* };
|
|
41
|
+
* const command = new GetInstanceProfileCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* /* response ==
|
|
44
|
+
* {
|
|
45
|
+
* "InstanceProfile": {
|
|
46
|
+
* "Arn": "arn:aws:iam::336924118301:instance-profile/ExampleInstanceProfile",
|
|
47
|
+
* "CreateDate": "2013-06-12T23:52:02Z",
|
|
48
|
+
* "InstanceProfileId": "AID2MAB8DPLSRHEXAMPLE",
|
|
49
|
+
* "InstanceProfileName": "ExampleInstanceProfile",
|
|
50
|
+
* "Path": "/",
|
|
51
|
+
* "Roles": [
|
|
52
|
+
* {
|
|
53
|
+
* "Arn": "arn:aws:iam::336924118301:role/Test-Role",
|
|
54
|
+
* "AssumeRolePolicyDocument": "<URL-encoded-JSON>",
|
|
55
|
+
* "CreateDate": "2013-01-09T06:33:26Z",
|
|
56
|
+
* "Path": "/",
|
|
57
|
+
* "RoleId": "AIDGPMS9RO4H3FEXAMPLE",
|
|
58
|
+
* "RoleName": "Test-Role"
|
|
59
|
+
* }
|
|
60
|
+
* ]
|
|
61
|
+
* }
|
|
62
|
+
* }
|
|
63
|
+
* *\/
|
|
64
|
+
* // example id: 463b9ba5-18cc-4608-9ccb-5a7c6b6e5fe7
|
|
65
|
+
* ```
|
|
66
|
+
*
|
|
35
67
|
*/
|
|
36
68
|
export declare class GetInstanceProfileCommand extends $Command<GetInstanceProfileCommandInput, GetInstanceProfileCommandOutput, IAMClientResolvedConfig> {
|
|
37
69
|
readonly input: GetInstanceProfileCommandInput;
|
|
@@ -38,6 +38,25 @@ export interface GetLoginProfileCommandOutput extends GetLoginProfileResponse, _
|
|
|
38
38
|
* @see {@link GetLoginProfileCommandOutput} for command's `response` shape.
|
|
39
39
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
40
40
|
*
|
|
41
|
+
* @example To get password information for an IAM user
|
|
42
|
+
* ```javascript
|
|
43
|
+
* // The following command gets information about the password for the IAM user named Anika.
|
|
44
|
+
* const input = {
|
|
45
|
+
* "UserName": "Anika"
|
|
46
|
+
* };
|
|
47
|
+
* const command = new GetLoginProfileCommand(input);
|
|
48
|
+
* const response = await client.send(command);
|
|
49
|
+
* /* response ==
|
|
50
|
+
* {
|
|
51
|
+
* "LoginProfile": {
|
|
52
|
+
* "CreateDate": "2012-09-21T23:03:39Z",
|
|
53
|
+
* "UserName": "Anika"
|
|
54
|
+
* }
|
|
55
|
+
* }
|
|
56
|
+
* *\/
|
|
57
|
+
* // example id: d6b580cc-909f-4925-9caa-d425cbc1ad47
|
|
58
|
+
* ```
|
|
59
|
+
*
|
|
41
60
|
*/
|
|
42
61
|
export declare class GetLoginProfileCommand extends $Command<GetLoginProfileCommandInput, GetLoginProfileCommandOutput, IAMClientResolvedConfig> {
|
|
43
62
|
readonly input: GetLoginProfileCommandInput;
|
|
@@ -47,6 +47,50 @@ export interface GetOrganizationsAccessReportCommandOutput extends GetOrganizati
|
|
|
47
47
|
* @see {@link GetOrganizationsAccessReportCommandOutput} for command's `response` shape.
|
|
48
48
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
49
49
|
*
|
|
50
|
+
* @example To get details from a previously generated organizational unit report
|
|
51
|
+
* ```javascript
|
|
52
|
+
* // The following operation gets details about the report with the job ID: examplea-1234-b567-cde8-90fg123abcd4
|
|
53
|
+
* const input = {
|
|
54
|
+
* "JobId": "examplea-1234-b567-cde8-90fg123abcd4"
|
|
55
|
+
* };
|
|
56
|
+
* const command = new GetOrganizationsAccessReportCommand(input);
|
|
57
|
+
* const response = await client.send(command);
|
|
58
|
+
* /* response ==
|
|
59
|
+
* {
|
|
60
|
+
* "AccessDetails": [
|
|
61
|
+
* {
|
|
62
|
+
* "EntityPath": "o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-1a2b3c-k9l8m7n6o5example/111122223333",
|
|
63
|
+
* "LastAuthenticatedTime": "2019-05-25T16:29:52Z",
|
|
64
|
+
* "Region": "us-east-1",
|
|
65
|
+
* "ServiceName": "Amazon DynamoDB",
|
|
66
|
+
* "ServiceNamespace": "dynamodb",
|
|
67
|
+
* "TotalAuthenticatedEntities": 2
|
|
68
|
+
* },
|
|
69
|
+
* {
|
|
70
|
+
* "EntityPath": "o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-1a2b3c-k9l8m7n6o5example/123456789012",
|
|
71
|
+
* "LastAuthenticatedTime": "2019-06-15T13:12:06Z",
|
|
72
|
+
* "Region": "us-east-1",
|
|
73
|
+
* "ServiceName": "AWS Identity and Access Management",
|
|
74
|
+
* "ServiceNamespace": "iam",
|
|
75
|
+
* "TotalAuthenticatedEntities": 4
|
|
76
|
+
* },
|
|
77
|
+
* {
|
|
78
|
+
* "ServiceName": "Amazon Simple Storage Service",
|
|
79
|
+
* "ServiceNamespace": "s3",
|
|
80
|
+
* "TotalAuthenticatedEntities": 0
|
|
81
|
+
* }
|
|
82
|
+
* ],
|
|
83
|
+
* "IsTruncated": false,
|
|
84
|
+
* "JobCompletionDate": "2019-06-18T19:47:35.241Z",
|
|
85
|
+
* "JobCreationDate": "2019-06-18T19:47:31.466Z",
|
|
86
|
+
* "JobStatus": "COMPLETED",
|
|
87
|
+
* "NumberOfServicesAccessible": 3,
|
|
88
|
+
* "NumberOfServicesNotAccessed": 1
|
|
89
|
+
* }
|
|
90
|
+
* *\/
|
|
91
|
+
* // example id: getorganizationsaccessreport-ou
|
|
92
|
+
* ```
|
|
93
|
+
*
|
|
50
94
|
*/
|
|
51
95
|
export declare class GetOrganizationsAccessReportCommand extends $Command<GetOrganizationsAccessReportCommandInput, GetOrganizationsAccessReportCommandOutput, IAMClientResolvedConfig> {
|
|
52
96
|
readonly input: GetOrganizationsAccessReportCommandInput;
|
|
@@ -38,6 +38,34 @@ export interface GetRoleCommandOutput extends GetRoleResponse, __MetadataBearer
|
|
|
38
38
|
* @see {@link GetRoleCommandOutput} for command's `response` shape.
|
|
39
39
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
40
40
|
*
|
|
41
|
+
* @example To get information about an IAM role
|
|
42
|
+
* ```javascript
|
|
43
|
+
* // The following command gets information about the role named Test-Role.
|
|
44
|
+
* const input = {
|
|
45
|
+
* "RoleName": "Test-Role"
|
|
46
|
+
* };
|
|
47
|
+
* const command = new GetRoleCommand(input);
|
|
48
|
+
* const response = await client.send(command);
|
|
49
|
+
* /* response ==
|
|
50
|
+
* {
|
|
51
|
+
* "Role": {
|
|
52
|
+
* "Arn": "arn:aws:iam::123456789012:role/Test-Role",
|
|
53
|
+
* "AssumeRolePolicyDocument": "<URL-encoded-JSON>",
|
|
54
|
+
* "CreateDate": "2013-04-18T05:01:58Z",
|
|
55
|
+
* "MaxSessionDuration": 3600,
|
|
56
|
+
* "Path": "/",
|
|
57
|
+
* "RoleId": "AROADBQP57FF2AEXAMPLE",
|
|
58
|
+
* "RoleLastUsed": {
|
|
59
|
+
* "LastUsedDate": "2019-11-18T05:01:58Z",
|
|
60
|
+
* "Region": "us-east-1"
|
|
61
|
+
* },
|
|
62
|
+
* "RoleName": "Test-Role"
|
|
63
|
+
* }
|
|
64
|
+
* }
|
|
65
|
+
* *\/
|
|
66
|
+
* // example id: 5b7d03a6-340c-472d-aa77-56425950d8b0
|
|
67
|
+
* ```
|
|
68
|
+
*
|
|
41
69
|
*/
|
|
42
70
|
export declare class GetRoleCommand extends $Command<GetRoleCommandInput, GetRoleCommandOutput, IAMClientResolvedConfig> {
|
|
43
71
|
readonly input: GetRoleCommandInput;
|
|
@@ -80,6 +80,39 @@ export interface GetServiceLastAccessedDetailsCommandOutput extends GetServiceLa
|
|
|
80
80
|
* @see {@link GetServiceLastAccessedDetailsCommandOutput} for command's `response` shape.
|
|
81
81
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
82
82
|
*
|
|
83
|
+
* @example To get details from a previously-generated report
|
|
84
|
+
* ```javascript
|
|
85
|
+
* // The following operation gets details about the report with the job ID: examplef-1305-c245-eba4-71fe298bcda7
|
|
86
|
+
* const input = {
|
|
87
|
+
* "JobId": "examplef-1305-c245-eba4-71fe298bcda7"
|
|
88
|
+
* };
|
|
89
|
+
* const command = new GetServiceLastAccessedDetailsCommand(input);
|
|
90
|
+
* const response = await client.send(command);
|
|
91
|
+
* /* response ==
|
|
92
|
+
* {
|
|
93
|
+
* "IsTruncated": false,
|
|
94
|
+
* "JobCompletionDate": "2018-10-24T19:47:35.241Z",
|
|
95
|
+
* "JobCreationDate": "2018-10-24T19:47:31.466Z",
|
|
96
|
+
* "JobStatus": "COMPLETED",
|
|
97
|
+
* "ServicesLastAccessed": [
|
|
98
|
+
* {
|
|
99
|
+
* "LastAuthenticated": "2018-10-24T19:11:00Z",
|
|
100
|
+
* "LastAuthenticatedEntity": "arn:aws:iam::123456789012:user/AWSExampleUser01",
|
|
101
|
+
* "ServiceName": "AWS Identity and Access Management",
|
|
102
|
+
* "ServiceNamespace": "iam",
|
|
103
|
+
* "TotalAuthenticatedEntities": 2
|
|
104
|
+
* },
|
|
105
|
+
* {
|
|
106
|
+
* "ServiceName": "Amazon Simple Storage Service",
|
|
107
|
+
* "ServiceNamespace": "s3",
|
|
108
|
+
* "TotalAuthenticatedEntities": 0
|
|
109
|
+
* }
|
|
110
|
+
* ]
|
|
111
|
+
* }
|
|
112
|
+
* *\/
|
|
113
|
+
* // example id: getserviceaccessdetails-policy-1541696298085
|
|
114
|
+
* ```
|
|
115
|
+
*
|
|
83
116
|
*/
|
|
84
117
|
export declare class GetServiceLastAccessedDetailsCommand extends $Command<GetServiceLastAccessedDetailsCommandInput, GetServiceLastAccessedDetailsCommandOutput, IAMClientResolvedConfig> {
|
|
85
118
|
readonly input: GetServiceLastAccessedDetailsCommandInput;
|
|
@@ -54,6 +54,47 @@ export interface GetServiceLastAccessedDetailsWithEntitiesCommandOutput extends
|
|
|
54
54
|
* @see {@link GetServiceLastAccessedDetailsWithEntitiesCommandOutput} for command's `response` shape.
|
|
55
55
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
56
56
|
*
|
|
57
|
+
* @example To get sntity details from a previously-generated report
|
|
58
|
+
* ```javascript
|
|
59
|
+
* // The following operation returns details about the entities that attempted to access the IAM service.
|
|
60
|
+
* const input = {
|
|
61
|
+
* "JobId": "examplef-1305-c245-eba4-71fe298bcda7",
|
|
62
|
+
* "ServiceNamespace": "iam"
|
|
63
|
+
* };
|
|
64
|
+
* const command = new GetServiceLastAccessedDetailsWithEntitiesCommand(input);
|
|
65
|
+
* const response = await client.send(command);
|
|
66
|
+
* /* response ==
|
|
67
|
+
* {
|
|
68
|
+
* "EntityDetailsList": [
|
|
69
|
+
* {
|
|
70
|
+
* "EntityInfo": {
|
|
71
|
+
* "Arn": "arn:aws:iam::123456789012:user/AWSExampleUser01",
|
|
72
|
+
* "Id": "AIDAEX2EXAMPLEB6IGCDC",
|
|
73
|
+
* "Name": "AWSExampleUser01",
|
|
74
|
+
* "Path": "/",
|
|
75
|
+
* "Type": "USER"
|
|
76
|
+
* },
|
|
77
|
+
* "LastAuthenticated": "2018-10-24T19:10:00Z"
|
|
78
|
+
* },
|
|
79
|
+
* {
|
|
80
|
+
* "EntityInfo": {
|
|
81
|
+
* "Arn": "arn:aws:iam::123456789012:role/AWSExampleRole01",
|
|
82
|
+
* "Id": "AROAEAEXAMPLEIANXSIU4",
|
|
83
|
+
* "Name": "AWSExampleRole01",
|
|
84
|
+
* "Path": "/",
|
|
85
|
+
* "Type": "ROLE"
|
|
86
|
+
* }
|
|
87
|
+
* }
|
|
88
|
+
* ],
|
|
89
|
+
* "IsTruncated": false,
|
|
90
|
+
* "JobCompletionDate": "2018-10-24T19:47:35.241Z",
|
|
91
|
+
* "JobCreationDate": "2018-10-24T19:47:31.466Z",
|
|
92
|
+
* "JobStatus": "COMPLETED"
|
|
93
|
+
* }
|
|
94
|
+
* *\/
|
|
95
|
+
* // example id: getserviceaccessdetailsentity-policy-1541697621384
|
|
96
|
+
* ```
|
|
97
|
+
*
|
|
57
98
|
*/
|
|
58
99
|
export declare class GetServiceLastAccessedDetailsWithEntitiesCommand extends $Command<GetServiceLastAccessedDetailsWithEntitiesCommandInput, GetServiceLastAccessedDetailsWithEntitiesCommandOutput, IAMClientResolvedConfig> {
|
|
59
100
|
readonly input: GetServiceLastAccessedDetailsWithEntitiesCommandInput;
|
|
@@ -32,6 +32,28 @@ export interface GetUserCommandOutput extends GetUserResponse, __MetadataBearer
|
|
|
32
32
|
* @see {@link GetUserCommandOutput} for command's `response` shape.
|
|
33
33
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
34
34
|
*
|
|
35
|
+
* @example To get information about an IAM user
|
|
36
|
+
* ```javascript
|
|
37
|
+
* // The following command gets information about the IAM user named Bob.
|
|
38
|
+
* const input = {
|
|
39
|
+
* "UserName": "Bob"
|
|
40
|
+
* };
|
|
41
|
+
* const command = new GetUserCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* /* response ==
|
|
44
|
+
* {
|
|
45
|
+
* "User": {
|
|
46
|
+
* "Arn": "arn:aws:iam::123456789012:user/Bob",
|
|
47
|
+
* "CreateDate": "2012-09-21T23:03:13Z",
|
|
48
|
+
* "Path": "/",
|
|
49
|
+
* "UserId": "AKIAIOSFODNN7EXAMPLE",
|
|
50
|
+
* "UserName": "Bob"
|
|
51
|
+
* }
|
|
52
|
+
* }
|
|
53
|
+
* *\/
|
|
54
|
+
* // example id: ede000a1-9e4c-40db-bd0a-d4f95e41a6ab
|
|
55
|
+
* ```
|
|
56
|
+
*
|
|
35
57
|
*/
|
|
36
58
|
export declare class GetUserCommand extends $Command<GetUserCommandInput, GetUserCommandOutput, IAMClientResolvedConfig> {
|
|
37
59
|
readonly input: GetUserCommandInput;
|
|
@@ -43,6 +43,35 @@ export interface ListAccessKeysCommandOutput extends ListAccessKeysResponse, __M
|
|
|
43
43
|
* @see {@link ListAccessKeysCommandOutput} for command's `response` shape.
|
|
44
44
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
45
45
|
*
|
|
46
|
+
* @example To list the access key IDs for an IAM user
|
|
47
|
+
* ```javascript
|
|
48
|
+
* // The following command lists the access keys IDs for the IAM user named Alice.
|
|
49
|
+
* const input = {
|
|
50
|
+
* "UserName": "Alice"
|
|
51
|
+
* };
|
|
52
|
+
* const command = new ListAccessKeysCommand(input);
|
|
53
|
+
* const response = await client.send(command);
|
|
54
|
+
* /* response ==
|
|
55
|
+
* {
|
|
56
|
+
* "AccessKeyMetadata": [
|
|
57
|
+
* {
|
|
58
|
+
* "AccessKeyId": "AKIA111111111EXAMPLE",
|
|
59
|
+
* "CreateDate": "2016-12-01T22:19:58Z",
|
|
60
|
+
* "Status": "Active",
|
|
61
|
+
* "UserName": "Alice"
|
|
62
|
+
* },
|
|
63
|
+
* {
|
|
64
|
+
* "AccessKeyId": "AKIA222222222EXAMPLE",
|
|
65
|
+
* "CreateDate": "2016-12-01T22:20:01Z",
|
|
66
|
+
* "Status": "Active",
|
|
67
|
+
* "UserName": "Alice"
|
|
68
|
+
* }
|
|
69
|
+
* ]
|
|
70
|
+
* }
|
|
71
|
+
* *\/
|
|
72
|
+
* // example id: 15571463-ebea-411a-a021-1c76bd2a3625
|
|
73
|
+
* ```
|
|
74
|
+
*
|
|
46
75
|
*/
|
|
47
76
|
export declare class ListAccessKeysCommand extends $Command<ListAccessKeysCommandInput, ListAccessKeysCommandOutput, IAMClientResolvedConfig> {
|
|
48
77
|
readonly input: ListAccessKeysCommandInput;
|
|
@@ -31,6 +31,22 @@ export interface ListAccountAliasesCommandOutput extends ListAccountAliasesRespo
|
|
|
31
31
|
* @see {@link ListAccountAliasesCommandOutput} for command's `response` shape.
|
|
32
32
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
33
33
|
*
|
|
34
|
+
* @example To list account aliases
|
|
35
|
+
* ```javascript
|
|
36
|
+
* // The following command lists the aliases for the current account.
|
|
37
|
+
* const input = {};
|
|
38
|
+
* const command = new ListAccountAliasesCommand(input);
|
|
39
|
+
* const response = await client.send(command);
|
|
40
|
+
* /* response ==
|
|
41
|
+
* {
|
|
42
|
+
* "AccountAliases": [
|
|
43
|
+
* "exmaple-corporation"
|
|
44
|
+
* ]
|
|
45
|
+
* }
|
|
46
|
+
* *\/
|
|
47
|
+
* // example id: e27b457a-16f9-4e05-a006-3df7b3472741
|
|
48
|
+
* ```
|
|
49
|
+
*
|
|
34
50
|
*/
|
|
35
51
|
export declare class ListAccountAliasesCommand extends $Command<ListAccountAliasesCommandInput, ListAccountAliasesCommandOutput, IAMClientResolvedConfig> {
|
|
36
52
|
readonly input: ListAccountAliasesCommandInput;
|
|
@@ -37,6 +37,25 @@ export interface ListGroupPoliciesCommandOutput extends ListGroupPoliciesRespons
|
|
|
37
37
|
* @see {@link ListGroupPoliciesCommandOutput} for command's `response` shape.
|
|
38
38
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
39
39
|
*
|
|
40
|
+
* @example To list the in-line policies for an IAM group
|
|
41
|
+
* ```javascript
|
|
42
|
+
* // The following command lists the names of in-line policies that are embedded in the IAM group named Admins.
|
|
43
|
+
* const input = {
|
|
44
|
+
* "GroupName": "Admins"
|
|
45
|
+
* };
|
|
46
|
+
* const command = new ListGroupPoliciesCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* /* response ==
|
|
49
|
+
* {
|
|
50
|
+
* "PolicyNames": [
|
|
51
|
+
* "AdminRoot",
|
|
52
|
+
* "KeyPolicy"
|
|
53
|
+
* ]
|
|
54
|
+
* }
|
|
55
|
+
* *\/
|
|
56
|
+
* // example id: 02de5095-2410-4d3a-ac1b-cc40234af68f
|
|
57
|
+
* ```
|
|
58
|
+
*
|
|
40
59
|
*/
|
|
41
60
|
export declare class ListGroupPoliciesCommand extends $Command<ListGroupPoliciesCommandInput, ListGroupPoliciesCommandOutput, IAMClientResolvedConfig> {
|
|
42
61
|
readonly input: ListGroupPoliciesCommandInput;
|
|
@@ -31,6 +31,42 @@ export interface ListGroupsCommandOutput extends ListGroupsResponse, __MetadataB
|
|
|
31
31
|
* @see {@link ListGroupsCommandOutput} for command's `response` shape.
|
|
32
32
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
33
33
|
*
|
|
34
|
+
* @example To list the IAM groups for the current account
|
|
35
|
+
* ```javascript
|
|
36
|
+
* // The following command lists the IAM groups in the current account:
|
|
37
|
+
* const input = {};
|
|
38
|
+
* const command = new ListGroupsCommand(input);
|
|
39
|
+
* const response = await client.send(command);
|
|
40
|
+
* /* response ==
|
|
41
|
+
* {
|
|
42
|
+
* "Groups": [
|
|
43
|
+
* {
|
|
44
|
+
* "Arn": "arn:aws:iam::123456789012:group/Admins",
|
|
45
|
+
* "CreateDate": "2016-12-15T21:40:08.121Z",
|
|
46
|
+
* "GroupId": "AGPA1111111111EXAMPLE",
|
|
47
|
+
* "GroupName": "Admins",
|
|
48
|
+
* "Path": "/division_abc/subdivision_xyz/"
|
|
49
|
+
* },
|
|
50
|
+
* {
|
|
51
|
+
* "Arn": "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/engineering/Test",
|
|
52
|
+
* "CreateDate": "2016-11-30T14:10:01.156Z",
|
|
53
|
+
* "GroupId": "AGP22222222222EXAMPLE",
|
|
54
|
+
* "GroupName": "Test",
|
|
55
|
+
* "Path": "/division_abc/subdivision_xyz/product_1234/engineering/"
|
|
56
|
+
* },
|
|
57
|
+
* {
|
|
58
|
+
* "Arn": "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/Managers",
|
|
59
|
+
* "CreateDate": "2016-06-12T20:14:52.032Z",
|
|
60
|
+
* "GroupId": "AGPI3333333333EXAMPLE",
|
|
61
|
+
* "GroupName": "Managers",
|
|
62
|
+
* "Path": "/division_abc/subdivision_xyz/product_1234/"
|
|
63
|
+
* }
|
|
64
|
+
* ]
|
|
65
|
+
* }
|
|
66
|
+
* *\/
|
|
67
|
+
* // example id: b3ab1380-2a21-42fb-8e85-503f65512c66
|
|
68
|
+
* ```
|
|
69
|
+
*
|
|
34
70
|
*/
|
|
35
71
|
export declare class ListGroupsCommand extends $Command<ListGroupsCommandInput, ListGroupsCommandOutput, IAMClientResolvedConfig> {
|
|
36
72
|
readonly input: ListGroupsCommandInput;
|
|
@@ -31,6 +31,37 @@ export interface ListGroupsForUserCommandOutput extends ListGroupsForUserRespons
|
|
|
31
31
|
* @see {@link ListGroupsForUserCommandOutput} for command's `response` shape.
|
|
32
32
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
33
33
|
*
|
|
34
|
+
* @example To list the groups that an IAM user belongs to
|
|
35
|
+
* ```javascript
|
|
36
|
+
* // The following command displays the groups that the IAM user named Bob belongs to.
|
|
37
|
+
* const input = {
|
|
38
|
+
* "UserName": "Bob"
|
|
39
|
+
* };
|
|
40
|
+
* const command = new ListGroupsForUserCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* /* response ==
|
|
43
|
+
* {
|
|
44
|
+
* "Groups": [
|
|
45
|
+
* {
|
|
46
|
+
* "Arn": "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/engineering/Test",
|
|
47
|
+
* "CreateDate": "2016-11-30T14:10:01.156Z",
|
|
48
|
+
* "GroupId": "AGP2111111111EXAMPLE",
|
|
49
|
+
* "GroupName": "Test",
|
|
50
|
+
* "Path": "/division_abc/subdivision_xyz/product_1234/engineering/"
|
|
51
|
+
* },
|
|
52
|
+
* {
|
|
53
|
+
* "Arn": "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/Managers",
|
|
54
|
+
* "CreateDate": "2016-06-12T20:14:52.032Z",
|
|
55
|
+
* "GroupId": "AGPI222222222SEXAMPLE",
|
|
56
|
+
* "GroupName": "Managers",
|
|
57
|
+
* "Path": "/division_abc/subdivision_xyz/product_1234/"
|
|
58
|
+
* }
|
|
59
|
+
* ]
|
|
60
|
+
* }
|
|
61
|
+
* *\/
|
|
62
|
+
* // example id: 278ec2ee-fc28-4136-83fb-433af0ae46a2
|
|
63
|
+
* ```
|
|
64
|
+
*
|
|
34
65
|
*/
|
|
35
66
|
export declare class ListGroupsForUserCommand extends $Command<ListGroupsForUserCommandInput, ListGroupsForUserCommandOutput, IAMClientResolvedConfig> {
|
|
36
67
|
readonly input: ListGroupsForUserCommandInput;
|
|
@@ -68,6 +68,54 @@ export interface ListPoliciesGrantingServiceAccessCommandOutput extends ListPoli
|
|
|
68
68
|
* @see {@link ListPoliciesGrantingServiceAccessCommandOutput} for command's `response` shape.
|
|
69
69
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
70
70
|
*
|
|
71
|
+
* @example To list policies that allow access to a service
|
|
72
|
+
* ```javascript
|
|
73
|
+
* // The following operation lists policies that allow ExampleUser01 to access IAM or EC2.
|
|
74
|
+
* const input = {
|
|
75
|
+
* "Arn": "arn:aws:iam::123456789012:user/ExampleUser01",
|
|
76
|
+
* "ServiceNamespaces": [
|
|
77
|
+
* "iam",
|
|
78
|
+
* "ec2"
|
|
79
|
+
* ]
|
|
80
|
+
* };
|
|
81
|
+
* const command = new ListPoliciesGrantingServiceAccessCommand(input);
|
|
82
|
+
* const response = await client.send(command);
|
|
83
|
+
* /* response ==
|
|
84
|
+
* {
|
|
85
|
+
* "IsTruncated": false,
|
|
86
|
+
* "PoliciesGrantingServiceAccess": [
|
|
87
|
+
* {
|
|
88
|
+
* "Policies": [
|
|
89
|
+
* {
|
|
90
|
+
* "PolicyArn": "arn:aws:iam::123456789012:policy/ExampleIamPolicy",
|
|
91
|
+
* "PolicyName": "ExampleIamPolicy",
|
|
92
|
+
* "PolicyType": "MANAGED"
|
|
93
|
+
* },
|
|
94
|
+
* {
|
|
95
|
+
* "EntityName": "AWSExampleGroup1",
|
|
96
|
+
* "EntityType": "GROUP",
|
|
97
|
+
* "PolicyName": "ExampleGroup1Policy",
|
|
98
|
+
* "PolicyType": "INLINE"
|
|
99
|
+
* }
|
|
100
|
+
* ],
|
|
101
|
+
* "ServiceNamespace": "iam"
|
|
102
|
+
* },
|
|
103
|
+
* {
|
|
104
|
+
* "Policies": [
|
|
105
|
+
* {
|
|
106
|
+
* "PolicyArn": "arn:aws:iam::123456789012:policy/ExampleEc2Policy",
|
|
107
|
+
* "PolicyName": "ExampleEc2Policy",
|
|
108
|
+
* "PolicyType": "MANAGED"
|
|
109
|
+
* }
|
|
110
|
+
* ],
|
|
111
|
+
* "ServiceNamespace": "ec2"
|
|
112
|
+
* }
|
|
113
|
+
* ]
|
|
114
|
+
* }
|
|
115
|
+
* *\/
|
|
116
|
+
* // example id: listpoliciesaccess-user-1541698749508
|
|
117
|
+
* ```
|
|
118
|
+
*
|
|
71
119
|
*/
|
|
72
120
|
export declare class ListPoliciesGrantingServiceAccessCommand extends $Command<ListPoliciesGrantingServiceAccessCommandInput, ListPoliciesGrantingServiceAccessCommandOutput, IAMClientResolvedConfig> {
|
|
73
121
|
readonly input: ListPoliciesGrantingServiceAccessCommandInput;
|
|
@@ -31,6 +31,32 @@ export interface ListRoleTagsCommandOutput extends ListRoleTagsResponse, __Metad
|
|
|
31
31
|
* @see {@link ListRoleTagsCommandOutput} for command's `response` shape.
|
|
32
32
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
33
33
|
*
|
|
34
|
+
* @example To list the tags attached to an IAM role
|
|
35
|
+
* ```javascript
|
|
36
|
+
* // The following example shows how to list the tags attached to a role.
|
|
37
|
+
* const input = {
|
|
38
|
+
* "RoleName": "taggedrole1"
|
|
39
|
+
* };
|
|
40
|
+
* const command = new ListRoleTagsCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* /* response ==
|
|
43
|
+
* {
|
|
44
|
+
* "IsTruncated": false,
|
|
45
|
+
* "Tags": [
|
|
46
|
+
* {
|
|
47
|
+
* "Key": "Dept",
|
|
48
|
+
* "Value": "12345"
|
|
49
|
+
* },
|
|
50
|
+
* {
|
|
51
|
+
* "Key": "Team",
|
|
52
|
+
* "Value": "Accounting"
|
|
53
|
+
* }
|
|
54
|
+
* ]
|
|
55
|
+
* }
|
|
56
|
+
* *\/
|
|
57
|
+
* // example id: to-list-the-tags-attached-to-an-iam-role-1506719238376
|
|
58
|
+
* ```
|
|
59
|
+
*
|
|
34
60
|
*/
|
|
35
61
|
export declare class ListRoleTagsCommand extends $Command<ListRoleTagsCommandInput, ListRoleTagsCommandOutput, IAMClientResolvedConfig> {
|
|
36
62
|
readonly input: ListRoleTagsCommandInput;
|
|
@@ -38,6 +38,30 @@ export interface ListSigningCertificatesCommandOutput extends ListSigningCertifi
|
|
|
38
38
|
* @see {@link ListSigningCertificatesCommandOutput} for command's `response` shape.
|
|
39
39
|
* @see {@link IAMClientResolvedConfig | config} for IAMClient's `config` shape.
|
|
40
40
|
*
|
|
41
|
+
* @example To list the signing certificates for an IAM user
|
|
42
|
+
* ```javascript
|
|
43
|
+
* // The following command lists the signing certificates for the IAM user named Bob.
|
|
44
|
+
* const input = {
|
|
45
|
+
* "UserName": "Bob"
|
|
46
|
+
* };
|
|
47
|
+
* const command = new ListSigningCertificatesCommand(input);
|
|
48
|
+
* const response = await client.send(command);
|
|
49
|
+
* /* response ==
|
|
50
|
+
* {
|
|
51
|
+
* "Certificates": [
|
|
52
|
+
* {
|
|
53
|
+
* "CertificateBody": "-----BEGIN CERTIFICATE-----<certificate-body>-----END CERTIFICATE-----",
|
|
54
|
+
* "CertificateId": "TA7SMP42TDN5Z26OBPJE7EXAMPLE",
|
|
55
|
+
* "Status": "Active",
|
|
56
|
+
* "UploadDate": "2013-06-06T21:40:08Z",
|
|
57
|
+
* "UserName": "Bob"
|
|
58
|
+
* }
|
|
59
|
+
* ]
|
|
60
|
+
* }
|
|
61
|
+
* *\/
|
|
62
|
+
* // example id: b4c10256-4fc9-457e-b3fd-4a110d4d73dc
|
|
63
|
+
* ```
|
|
64
|
+
*
|
|
41
65
|
*/
|
|
42
66
|
export declare class ListSigningCertificatesCommand extends $Command<ListSigningCertificatesCommandInput, ListSigningCertificatesCommandOutput, IAMClientResolvedConfig> {
|
|
43
67
|
readonly input: ListSigningCertificatesCommandInput;
|