docs(client-iam): Documentation updates for AWS Identity and Access M…

…anagement (IAM).
aws · Jul 13, 2023 · 9a4bb10 · 9a4bb10
1 parent 082547a
commit 9a4bb10
Show file tree

Hide file tree

Showing 15 changed files with 58 additions and 54 deletions.
diff --git a/clients/client-iam/src/commands/AddRoleToInstanceProfileCommand.ts b/clients/client-iam/src/commands/AddRoleToInstanceProfileCommand.ts
@@ -46,9 +46,10 @@ export interface AddRoleToInstanceProfileCommandOutput extends __MetadataBearer
  *             <p>The caller of this operation must be granted the <code>PassRole</code> permission
  *                 on the IAM role by a permissions policy.</p>
  *          </note>
- *          <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
- *             information about instance profiles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About instance
- *             profiles</a>.</p>
+ *          <p> For more information about roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM roles</a> in the
+ *                 <i>IAM User Guide</i>. For more information about instance profiles,
+ *             see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html">Using
+ *                 instance profiles</a> in the <i>IAM User Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-iam/src/commands/CreateOpenIDConnectProviderCommand.ts b/clients/client-iam/src/commands/CreateOpenIDConnectProviderCommand.ts
@@ -69,11 +69,11 @@ export interface CreateOpenIDConnectProviderCommandOutput
  *             Amazon Web Services.</p>
  *          <note>
  *             <p>Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our
- *             library of trusted certificate authorities (CAs) instead of using a certificate
- *             thumbprint to verify your IdP server certificate. These OIDC IdPs include Google, Auth0,
- *             and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these
- *             cases, your legacy thumbprint remains in your configuration, but is no longer used for
- *             validation.</p>
+ *             library of trusted root certificate authorities (CAs) instead of using a certificate
+ *             thumbprint to verify your IdP server certificate. These OIDC IdPs include Auth0, GitHub,
+ *             Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In
+ *             these cases, your legacy thumbprint remains in your configuration, but is no longer used
+ *             for validation.</p>
  *          </note>
  *          <note>
  *             <p>The trust for the OIDC provider is derived from the IAM provider that this

