@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
|
@@ -10,7 +10,7 @@ export interface AddClientIDToOpenIDConnectProviderCommandOutput extends __Metad
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Adds a new client ID (also known as audience) to the list of client IDs already
|
|
12
12
|
* registered for the specified IAM OpenID Connect (OIDC) provider resource.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>This operation is idempotent; it does not fail or return an error if you add an
|
|
14
14
|
* existing client ID to the provider.</p>
|
|
15
15
|
* @example
|
|
16
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -14,11 +14,11 @@ export interface AddRoleToInstanceProfileCommandOutput extends __MetadataBearer
|
|
|
14
14
|
* for the change to appear across all of Amazon Web Services because of <a href="https://en.wikipedia.org/wiki/Eventual_consistency">eventual
|
|
15
15
|
* consistency</a>. To force the change, you must <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DisassociateIamInstanceProfile.html">disassociate the instance profile</a> and then <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_AssociateIamInstanceProfile.html">associate the
|
|
16
16
|
* instance profile</a>, or you can stop your instance and then restart it.</p>
|
|
17
|
-
*
|
|
17
|
+
* <note>
|
|
18
18
|
* <p>The caller of this operation must be granted the <code>PassRole</code> permission
|
|
19
19
|
* on the IAM role by a permissions policy.</p>
|
|
20
|
-
*
|
|
21
|
-
*
|
|
20
|
+
* </note>
|
|
21
|
+
* <p>For more information about roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with roles</a>. For more
|
|
22
22
|
* information about instance profiles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About instance
|
|
23
23
|
* profiles</a>.</p>
|
|
24
24
|
* @example
|
|
@@ -9,12 +9,12 @@ export interface AttachGroupPolicyCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Attaches the specified managed policy to the specified IAM group.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>You use this operation to attach a managed policy to a group. To embed an inline
|
|
13
13
|
* policy in a group, use <a>PutGroupPolicy</a>.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>As a best practice, you can validate your IAM policies.
|
|
15
15
|
* To learn more, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html">Validating IAM policies</a>
|
|
16
16
|
* in the <i>IAM User Guide</i>.</p>
|
|
17
|
-
*
|
|
17
|
+
* <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
|
|
18
18
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
19
19
|
* @example
|
|
20
20
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -11,16 +11,16 @@ export interface AttachRolePolicyCommandOutput extends __MetadataBearer {
|
|
|
11
11
|
* <p>Attaches the specified managed policy to the specified IAM role. When you attach a
|
|
12
12
|
* managed policy to a role, the managed policy becomes part of the role's permission
|
|
13
13
|
* (access) policy.</p>
|
|
14
|
-
*
|
|
14
|
+
* <note>
|
|
15
15
|
* <p>You cannot use a managed policy as the role's trust policy. The role's trust
|
|
16
16
|
* policy is created at the same time as the role, using <a>CreateRole</a>.
|
|
17
17
|
* You can update a role's trust policy using <a>UpdateAssumeRolePolicy</a>.</p>
|
|
18
|
-
*
|
|
19
|
-
*
|
|
18
|
+
* </note>
|
|
19
|
+
* <p>Use this operation to attach a <i>managed</i> policy to a role. To embed
|
|
20
20
|
* an inline policy in a role, use <a>PutRolePolicy</a>. For more information
|
|
21
21
|
* about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline
|
|
22
22
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
23
|
-
*
|
|
23
|
+
* <p>As a best practice, you can validate your IAM policies.
|
|
24
24
|
* To learn more, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html">Validating IAM policies</a>
|
|
25
25
|
* in the <i>IAM User Guide</i>.</p>
|
|
26
26
|
* @example
|
|
@@ -9,12 +9,12 @@ export interface AttachUserPolicyCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Attaches the specified managed policy to the specified user.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>You use this operation to attach a <i>managed</i> policy to a user. To
|
|
13
13
|
* embed an inline policy in a user, use <a>PutUserPolicy</a>.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>As a best practice, you can validate your IAM policies.
|
|
15
15
|
* To learn more, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html">Validating IAM policies</a>
|
|
16
16
|
* in the <i>IAM User Guide</i>.</p>
|
|
17
|
-
*
|
|
17
|
+
* <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
|
|
18
18
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
19
19
|
* @example
|
|
20
20
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -12,7 +12,7 @@ export interface ChangePasswordCommandOutput extends __MetadataBearer {
|
|
|
12
12
|
* can be performed using the CLI, the Amazon Web Services API, or the <b>My
|
|
13
13
|
* Security Credentials</b> page in the Amazon Web Services Management Console. The Amazon Web Services account root user
|
|
14
14
|
* password is not affected by this operation.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>Use <a>UpdateLoginProfile</a> to use the CLI, the Amazon Web Services API, or the
|
|
16
16
|
* <b>Users</b> page in the IAM console to change the
|
|
17
17
|
* password for any IAM user. For more information about modifying passwords, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html">Managing
|
|
18
18
|
* passwords</a> in the <i>IAM User Guide</i>.</p>
|
|
@@ -10,18 +10,18 @@ export interface CreateAccessKeyCommandOutput extends CreateAccessKeyResponse, _
|
|
|
10
10
|
/**
|
|
11
11
|
* <p> Creates a new Amazon Web Services secret access key and corresponding Amazon Web Services access key ID for the
|
|
12
12
|
* specified user. The default status for new keys is <code>Active</code>.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>If you do not specify a user name, IAM determines the user name implicitly based on
|
|
14
14
|
* the Amazon Web Services access key ID signing the request. This operation works for access keys under
|
|
15
15
|
* the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root
|
|
16
16
|
* user credentials. This is true even if the Amazon Web Services account has no associated users.</p>
|
|
17
|
-
*
|
|
17
|
+
* <p> For information about quotas on the number of keys you can create, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS
|
|
18
18
|
* quotas</a> in the <i>IAM User Guide</i>.</p>
|
|
19
|
-
*
|
|
19
|
+
* <important>
|
|
20
20
|
* <p>To ensure the security of your Amazon Web Services account, the secret access key is accessible
|
|
21
21
|
* only during key and user creation. You must save the key (for example, in a text
|
|
22
22
|
* file) if you want to be able to access it again. If a secret key is lost, you can
|
|
23
23
|
* delete the access keys for the associated user and then create new keys.</p>
|
|
24
|
-
*
|
|
24
|
+
* </important>
|
|
25
25
|
* @example
|
|
26
26
|
* Use a bare-bones client and the command you need to make an API call.
|
|
27
27
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface CreateGroupCommandOutput extends CreateGroupResponse, __Metadat
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates a new group.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p> For information about the number of groups you can create, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS
|
|
13
13
|
* quotas</a> in the <i>IAM User Guide</i>.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -11,7 +11,7 @@ export interface CreateInstanceProfileCommandOutput extends CreateInstanceProfil
|
|
|
11
11
|
* <p> Creates a new instance profile. For information about instance profiles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html">Using
|
|
12
12
|
* roles for applications on Amazon EC2</a> in the
|
|
13
13
|
* <i>IAM User Guide</i>, and <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html#ec2-instance-profile">Instance profiles</a> in the <i>Amazon EC2 User Guide</i>.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p> For information about the number of instance profiles you can create, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM object
|
|
15
15
|
* quotas</a> in the <i>IAM User Guide</i>.</p>
|
|
16
16
|
* @example
|
|
17
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -10,9 +10,9 @@ export interface CreateLoginProfileCommandOutput extends CreateLoginProfileRespo
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates a password for the specified IAM user. A password allows an IAM user to
|
|
12
12
|
* access Amazon Web Services services through the Amazon Web Services Management Console.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>You can use the CLI, the Amazon Web Services API, or the <b>Users</b>
|
|
14
14
|
* page in the IAM console to create a password for any IAM user. Use <a>ChangePassword</a> to update your own existing password in the <b>My Security Credentials</b> page in the Amazon Web Services Management Console.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>For more information about managing passwords, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html">Managing passwords</a> in the
|
|
16
16
|
* <i>IAM User Guide</i>.</p>
|
|
17
17
|
* @example
|
|
18
18
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,43 +9,44 @@ export interface CreateOpenIDConnectProviderCommandOutput extends CreateOpenIDCo
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates an IAM entity to describe an identity provider (IdP) that supports <a href="http://openid.net/connect/">OpenID Connect (OIDC)</a>.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>The OIDC provider that you create with this operation can be used as a principal in a
|
|
13
13
|
* role's trust policy. Such a policy establishes a trust relationship between Amazon Web Services and
|
|
14
14
|
* the OIDC provider.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>If you are using an OIDC identity provider from Google, Facebook, or Amazon Cognito, you don't
|
|
16
16
|
* need to create a separate IAM identity provider. These OIDC identity providers are
|
|
17
17
|
* already built-in to Amazon Web Services and are available for your use. Instead, you can move directly
|
|
18
18
|
* to creating new roles using your identity provider. To learn more, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-idp_oidc.html">Creating
|
|
19
19
|
* a role for web identity or OpenID connect federation</a> in the <i>IAM
|
|
20
20
|
* User Guide</i>.</p>
|
|
21
|
-
*
|
|
22
|
-
*
|
|
21
|
+
* <p>When you create the IAM OIDC provider, you specify the following:</p>
|
|
22
|
+
* <ul>
|
|
23
23
|
* <li>
|
|
24
|
-
*
|
|
24
|
+
* <p>The URL of the OIDC identity provider (IdP) to trust</p>
|
|
25
25
|
* </li>
|
|
26
26
|
* <li>
|
|
27
|
-
*
|
|
27
|
+
* <p>A list of client IDs (also known as audiences) that identify the application
|
|
28
28
|
* or applications allowed to authenticate using the OIDC provider</p>
|
|
29
29
|
* </li>
|
|
30
30
|
* <li>
|
|
31
|
-
*
|
|
31
|
+
* <p>A list of thumbprints of one or more server certificates that the IdP
|
|
32
32
|
* uses</p>
|
|
33
33
|
* </li>
|
|
34
34
|
* </ul>
|
|
35
|
-
*
|
|
35
|
+
* <p>You get all of this information from the OIDC IdP you want to use to access
|
|
36
36
|
* Amazon Web Services.</p>
|
|
37
|
-
*
|
|
37
|
+
* <note>
|
|
38
38
|
* <p>Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our
|
|
39
39
|
* library of trusted certificate authorities (CAs) instead of using a certificate
|
|
40
|
-
* thumbprint to verify your IdP server certificate. These OIDC IdPs include Google,
|
|
41
|
-
* those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these
|
|
42
|
-
* cases, your legacy thumbprint remains in your configuration, but is no longer used for
|
|
40
|
+
* thumbprint to verify your IdP server certificate. These OIDC IdPs include Google, Auth0,
|
|
41
|
+
* and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these
|
|
42
|
+
* cases, your legacy thumbprint remains in your configuration, but is no longer used for
|
|
43
|
+
* validation.</p>
|
|
43
44
|
* </note>
|
|
44
|
-
*
|
|
45
|
+
* <note>
|
|
45
46
|
* <p>The trust for the OIDC provider is derived from the IAM provider that this
|
|
46
47
|
* operation creates. Therefore, it is best to limit access to the <a>CreateOpenIDConnectProvider</a> operation to highly privileged
|
|
47
48
|
* users.</p>
|
|
48
|
-
*
|
|
49
|
+
* </note>
|
|
49
50
|
* @example
|
|
50
51
|
* Use a bare-bones client and the command you need to make an API call.
|
|
51
52
|
* ```javascript
|
|
@@ -9,14 +9,14 @@ export interface CreatePolicyCommandOutput extends CreatePolicyResponse, __Metad
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates a new managed policy for your Amazon Web Services account.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>This operation creates a policy version with a version identifier of <code>v1</code>
|
|
13
13
|
* and sets v1 as the policy's default version. For more information about policy versions,
|
|
14
14
|
* see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html">Versioning for managed policies</a> in the
|
|
15
15
|
* <i>IAM User Guide</i>.</p>
|
|
16
|
-
*
|
|
16
|
+
* <p>As a best practice, you can validate your IAM policies.
|
|
17
17
|
* To learn more, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html">Validating IAM policies</a>
|
|
18
18
|
* in the <i>IAM User Guide</i>.</p>
|
|
19
|
-
*
|
|
19
|
+
* <p>For more information about managed policies in general, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed
|
|
20
20
|
* policies and inline policies</a> in the
|
|
21
21
|
* <i>IAM User Guide</i>.</p>
|
|
22
22
|
* @example
|
|
@@ -11,10 +11,10 @@ export interface CreatePolicyVersionCommandOutput extends CreatePolicyVersionRes
|
|
|
11
11
|
* <p>Creates a new version of the specified managed policy. To update a managed policy, you
|
|
12
12
|
* create a new policy version. A managed policy can have up to five versions. If the
|
|
13
13
|
* policy has five versions, you must delete an existing version using <a>DeletePolicyVersion</a> before you create a new version.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>Optionally, you can set the new version as the policy's default version. The default
|
|
15
15
|
* version is the version that is in effect for the IAM users, groups, and roles to which
|
|
16
16
|
* the policy is attached.</p>
|
|
17
|
-
*
|
|
17
|
+
* <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
|
|
18
18
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
19
19
|
* @example
|
|
20
20
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -10,20 +10,20 @@ export interface CreateSAMLProviderCommandOutput extends CreateSAMLProviderRespo
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates an IAM resource that describes an identity provider (IdP) that supports SAML
|
|
12
12
|
* 2.0.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>The SAML provider resource that you create with this operation can be used as a
|
|
14
14
|
* principal in an IAM role's trust policy. Such a policy can enable federated users who
|
|
15
15
|
* sign in using the SAML IdP to assume the role. You can create an IAM role that
|
|
16
16
|
* supports Web-based single sign-on (SSO) to the Amazon Web Services Management Console or one that supports API access
|
|
17
17
|
* to Amazon Web Services.</p>
|
|
18
|
-
*
|
|
18
|
+
* <p>When you create the SAML provider resource, you upload a SAML metadata document that
|
|
19
19
|
* you get from your IdP. That document includes the issuer's name, expiration information,
|
|
20
20
|
* and keys that can be used to validate the SAML authentication response (assertions) that
|
|
21
21
|
* the IdP sends. You must generate the metadata document using the identity management
|
|
22
22
|
* software that is used as your organization's IdP.</p>
|
|
23
|
-
*
|
|
23
|
+
* <note>
|
|
24
24
|
* <p> This operation requires <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>.</p>
|
|
25
|
-
*
|
|
26
|
-
*
|
|
25
|
+
* </note>
|
|
26
|
+
* <p> For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-saml.html">Enabling SAML 2.0
|
|
27
27
|
* federated users to access the Amazon Web Services Management Console</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html">About SAML 2.0-based
|
|
28
28
|
* federation</a> in the <i>IAM User Guide</i>.</p>
|
|
29
29
|
* @example
|
|
@@ -15,7 +15,7 @@ export interface CreateServiceLinkedRoleCommandOutput extends CreateServiceLinke
|
|
|
15
15
|
* improve service stability and proper cleanup when a service and its role are no longer
|
|
16
16
|
* needed. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html">Using service-linked
|
|
17
17
|
* roles</a> in the <i>IAM User Guide</i>. </p>
|
|
18
|
-
*
|
|
18
|
+
* <p>To attach a policy to this service-linked role, you must make the request using the
|
|
19
19
|
* Amazon Web Services service that depends on this role.</p>
|
|
20
20
|
* @example
|
|
21
21
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -11,12 +11,12 @@ export interface CreateServiceSpecificCredentialCommandOutput extends CreateServ
|
|
|
11
11
|
* <p>Generates a set of credentials consisting of a user name and password that can be used
|
|
12
12
|
* to access the service specified in the request. These credentials are generated by
|
|
13
13
|
* IAM, and can be used only for the specified service. </p>
|
|
14
|
-
*
|
|
14
|
+
* <p>You can have a maximum of two sets of service-specific credentials for each supported
|
|
15
15
|
* service per user.</p>
|
|
16
|
-
*
|
|
16
|
+
* <p>You can create service-specific credentials for CodeCommit and Amazon Keyspaces (for Apache
|
|
17
17
|
* Cassandra).</p>
|
|
18
|
-
*
|
|
19
|
-
*
|
|
18
|
+
* <p>You can reset the password to a new service-generated value by calling <a>ResetServiceSpecificCredential</a>.</p>
|
|
19
|
+
* <p>For more information about service-specific credentials, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_ssh-keys.html">Using IAM
|
|
20
20
|
* with CodeCommit: Git credentials, SSH keys, and Amazon Web Services access keys</a> in the
|
|
21
21
|
* <i>IAM User Guide</i>.</p>
|
|
22
22
|
* @example
|
|
@@ -9,7 +9,7 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates a new IAM user for your Amazon Web Services account.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p> For information about quotas for the number of IAM users you can create, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS
|
|
13
13
|
* quotas</a> in the <i>IAM User Guide</i>.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -12,15 +12,15 @@ export interface CreateVirtualMFADeviceCommandOutput extends CreateVirtualMFADev
|
|
|
12
12
|
* MFA, use <a>EnableMFADevice</a> to attach the MFA device to an IAM user.
|
|
13
13
|
* For more information about creating and working with virtual MFA devices, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html">Using a virtual MFA
|
|
14
14
|
* device</a> in the <i>IAM User Guide</i>.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>For information about the maximum number of MFA devices you can create, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS
|
|
16
16
|
* quotas</a> in the <i>IAM User Guide</i>.</p>
|
|
17
|
-
*
|
|
17
|
+
* <important>
|
|
18
18
|
* <p>The seed information contained in the QR code and the Base32 string should be
|
|
19
19
|
* treated like any other secret access information. In other words, protect the seed
|
|
20
20
|
* information as you would your Amazon Web Services access keys or your passwords. After you
|
|
21
21
|
* provision your virtual device, you should ensure that the information is destroyed
|
|
22
22
|
* following secure procedures.</p>
|
|
23
|
-
*
|
|
23
|
+
* </important>
|
|
24
24
|
* @example
|
|
25
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
26
26
|
* ```javascript
|
|
@@ -10,7 +10,7 @@ export interface DeactivateMFADeviceCommandOutput extends __MetadataBearer {
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deactivates the specified MFA device and removes it from association with the user
|
|
12
12
|
* name for which it was originally enabled.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>For more information about creating and working with virtual MFA devices, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html">Enabling a virtual
|
|
14
14
|
* multi-factor authentication (MFA) device</a> in the
|
|
15
15
|
* <i>IAM User Guide</i>.</p>
|
|
16
16
|
* @example
|
|
@@ -9,7 +9,7 @@ export interface DeleteAccessKeyCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes the access key pair 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 users.</p>
|
|
@@ -10,7 +10,7 @@ export interface DeleteGroupPolicyCommandOutput extends __MetadataBearer {
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes the specified inline policy that is embedded in the specified IAM
|
|
12
12
|
* group.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>A group can also have managed policies attached to it. To detach a managed policy from
|
|
14
14
|
* a group, use <a>DetachGroupPolicy</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>
|
|
@@ -10,13 +10,13 @@ export interface DeleteInstanceProfileCommandOutput extends __MetadataBearer {
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes the specified instance profile. The instance profile must not have an
|
|
12
12
|
* associated role.</p>
|
|
13
|
-
*
|
|
13
|
+
* <important>
|
|
14
14
|
* <p>Make sure that you do not have any Amazon EC2 instances running with the instance
|
|
15
15
|
* profile you are about to delete. Deleting a role or instance profile that is
|
|
16
16
|
* associated with a running instance will break any applications running on the
|
|
17
17
|
* instance.</p>
|
|
18
|
-
*
|
|
19
|
-
*
|
|
18
|
+
* </important>
|
|
19
|
+
* <p>For more information about instance profiles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About instance
|
|
20
20
|
* profiles</a>.</p>
|
|
21
21
|
* @example
|
|
22
22
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -10,17 +10,17 @@ export interface DeleteLoginProfileCommandOutput extends __MetadataBearer {
|
|
|
10
10
|
/**
|
|
11
11
|
* <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
|
|
12
12
|
* passwords for IAM users</a>.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>You can use the CLI, the Amazon Web Services API, or the <b>Users</b>
|
|
14
14
|
* 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
|
|
15
15
|
* <b>My Security Credentials</b> page in the
|
|
16
16
|
* Amazon Web Services Management Console.</p>
|
|
17
|
-
*
|
|
17
|
+
* <important>
|
|
18
18
|
* <p>Deleting a user's password does not prevent a user from accessing Amazon Web Services through
|
|
19
19
|
* the command line interface or the API. To prevent all user access, you must also
|
|
20
20
|
* either make any access keys inactive or delete them. For more information about
|
|
21
21
|
* making keys inactive or deleting them, see <a>UpdateAccessKey</a> and
|
|
22
22
|
* <a>DeleteAccessKey</a>.</p>
|
|
23
|
-
*
|
|
23
|
+
* </important>
|
|
24
24
|
* @example
|
|
25
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
26
26
|
* ```javascript
|
|
@@ -9,10 +9,10 @@ export interface DeleteOpenIDConnectProviderCommandOutput extends __MetadataBear
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes an OpenID Connect identity provider (IdP) resource object in IAM.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Deleting an IAM OIDC provider resource does not update any roles that reference the
|
|
13
13
|
* provider as a principal in their trust policies. Any attempt to assume a role that
|
|
14
14
|
* references a deleted provider fails.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>This operation is idempotent; it does not fail or return an error if you call the
|
|
16
16
|
* operation for a provider that does not exist.</p>
|
|
17
17
|
* @example
|
|
18
18
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,29 +9,29 @@ export interface DeletePolicyCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes the specified managed policy.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Before you can delete a managed policy, you must first detach the policy from all
|
|
13
13
|
* users, groups, and roles that it is attached to. In addition, you must delete all the
|
|
14
14
|
* policy's versions. The following steps describe the process for deleting a managed
|
|
15
15
|
* policy:</p>
|
|
16
|
-
*
|
|
16
|
+
* <ul>
|
|
17
17
|
* <li>
|
|
18
|
-
*
|
|
18
|
+
* <p>Detach the policy from all users, groups, and roles that the policy is
|
|
19
19
|
* attached to, using <a>DetachUserPolicy</a>, <a>DetachGroupPolicy</a>, or <a>DetachRolePolicy</a>. To
|
|
20
20
|
* list all the users, groups, and roles that a policy is attached to, use <a>ListEntitiesForPolicy</a>.</p>
|
|
21
21
|
* </li>
|
|
22
22
|
* <li>
|
|
23
|
-
*
|
|
23
|
+
* <p>Delete all versions of the policy using <a>DeletePolicyVersion</a>.
|
|
24
24
|
* To list the policy's versions, use <a>ListPolicyVersions</a>. You
|
|
25
25
|
* cannot use <a>DeletePolicyVersion</a> to delete the version that is
|
|
26
26
|
* marked as the default version. You delete the policy's default version in the
|
|
27
27
|
* next step of the process.</p>
|
|
28
28
|
* </li>
|
|
29
29
|
* <li>
|
|
30
|
-
*
|
|
30
|
+
* <p>Delete the policy (this automatically deletes the policy's default version)
|
|
31
31
|
* using this operation.</p>
|
|
32
32
|
* </li>
|
|
33
33
|
* </ul>
|
|
34
|
-
*
|
|
34
|
+
* <p>For information about managed policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline
|
|
35
35
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
36
36
|
* @example
|
|
37
37
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,10 +9,10 @@ export interface DeletePolicyVersionCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes the specified version from the specified managed policy.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>You cannot delete the default version from a policy using this operation. To delete
|
|
13
13
|
* the default version from a policy, use <a>DeletePolicy</a>. To find out which
|
|
14
14
|
* version of a policy is marked as the default version, use <a>ListPolicyVersions</a>.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>For information about versions for managed policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html">Versioning for managed
|
|
16
16
|
* policies</a> in the <i>IAM User Guide</i>.</p>
|
|
17
17
|
* @example
|
|
18
18
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -8,13 +8,30 @@ export interface DeleteRoleCommandInput extends DeleteRoleRequest {
|
|
|
8
8
|
export interface DeleteRoleCommandOutput extends __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Deletes the specified role.
|
|
12
|
-
*
|
|
13
|
-
*
|
|
11
|
+
* <p>Deletes the specified role. Unlike the Amazon Web Services Management Console, when you delete a role
|
|
12
|
+
* programmatically, you must delete the items attached to the role manually, or the
|
|
13
|
+
* deletion fails. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage_delete.html#roles-managingrole-deleting-cli">Deleting an IAM role</a>. Before attempting to delete a role, remove the
|
|
14
|
+
* following attached items: </p>
|
|
15
|
+
* <ul>
|
|
16
|
+
* <li>
|
|
17
|
+
* <p>Inline policies (<a>DeleteRolePolicy</a>)</p>
|
|
18
|
+
* </li>
|
|
19
|
+
* <li>
|
|
20
|
+
* <p>Attached managed policies (<a>DetachRolePolicy</a>)</p>
|
|
21
|
+
* </li>
|
|
22
|
+
* <li>
|
|
23
|
+
* <p>Instance profile (<a>RemoveRoleFromInstanceProfile</a>)</p>
|
|
24
|
+
* </li>
|
|
25
|
+
* <li>
|
|
26
|
+
* <p>Optional – Delete instance profile after detaching from role for
|
|
27
|
+
* resource clean up (<a>DeleteInstanceProfile</a>)</p>
|
|
28
|
+
* </li>
|
|
29
|
+
* </ul>
|
|
30
|
+
* <important>
|
|
14
31
|
* <p>Make sure that you do not have any Amazon EC2 instances running with the role you
|
|
15
32
|
* are about to delete. Deleting a role or instance profile that is associated with a
|
|
16
33
|
* running instance will break any applications running on the instance.</p>
|
|
17
|
-
*
|
|
34
|
+
* </important>
|
|
18
35
|
* @example
|
|
19
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
20
37
|
* ```javascript
|
|
@@ -9,11 +9,11 @@ export interface DeleteRolePermissionsBoundaryCommandOutput extends __MetadataBe
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes the permissions boundary for the specified IAM role. </p>
|
|
12
|
-
*
|
|
12
|
+
* <important>
|
|
13
13
|
* <p>Deleting the permissions boundary for a role might increase its permissions. For
|
|
14
14
|
* example, it might allow anyone who assumes the role to perform all the actions
|
|
15
15
|
* granted in its permissions policies. </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 DeleteRolePolicyCommandOutput extends __MetadataBearer {
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes the specified inline policy that is embedded in the specified IAM
|
|
12
12
|
* role.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>A role can also have managed policies attached to it. To detach a managed policy from
|
|
14
14
|
* a role, use <a>DetachRolePolicy</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,12 +9,12 @@ export interface DeleteSAMLProviderCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes a SAML provider resource in IAM.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Deleting the provider resource from IAM does not update any roles that reference the
|
|
13
13
|
* SAML provider resource's ARN as a principal in their trust policies. Any attempt to
|
|
14
14
|
* assume a role that references a non-existent provider resource ARN fails.</p>
|
|
15
|
-
*
|
|
15
|
+
* <note>
|
|
16
16
|
* <p> This operation requires <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>.</p>
|
|
17
|
-
*
|
|
17
|
+
* </note>
|
|
18
18
|
* @example
|
|
19
19
|
* Use a bare-bones client and the command you need to make an API call.
|
|
20
20
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface DeleteSSHPublicKeyCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes the specified SSH public key.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>The SSH public key deleted 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
|
|
15
15
|
* SSH connections</a> in the <i>CodeCommit User Guide</i>.</p>
|
|
@@ -9,11 +9,11 @@ export interface DeleteServerCertificateCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes the specified server certificate.</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 also includes a list of Amazon Web Services services that can use the server certificates that
|
|
15
15
|
* you manage with IAM.</p>
|
|
16
|
-
*
|
|
16
|
+
* <important>
|
|
17
17
|
* <p> If you are using a server certificate with Elastic Load Balancing, deleting the
|
|
18
18
|
* certificate could have implications for your application. If Elastic Load Balancing
|
|
19
19
|
* doesn't detect the deletion of bound certificates, it may continue to use the
|
|
@@ -22,7 +22,7 @@ export interface DeleteServerCertificateCommandOutput extends __MetadataBearer {
|
|
|
22
22
|
* Balancing before using this command to delete the certificate. For more information,
|
|
23
23
|
* see <a href="https://docs.aws.amazon.com/ElasticLoadBalancing/latest/APIReference/API_DeleteLoadBalancerListeners.html">DeleteLoadBalancerListeners</a> in the <i>Elastic Load Balancing API
|
|
24
24
|
* Reference</i>.</p>
|
|
25
|
-
*
|
|
25
|
+
* </important>
|
|
26
26
|
* @example
|
|
27
27
|
* Use a bare-bones client and the command you need to make an API call.
|
|
28
28
|
* ```javascript
|