docs(client-cognito-identity): Updated API model build artifacts for identity pools

awstools · awstools · commit 3144f880cf8b · 2025-03-14T18:09:50.000Z
diff --git a/clients/client-cognito-identity/README.md b/clients/client-cognito-identity/README.md
@@ -16,11 +16,12 @@ application.</p>
 more third-party identity providers (Facebook, Google, or Login with Amazon) or an Amazon
 Cognito user pool, and you can also choose to support unauthenticated access from your app.
 Cognito delivers a unique identifier for each user and acts as an OpenID token provider
-trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS
-credentials.</p>
+trusted by Security Token Service (STS) to access temporary, limited-privilege Amazon Web Services credentials.</p>
 <p>For a description of the authentication flow from the Amazon Cognito Developer Guide
-see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html">Authentication Flow</a>.</p>
-<p>For more information see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html">Amazon Cognito Federated Identities</a>.</p>
+see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html">Authentication
+Flow</a>.</p>
+<p>For more information see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html">Amazon Cognito Federated
+Identities</a>.</p>
 
 ## Installing
 
diff --git a/clients/client-cognito-identity/src/CognitoIdentity.ts b/clients/client-cognito-identity/src/CognitoIdentity.ts
@@ -513,11 +513,12 @@ export interface CognitoIdentity {
  *          more third-party identity providers (Facebook, Google, or Login with Amazon) or an Amazon
  *          Cognito user pool, and you can also choose to support unauthenticated access from your app.
  *          Cognito delivers a unique identifier for each user and acts as an OpenID token provider
- *          trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS
- *          credentials.</p>
+ *          trusted by Security Token Service (STS) to access temporary, limited-privilege Amazon Web Services credentials.</p>
  *          <p>For a description of the authentication flow from the Amazon Cognito Developer Guide
- *          see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html">Authentication Flow</a>.</p>
- *          <p>For more information see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html">Amazon Cognito Federated Identities</a>.</p>
+ *          see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html">Authentication
+ *          Flow</a>.</p>
+ *          <p>For more information see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html">Amazon Cognito Federated
+ *             Identities</a>.</p>
  * @public
  */
 export class CognitoIdentity extends CognitoIdentityClient implements CognitoIdentity {}
diff --git a/clients/client-cognito-identity/src/CognitoIdentityClient.ts b/clients/client-cognito-identity/src/CognitoIdentityClient.ts
@@ -376,11 +376,12 @@ export interface CognitoIdentityClientResolvedConfig extends CognitoIdentityClie
  *          more third-party identity providers (Facebook, Google, or Login with Amazon) or an Amazon
  *          Cognito user pool, and you can also choose to support unauthenticated access from your app.
  *          Cognito delivers a unique identifier for each user and acts as an OpenID token provider
- *          trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS
- *          credentials.</p>
+ *          trusted by Security Token Service (STS) to access temporary, limited-privilege Amazon Web Services credentials.</p>
  *          <p>For a description of the authentication flow from the Amazon Cognito Developer Guide
- *          see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html">Authentication Flow</a>.</p>
- *          <p>For more information see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html">Amazon Cognito Federated Identities</a>.</p>
+ *          see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html">Authentication
+ *          Flow</a>.</p>
+ *          <p>For more information see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html">Amazon Cognito Federated
+ *             Identities</a>.</p>
  * @public
  */
 export class CognitoIdentityClient extends __Client<
diff --git a/clients/client-cognito-identity/src/commands/CreateIdentityPoolCommand.ts b/clients/client-cognito-identity/src/commands/CreateIdentityPoolCommand.ts
@@ -29,8 +29,8 @@ export interface CreateIdentityPoolCommandOutput extends IdentityPool, __Metadat
 
 /**
  * <p>Creates a new identity pool. The identity pool is a store of user identity
- *          information that is specific to your AWS account. The keys for <code>SupportedLoginProviders</code> are as follows:</p>
- *
+ *          information that is specific to your Amazon Web Services account. The keys for
+ *             <code>SupportedLoginProviders</code> are as follows:</p>
  *          <ul>
  *             <li>
  *                <p>Facebook: <code>graph.facebook.com</code>
@@ -41,6 +41,10 @@ export interface CreateIdentityPoolCommandOutput extends IdentityPool, __Metadat
  *                </p>
  *             </li>
  *             <li>
+ *                <p>Sign in With Apple: <code>appleid.apple.com</code>
+ *                </p>
+ *             </li>
+ *             <li>
  *                <p>Amazon: <code>www.amazon.com</code>
  *                </p>
  *             </li>
@@ -53,8 +57,12 @@ export interface CreateIdentityPoolCommandOutput extends IdentityPool, __Metadat
  *                </p>
  *             </li>
  *          </ul>
- *
- *          <p>You must use AWS Developer credentials to call this API.</p>
+ *          <important>
+ *             <p>If you don't provide a value for a parameter, Amazon Cognito sets it to its default value.
+ *       </p>
+ *          </important>
+ *          <p>You must use Amazon Web Services developer credentials to call this
+ *          operation.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-cognito-identity/src/commands/DeleteIdentitiesCommand.ts b/clients/client-cognito-identity/src/commands/DeleteIdentitiesCommand.ts
@@ -30,7 +30,8 @@ export interface DeleteIdentitiesCommandOutput extends DeleteIdentitiesResponse,
 /**
  * <p>Deletes identities from an identity pool. You can specify a list of 1-60 identities
  *          that you want to delete.</p>
- *          <p>You must use AWS Developer credentials to call this API.</p>
+ *          <p>You must use Amazon Web Services developer credentials to call this
+ *          operation.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-cognito-identity/src/commands/DeleteIdentityPoolCommand.ts b/clients/client-cognito-identity/src/commands/DeleteIdentityPoolCommand.ts
@@ -30,7 +30,8 @@ export interface DeleteIdentityPoolCommandOutput extends __MetadataBearer {}
 /**
  * <p>Deletes an identity pool. Once a pool is deleted, users will not be able to
  *          authenticate with the pool.</p>
- *          <p>You must use AWS Developer credentials to call this API.</p>
+ *          <p>You must use Amazon Web Services developer credentials to call this
+ *          operation.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-cognito-identity/src/commands/DescribeIdentityCommand.ts b/clients/client-cognito-identity/src/commands/DescribeIdentityCommand.ts
@@ -30,7 +30,8 @@ export interface DescribeIdentityCommandOutput extends IdentityDescription, __Me
 /**
  * <p>Returns metadata related to the given identity, including when the identity was
  *          created and any associated linked logins.</p>
- *          <p>You must use AWS Developer credentials to call this API.</p>
+ *          <p>You must use Amazon Web Services developer credentials to call this
+ *          operation.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-cognito-identity/src/commands/DescribeIdentityPoolCommand.ts b/clients/client-cognito-identity/src/commands/DescribeIdentityPoolCommand.ts
@@ -30,7 +30,8 @@ export interface DescribeIdentityPoolCommandOutput extends IdentityPool, __Metad
 /**
  * <p>Gets details about a particular identity pool, including the pool name, ID
  *          description, creation date, and current number of users.</p>
- *          <p>You must use AWS Developer credentials to call this API.</p>
+ *          <p>You must use Amazon Web Services developer credentials to call this
+ *          operation.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-cognito-identity/src/commands/GetCredentialsForIdentityCommand.ts b/clients/client-cognito-identity/src/commands/GetCredentialsForIdentityCommand.ts
@@ -35,8 +35,7 @@ export interface GetCredentialsForIdentityCommandOutput extends GetCredentialsFo
 /**
  * <p>Returns credentials for the provided identity ID. Any provided logins will be
  *          validated against supported login providers. If the token is for
- *          cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service
- *          with the appropriate role for the token.</p>
+ *             <code>cognito-identity.amazonaws.com</code>, it will be passed through to Security Token Service with the appropriate role for the token.</p>
  *          <p>This is a public API. You do not need any credentials to call this API.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -79,8 +78,13 @@ export interface GetCredentialsForIdentityCommandOutput extends GetCredentialsFo
  *  <p>Thrown when the service encounters an error during processing the request.</p>
  *
  * @throws {@link InvalidIdentityPoolConfigurationException} (client fault)
- *  <p>Thrown if the identity pool has no role associated for the given auth type
- *          (auth/unauth) or if the AssumeRole fails.</p>
+ *  <p>If you provided authentication information in the request, the identity pool has no
+ *          authenticated role configured, or STS returned an error response to the
+ *          request to assume the authenticated role from the identity pool. If you provided no
+ *          authentication information in the request, the identity pool has no unauthenticated role
+ *          configured, or STS returned an error response to the request to assume the
+ *          unauthenticated role from the identity pool.</p>
+ *          <p>Your role trust policy must grant <code>AssumeRoleWithWebIdentity</code> permissions to <code>cognito-identity.amazonaws.com</code>.</p>
  *
  * @throws {@link InvalidParameterException} (client fault)
  *  <p>Thrown for missing or bad input parameter(s).</p>
diff --git a/clients/client-cognito-identity/src/commands/GetIdCommand.ts b/clients/client-cognito-identity/src/commands/GetIdCommand.ts
@@ -28,7 +28,7 @@ export interface GetIdCommandInput extends GetIdInput {}
 export interface GetIdCommandOutput extends GetIdResponse, __MetadataBearer {}
 
 /**
- * <p>Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an
+ * <p>Generates (or retrieves) IdentityID. Supplying multiple logins will create an
  *          implicit linked account.</p>
  *          <p>This is a public API. You do not need any credentials to call this API.</p>
  * @example
diff --git a/clients/client-cognito-identity/src/commands/GetIdentityPoolRolesCommand.ts b/clients/client-cognito-identity/src/commands/GetIdentityPoolRolesCommand.ts
@@ -29,7 +29,8 @@ export interface GetIdentityPoolRolesCommandOutput extends GetIdentityPoolRolesR
 
 /**
  * <p>Gets the roles for an identity pool.</p>
- *          <p>You must use AWS Developer credentials to call this API.</p>
+ *          <p>You must use Amazon Web Services developer credentials to call this
+ *          operation.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-cognito-identity/src/commands/GetOpenIdTokenForDeveloperIdentityCommand.ts b/clients/client-cognito-identity/src/commands/GetOpenIdTokenForDeveloperIdentityCommand.ts
@@ -50,7 +50,8 @@ export interface GetOpenIdTokenForDeveloperIdentityCommandOutput
  *          existing authenticated/unauthenticated identity, you can do so by providing the existing
  *             <code>IdentityId</code>. This API will create the identity in the specified
  *             <code>IdentityPoolId</code>.</p>
- *          <p>You must use AWS Developer credentials to call this API.</p>
+ *          <p>You must use Amazon Web Services developer credentials to call this
+ *          operation.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-cognito-identity/src/commands/GetPrincipalTagAttributeMapCommand.ts b/clients/client-cognito-identity/src/commands/GetPrincipalTagAttributeMapCommand.ts
@@ -30,7 +30,8 @@ export interface GetPrincipalTagAttributeMapCommandOutput
     __MetadataBearer {}
 
 /**
- * <p>Use <code>GetPrincipalTagAttributeMap</code> to list all mappings between <code>PrincipalTags</code> and user attributes.</p>
+ * <p>Use <code>GetPrincipalTagAttributeMap</code> to list all mappings between
+ *             <code>PrincipalTags</code> and user attributes.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-cognito-identity/src/commands/ListIdentitiesCommand.ts b/clients/client-cognito-identity/src/commands/ListIdentitiesCommand.ts
@@ -29,7 +29,8 @@ export interface ListIdentitiesCommandOutput extends ListIdentitiesResponse, __M
 
 /**
  * <p>Lists the identities in an identity pool.</p>
- *          <p>You must use AWS Developer credentials to call this API.</p>
+ *          <p>You must use Amazon Web Services developer credentials to call this
+ *          operation.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-cognito-identity/src/commands/ListIdentityPoolsCommand.ts b/clients/client-cognito-identity/src/commands/ListIdentityPoolsCommand.ts
@@ -29,7 +29,8 @@ export interface ListIdentityPoolsCommandOutput extends ListIdentityPoolsRespons
 
 /**
  * <p>Lists all of the Cognito identity pools registered for your account.</p>
- *          <p>You must use AWS Developer credentials to call this API.</p>
+ *          <p>You must use Amazon Web Services developer credentials to call this
+ *          operation.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-cognito-identity/src/commands/LookupDeveloperIdentityCommand.ts b/clients/client-cognito-identity/src/commands/LookupDeveloperIdentityCommand.ts
@@ -36,15 +36,16 @@ export interface LookupDeveloperIdentityCommandOutput extends LookupDeveloperIde
  *          returned as a part of the response. If you supply both,
  *             <code>DeveloperUserIdentifier</code> will be matched against <code>IdentityID</code>. If
  *          the values are verified against the database, the response returns both values and is the
- *          same as the request. Otherwise a <code>ResourceConflictException</code> is
+ *          same as the request. Otherwise, a <code>ResourceConflictException</code> is
  *          thrown.</p>
  *          <p>
  *             <code>LookupDeveloperIdentity</code> is intended for low-throughput control plane
  *          operations: for example, to enable customer service to locate an identity ID by username.
  *          If you are using it for higher-volume operations such as user authentication, your requests
  *          are likely to be throttled. <a>GetOpenIdTokenForDeveloperIdentity</a> is a
  *          better option for higher-volume operations for user authentication.</p>
- *          <p>You must use AWS Developer credentials to call this API.</p>
+ *          <p>You must use Amazon Web Services developer credentials to call this
+ *          operation.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-cognito-identity/src/commands/MergeDeveloperIdentitiesCommand.ts b/clients/client-cognito-identity/src/commands/MergeDeveloperIdentitiesCommand.ts
@@ -38,9 +38,10 @@ export interface MergeDeveloperIdentitiesCommandOutput extends MergeDeveloperIde
  *          thrown.</p>
  *          <p>The number of linked logins is limited to 20. So, the number of linked logins for the
  *          source user, <code>SourceUserIdentifier</code>, and the destination user,
- *          <code>DestinationUserIdentifier</code>, together should not be larger than 20.
+ *             <code>DestinationUserIdentifier</code>, together should not be larger than 20.
  *          Otherwise, an exception will be thrown.</p>
- *          <p>You must use AWS Developer credentials to call this API.</p>
+ *          <p>You must use Amazon Web Services developer credentials to call this
+ *          operation.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-cognito-identity/src/commands/SetIdentityPoolRolesCommand.ts b/clients/client-cognito-identity/src/commands/SetIdentityPoolRolesCommand.ts
@@ -29,7 +29,8 @@ export interface SetIdentityPoolRolesCommandOutput extends __MetadataBearer {}
 
 /**
  * <p>Sets the roles for an identity pool. These roles are used when making calls to <a>GetCredentialsForIdentity</a> action.</p>
- *          <p>You must use AWS Developer credentials to call this API.</p>
+ *          <p>You must use Amazon Web Services developer credentials to call this
+ *          operation.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-cognito-identity/src/commands/SetPrincipalTagAttributeMapCommand.ts b/clients/client-cognito-identity/src/commands/SetPrincipalTagAttributeMapCommand.ts
@@ -30,7 +30,8 @@ export interface SetPrincipalTagAttributeMapCommandOutput
     __MetadataBearer {}
 
 /**
- * <p>You can use this operation to use default (username and clientID) attribute or custom attribute mappings.</p>
+ * <p>You can use this operation to use default (username and clientID) attribute or custom
+ *          attribute mappings.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-cognito-identity/src/commands/TagResourceCommand.ts b/clients/client-cognito-identity/src/commands/TagResourceCommand.ts
@@ -39,8 +39,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
  *          other.</p>
  *          <p>Tags are useful for cost tracking and access control. You can activate your tags so that
  *          they appear on the Billing and Cost Management console, where you can track the costs
- *          associated with your identity pools. In an IAM policy, you can constrain permissions for
- *          identity pools based on specific tags or tag values.</p>
+ *          associated with your identity pools. In an IAM policy, you can constrain
+ *          permissions for identity pools based on specific tags or tag values.</p>
  *          <p>You can use this action up to 5 times per second, per account. An identity pool can have
  *          as many as 50 tags.</p>
  * @example
diff --git a/clients/client-cognito-identity/src/commands/UnlinkDeveloperIdentityCommand.ts b/clients/client-cognito-identity/src/commands/UnlinkDeveloperIdentityCommand.ts
@@ -32,7 +32,8 @@ export interface UnlinkDeveloperIdentityCommandOutput extends __MetadataBearer {
  *          developer users will be considered new identities next time they are seen. If, for a given
  *          Cognito identity, you remove all federated identities as well as the developer user
  *          identifier, the Cognito identity becomes inaccessible.</p>
- *          <p>You must use AWS Developer credentials to call this API.</p>
+ *          <p>You must use Amazon Web Services developer credentials to call this
+ *          operation.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-cognito-identity/src/commands/UpdateIdentityPoolCommand.ts b/clients/client-cognito-identity/src/commands/UpdateIdentityPoolCommand.ts
@@ -28,8 +28,13 @@ export interface UpdateIdentityPoolCommandInput extends IdentityPool {}
 export interface UpdateIdentityPoolCommandOutput extends IdentityPool, __MetadataBearer {}
 
 /**
- * <p>Updates an identity pool.</p>
- *          <p>You must use AWS Developer credentials to call this API.</p>
+ * <p>Updates the configuration of an identity pool.</p>
+ *          <important>
+ *             <p>If you don't provide a value for a parameter, Amazon Cognito sets it to its default value.
+ *       </p>
+ *          </important>
+ *          <p>You must use Amazon Web Services developer credentials to call this
+ *          operation.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-cognito-identity/src/index.ts b/clients/client-cognito-identity/src/index.ts
@@ -10,11 +10,12 @@
  *          more third-party identity providers (Facebook, Google, or Login with Amazon) or an Amazon
  *          Cognito user pool, and you can also choose to support unauthenticated access from your app.
  *          Cognito delivers a unique identifier for each user and acts as an OpenID token provider
- *          trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS
- *          credentials.</p>
+ *          trusted by Security Token Service (STS) to access temporary, limited-privilege Amazon Web Services credentials.</p>
  *          <p>For a description of the authentication flow from the Amazon Cognito Developer Guide
- *          see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html">Authentication Flow</a>.</p>
- *          <p>For more information see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html">Amazon Cognito Federated Identities</a>.</p>
+ *          see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html">Authentication
+ *          Flow</a>.</p>
+ *          <p>For more information see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html">Amazon Cognito Federated
+ *             Identities</a>.</p>
  *
  * @packageDocumentation
  */
diff --git a/clients/client-cognito-identity/src/models/models_0.ts b/clients/client-cognito-identity/src/models/models_0.ts
diff --git a/codegen/sdk-codegen/aws-models/cognito-identity.json b/codegen/sdk-codegen/aws-models/cognito-identity.json
