@aws-sdk/client-cognito-identity-provider 3.865.0 → 3.873.0

package/dist-types/commands/UpdateTermsCommand.d.ts

@@ -0,0 +1,147 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
+import { UpdateTermsRequest, UpdateTermsResponse } from "../models/models_1";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateTermsCommand}.
+ */
+export interface UpdateTermsCommandInput extends UpdateTermsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateTermsCommand}.
+ */
+export interface UpdateTermsCommandOutput extends UpdateTermsResponse, __MetadataBearer {
+}
+declare const UpdateTermsCommand_base: {
+    new (input: UpdateTermsCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateTermsCommandInput, UpdateTermsCommandOutput, CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: UpdateTermsCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateTermsCommandInput, UpdateTermsCommandOutput, CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Modifies existing terms documents for the requested app client. When Terms and
+ *             conditions and Privacy policy documents are configured, the app client displays links to
+ *             them in the sign-up page of managed login for the app client.</p>
+ *          <p>You can provide URLs for terms documents in the languages that are supported by <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html#managed-login-localization">managed login localization</a>. Amazon Cognito directs users to the terms documents for
+ *             their current language, with fallback to <code>default</code> if no document exists for
+ *             the language.</p>
+ *          <p>Each request accepts one type of terms document and a map of language-to-link for that
+ *             document type. You must provide both types of terms documents in at least one language
+ *             before Amazon Cognito displays your terms documents. Supply each type in separate
+ *             requests.</p>
+ *          <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html#managed-login-terms-documents">Terms documents</a>.</p>
+ *          <note>
+ *             <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
+ *     this operation, you must use IAM credentials to authorize requests, and you must
+ *     grant yourself the corresponding IAM permission in a policy.</p>
+ *             <p class="title">
+ *                <b>Learn more</b>
+ *             </p>
+ *             <ul>
+ *                <li>
+ *                   <p>
+ *                      <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
+ *                   </p>
+ *                </li>
+ *                <li>
+ *                   <p>
+ *                      <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>
+ *                   </p>
+ *                </li>
+ *             </ul>
+ *          </note>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CognitoIdentityProviderClient, UpdateTermsCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
+ * // const { CognitoIdentityProviderClient, UpdateTermsCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
+ * const client = new CognitoIdentityProviderClient(config);
+ * const input = { // UpdateTermsRequest
+ *   TermsId: "STRING_VALUE", // required
+ *   UserPoolId: "STRING_VALUE", // required
+ *   TermsName: "STRING_VALUE",
+ *   TermsSource: "LINK",
+ *   Enforcement: "NONE",
+ *   Links: { // LinksType
+ *     "<keys>": "STRING_VALUE",
+ *   },
+ * };
+ * const command = new UpdateTermsCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateTermsResponse
+ * //   Terms: { // TermsType
+ * //     TermsId: "STRING_VALUE", // required
+ * //     UserPoolId: "STRING_VALUE", // required
+ * //     ClientId: "STRING_VALUE", // required
+ * //     TermsName: "STRING_VALUE", // required
+ * //     TermsSource: "LINK", // required
+ * //     Enforcement: "NONE", // required
+ * //     Links: { // LinksType // required
+ * //       "<keys>": "STRING_VALUE",
+ * //     },
+ * //     CreationDate: new Date("TIMESTAMP"), // required
+ * //     LastModifiedDate: new Date("TIMESTAMP"), // required
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateTermsCommandInput - {@link UpdateTermsCommandInput}
+ * @returns {@link UpdateTermsCommandOutput}
+ * @see {@link UpdateTermsCommandInput} for command's `input` shape.
+ * @see {@link UpdateTermsCommandOutput} for command's `response` shape.
+ * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
+ *
+ * @throws {@link ConcurrentModificationException} (client fault)
+ *  <p>This exception is thrown if two or more modifications are happening
+ *             concurrently.</p>
+ *
+ * @throws {@link InternalErrorException} (server fault)
+ *  <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>This exception is thrown when the Amazon Cognito service encounters an invalid
+ *             parameter.</p>
+ *
+ * @throws {@link NotAuthorizedException} (client fault)
+ *  <p>This exception is thrown when a user isn't authorized.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>This exception is thrown when the Amazon Cognito service can't find the requested
+ *             resource.</p>
+ *
+ * @throws {@link TermsExistsException} (client fault)
+ *  <p>Terms document names must be unique to the app client. This exception is thrown when
+ *             you attempt to create terms documents with a duplicate <code>TermsName</code>.</p>
+ *
+ * @throws {@link TooManyRequestsException} (client fault)
+ *  <p>This exception is thrown when the user has made too many requests for a given
+ *             operation.</p>
+ *
+ * @throws {@link CognitoIdentityProviderServiceException}
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
+ *
+ *
+ * @public
+ */
+export declare class UpdateTermsCommand extends UpdateTermsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateTermsRequest;
+            output: UpdateTermsResponse;
+        };
+        sdk: {
+            input: UpdateTermsCommandInput;
+            output: UpdateTermsCommandOutput;
+        };
+    };
+}

package/dist-types/commands/index.d.ts

@@ -35,6 +35,7 @@ export * from "./CreateGroupCommand";
 export * from "./CreateIdentityProviderCommand";
 export * from "./CreateManagedLoginBrandingCommand";
 export * from "./CreateResourceServerCommand";
+export * from "./CreateTermsCommand";
 export * from "./CreateUserImportJobCommand";
 export * from "./CreateUserPoolClientCommand";
 export * from "./CreateUserPoolCommand";
@@ -43,6 +44,7 @@ export * from "./DeleteGroupCommand";
 export * from "./DeleteIdentityProviderCommand";
 export * from "./DeleteManagedLoginBrandingCommand";
 export * from "./DeleteResourceServerCommand";
+export * from "./DeleteTermsCommand";
 export * from "./DeleteUserAttributesCommand";
 export * from "./DeleteUserCommand";
 export * from "./DeleteUserPoolClientCommand";
@@ -54,6 +56,7 @@ export * from "./DescribeManagedLoginBrandingByClientCommand";
 export * from "./DescribeManagedLoginBrandingCommand";
 export * from "./DescribeResourceServerCommand";
 export * from "./DescribeRiskConfigurationCommand";
+export * from "./DescribeTermsCommand";
 export * from "./DescribeUserImportJobCommand";
 export * from "./DescribeUserPoolClientCommand";
 export * from "./DescribeUserPoolCommand";
@@ -79,6 +82,7 @@ export * from "./ListGroupsCommand";
 export * from "./ListIdentityProvidersCommand";
 export * from "./ListResourceServersCommand";
 export * from "./ListTagsForResourceCommand";
+export * from "./ListTermsCommand";
 export * from "./ListUserImportJobsCommand";
 export * from "./ListUserPoolClientsCommand";
 export * from "./ListUserPoolsCommand";
@@ -106,6 +110,7 @@ export * from "./UpdateGroupCommand";
 export * from "./UpdateIdentityProviderCommand";
 export * from "./UpdateManagedLoginBrandingCommand";
 export * from "./UpdateResourceServerCommand";
+export * from "./UpdateTermsCommand";
 export * from "./UpdateUserAttributesCommand";
 export * from "./UpdateUserPoolClientCommand";
 export * from "./UpdateUserPoolCommand";