@aws-sdk/client-iam 3.262.0 → 3.263.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 +1 -1
|
@@ -15,7 +15,7 @@ export interface DeleteServiceLinkedRoleCommandOutput extends DeleteServiceLinke
|
|
|
15
15
|
* operation more than once for the same service-linked role and an earlier deletion task
|
|
16
16
|
* is not complete, then the <code>DeletionTaskId</code> of the earlier request is
|
|
17
17
|
* returned.</p>
|
|
18
|
-
*
|
|
18
|
+
* <p>If you submit a deletion request for a service-linked role whose linked service is
|
|
19
19
|
* still accessing a resource, then the deletion task fails. If it fails, the <a>GetServiceLinkedRoleDeletionStatus</a> operation returns the reason for the
|
|
20
20
|
* failure, usually including the resources that must be deleted. To delete the
|
|
21
21
|
* service-linked role, you must first remove those resources from the linked service and
|
|
@@ -23,7 +23,7 @@ export interface DeleteServiceLinkedRoleCommandOutput extends DeleteServiceLinke
|
|
|
23
23
|
* linked to the role. For more information about removing resources from a service, see
|
|
24
24
|
* the <a href="http://docs.aws.amazon.com/">Amazon Web Services documentation</a> for your
|
|
25
25
|
* service.</p>
|
|
26
|
-
*
|
|
26
|
+
* <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
|
|
27
27
|
* <i>IAM User Guide</i>.</p>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,7 +9,7 @@ export interface DeleteSigningCertificateCommandOutput extends __MetadataBearer
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes a signing certificate associated with the specified IAM user.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>If you do not specify a user name, IAM determines the user name implicitly based on
|
|
13
13
|
* the Amazon Web Services access key ID signing the request. This operation works for access keys under
|
|
14
14
|
* the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root
|
|
15
15
|
* user credentials even if the Amazon Web Services account has no associated IAM users.</p>
|
|
@@ -12,33 +12,33 @@ export interface DeleteUserCommandOutput extends __MetadataBearer {
|
|
|
12
12
|
* programmatically, you must delete the items attached to the user manually, or the
|
|
13
13
|
* 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
|
|
14
14
|
* user</a>. Before attempting to delete a user, remove the following items:</p>
|
|
15
|
-
*
|
|
15
|
+
* <ul>
|
|
16
16
|
* <li>
|
|
17
|
-
*
|
|
17
|
+
* <p>Password (<a>DeleteLoginProfile</a>)</p>
|
|
18
18
|
* </li>
|
|
19
19
|
* <li>
|
|
20
|
-
*
|
|
20
|
+
* <p>Access keys (<a>DeleteAccessKey</a>)</p>
|
|
21
21
|
* </li>
|
|
22
22
|
* <li>
|
|
23
|
-
*
|
|
23
|
+
* <p>Signing certificate (<a>DeleteSigningCertificate</a>)</p>
|
|
24
24
|
* </li>
|
|
25
25
|
* <li>
|
|
26
|
-
*
|
|
26
|
+
* <p>SSH public key (<a>DeleteSSHPublicKey</a>)</p>
|
|
27
27
|
* </li>
|
|
28
28
|
* <li>
|
|
29
|
-
*
|
|
29
|
+
* <p>Git credentials (<a>DeleteServiceSpecificCredential</a>)</p>
|
|
30
30
|
* </li>
|
|
31
31
|
* <li>
|
|
32
|
-
*
|
|
32
|
+
* <p>Multi-factor authentication (MFA) device (<a>DeactivateMFADevice</a>, <a>DeleteVirtualMFADevice</a>)</p>
|
|
33
33
|
* </li>
|
|
34
34
|
* <li>
|
|
35
|
-
*
|
|
35
|
+
* <p>Inline policies (<a>DeleteUserPolicy</a>)</p>
|
|
36
36
|
* </li>
|
|
37
37
|
* <li>
|
|
38
|
-
*
|
|
38
|
+
* <p>Attached managed policies (<a>DetachUserPolicy</a>)</p>
|
|
39
39
|
* </li>
|
|
40
40
|
* <li>
|
|
41
|
-
*
|
|
41
|
+
* <p>Group memberships (<a>RemoveUserFromGroup</a>)</p>
|
|
42
42
|
* </li>
|
|
43
43
|
* </ul>
|
|
44
44
|
* @example
|
|
@@ -9,11 +9,11 @@ export interface DeleteUserPermissionsBoundaryCommandOutput extends __MetadataBe
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes the permissions boundary for the specified IAM user.</p>
|
|
12
|
-
*
|
|
12
|
+
* <important>
|
|
13
13
|
* <p>Deleting the permissions boundary for a user might increase its permissions by
|
|
14
14
|
* allowing the user to perform all the actions granted in its permissions policies.
|
|
15
15
|
* </p>
|
|
16
|
-
*
|
|
16
|
+
* </important>
|
|
17
17
|
* @example
|
|
18
18
|
* Use a bare-bones client and the command you need to make an API call.
|
|
19
19
|
* ```javascript
|
|
@@ -10,7 +10,7 @@ export interface DeleteUserPolicyCommandOutput extends __MetadataBearer {
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes the specified inline policy that is embedded in the specified IAM
|
|
12
12
|
* user.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>A user can also have managed policies attached to it. To detach a managed policy from
|
|
14
14
|
* a user, use <a>DetachUserPolicy</a>. For more information about policies,
|
|
15
15
|
* refer to <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline
|
|
16
16
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
@@ -9,10 +9,10 @@ export interface DeleteVirtualMFADeviceCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes a virtual MFA device.</p>
|
|
12
|
-
*
|
|
12
|
+
* <note>
|
|
13
13
|
* <p> You must deactivate a user's virtual MFA device before you can delete it. For
|
|
14
14
|
* information about deactivating MFA devices, see <a>DeactivateMFADevice</a>. </p>
|
|
15
|
-
*
|
|
15
|
+
* </note>
|
|
16
16
|
* @example
|
|
17
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
18
18
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface DetachGroupPolicyCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Removes the specified managed policy from the specified IAM group.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>A group can also have inline policies embedded with it. To delete an inline policy,
|
|
13
13
|
* 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
|
|
14
14
|
* policies and inline policies</a> in the
|
|
15
15
|
* <i>IAM User Guide</i>.</p>
|
|
@@ -9,7 +9,7 @@ export interface DetachRolePolicyCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Removes the specified managed policy from the specified role.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>A role can also have inline policies embedded with it. To delete an inline policy, use
|
|
13
13
|
* <a>DeleteRolePolicy</a>. For information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed
|
|
14
14
|
* policies and inline policies</a> in the
|
|
15
15
|
* <i>IAM User Guide</i>.</p>
|
|
@@ -9,7 +9,7 @@ export interface DetachUserPolicyCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Removes the specified managed policy from the specified user.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>A user can also have inline policies embedded with it. To delete an inline policy, use
|
|
13
13
|
* <a>DeleteUserPolicy</a>. For information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed
|
|
14
14
|
* policies and inline policies</a> in the
|
|
15
15
|
* <i>IAM User Guide</i>.</p>
|
|
@@ -11,26 +11,26 @@ export interface GenerateOrganizationsAccessReportCommandOutput extends Generate
|
|
|
11
11
|
* <p>Generates a report for service last accessed data for Organizations. You can generate a
|
|
12
12
|
* report for any entities (organization root, organizational unit, or account) or policies
|
|
13
13
|
* in your organization.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>To call this operation, you must be signed in using your Organizations management account
|
|
15
15
|
* credentials. You can use your long-term IAM user or root user credentials, or
|
|
16
16
|
* temporary credentials from assuming an IAM role. SCPs must be enabled for your
|
|
17
17
|
* organization root. You must have the required IAM and Organizations permissions. For more
|
|
18
18
|
* information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html">Refining permissions using
|
|
19
19
|
* service last accessed data</a> in the
|
|
20
20
|
* <i>IAM User Guide</i>.</p>
|
|
21
|
-
*
|
|
21
|
+
* <p>You can generate a service last accessed data report for entities by specifying only
|
|
22
22
|
* the entity's path. This data includes a list of services that are allowed by any service
|
|
23
23
|
* control policies (SCPs) that apply to the entity.</p>
|
|
24
|
-
*
|
|
24
|
+
* <p>You can generate a service last accessed data report for a policy by specifying an
|
|
25
25
|
* entity's path and an optional Organizations policy ID. This data includes a list of services that
|
|
26
26
|
* are allowed by the specified SCP.</p>
|
|
27
|
-
*
|
|
27
|
+
* <p>For each service in both report types, the data includes the most recent account
|
|
28
28
|
* activity that the policy allows to account principals in the entity or the entity's
|
|
29
29
|
* children. For important information about the data, reporting period, permissions
|
|
30
30
|
* required, troubleshooting, and supported Regions see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html">Reducing permissions using
|
|
31
31
|
* service last accessed data</a> in the
|
|
32
32
|
* <i>IAM User Guide</i>.</p>
|
|
33
|
-
*
|
|
33
|
+
* <important>
|
|
34
34
|
* <p>The data includes all attempts to access Amazon Web Services, not just the successful ones. This
|
|
35
35
|
* includes all attempts that were made using the Amazon Web Services Management Console, the Amazon Web Services API through any
|
|
36
36
|
* of the SDKs, or any of the command line tools. An unexpected entry in the service
|
|
@@ -39,8 +39,8 @@ export interface GenerateOrganizationsAccessReportCommandOutput extends Generate
|
|
|
39
39
|
* source for information about all API calls and whether they were successful or
|
|
40
40
|
* denied access. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/cloudtrail-integration.html">Logging IAM events with
|
|
41
41
|
* CloudTrail</a> in the <i>IAM User Guide</i>.</p>
|
|
42
|
-
*
|
|
43
|
-
*
|
|
42
|
+
* </important>
|
|
43
|
+
* <p>This operation returns a <code>JobId</code>. Use this parameter in the <code>
|
|
44
44
|
* <a>GetOrganizationsAccessReport</a>
|
|
45
45
|
* </code> operation to check the status of
|
|
46
46
|
* the report generation. To check the status of this request, use the <code>JobId</code>
|
|
@@ -49,12 +49,12 @@ export interface GenerateOrganizationsAccessReportCommandOutput extends Generate
|
|
|
49
49
|
* </code> operation
|
|
50
50
|
* and test the <code>JobStatus</code> response parameter. When the job is complete, you
|
|
51
51
|
* can retrieve the report.</p>
|
|
52
|
-
*
|
|
52
|
+
* <p>To generate a service last accessed data report for entities, specify an entity path
|
|
53
53
|
* without specifying the optional Organizations policy ID. The type of entity that you specify
|
|
54
54
|
* determines the data returned in the report.</p>
|
|
55
|
-
*
|
|
55
|
+
* <ul>
|
|
56
56
|
* <li>
|
|
57
|
-
*
|
|
57
|
+
* <p>
|
|
58
58
|
* <b>Root</b> – When you specify the
|
|
59
59
|
* organizations root as the entity, the resulting report lists all of the services
|
|
60
60
|
* allowed by SCPs that are attached to your root. For each service, the report
|
|
@@ -62,7 +62,7 @@ export interface GenerateOrganizationsAccessReportCommandOutput extends Generate
|
|
|
62
62
|
* management account, because the management account is not limited by SCPs.</p>
|
|
63
63
|
* </li>
|
|
64
64
|
* <li>
|
|
65
|
-
*
|
|
65
|
+
* <p>
|
|
66
66
|
* <b>OU</b> – When you specify an
|
|
67
67
|
* organizational unit (OU) as the entity, the resulting report lists all of the
|
|
68
68
|
* services allowed by SCPs that are attached to the OU and its parents. For each
|
|
@@ -71,26 +71,26 @@ export interface GenerateOrganizationsAccessReportCommandOutput extends Generate
|
|
|
71
71
|
* limited by SCPs.</p>
|
|
72
72
|
* </li>
|
|
73
73
|
* <li>
|
|
74
|
-
*
|
|
74
|
+
* <p>
|
|
75
75
|
* <b>management account</b> – When you specify the
|
|
76
76
|
* management account, the resulting report lists all Amazon Web Services services, because the
|
|
77
77
|
* management account is not limited by SCPs. For each service, the report includes
|
|
78
78
|
* data for only the management account.</p>
|
|
79
79
|
* </li>
|
|
80
80
|
* <li>
|
|
81
|
-
*
|
|
81
|
+
* <p>
|
|
82
82
|
* <b>Account</b> – When you specify another
|
|
83
83
|
* account as the entity, the resulting report lists all of the services allowed by
|
|
84
84
|
* SCPs that are attached to the account and its parents. For each service, the
|
|
85
85
|
* report includes data for only the specified account.</p>
|
|
86
86
|
* </li>
|
|
87
87
|
* </ul>
|
|
88
|
-
*
|
|
88
|
+
* <p>To generate a service last accessed data report for policies, specify an entity path
|
|
89
89
|
* and the optional Organizations policy ID. The type of entity that you specify determines the data
|
|
90
90
|
* returned for each service.</p>
|
|
91
|
-
*
|
|
91
|
+
* <ul>
|
|
92
92
|
* <li>
|
|
93
|
-
*
|
|
93
|
+
* <p>
|
|
94
94
|
* <b>Root</b> – When you specify the root
|
|
95
95
|
* entity and a policy ID, the resulting report lists all of the services that are
|
|
96
96
|
* allowed by the specified SCP. For each service, the report includes data for all
|
|
@@ -100,7 +100,7 @@ export interface GenerateOrganizationsAccessReportCommandOutput extends Generate
|
|
|
100
100
|
* return a list of services with no data.</p>
|
|
101
101
|
* </li>
|
|
102
102
|
* <li>
|
|
103
|
-
*
|
|
103
|
+
* <p>
|
|
104
104
|
* <b>OU</b> – When you specify an OU entity and
|
|
105
105
|
* a policy ID, the resulting report lists all of the services that are allowed by
|
|
106
106
|
* the specified SCP. For each service, the report includes data for all accounts
|
|
@@ -112,7 +112,7 @@ export interface GenerateOrganizationsAccessReportCommandOutput extends Generate
|
|
|
112
112
|
* data.</p>
|
|
113
113
|
* </li>
|
|
114
114
|
* <li>
|
|
115
|
-
*
|
|
115
|
+
* <p>
|
|
116
116
|
* <b>management account</b> – When you specify the
|
|
117
117
|
* management account, the resulting report lists all Amazon Web Services services, because the
|
|
118
118
|
* management account is not limited by SCPs. If you specify a policy ID in the CLI
|
|
@@ -120,7 +120,7 @@ export interface GenerateOrganizationsAccessReportCommandOutput extends Generate
|
|
|
120
120
|
* only the management account.</p>
|
|
121
121
|
* </li>
|
|
122
122
|
* <li>
|
|
123
|
-
*
|
|
123
|
+
* <p>
|
|
124
124
|
* <b>Account</b> – When you specify another
|
|
125
125
|
* account entity and a policy ID, the resulting report lists all of the services
|
|
126
126
|
* that are allowed by the specified SCP. For each service, the report includes
|
|
@@ -130,15 +130,15 @@ export interface GenerateOrganizationsAccessReportCommandOutput extends Generate
|
|
|
130
130
|
* services with no data.</p>
|
|
131
131
|
* </li>
|
|
132
132
|
* </ul>
|
|
133
|
-
*
|
|
133
|
+
* <note>
|
|
134
134
|
* <p>Service last accessed data does not use other policy types when determining
|
|
135
135
|
* whether a principal could access a service. These other policy types include
|
|
136
136
|
* identity-based policies, resource-based policies, access control lists, IAM
|
|
137
137
|
* permissions boundaries, and STS assume role policies. It only applies SCP logic.
|
|
138
138
|
* 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
|
|
139
139
|
* <i>IAM User Guide</i>.</p>
|
|
140
|
-
*
|
|
141
|
-
*
|
|
140
|
+
* </note>
|
|
141
|
+
* <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
|
|
142
142
|
* viewing user activity</a> in the <i>IAM User Guide</i>.</p>
|
|
143
143
|
* @example
|
|
144
144
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -13,7 +13,7 @@ export interface GenerateServiceLastAccessedDetailsCommandOutput extends Generat
|
|
|
13
13
|
* usually appears within four hours. IAM reports activity for at least the last 400
|
|
14
14
|
* days, or less if your Region began supporting this feature within the last year. For
|
|
15
15
|
* 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>
|
|
16
|
-
*
|
|
16
|
+
* <important>
|
|
17
17
|
* <p>The service last accessed data includes all attempts to access an Amazon Web Services API, not
|
|
18
18
|
* just the successful ones. This includes all attempts that were made using the
|
|
19
19
|
* Amazon Web Services Management Console, the Amazon Web Services API through any of the SDKs, or any of the command line tools.
|
|
@@ -23,44 +23,44 @@ export interface GenerateServiceLastAccessedDetailsCommandOutput extends Generat
|
|
|
23
23
|
* 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
|
|
24
24
|
* IAM events with CloudTrail</a> in the
|
|
25
25
|
* <i>IAM User Guide</i>.</p>
|
|
26
|
-
*
|
|
27
|
-
*
|
|
26
|
+
* </important>
|
|
27
|
+
* <p>The <code>GenerateServiceLastAccessedDetails</code> operation returns a
|
|
28
28
|
* <code>JobId</code>. Use this parameter in the following operations to retrieve the
|
|
29
29
|
* following details from your report: </p>
|
|
30
|
-
*
|
|
30
|
+
* <ul>
|
|
31
31
|
* <li>
|
|
32
|
-
*
|
|
32
|
+
* <p>
|
|
33
33
|
* <a>GetServiceLastAccessedDetails</a> – Use this operation
|
|
34
34
|
* for users, groups, roles, or policies to list every Amazon Web Services service that the
|
|
35
35
|
* resource could access using permissions policies. For each service, the response
|
|
36
36
|
* includes information about the most recent access attempt.</p>
|
|
37
|
-
*
|
|
37
|
+
* <p>The <code>JobId</code> returned by
|
|
38
38
|
* <code>GenerateServiceLastAccessedDetail</code> must be used by the same role
|
|
39
39
|
* within a session, or by the same user when used to call
|
|
40
40
|
* <code>GetServiceLastAccessedDetail</code>.</p>
|
|
41
41
|
* </li>
|
|
42
42
|
* <li>
|
|
43
|
-
*
|
|
43
|
+
* <p>
|
|
44
44
|
* <a>GetServiceLastAccessedDetailsWithEntities</a> – Use this
|
|
45
45
|
* operation for groups and policies to list information about the associated
|
|
46
46
|
* entities (users or roles) that attempted to access a specific Amazon Web Services service.
|
|
47
47
|
* </p>
|
|
48
48
|
* </li>
|
|
49
49
|
* </ul>
|
|
50
|
-
*
|
|
50
|
+
* <p>To check the status of the <code>GenerateServiceLastAccessedDetails</code> request,
|
|
51
51
|
* use the <code>JobId</code> parameter in the same operations and test the
|
|
52
52
|
* <code>JobStatus</code> response parameter.</p>
|
|
53
|
-
*
|
|
53
|
+
* <p>For additional information about the permissions policies that allow an identity
|
|
54
54
|
* (user, group, or role) to access specific services, use the <a>ListPoliciesGrantingServiceAccess</a> operation.</p>
|
|
55
|
-
*
|
|
55
|
+
* <note>
|
|
56
56
|
* <p>Service last accessed data does not use other policy types when determining
|
|
57
57
|
* whether a resource could access a service. These other policy types include
|
|
58
58
|
* resource-based policies, access control lists, Organizations policies, IAM permissions
|
|
59
59
|
* boundaries, and STS assume role policies. It only applies permissions policy
|
|
60
60
|
* 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
|
|
61
61
|
* <i>IAM User Guide</i>.</p>
|
|
62
|
-
*
|
|
63
|
-
*
|
|
62
|
+
* </note>
|
|
63
|
+
* <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
|
|
64
64
|
* <i>IAM User Guide</i>.</p>
|
|
65
65
|
* @example
|
|
66
66
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -12,14 +12,14 @@ export interface GetAccountAuthorizationDetailsCommandOutput extends GetAccountA
|
|
|
12
12
|
* account, including their relationships to one another. Use this operation to obtain a
|
|
13
13
|
* snapshot of the configuration of IAM permissions (users, groups, roles, and policies)
|
|
14
14
|
* in your account.</p>
|
|
15
|
-
*
|
|
15
|
+
* <note>
|
|
16
16
|
* <p>Policies returned by this operation are URL-encoded compliant
|
|
17
17
|
* with <a href="https://tools.ietf.org/html/rfc3986">RFC 3986</a>. You can use a URL
|
|
18
18
|
* decoding method to convert the policy back to plain JSON text. For example, if you use Java, you
|
|
19
19
|
* can use the <code>decode</code> method of the <code>java.net.URLDecoder</code> utility class in
|
|
20
20
|
* the Java SDK. Other languages and SDKs provide similar functionality.</p>
|
|
21
21
|
* </note>
|
|
22
|
-
*
|
|
22
|
+
* <p>You can optionally filter the results using the <code>Filter</code> parameter. You can
|
|
23
23
|
* paginate the results using the <code>MaxItems</code> and <code>Marker</code>
|
|
24
24
|
* parameters.</p>
|
|
25
25
|
* @example
|
|
@@ -10,7 +10,7 @@ export interface GetAccountSummaryCommandOutput extends GetAccountSummaryRespons
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Retrieves information about IAM entity usage and IAM quotas in the Amazon Web Services
|
|
12
12
|
* account.</p>
|
|
13
|
-
*
|
|
13
|
+
* <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
|
|
14
14
|
* <i>IAM User Guide</i>.</p>
|
|
15
15
|
* @example
|
|
16
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -11,7 +11,7 @@ export interface GetContextKeysForCustomPolicyCommandOutput extends GetContextKe
|
|
|
11
11
|
* <p>Gets a list of all of the context keys referenced in the input policies. The policies
|
|
12
12
|
* are supplied as a list of one or more strings. To get the context keys from policies
|
|
13
13
|
* associated with an IAM user, group, or role, use <a>GetContextKeysForPrincipalPolicy</a>.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>Context keys are variables maintained by Amazon Web Services and its services that provide details
|
|
15
15
|
* about the context of an API query request. Context keys can be evaluated by testing
|
|
16
16
|
* against a value specified in an IAM policy. Use
|
|
17
17
|
* <code>GetContextKeysForCustomPolicy</code> to understand what key names and values
|
|
@@ -12,14 +12,14 @@ export interface GetContextKeysForPrincipalPolicyCommandOutput extends GetContex
|
|
|
12
12
|
* attached to the specified IAM entity. The entity can be an IAM user, group, or role.
|
|
13
13
|
* If you specify a user, then the request also includes all of the policies attached to
|
|
14
14
|
* groups that the user is a member of.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>You can optionally include a list of one or more additional policies, specified as
|
|
16
16
|
* strings. If you want to include <i>only</i> a list of policies by string,
|
|
17
17
|
* use <a>GetContextKeysForCustomPolicy</a> instead.</p>
|
|
18
|
-
*
|
|
18
|
+
* <p>
|
|
19
19
|
* <b>Note:</b> This operation discloses information about the
|
|
20
20
|
* permissions granted to other users. If you do not want users to see other user's
|
|
21
21
|
* permissions, then consider allowing them to use <a>GetContextKeysForCustomPolicy</a> instead.</p>
|
|
22
|
-
*
|
|
22
|
+
* <p>Context keys are variables maintained by Amazon Web Services and its services that provide details
|
|
23
23
|
* about the context of an API query request. Context keys can be evaluated by testing
|
|
24
24
|
* 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>
|
|
25
25
|
* @example
|
|
@@ -10,18 +10,18 @@ export interface GetGroupPolicyCommandOutput extends GetGroupPolicyResponse, __M
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Retrieves the specified inline policy document that is embedded in the specified IAM
|
|
12
12
|
* group.</p>
|
|
13
|
-
*
|
|
13
|
+
* <note>
|
|
14
14
|
* <p>Policies returned by this operation are URL-encoded compliant
|
|
15
15
|
* with <a href="https://tools.ietf.org/html/rfc3986">RFC 3986</a>. You can use a URL
|
|
16
16
|
* decoding method to convert the policy back to plain JSON text. For example, if you use Java, you
|
|
17
17
|
* can use the <code>decode</code> method of the <code>java.net.URLDecoder</code> utility class in
|
|
18
18
|
* the Java SDK. Other languages and SDKs provide similar functionality.</p>
|
|
19
19
|
* </note>
|
|
20
|
-
*
|
|
20
|
+
* <p>An IAM group can also have managed policies attached to it. To retrieve a managed
|
|
21
21
|
* policy document that is attached to a group, use <a>GetPolicy</a> to
|
|
22
22
|
* determine the policy's default version, then use <a>GetPolicyVersion</a> to
|
|
23
23
|
* retrieve the policy document.</p>
|
|
24
|
-
*
|
|
24
|
+
* <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
|
|
25
25
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
26
26
|
* @example
|
|
27
27
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -12,9 +12,9 @@ export interface GetLoginProfileCommandOutput extends GetLoginProfileResponse, _
|
|
|
12
12
|
* you create a password for the user to access the Amazon Web Services Management Console. If the user does not exist
|
|
13
13
|
* or does not have a password, the operation returns a 404 (<code>NoSuchEntity</code>)
|
|
14
14
|
* error.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>If you create an IAM user with access to the console, the <code>CreateDate</code>
|
|
16
16
|
* reflects the date you created the initial password for the user.</p>
|
|
17
|
-
*
|
|
17
|
+
* <p>If you create an IAM user with programmatic access, and then later add a password
|
|
18
18
|
* for the user to access the Amazon Web Services Management Console, the <code>CreateDate</code> reflects the initial
|
|
19
19
|
* password creation date. A user with programmatic access does not have a login profile
|
|
20
20
|
* unless you create a password for the user to access the Amazon Web Services Management Console.</p>
|
|
@@ -14,19 +14,19 @@ export interface GetOrganizationsAccessReportCommandOutput extends GetOrganizati
|
|
|
14
14
|
* </code>
|
|
15
15
|
* operation. This operation retrieves the status of your report job and the report
|
|
16
16
|
* contents.</p>
|
|
17
|
-
*
|
|
17
|
+
* <p>Depending on the parameters that you passed when you generated the report, the data
|
|
18
18
|
* returned could include different information. For details, see <a>GenerateOrganizationsAccessReport</a>.</p>
|
|
19
|
-
*
|
|
19
|
+
* <p>To call this operation, you must be signed in to the management account in your
|
|
20
20
|
* organization. SCPs must be enabled for your organization root. You must have permissions
|
|
21
21
|
* 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
|
|
22
22
|
* service last accessed data</a> in the
|
|
23
23
|
* <i>IAM User Guide</i>.</p>
|
|
24
|
-
*
|
|
24
|
+
* <p>For each service that principals in an account (root users, IAM users, or IAM
|
|
25
25
|
* roles) could access using SCPs, the operation returns details about the most recent
|
|
26
26
|
* access attempt. If there was no attempt, the service is listed without details about the
|
|
27
27
|
* most recent attempt to access the service. If the operation fails, it returns the reason
|
|
28
28
|
* that it failed.</p>
|
|
29
|
-
*
|
|
29
|
+
* <p>By default, the list is sorted by service namespace.</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
32
|
* ```javascript
|
|
@@ -14,9 +14,9 @@ export interface GetPolicyCommandOutput extends GetPolicyResponse, __MetadataBea
|
|
|
14
14
|
* the policy is attached to, use <a>ListEntitiesForPolicy</a>. This operation
|
|
15
15
|
* returns metadata about the policy. To retrieve the actual policy document for a specific
|
|
16
16
|
* version of the policy, use <a>GetPolicyVersion</a>.</p>
|
|
17
|
-
*
|
|
17
|
+
* <p>This operation retrieves information about managed policies. To retrieve information
|
|
18
18
|
* 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>
|
|
19
|
-
*
|
|
19
|
+
* <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
|
|
20
20
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
21
21
|
* @example
|
|
22
22
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -10,19 +10,19 @@ export interface GetPolicyVersionCommandOutput extends GetPolicyVersionResponse,
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Retrieves information about the specified version of the specified managed policy,
|
|
12
12
|
* including the policy document.</p>
|
|
13
|
-
*
|
|
13
|
+
* <note>
|
|
14
14
|
* <p>Policies returned by this operation are URL-encoded compliant
|
|
15
15
|
* with <a href="https://tools.ietf.org/html/rfc3986">RFC 3986</a>. You can use a URL
|
|
16
16
|
* decoding method to convert the policy back to plain JSON text. For example, if you use Java, you
|
|
17
17
|
* can use the <code>decode</code> method of the <code>java.net.URLDecoder</code> utility class in
|
|
18
18
|
* the Java SDK. Other languages and SDKs provide similar functionality.</p>
|
|
19
19
|
* </note>
|
|
20
|
-
*
|
|
21
|
-
*
|
|
20
|
+
* <p>To list the available versions for a policy, use <a>ListPolicyVersions</a>.</p>
|
|
21
|
+
* <p>This operation retrieves information about managed policies. To retrieve information
|
|
22
22
|
* 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>
|
|
23
|
-
*
|
|
23
|
+
* <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
|
|
24
24
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
25
|
-
*
|
|
25
|
+
* <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
|
|
26
26
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
27
27
|
* @example
|
|
28
28
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -11,7 +11,7 @@ export interface GetRoleCommandOutput extends GetRoleResponse, __MetadataBearer
|
|
|
11
11
|
* <p>Retrieves information about the specified role, including the role's path, GUID, ARN,
|
|
12
12
|
* and the role's trust policy that grants permission to assume the role. For more
|
|
13
13
|
* information about roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with roles</a>.</p>
|
|
14
|
-
*
|
|
14
|
+
* <note>
|
|
15
15
|
* <p>Policies returned by this operation are URL-encoded compliant
|
|
16
16
|
* with <a href="https://tools.ietf.org/html/rfc3986">RFC 3986</a>. You can use a URL
|
|
17
17
|
* decoding method to convert the policy back to plain JSON text. For example, if you use Java, you
|
|
@@ -10,20 +10,20 @@ export interface GetRolePolicyCommandOutput extends GetRolePolicyResponse, __Met
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Retrieves the specified inline policy document that is embedded with the specified
|
|
12
12
|
* IAM role.</p>
|
|
13
|
-
*
|
|
13
|
+
* <note>
|
|
14
14
|
* <p>Policies returned by this operation are URL-encoded compliant
|
|
15
15
|
* with <a href="https://tools.ietf.org/html/rfc3986">RFC 3986</a>. You can use a URL
|
|
16
16
|
* decoding method to convert the policy back to plain JSON text. For example, if you use Java, you
|
|
17
17
|
* can use the <code>decode</code> method of the <code>java.net.URLDecoder</code> utility class in
|
|
18
18
|
* the Java SDK. Other languages and SDKs provide similar functionality.</p>
|
|
19
19
|
* </note>
|
|
20
|
-
*
|
|
20
|
+
* <p>An IAM role can also have managed policies attached to it. To retrieve a managed
|
|
21
21
|
* policy document that is attached to a role, use <a>GetPolicy</a> to determine
|
|
22
22
|
* the policy's default version, then use <a>GetPolicyVersion</a> to retrieve
|
|
23
23
|
* the policy document.</p>
|
|
24
|
-
*
|
|
24
|
+
* <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
|
|
25
25
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
26
|
-
*
|
|
26
|
+
* <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
|
|
27
27
|
* federate identities</a>.</p>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -10,9 +10,9 @@ export interface GetSAMLProviderCommandOutput extends GetSAMLProviderResponse, _
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Returns the SAML provider metadocument that was uploaded when the IAM SAML provider
|
|
12
12
|
* resource object was created or updated.</p>
|
|
13
|
-
*
|
|
13
|
+
* <note>
|
|
14
14
|
* <p>This operation requires <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>.</p>
|
|
15
|
-
*
|
|
15
|
+
* </note>
|
|
16
16
|
* @example
|
|
17
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
18
18
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface GetSSHPublicKeyCommandOutput extends GetSSHPublicKeyResponse, _
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Retrieves the specified SSH public key, including metadata about the key.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>The SSH public key retrieved by this operation is used only for authenticating the
|
|
13
13
|
* associated IAM user to an CodeCommit repository. For more information about using SSH keys
|
|
14
14
|
* 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
|
|
15
15
|
* connections</a> in the <i>CodeCommit User Guide</i>.</p>
|
|
@@ -9,7 +9,7 @@ export interface GetServerCertificateCommandOutput extends GetServerCertificateR
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Retrieves information about the specified server certificate stored in IAM.</p>
|
|
12
|
-
*
|
|
12
|
+
* <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
|
|
13
13
|
* with server certificates</a> in the <i>IAM User Guide</i>. This
|
|
14
14
|
* topic includes a list of Amazon Web Services services that can use the server certificates that you
|
|
15
15
|
* manage with IAM.</p>
|