@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,24 +10,24 @@ export interface PutRolePolicyCommandOutput extends __MetadataBearer {
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Adds or updates an inline policy document that is embedded in the specified IAM
|
|
12
12
|
* role.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>When you embed an inline policy in a role, the inline policy is used as part of the
|
|
14
14
|
* role's access (permissions) policy. The role's trust policy is created at the same time
|
|
15
15
|
* as the role, using <a>CreateRole</a>. You can update a role's trust policy
|
|
16
16
|
* using <a>UpdateAssumeRolePolicy</a>. For more information about IAM roles,
|
|
17
17
|
* see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html">Using roles to
|
|
18
18
|
* delegate permissions and federate identities</a>.</p>
|
|
19
|
-
*
|
|
19
|
+
* <p>A role can also have a managed policy attached to it. To attach a managed policy to a
|
|
20
20
|
* role, use <a>AttachRolePolicy</a>. To create a new managed policy, use <a>CreatePolicy</a>. For information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed
|
|
21
21
|
* policies and inline policies</a> in the
|
|
22
22
|
* <i>IAM User Guide</i>.</p>
|
|
23
|
-
*
|
|
23
|
+
* <p>For information about the maximum number of inline policies that you can embed with a
|
|
24
24
|
* role, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS quotas</a> in the <i>IAM User Guide</i>.</p>
|
|
25
|
-
*
|
|
25
|
+
* <note>
|
|
26
26
|
* <p>Because policy documents can be large, you should use POST rather than GET when
|
|
27
27
|
* calling <code>PutRolePolicy</code>. For general information about using the Query
|
|
28
28
|
* API with IAM, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html">Making query requests</a> in the
|
|
29
29
|
* <i>IAM User Guide</i>.</p>
|
|
30
|
-
*
|
|
30
|
+
* </note>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -13,12 +13,12 @@ export interface PutUserPermissionsBoundaryCommandOutput extends __MetadataBeare
|
|
|
13
13
|
* a user. Use the boundary to control the maximum permissions that the user can have.
|
|
14
14
|
* Setting a permissions boundary is an advanced feature that can affect the permissions
|
|
15
15
|
* for the user.</p>
|
|
16
|
-
*
|
|
16
|
+
* <important>
|
|
17
17
|
* <p>Policies that are used as permissions boundaries do not provide permissions. You
|
|
18
18
|
* must also attach a permissions policy to the user. To learn how the effective
|
|
19
19
|
* permissions for a user are evaluated, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html">IAM JSON policy
|
|
20
20
|
* evaluation logic</a> in the IAM User Guide. </p>
|
|
21
|
-
*
|
|
21
|
+
* </important>
|
|
22
22
|
* @example
|
|
23
23
|
* Use a bare-bones client and the command you need to make an API call.
|
|
24
24
|
* ```javascript
|
|
@@ -10,19 +10,19 @@ export interface PutUserPolicyCommandOutput extends __MetadataBearer {
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Adds or updates an inline policy document that is embedded in the specified IAM
|
|
12
12
|
* user.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>An IAM user can also have a managed policy attached to it. To attach a managed
|
|
14
14
|
* policy to a user, use <a>AttachUserPolicy</a>. To create a new managed
|
|
15
15
|
* policy, use <a>CreatePolicy</a>. For information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed
|
|
16
16
|
* policies and inline policies</a> in the
|
|
17
17
|
* <i>IAM User Guide</i>.</p>
|
|
18
|
-
*
|
|
18
|
+
* <p>For information about the maximum number of inline policies that you can embed in a
|
|
19
19
|
* user, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS quotas</a> in the <i>IAM User Guide</i>.</p>
|
|
20
|
-
*
|
|
20
|
+
* <note>
|
|
21
21
|
* <p>Because policy documents can be large, you should use POST rather than GET when
|
|
22
22
|
* calling <code>PutUserPolicy</code>. For general information about using the Query
|
|
23
23
|
* API with IAM, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html">Making query requests</a> in the
|
|
24
24
|
* <i>IAM User Guide</i>.</p>
|
|
25
|
-
*
|
|
25
|
+
* </note>
|
|
26
26
|
* @example
|
|
27
27
|
* Use a bare-bones client and the command you need to make an API call.
|
|
28
28
|
* ```javascript
|
|
@@ -11,7 +11,7 @@ export interface RemoveClientIDFromOpenIDConnectProviderCommandOutput extends __
|
|
|
11
11
|
* <p>Removes the specified client ID (also known as audience) from the list of client IDs
|
|
12
12
|
* registered for the specified IAM OpenID Connect (OIDC) provider resource
|
|
13
13
|
* object.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>This operation is idempotent; it does not fail or return an error if you try to remove
|
|
15
15
|
* a client ID that does not exist.</p>
|
|
16
16
|
* @example
|
|
17
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,13 +9,13 @@ export interface RemoveRoleFromInstanceProfileCommandOutput extends __MetadataBe
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Removes the specified IAM role from the specified EC2 instance profile.</p>
|
|
12
|
-
*
|
|
12
|
+
* <important>
|
|
13
13
|
* <p>Make sure that you do not have any Amazon EC2 instances running with the role you
|
|
14
14
|
* are about to remove from the instance profile. Removing a role from an instance
|
|
15
15
|
* profile that is associated with a running instance might break any applications
|
|
16
16
|
* running on the instance.</p>
|
|
17
|
-
*
|
|
18
|
-
*
|
|
17
|
+
* </important>
|
|
18
|
+
* <p> For more information about IAM roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with roles</a>. For more
|
|
19
19
|
* 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
|
|
@@ -10,7 +10,7 @@ export interface ResyncMFADeviceCommandOutput extends __MetadataBearer {
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Synchronizes the specified MFA device with its IAM resource object on the Amazon Web Services
|
|
12
12
|
* servers.</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">Using a virtual MFA
|
|
14
14
|
* device</a> in the <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.
|
|
@@ -10,9 +10,9 @@ export interface SetDefaultPolicyVersionCommandOutput extends __MetadataBearer {
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Sets the specified version of the specified policy as the policy's default (operative)
|
|
12
12
|
* version.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>This operation affects all users, groups, and roles that the policy is attached to. To
|
|
14
14
|
* list the users, groups, and roles that the policy is attached to, use <a>ListEntitiesForPolicy</a>.</p>
|
|
15
|
-
*
|
|
15
|
+
* <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
|
|
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.
|
|
@@ -10,13 +10,13 @@ export interface SetSecurityTokenServicePreferencesCommandOutput extends __Metad
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Sets the specified version of the global endpoint token as the token version used for
|
|
12
12
|
* the Amazon Web Services account.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>By default, Security Token Service (STS) is available as a global service, and all STS requests
|
|
14
14
|
* go to a single endpoint at <code>https://sts.amazonaws.com</code>. Amazon Web Services recommends
|
|
15
15
|
* using Regional STS endpoints to reduce latency, build in redundancy, and increase
|
|
16
16
|
* session token availability. For information about Regional endpoints for STS, see
|
|
17
17
|
* <a href="https://docs.aws.amazon.com/general/latest/gr/sts.html">Security Token Service
|
|
18
18
|
* endpoints and quotas</a> in the <i>Amazon Web Services General Reference</i>.</p>
|
|
19
|
-
*
|
|
19
|
+
* <p>If you make an STS call to the global endpoint, the resulting session tokens might
|
|
20
20
|
* be valid in some Regions but not others. It depends on the version that is set in this
|
|
21
21
|
* operation. Version 1 tokens are valid only in Amazon Web Services Regions that are
|
|
22
22
|
* available by default. These tokens do not work in manually enabled Regions, such as Asia
|
|
@@ -25,7 +25,7 @@ export interface SetSecurityTokenServicePreferencesCommandOutput extends __Metad
|
|
|
25
25
|
* information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and
|
|
26
26
|
* deactivating STS in an Amazon Web Services Region</a> in the
|
|
27
27
|
* <i>IAM User Guide</i>.</p>
|
|
28
|
-
*
|
|
28
|
+
* <p>To view the current session token version, see the
|
|
29
29
|
* <code>GlobalEndpointTokenVersion</code> entry in the response of the <a>GetAccountSummary</a> operation.</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -11,20 +11,27 @@ export interface SimulateCustomPolicyCommandOutput extends SimulatePolicyRespons
|
|
|
11
11
|
* <p>Simulate how a set of IAM policies and optionally a resource-based policy works with
|
|
12
12
|
* a list of API operations and Amazon Web Services resources to determine the policies' effective
|
|
13
13
|
* permissions. The policies are provided as strings.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>The simulation does not perform the API operations; it only checks the authorization
|
|
15
15
|
* to determine if the simulated policies allow or deny the operations. You can simulate
|
|
16
16
|
* resources that don't exist in your account.</p>
|
|
17
|
-
*
|
|
17
|
+
* <p>If you want to simulate existing policies that are attached to an IAM user, group,
|
|
18
18
|
* or role, use <a>SimulatePrincipalPolicy</a> instead.</p>
|
|
19
|
-
*
|
|
19
|
+
* <p>Context keys are variables that are maintained by Amazon Web Services and its services and which
|
|
20
20
|
* provide details about the context of an API query request. You can use the
|
|
21
21
|
* <code>Condition</code> element of an IAM policy to evaluate context keys. To get
|
|
22
22
|
* the list of context keys that the policies require for correct simulation, use <a>GetContextKeysForCustomPolicy</a>.</p>
|
|
23
|
-
*
|
|
23
|
+
* <p>If the output is long, you can use <code>MaxItems</code> and <code>Marker</code>
|
|
24
24
|
* parameters to paginate the results.</p>
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
25
|
+
* <note>
|
|
26
|
+
* <p>The IAM policy simulator evaluates statements in the identity-based policy and
|
|
27
|
+
* the inputs that you provide during simulation. The policy simulator results can
|
|
28
|
+
* differ from your live Amazon Web Services environment. We recommend that you check your policies
|
|
29
|
+
* against your live Amazon Web Services environment after testing using the policy simulator to
|
|
30
|
+
* confirm that you have the desired results. For more information about using the
|
|
31
|
+
* policy simulator, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_testing-policies.html">Testing IAM
|
|
32
|
+
* policies with the IAM policy simulator </a>in the
|
|
33
|
+
* <i>IAM User Guide</i>.</p>
|
|
34
|
+
* </note>
|
|
28
35
|
* @example
|
|
29
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
37
|
* ```javascript
|
|
@@ -13,27 +13,34 @@ export interface SimulatePrincipalPolicyCommandOutput extends SimulatePolicyResp
|
|
|
13
13
|
* entity can be an IAM user, group, or role. If you specify a user, then the simulation
|
|
14
14
|
* also includes all of the policies that are attached to groups that the user belongs to.
|
|
15
15
|
* You can simulate resources that don't exist in your account.</p>
|
|
16
|
-
*
|
|
16
|
+
* <p>You can optionally include a list of one or more additional policies specified as
|
|
17
17
|
* strings to include in the simulation. If you want to simulate only policies specified as
|
|
18
18
|
* strings, use <a>SimulateCustomPolicy</a> instead.</p>
|
|
19
|
-
*
|
|
20
|
-
* the resources included in the simulation.</p>
|
|
21
|
-
*
|
|
19
|
+
* <p>You can also optionally include one resource-based policy to be evaluated with each of
|
|
20
|
+
* the resources included in the simulation for IAM users only.</p>
|
|
21
|
+
* <p>The simulation does not perform the API operations; it only checks the authorization
|
|
22
22
|
* to determine if the simulated policies allow or deny the operations.</p>
|
|
23
|
-
*
|
|
23
|
+
* <p>
|
|
24
24
|
* <b>Note:</b> This operation discloses information about the
|
|
25
25
|
* permissions granted to other users. If you do not want users to see other user's
|
|
26
26
|
* permissions, then consider allowing them to use <a>SimulateCustomPolicy</a>
|
|
27
27
|
* instead.</p>
|
|
28
|
-
*
|
|
28
|
+
* <p>Context keys are variables maintained by Amazon Web Services and its services that provide details
|
|
29
29
|
* about the context of an API query request. You can use the <code>Condition</code>
|
|
30
30
|
* element of an IAM policy to evaluate context keys. To get the list of context keys
|
|
31
31
|
* that the policies require for correct simulation, use <a>GetContextKeysForPrincipalPolicy</a>.</p>
|
|
32
|
-
*
|
|
32
|
+
* <p>If the output is long, you can use the <code>MaxItems</code> and <code>Marker</code>
|
|
33
33
|
* parameters to paginate the results.</p>
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
34
|
+
* <note>
|
|
35
|
+
* <p>The IAM policy simulator evaluates statements in the identity-based policy and
|
|
36
|
+
* the inputs that you provide during simulation. The policy simulator results can
|
|
37
|
+
* differ from your live Amazon Web Services environment. We recommend that you check your policies
|
|
38
|
+
* against your live Amazon Web Services environment after testing using the policy simulator to
|
|
39
|
+
* confirm that you have the desired results. For more information about using the
|
|
40
|
+
* policy simulator, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_testing-policies.html">Testing IAM
|
|
41
|
+
* policies with the IAM policy simulator </a>in the
|
|
42
|
+
* <i>IAM User Guide</i>.</p>
|
|
43
|
+
* </note>
|
|
37
44
|
* @example
|
|
38
45
|
* Use a bare-bones client and the command you need to make an API call.
|
|
39
46
|
* ```javascript
|
|
@@ -11,14 +11,14 @@ export interface UpdateAccessKeyCommandOutput extends __MetadataBearer {
|
|
|
11
11
|
* <p>Changes the status of the specified access key from Active to Inactive, or vice versa.
|
|
12
12
|
* This operation can be used to disable a user's key as part of a key rotation
|
|
13
13
|
* workflow.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>If the <code>UserName</code> is not specified, the user name is determined implicitly
|
|
15
15
|
* based on the Amazon Web Services access key ID used to sign the request. If a temporary access key is
|
|
16
16
|
* used, then <code>UserName</code> is required. If a long-term key is assigned to the
|
|
17
17
|
* user, then <code>UserName</code> is not required. This operation works for access keys
|
|
18
18
|
* under the Amazon Web Services account. Consequently, you can use this operation to manage
|
|
19
19
|
* Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated
|
|
20
20
|
* users.</p>
|
|
21
|
-
*
|
|
21
|
+
* <p>For information about rotating keys, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/ManagingCredentials.html">Managing keys and certificates</a>
|
|
22
22
|
* in the <i>IAM User Guide</i>.</p>
|
|
23
23
|
* @example
|
|
24
24
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,15 +9,15 @@ export interface UpdateAccountPasswordPolicyCommandOutput extends __MetadataBear
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Updates the password policy settings for the Amazon Web Services account.</p>
|
|
12
|
-
*
|
|
12
|
+
* <note>
|
|
13
13
|
* <p>This operation does not support partial updates. No parameters are required, but
|
|
14
14
|
* if you do not specify a parameter, that parameter's value reverts to its default
|
|
15
15
|
* value. See the <b>Request Parameters</b> section for each
|
|
16
16
|
* parameter's default value. Also note that some parameters do not allow the default
|
|
17
17
|
* parameter to be explicitly set. Instead, to invoke the default value, do not include
|
|
18
18
|
* that parameter when you invoke the operation.</p>
|
|
19
|
-
*
|
|
20
|
-
*
|
|
19
|
+
* </note>
|
|
20
|
+
* <p> For more information about using a password policy, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html">Managing an IAM password
|
|
21
21
|
* policy</a> in the <i>IAM User Guide</i>.</p>
|
|
22
22
|
* @example
|
|
23
23
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,12 +9,12 @@ export interface UpdateGroupCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Updates the name and/or the path of the specified IAM group.</p>
|
|
12
|
-
*
|
|
12
|
+
* <important>
|
|
13
13
|
* <p> You should understand the implications of changing a group's path or name. For
|
|
14
14
|
* more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_WorkingWithGroupsAndUsers.html">Renaming users and
|
|
15
15
|
* groups</a> in the <i>IAM User Guide</i>.</p>
|
|
16
|
-
*
|
|
17
|
-
*
|
|
16
|
+
* </important>
|
|
17
|
+
* <note>
|
|
18
18
|
* <p>The person making the request (the principal), must have permission to change the
|
|
19
19
|
* role group with the old name and the new name. For example, to change the group
|
|
20
20
|
* named <code>Managers</code> to <code>MGRs</code>, the principal must have a policy
|
|
@@ -22,7 +22,7 @@ export interface UpdateGroupCommandOutput extends __MetadataBearer {
|
|
|
22
22
|
* the <code>Managers</code> group, but not the <code>MGRs</code> group, then the
|
|
23
23
|
* update fails. For more information about permissions, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access management</a>.
|
|
24
24
|
* </p>
|
|
25
|
-
*
|
|
25
|
+
* </note>
|
|
26
26
|
* @example
|
|
27
27
|
* Use a bare-bones client and the command you need to make an API call.
|
|
28
28
|
* ```javascript
|
|
@@ -8,12 +8,12 @@ export interface UpdateLoginProfileCommandInput extends UpdateLoginProfileReques
|
|
|
8
8
|
export interface UpdateLoginProfileCommandOutput extends __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Changes the password for the specified IAM user. You can use the CLI,
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
11
|
+
* <p>Changes the password for the specified IAM user. You can use the CLI, the Amazon Web Services
|
|
12
|
+
* API, or the <b>Users</b> page in the IAM console to change
|
|
13
|
+
* the password for any IAM user. Use <a>ChangePassword</a> to change your own
|
|
14
|
+
* password in the <b>My Security Credentials</b> page in the
|
|
15
|
+
* Amazon Web Services Management Console.</p>
|
|
16
|
+
* <p>For more information about modifying passwords, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html">Managing passwords</a> in the
|
|
17
17
|
* <i>IAM User Guide</i>.</p>
|
|
18
18
|
* @example
|
|
19
19
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -10,26 +10,27 @@ export interface UpdateOpenIDConnectProviderThumbprintCommandOutput extends __Me
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Replaces the existing list of server certificate thumbprints associated with an OpenID
|
|
12
12
|
* Connect (OIDC) provider resource object with a new list of thumbprints.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>The list that you pass with this operation completely replaces the existing list of
|
|
14
14
|
* thumbprints. (The lists are not merged.)</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>Typically, you need to update a thumbprint only when the identity provider certificate
|
|
16
16
|
* changes, which occurs rarely. However, if the provider's certificate
|
|
17
17
|
* <i>does</i> change, any attempt to assume an IAM role that specifies
|
|
18
18
|
* the OIDC provider as a principal fails until the certificate thumbprint is
|
|
19
19
|
* updated.</p>
|
|
20
|
-
*
|
|
20
|
+
* <note>
|
|
21
21
|
* <p>Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our
|
|
22
22
|
* library of trusted certificate authorities (CAs) instead of using a certificate
|
|
23
|
-
* thumbprint to verify your IdP server certificate. These OIDC IdPs include Google,
|
|
24
|
-
* those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these
|
|
25
|
-
* cases, your legacy thumbprint remains in your configuration, but is no longer used for
|
|
23
|
+
* thumbprint to verify your IdP server certificate. These OIDC IdPs include Google, Auth0,
|
|
24
|
+
* and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these
|
|
25
|
+
* cases, your legacy thumbprint remains in your configuration, but is no longer used for
|
|
26
|
+
* validation.</p>
|
|
26
27
|
* </note>
|
|
27
|
-
*
|
|
28
|
+
* <note>
|
|
28
29
|
* <p>Trust for the OIDC provider is derived from the provider certificate and is
|
|
29
30
|
* validated by the thumbprint. Therefore, it is best to limit access to the
|
|
30
31
|
* <code>UpdateOpenIDConnectProviderThumbprint</code> operation to highly
|
|
31
32
|
* privileged users.</p>
|
|
32
|
-
*
|
|
33
|
+
* </note>
|
|
33
34
|
* @example
|
|
34
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
36
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface UpdateRoleDescriptionCommandOutput extends UpdateRoleDescriptio
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Use <a>UpdateRole</a> instead.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Modifies only the description of a role. This operation performs the same function as
|
|
13
13
|
* the <code>Description</code> parameter in the <code>UpdateRole</code> operation.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,9 +9,9 @@ export interface UpdateSAMLProviderCommandOutput extends UpdateSAMLProviderRespo
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Updates the metadata document for an existing SAML provider resource object.</p>
|
|
12
|
-
*
|
|
12
|
+
* <note>
|
|
13
13
|
* <p>This operation requires <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>.</p>
|
|
14
|
-
*
|
|
14
|
+
* </note>
|
|
15
15
|
* @example
|
|
16
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
17
|
* ```javascript
|
|
@@ -11,7 +11,7 @@ export interface UpdateSSHPublicKeyCommandOutput extends __MetadataBearer {
|
|
|
11
11
|
* <p>Sets the status of an IAM user's SSH public key to active or inactive. SSH public
|
|
12
12
|
* keys that are inactive cannot be used for authentication. This operation can be used to
|
|
13
13
|
* disable a user's SSH public key as part of a key rotation work flow.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>The SSH public key affected by this operation is used only for authenticating the
|
|
15
15
|
* associated IAM user to an CodeCommit repository. For more information about using SSH keys
|
|
16
16
|
* 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
|
|
17
17
|
* SSH connections</a> in the <i>CodeCommit User Guide</i>.</p>
|
|
@@ -10,16 +10,16 @@ export interface UpdateServerCertificateCommandOutput extends __MetadataBearer {
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Updates the name and/or the path of the specified server certificate stored in
|
|
12
12
|
* IAM.</p>
|
|
13
|
-
*
|
|
13
|
+
* <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
|
|
14
14
|
* with server certificates</a> in the <i>IAM User Guide</i>. This
|
|
15
15
|
* topic also includes a list of Amazon Web Services services that can use the server certificates that
|
|
16
16
|
* you manage with IAM.</p>
|
|
17
|
-
*
|
|
17
|
+
* <important>
|
|
18
18
|
* <p>You should understand the implications of changing a server certificate's path or
|
|
19
19
|
* name. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs_manage.html#RenamingServerCerts">Renaming a server certificate</a> in the
|
|
20
20
|
* <i>IAM User Guide</i>.</p>
|
|
21
|
-
*
|
|
22
|
-
*
|
|
21
|
+
* </important>
|
|
22
|
+
* <note>
|
|
23
23
|
* <p>The person making the request (the principal), must have permission to change the
|
|
24
24
|
* server certificate with the old name and the new name. For example, to change the
|
|
25
25
|
* certificate named <code>ProductionCert</code> to <code>ProdCert</code>, the
|
|
@@ -27,7 +27,7 @@ export interface UpdateServerCertificateCommandOutput extends __MetadataBearer {
|
|
|
27
27
|
* principal has permission to update the <code>ProductionCert</code> group, but not
|
|
28
28
|
* the <code>ProdCert</code> certificate, then the update fails. For more information
|
|
29
29
|
* about permissions, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access management</a> in the <i>IAM User Guide</i>.</p>
|
|
30
|
-
*
|
|
30
|
+
* </note>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -11,7 +11,7 @@ export interface UpdateSigningCertificateCommandOutput extends __MetadataBearer
|
|
|
11
11
|
* <p>Changes the status of the specified user signing certificate from active to disabled,
|
|
12
12
|
* or vice versa. This operation can be used to disable an IAM user's signing certificate
|
|
13
13
|
* as part of a certificate rotation work flow.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>If the <code>UserName</code> field is not specified, the user name is determined
|
|
15
15
|
* implicitly based on the Amazon Web Services access key ID used to sign the request. This operation
|
|
16
16
|
* works for access keys under the Amazon Web Services account. Consequently, you can use this operation
|
|
17
17
|
* to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no
|
|
@@ -9,18 +9,18 @@ export interface UpdateUserCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Updates the name and/or the path of the specified IAM user.</p>
|
|
12
|
-
*
|
|
12
|
+
* <important>
|
|
13
13
|
* <p> You should understand the implications of changing an IAM user's path or name.
|
|
14
14
|
* For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_manage.html#id_users_renaming">Renaming an IAM
|
|
15
15
|
* user</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups_manage_rename.html">Renaming an IAM
|
|
16
16
|
* group</a> in the <i>IAM User Guide</i>.</p>
|
|
17
|
-
*
|
|
18
|
-
*
|
|
17
|
+
* </important>
|
|
18
|
+
* <note>
|
|
19
19
|
* <p> To change a user name, the requester must have appropriate permissions on both
|
|
20
20
|
* the source object and the target object. For example, to change Bob to Robert, the
|
|
21
21
|
* entity making the request must have permission on Bob and Robert, or must have
|
|
22
22
|
* permission on all (*). For more information about permissions, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/PermissionsAndPolicies.html">Permissions and policies</a>. </p>
|
|
23
|
-
*
|
|
23
|
+
* </note>
|
|
24
24
|
* @example
|
|
25
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
26
26
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface UploadSSHPublicKeyCommandOutput extends UploadSSHPublicKeyRespo
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Uploads an SSH public key and associates it with the specified IAM user.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>The SSH public key uploaded by this operation can be 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>
|
|
@@ -11,19 +11,19 @@ export interface UploadServerCertificateCommandOutput extends UploadServerCertif
|
|
|
11
11
|
* <p>Uploads a server certificate entity for the Amazon Web Services account. The server certificate
|
|
12
12
|
* entity includes a public key certificate, a private key, and an optional certificate
|
|
13
13
|
* chain, which should all be PEM-encoded.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>We recommend that you use <a href="https://docs.aws.amazon.com/acm/">Certificate Manager</a> to
|
|
15
15
|
* provision, manage, and deploy your server certificates. With ACM you can request a
|
|
16
16
|
* certificate, deploy it to Amazon Web Services resources, and let ACM handle certificate renewals for
|
|
17
17
|
* you. Certificates provided by ACM are free. For more information about using ACM,
|
|
18
18
|
* see the <a href="https://docs.aws.amazon.com/acm/latest/userguide/">Certificate Manager User
|
|
19
19
|
* Guide</a>.</p>
|
|
20
|
-
*
|
|
20
|
+
* <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
|
|
21
21
|
* with server certificates</a> in the <i>IAM User Guide</i>. This
|
|
22
22
|
* topic includes a list of Amazon Web Services services that can use the server certificates that you
|
|
23
23
|
* manage with IAM.</p>
|
|
24
|
-
*
|
|
24
|
+
* <p>For information about the number of server certificates you can upload, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS
|
|
25
25
|
* quotas</a> in the <i>IAM User Guide</i>.</p>
|
|
26
|
-
*
|
|
26
|
+
* <note>
|
|
27
27
|
* <p>Because the body of the public key certificate, private key, and the certificate
|
|
28
28
|
* chain can be large, you should use POST rather than GET when calling
|
|
29
29
|
* <code>UploadServerCertificate</code>. For information about setting up
|
|
@@ -31,7 +31,7 @@ export interface UploadServerCertificateCommandOutput extends UploadServerCertif
|
|
|
31
31
|
* requests</a> in the <i>Amazon Web Services General Reference</i>. For general
|
|
32
32
|
* information about using the Query API with IAM, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/programming.html">Calling the API by making HTTP query
|
|
33
33
|
* requests</a> in the <i>IAM User Guide</i>.</p>
|
|
34
|
-
*
|
|
34
|
+
* </note>
|
|
35
35
|
* @example
|
|
36
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
37
|
* ```javascript
|
|
@@ -12,22 +12,22 @@ export interface UploadSigningCertificateCommandOutput extends UploadSigningCert
|
|
|
12
12
|
* Some Amazon Web Services services require you to use certificates to validate requests that are signed
|
|
13
13
|
* with a corresponding private key. When you upload the certificate, its default status is
|
|
14
14
|
* <code>Active</code>.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>For information about when you would use an X.509 signing certificate, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Managing
|
|
16
16
|
* server certificates in IAM</a> in the
|
|
17
17
|
* <i>IAM User Guide</i>.</p>
|
|
18
|
-
*
|
|
18
|
+
* <p>If the <code>UserName</code> is not specified, the IAM user name is determined
|
|
19
19
|
* implicitly based on the Amazon Web Services access key ID used to sign the request. This operation
|
|
20
20
|
* works for access keys under the Amazon Web Services account. Consequently, you can use this operation
|
|
21
21
|
* to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no
|
|
22
22
|
* associated users.</p>
|
|
23
|
-
*
|
|
23
|
+
* <note>
|
|
24
24
|
* <p>Because the body of an X.509 certificate can be large, you should use POST rather
|
|
25
25
|
* than GET when calling <code>UploadSigningCertificate</code>. For information about
|
|
26
26
|
* setting up signatures and authorization through the API, see <a href="https://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html">Signing
|
|
27
27
|
* Amazon Web Services API requests</a> in the <i>Amazon Web Services General Reference</i>. For
|
|
28
28
|
* general information about using the Query API with IAM, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html">Making query
|
|
29
29
|
* requests</a> in the <i>IAM User Guide</i>.</p>
|
|
30
|
-
*
|
|
30
|
+
* </note>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
|
|
|
12
12
|
defaultSigningName: string;
|
|
13
13
|
};
|
|
14
14
|
export interface EndpointParameters extends __EndpointParameters {
|
|
15
|
-
Region
|
|
15
|
+
Region: string;
|
|
16
16
|
UseDualStack?: boolean;
|
|
17
17
|
UseFIPS?: boolean;
|
|
18
18
|
Endpoint?: string;
|