diff --git a/clients/client-iam/src/commands/CreateRoleCommand.ts b/clients/client-iam/src/commands/CreateRoleCommand.ts
@@ -36,10 +36,10 @@ export interface CreateRoleCommandOutput extends CreateRoleResponse, __MetadataB
 
 /**
  * @public
- * <p>Creates a new role for your Amazon Web Services account. For more information about roles, see
- *                 <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">IAM
- *                 roles</a>. For information about quotas for role names and the number of roles
- *             you can create, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS quotas</a> in the
+ * <p>Creates a new role for your Amazon Web Services account.</p>
+ *          <p> For more information about roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM roles</a> in the
+ *                 <i>IAM User Guide</i>. For information about quotas for role names
+ *             and the number of roles you can create, 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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-iam/src/commands/DeleteInstanceProfileCommand.ts b/clients/client-iam/src/commands/DeleteInstanceProfileCommand.ts
@@ -44,8 +44,8 @@ export interface DeleteInstanceProfileCommandOutput extends __MetadataBearer {}
  *                 associated with a running instance will break any applications running on the
  *                 instance.</p>
  *          </important>
- *          <p>For more information about instance profiles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About instance
- *             profiles</a>.</p>
+ *          <p>For more information about instance profiles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html">Using
+ *                 instance profiles</a> in the <i>IAM User Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-iam/src/commands/GetInstanceProfileCommand.ts b/clients/client-iam/src/commands/GetInstanceProfileCommand.ts
@@ -38,7 +38,7 @@ export interface GetInstanceProfileCommandOutput extends GetInstanceProfileRespo
  * @public
  * <p> Retrieves information about the specified instance profile, including the instance
  *             profile's path, GUID, ARN, and role. For more information about instance profiles, see
- *                 <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About
+ *                 <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html">Using
  *                 instance profiles</a> in the <i>IAM User Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-iam/src/commands/GetRoleCommand.ts b/clients/client-iam/src/commands/GetRoleCommand.ts
@@ -38,7 +38,8 @@ export interface GetRoleCommandOutput extends GetRoleResponse, __MetadataBearer
  * @public
  * <p>Retrieves information about the specified role, including the role's path, GUID, ARN,
  *             and the role's trust policy that grants permission to assume the role. For more
- *             information about roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with roles</a>.</p>
+ *             information about roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM roles</a> in the
+ *                 <i>IAM User Guide</i>.</p>
  *          <note>
  *             <p>Policies returned by this operation are URL-encoded compliant
  *     with <a href="https://tools.ietf.org/html/rfc3986">RFC 3986</a>. You can use a URL

diff --git a/clients/client-iam/src/commands/GetRolePolicyCommand.ts b/clients/client-iam/src/commands/GetRolePolicyCommand.ts
@@ -51,8 +51,8 @@ export interface GetRolePolicyCommandOutput extends GetRolePolicyResponse, __Met
  *             the policy document.</p>
  *          <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
  *                 policies</a> in the <i>IAM User Guide</i>.</p>
- *          <p>For more information about roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html">Using roles to delegate permissions and
- *                 federate identities</a>.</p>
+ *          <p> For more information about roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM roles</a> in the
+ *                 <i>IAM User Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-iam/src/commands/ListInstanceProfilesCommand.ts b/clients/client-iam/src/commands/ListInstanceProfilesCommand.ts
@@ -38,8 +38,8 @@ export interface ListInstanceProfilesCommandOutput extends ListInstanceProfilesR
  * @public
  * <p>Lists the instance profiles that have the specified path prefix. If there are none,
  *             the operation returns an empty list. For more information about instance profiles, see
- *                 <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About
- *                 instance profiles</a>.</p>
+ *                 <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html">Using
+ *                 instance profiles</a> in the <i>IAM User Guide</i>.</p>
  *          <note>
  *             <p>IAM resource-listing operations return a subset of the available
  *    attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an instance profile, see <a>GetInstanceProfile</a>.</p>

diff --git a/clients/client-iam/src/commands/ListInstanceProfilesForRoleCommand.ts b/clients/client-iam/src/commands/ListInstanceProfilesForRoleCommand.ts
@@ -40,8 +40,8 @@ export interface ListInstanceProfilesForRoleCommandOutput
  * @public
  * <p>Lists the instance profiles that have the specified associated IAM role. If there
  *             are none, the operation returns an empty list. For more information about instance
- *             profiles, go to <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About instance
- *             profiles</a>.</p>
+ *             profiles, go to <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html">Using
+ *                 instance profiles</a> in the <i>IAM User Guide</i>.</p>
  *          <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code>
  *             parameters.</p>
  * @example

diff --git a/clients/client-iam/src/commands/ListRolesCommand.ts b/clients/client-iam/src/commands/ListRolesCommand.ts
@@ -37,8 +37,8 @@ export interface ListRolesCommandOutput extends ListRolesResponse, __MetadataBea
 /**
  * @public
  * <p>Lists the IAM roles that have the specified path prefix. If there are none, the
- *             operation returns an empty list. For more information about roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with
- *                 roles</a>.</p>
+ *             operation returns an empty list. For more information about roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM roles</a> in the
+ *                 <i>IAM User Guide</i>.</p>
  *          <note>
  *             <p>IAM resource-listing operations return a subset of the available
  *    attributes for the resource. This operation does not return the following attributes, even though they are an attribute of the returned object:</p>

diff --git a/clients/client-iam/src/commands/PutRolePolicyCommand.ts b/clients/client-iam/src/commands/PutRolePolicyCommand.ts
@@ -44,10 +44,10 @@ export interface PutRolePolicyCommandOutput extends __MetadataBearer {}
  *                <code>CreateRole</code>
  *             </a>.
  *             You can update a role's trust policy using <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_UpdateAssumeRolePolicy.html">
- *                <code>UpdateAssumerolePolicy</code>
- *             </a>. For more information about IAM
- *             roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html">Using
- *                 roles to delegate permissions and federate identities</a>.</p>
+ *                <code>UpdateAssumeRolePolicy</code>
+ *             </a>. For more information about roles,
+ *             see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html">IAM
+ *                 roles</a> in the <i>IAM User Guide</i>.</p>
  *          <p>A role can also have a managed policy attached to it. To attach a managed policy to a
  *             role, use <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_AttachRolePolicy.html">
  *                <code>AttachRolePolicy</code>

diff --git a/clients/client-iam/src/commands/RemoveRoleFromInstanceProfileCommand.ts b/clients/client-iam/src/commands/RemoveRoleFromInstanceProfileCommand.ts
@@ -46,9 +46,10 @@ export interface RemoveRoleFromInstanceProfileCommandOutput extends __MetadataBe
  *                 profile that is associated with a running instance might break any applications
  *                 running on the instance.</p>
  *          </important>
- *          <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
- *             information about instance profiles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About instance
- *             profiles</a>.</p>
+ *          <p> For more information about roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM roles</a> in the
+ *                 <i>IAM User Guide</i>. For more information about instance profiles,
+ *             see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html">Using
+ *                 instance profiles</a> in the <i>IAM User Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-iam/src/commands/UpdateOpenIDConnectProviderThumbprintCommand.ts b/clients/client-iam/src/commands/UpdateOpenIDConnectProviderThumbprintCommand.ts
@@ -51,11 +51,11 @@ export interface UpdateOpenIDConnectProviderThumbprintCommandOutput extends __Me
  *             updated.</p>
  *          <note>
  *             <p>Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our
- *             library of trusted certificate authorities (CAs) instead of using a certificate
- *             thumbprint to verify your IdP server certificate. These OIDC IdPs include Google, Auth0,
- *             and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these
- *             cases, your legacy thumbprint remains in your configuration, but is no longer used for
- *             validation.</p>
+ *             library of trusted root certificate authorities (CAs) instead of using a certificate
+ *             thumbprint to verify your IdP server certificate. These OIDC IdPs include Auth0, GitHub,
+ *             Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In
+ *             these cases, your legacy thumbprint remains in your configuration, but is no longer used
+ *             for validation.</p>
  *          </note>
  *          <note>
  *             <p>Trust for the OIDC provider is derived from the provider certificate and is

diff --git a/clients/client-iam/src/models/models_0.ts b/clients/client-iam/src/models/models_0.ts
@@ -3594,8 +3594,9 @@ export interface GetMFADeviceResponse {
   EnableDate?: Date;
 
   /**
-   * <p>The certifications of a specified user's MFA device. We currently provide FIPS-140-2, FIPS-140-3, and FIDO certification levels
-   *             obtained from <a href="https://fidoalliance.org/metadata/"> FIDO Alliance Metadata Service (MDS)</a>.</p>
+   * <p>The certifications of a specified user's MFA device. We currently provide FIPS-140-2,
+   *             FIPS-140-3, and FIDO certification levels obtained from <a href="https://fidoalliance.org/metadata/"> FIDO Alliance Metadata Service
+   *                 (MDS)</a>.</p>
    */
   Certifications?: Record<string, string>;
 }
@@ -7130,7 +7131,7 @@ export interface PutGroupPolicyRequest {
    * <p>The policy document.</p>
    *          <p>You must provide policies in JSON format in IAM. However, for CloudFormation templates
    *             formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always
-   *             converts a YAML policy to JSON format before submitting it to = IAM.</p>
+   *             converts a YAML policy to JSON format before submitting it to IAM.</p>
    *          <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a>
    *     used to validate this parameter is a string of characters consisting of the following:</p>
    *          <ul>