Skip to content

Commit d4422ff

Browse files
author
awstools
committed
docs(client-iam): Documentation updates for the AWS Identity and Access Management API Reference.
1 parent 8e266f0 commit d4422ff

File tree

4 files changed

+749
-536
lines changed

4 files changed

+749
-536
lines changed

clients/client-iam/src/IAM.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1792,18 +1792,18 @@ export class IAM extends IAMClient {
17921792
}
17931793

17941794
/**
1795-
* <p>Deletes the password for the specified IAM user, which terminates the user's ability
1796-
* to access Amazon Web Services services through the Amazon Web Services Management Console.</p>
1795+
* <p>Deletes the password for the specified IAM user, For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_passwords_admin-change-user.html">Managing
1796+
* passwords for IAM users</a>.</p>
17971797
* <p>You can use the CLI, the Amazon Web Services API, or the <b>Users</b>
17981798
* page in the IAM console to delete a password for any IAM user. You can use <a>ChangePassword</a> to update, but not delete, your own password in the
17991799
* <b>My Security Credentials</b> page in the
18001800
* Amazon Web Services Management Console.</p>
18011801
* <important>
1802-
* <p> Deleting a user's password does not prevent a user from accessing Amazon Web Services through
1802+
* <p>Deleting a user's password does not prevent a user from accessing Amazon Web Services through
18031803
* the command line interface or the API. To prevent all user access, you must also
18041804
* either make any access keys inactive or delete them. For more information about
18051805
* making keys inactive or deleting them, see <a>UpdateAccessKey</a> and
1806-
* <a>DeleteAccessKey</a>. </p>
1806+
* <a>DeleteAccessKey</a>.</p>
18071807
* </important>
18081808
*/
18091809
public deleteLoginProfile(

clients/client-iam/src/commands/DeleteLoginProfileCommand.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,18 @@ export interface DeleteLoginProfileCommandInput extends DeleteLoginProfileReques
2323
export interface DeleteLoginProfileCommandOutput extends __MetadataBearer {}
2424

2525
/**
26-
* <p>Deletes the password for the specified IAM user, which terminates the user's ability
27-
* to access Amazon Web Services services through the Amazon Web Services Management Console.</p>
26+
* <p>Deletes the password for the specified IAM user, For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_passwords_admin-change-user.html">Managing
27+
* passwords for IAM users</a>.</p>
2828
* <p>You can use the CLI, the Amazon Web Services API, or the <b>Users</b>
2929
* page in the IAM console to delete a password for any IAM user. You can use <a>ChangePassword</a> to update, but not delete, your own password in the
3030
* <b>My Security Credentials</b> page in the
3131
* Amazon Web Services Management Console.</p>
3232
* <important>
33-
* <p> Deleting a user's password does not prevent a user from accessing Amazon Web Services through
33+
* <p>Deleting a user's password does not prevent a user from accessing Amazon Web Services through
3434
* the command line interface or the API. To prevent all user access, you must also
3535
* either make any access keys inactive or delete them. For more information about
3636
* making keys inactive or deleting them, see <a>UpdateAccessKey</a> and
37-
* <a>DeleteAccessKey</a>. </p>
37+
* <a>DeleteAccessKey</a>.</p>
3838
* </important>
3939
* @example
4040
* Use a bare-bones client and the command you need to make an API call.

clients/client-iam/src/models/models_0.ts

Lines changed: 65 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ export interface AccessDetail {
3434
/**
3535
* <p>The Region where the last service access attempt occurred.</p>
3636
* <p>This field is null if no principals in the reported Organizations entity attempted to access the
37-
* service within the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period">reporting period</a>.</p>
37+
* service within the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period">tracking period</a>.</p>
3838
*/
3939
Region?: string;
4040

@@ -43,7 +43,7 @@ export interface AccessDetail {
4343
* authenticated principal last attempted to access the service. Amazon Web Services does not report
4444
* unauthenticated requests.</p>
4545
* <p>This field is null if no principals (IAM users, IAM roles, or root users) in the
46-
* reported Organizations entity attempted to access the service within the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period">reporting period</a>.</p>
46+
* reported Organizations entity attempted to access the service within the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period">tracking period</a>.</p>
4747
*/
4848
EntityPath?: string;
4949

@@ -52,18 +52,21 @@ export interface AccessDetail {
5252
* format</a>, when an authenticated principal most recently attempted to access the
5353
* service. Amazon Web Services does not report unauthenticated requests.</p>
5454
* <p>This field is null if no principals in the reported Organizations entity attempted to access the
55-
* service within the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period">reporting period</a>.</p>
55+
* service within the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period">tracking period</a>.</p>
5656
*/
5757
LastAuthenticatedTime?: Date;
5858

5959
/**
6060
* <p>The number of accounts with authenticated principals (root users, IAM users, and IAM
61-
* roles) that attempted to access the service in the reporting period.</p>
61+
* roles) that attempted to access the service in the tracking period.</p>
6262
*/
6363
TotalAuthenticatedEntities?: number;
6464
}
6565

66-
export type StatusType = "Active" | "Inactive";
66+
export enum StatusType {
67+
Active = "Active",
68+
Inactive = "Inactive",
69+
}
6770

6871
/**
6972
* <p>Contains information about an Amazon Web Services access key.</p>
@@ -363,7 +366,11 @@ export interface AddUserToGroupRequest {
363366
UserName: string | undefined;
364367
}
365368

366-
export type AssignmentStatusType = "Any" | "Assigned" | "Unassigned";
369+
export enum AssignmentStatusType {
370+
Any = "Any",
371+
Assigned = "Assigned",
372+
Unassigned = "Unassigned",
373+
}
367374

368375
export enum PermissionsBoundaryAttachmentType {
369376
Policy = "PermissionsBoundaryPolicy",
@@ -2867,33 +2874,34 @@ export interface GetAccountPasswordPolicyResponse {
28672874
PasswordPolicy: PasswordPolicy | undefined;
28682875
}
28692876

2870-
export type SummaryKeyType =
2871-
| "AccessKeysPerUserQuota"
2872-
| "AccountAccessKeysPresent"
2873-
| "AccountMFAEnabled"
2874-
| "AccountSigningCertificatesPresent"
2875-
| "AttachedPoliciesPerGroupQuota"
2876-
| "AttachedPoliciesPerRoleQuota"
2877-
| "AttachedPoliciesPerUserQuota"
2878-
| "GlobalEndpointTokenVersion"
2879-
| "GroupPolicySizeQuota"
2880-
| "Groups"
2881-
| "GroupsPerUserQuota"
2882-
| "GroupsQuota"
2883-
| "MFADevices"
2884-
| "MFADevicesInUse"
2885-
| "Policies"
2886-
| "PoliciesQuota"
2887-
| "PolicySizeQuota"
2888-
| "PolicyVersionsInUse"
2889-
| "PolicyVersionsInUseQuota"
2890-
| "ServerCertificates"
2891-
| "ServerCertificatesQuota"
2892-
| "SigningCertificatesPerUserQuota"
2893-
| "UserPolicySizeQuota"
2894-
| "Users"
2895-
| "UsersQuota"
2896-
| "VersionsPerPolicyQuota";
2877+
export enum SummaryKeyType {
2878+
AccessKeysPerUserQuota = "AccessKeysPerUserQuota",
2879+
AccountAccessKeysPresent = "AccountAccessKeysPresent",
2880+
AccountMFAEnabled = "AccountMFAEnabled",
2881+
AccountSigningCertificatesPresent = "AccountSigningCertificatesPresent",
2882+
AttachedPoliciesPerGroupQuota = "AttachedPoliciesPerGroupQuota",
2883+
AttachedPoliciesPerRoleQuota = "AttachedPoliciesPerRoleQuota",
2884+
AttachedPoliciesPerUserQuota = "AttachedPoliciesPerUserQuota",
2885+
GlobalEndpointTokenVersion = "GlobalEndpointTokenVersion",
2886+
GroupPolicySizeQuota = "GroupPolicySizeQuota",
2887+
Groups = "Groups",
2888+
GroupsPerUserQuota = "GroupsPerUserQuota",
2889+
GroupsQuota = "GroupsQuota",
2890+
MFADevices = "MFADevices",
2891+
MFADevicesInUse = "MFADevicesInUse",
2892+
Policies = "Policies",
2893+
PoliciesQuota = "PoliciesQuota",
2894+
PolicySizeQuota = "PolicySizeQuota",
2895+
PolicyVersionsInUse = "PolicyVersionsInUse",
2896+
PolicyVersionsInUseQuota = "PolicyVersionsInUseQuota",
2897+
ServerCertificates = "ServerCertificates",
2898+
ServerCertificatesQuota = "ServerCertificatesQuota",
2899+
SigningCertificatesPerUserQuota = "SigningCertificatesPerUserQuota",
2900+
UserPolicySizeQuota = "UserPolicySizeQuota",
2901+
Users = "Users",
2902+
UsersQuota = "UsersQuota",
2903+
VersionsPerPolicyQuota = "VersionsPerPolicyQuota",
2904+
}
28972905

28982906
/**
28992907
* <p>Contains the response to a successful <a>GetAccountSummary</a> request.
@@ -3039,7 +3047,9 @@ export class CredentialReportNotReadyException extends __BaseException {
30393047
}
30403048
}
30413049

3042-
export type ReportFormatType = "text/csv";
3050+
export enum ReportFormatType {
3051+
text_csv = "text/csv",
3052+
}
30433053

30443054
/**
30453055
* <p>Contains the response to a successful <a>GetCredentialReport</a> request.
@@ -3308,7 +3318,11 @@ export interface ErrorDetails {
33083318
Code: string | undefined;
33093319
}
33103320

3311-
export type JobStatusType = "COMPLETED" | "FAILED" | "IN_PROGRESS";
3321+
export enum JobStatusType {
3322+
COMPLETED = "COMPLETED",
3323+
FAILED = "FAILED",
3324+
IN_PROGRESS = "IN_PROGRESS",
3325+
}
33123326

33133327
export interface GetOrganizationsAccessReportResponse {
33143328
/**
@@ -3659,15 +3673,15 @@ export interface TrackedActionLastAccessed {
36593673
* format</a>, when an authenticated entity most recently attempted to access the
36603674
* tracked service. Amazon Web Services does not report unauthenticated requests.</p>
36613675
* <p>This field is null if no IAM entities attempted to access the service within the
3662-
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period">reporting period</a>.</p>
3676+
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period">tracking period</a>.</p>
36633677
*/
36643678
LastAccessedTime?: Date;
36653679

36663680
/**
36673681
* <p>The Region from which the authenticated entity (user or role) last attempted to access
36683682
* the tracked action. Amazon Web Services does not report unauthenticated requests.</p>
36693683
* <p>This field is null if no IAM entities attempted to access the service within the
3670-
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period">reporting period</a>.</p>
3684+
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period">tracking period</a>.</p>
36713685
*/
36723686
LastAccessedRegion?: string;
36733687
}
@@ -3687,7 +3701,7 @@ export interface ServiceLastAccessed {
36873701
* format</a>, when an authenticated entity most recently attempted to access the
36883702
* service. Amazon Web Services does not report unauthenticated requests.</p>
36893703
* <p>This field is null if no IAM entities attempted to access the service within the
3690-
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period">reporting period</a>.</p>
3704+
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period">tracking period</a>.</p>
36913705
*/
36923706
LastAuthenticated?: Date;
36933707

@@ -3706,30 +3720,30 @@ export interface ServiceLastAccessed {
37063720
* <p>The ARN of the authenticated entity (user or role) that last attempted to access the
37073721
* service. Amazon Web Services does not report unauthenticated requests.</p>
37083722
* <p>This field is null if no IAM entities attempted to access the service within the
3709-
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period">reporting period</a>.</p>
3723+
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period">tracking period</a>.</p>
37103724
*/
37113725
LastAuthenticatedEntity?: string;
37123726

37133727
/**
37143728
* <p>The Region from which the authenticated entity (user or role) last attempted to access
37153729
* the service. Amazon Web Services does not report unauthenticated requests.</p>
37163730
* <p>This field is null if no IAM entities attempted to access the service within the
3717-
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period">reporting period</a>.</p>
3731+
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period">tracking period</a>.</p>
37183732
*/
37193733
LastAuthenticatedRegion?: string;
37203734

37213735
/**
37223736
* <p>The total number of authenticated principals (root user, IAM users, or IAM roles)
37233737
* that have attempted to access the service.</p>
3724-
* <p>This field is null if no principals attempted to access the service within the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period">reporting period</a>.</p>
3738+
* <p>This field is null if no principals attempted to access the service within the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period">tracking period</a>.</p>
37253739
*/
37263740
TotalAuthenticatedEntities?: number;
37273741

37283742
/**
37293743
* <p>An object that contains details about the most recent attempt to access a tracked action
37303744
* within the service.</p>
37313745
* <p>This field is null if there no tracked actions or if the principal did not use the
3732-
* tracked actions within the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period">reporting period</a>. This field is also null if the report was generated at the
3746+
* tracked actions within the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period">tracking period</a>. This field is also null if the report was generated at the
37333747
* service level and not the action level. For more information, see the
37343748
* <code>Granularity</code> field in <a>GenerateServiceLastAccessedDetails</a>.</p>
37353749
*/
@@ -3889,7 +3903,7 @@ export interface EntityDetails {
38893903
* format</a>, when the authenticated entity last attempted to access Amazon Web Services. Amazon Web Services does
38903904
* not report unauthenticated requests.</p>
38913905
* <p>This field is null if no IAM entities attempted to access the service within the
3892-
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period">reporting period</a>.</p>
3906+
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period">tracking period</a>.</p>
38933907
*/
38943908
LastAuthenticated?: Date;
38953909
}
@@ -4009,7 +4023,10 @@ export interface GetServiceLinkedRoleDeletionStatusResponse {
40094023
Reason?: DeletionTaskFailureReasonType;
40104024
}
40114025

4012-
export type EncodingType = "PEM" | "SSH";
4026+
export enum EncodingType {
4027+
PEM = "PEM",
4028+
SSH = "SSH",
4029+
}
40134030

40144031
export interface GetSSHPublicKeyRequest {
40154032
/**
@@ -4490,7 +4507,10 @@ export interface ListAttachedUserPoliciesResponse {
44904507
Marker?: string;
44914508
}
44924509

4493-
export type PolicyUsageType = "PermissionsBoundary" | "PermissionsPolicy";
4510+
export enum PolicyUsageType {
4511+
PermissionsBoundary = "PermissionsBoundary",
4512+
PermissionsPolicy = "PermissionsPolicy",
4513+
}
44944514

44954515
export interface ListEntitiesForPolicyRequest {
44964516
/**

0 commit comments

Comments
 (0)