@aws-sdk/client-chime-sdk-identity 3.297.0 → 3.299.0

package/dist-types/models/models_0.d.ts

@@ -36,7 +36,7 @@ export interface AppInstance {
 }
 /**
  * @public
- * <p>The details of a user.</p>
+ * <p>The details of a user or bot.</p>
  */
 export interface Identity {
     /**
@@ -50,7 +50,7 @@ export interface Identity {
 }
 /**
  * @public
- * <p>The details of an <code>AppInstanceAdmin</code>.</p>
+ * <p>The name and ARN of the admin for the <code>AppInstance</code>.</p>
  */
 export interface AppInstanceAdmin {
     /**
@@ -76,6 +76,96 @@ export interface AppInstanceAdminSummary {
      */
     Admin?: Identity;
 }
+/**
+ * @public
+ */
+export declare enum RespondsTo {
+    STANDARD_MESSAGES = "STANDARD_MESSAGES"
+}
+/**
+ * @public
+ * <p>The configuration for an Amazon Lex V2 bot.</p>
+ */
+export interface LexConfiguration {
+    /**
+     * <p>Determines whether the Amazon Lex V2 bot responds to all standard messages. Control messages are not supported.</p>
+     */
+    RespondsTo: RespondsTo | string | undefined;
+    /**
+     * <p>The ARN of the Amazon Lex V2 bot's alias. The ARN uses this format:
+     *          <code>arn:aws:lex:REGION:ACCOUNT:bot-alias/MYBOTID/MYBOTALIAS</code>
+     *          </p>
+     */
+    LexBotAliasArn: string | undefined;
+    /**
+     * <p>Identifies the Amazon Lex V2 bot's language and locale. The string must match one of the
+     *          supported locales in Amazon Lex V2. All of the intents, slot types, and slots used in the bot must have the same
+     *          locale. For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a> in the <i>Amazon Lex V2 Developer Guide</i>.</p>
+     */
+    LocaleId: string | undefined;
+    /**
+     * <p>The name of the welcome intent configured in the Amazon Lex V2 bot.</p>
+     */
+    WelcomeIntent?: string;
+}
+/**
+ * @public
+ * <p>A structure that contains configuration data.</p>
+ */
+export interface Configuration {
+    /**
+     * <p>The configuration for an Amazon Lex V2 bot.</p>
+     */
+    Lex: LexConfiguration | undefined;
+}
+/**
+ * @public
+ * <p>An Amazon Lex V2 chat bot created under an <code>AppInstance</code>.</p>
+ */
+export interface AppInstanceBot {
+    /**
+     * <p>The ARN of the AppInstanceBot.</p>
+     */
+    AppInstanceBotArn?: string;
+    /**
+     * <p>The name of the AppInstanceBot.</p>
+     */
+    Name?: string;
+    /**
+     * <p>The data processing instructions for an AppInstanceBot.</p>
+     */
+    Configuration?: Configuration;
+    /**
+     * <p>The time at which the <code>AppInstanceBot</code> was created.</p>
+     */
+    CreatedTimestamp?: Date;
+    /**
+     * <p>The time at which the <code>AppInstanceBot</code> was last updated.</p>
+     */
+    LastUpdatedTimestamp?: Date;
+    /**
+     * <p>The metadata for an AppInstanceBot.</p>
+     */
+    Metadata?: string;
+}
+/**
+ * @public
+ * <p>High-level information about an AppInstanceBot.</p>
+ */
+export interface AppInstanceBotSummary {
+    /**
+     * <p>The ARN of the AppInstanceBot.</p>
+     */
+    AppInstanceBotArn?: string;
+    /**
+     * <p>The name of the AppInstanceBox.</p>
+     */
+    Name?: string;
+    /**
+     * <p>The metadata of the AppInstanceBot.</p>
+     */
+    Metadata?: string;
+}
 /**
  * @public
  * <p>Summary of the data for an <code>AppInstance</code>.</p>
@@ -114,6 +204,26 @@ export interface AppInstanceRetentionSettings {
      */
     ChannelRetentionSettings?: ChannelRetentionSettings;
 }
+/**
+ * @public
+ */
+export declare enum ExpirationCriterion {
+    CREATED_TIMESTAMP = "CREATED_TIMESTAMP"
+}
+/**
+ * @public
+ * <p>Determines the interval after which an <code>AppInstanceUser</code> is automatically deleted.</p>
+ */
+export interface ExpirationSettings {
+    /**
+     * <p>The period in days after which an <code>AppInstanceUser</code> will be automatically deleted.</p>
+     */
+    ExpirationDays: number | undefined;
+    /**
+     * <p>Specifies the conditions under which an <code>AppInstanceUser</code> will expire.</p>
+     */
+    ExpirationCriterion: ExpirationCriterion | string | undefined;
+}
 /**
  * @public
  * <p>The details of an <code>AppInstanceUser</code>.</p>
@@ -139,6 +249,10 @@ export interface AppInstanceUser {
      * <p>The time at which the <code>AppInstanceUser</code> was last updated.</p>
      */
     LastUpdatedTimestamp?: Date;
+    /**
+     * <p>The interval after which an <code>AppInstanceUser</code> is automatically deleted.</p>
+     */
+    ExpirationSettings?: ExpirationSettings;
 }
 /**
  * @public
@@ -402,11 +516,11 @@ export interface CreateAppInstanceRequest {
      */
     Metadata?: string;
     /**
-     * <p>The <code>ClientRequestToken</code> of the <code>AppInstance</code>.</p>
+     * <p>The unique ID of the request. Use different tokens to create different <code>AppInstances</code>.</p>
      */
     ClientRequestToken?: string;
     /**
-     * <p>Tags assigned to the <code>AppInstanceUser</code>.</p>
+     * <p>Tags assigned to the <code>AppInstance</code>.</p>
      */
     Tags?: Tag[];
 }
@@ -521,7 +635,8 @@ export interface CreateAppInstanceAdminRequest {
  */
 export interface CreateAppInstanceAdminResponse {
     /**
-     * <p>The name and ARN of the admin for the <code>AppInstance</code>.</p>
+     * <p>The ARN and name of the administrator, the ARN of the <code>AppInstance</code>, and the created and
+     *          last-updated timestamps. All timestamps use epoch milliseconds.</p>
      */
     AppInstanceAdmin?: Identity;
     /**
@@ -529,6 +644,44 @@ export interface CreateAppInstanceAdminResponse {
      */
     AppInstanceArn?: string;
 }
+/**
+ * @public
+ */
+export interface CreateAppInstanceBotRequest {
+    /**
+     * <p>The ARN of the <code>AppInstance</code> request.</p>
+     */
+    AppInstanceArn: string | undefined;
+    /**
+     * <p>The user's name.</p>
+     */
+    Name?: string;
+    /**
+     * <p>The request metadata. Limited to a 1KB string in UTF-8.</p>
+     */
+    Metadata?: string;
+    /**
+     * <p>The unique ID for the client making the request. Use different tokens for different <code>AppInstanceBots</code>.</p>
+     */
+    ClientRequestToken?: string;
+    /**
+     * <p>The tags assigned to the <code>AppInstanceBot</code>.</p>
+     */
+    Tags?: Tag[];
+    /**
+     * <p>Configuration information about the Amazon Lex V2 V2 bot.</p>
+     */
+    Configuration: Configuration | undefined;
+}
+/**
+ * @public
+ */
+export interface CreateAppInstanceBotResponse {
+    /**
+     * <p>The ARN of the <code>AppinstanceBot</code>.</p>
+     */
+    AppInstanceBotArn?: string;
+}
 /**
  * @public
  */
@@ -550,13 +703,17 @@ export interface CreateAppInstanceUserRequest {
      */
     Metadata?: string;
     /**
-     * <p>The token assigned to the user requesting an <code>AppInstance</code>.</p>
+     * <p>The unique ID of the request. Use different tokens to request additional <code>AppInstances</code>.</p>
      */
     ClientRequestToken?: string;
     /**
      * <p>Tags assigned to the <code>AppInstanceUser</code>.</p>
      */
     Tags?: Tag[];
+    /**
+     * <p>Settings that control the interval after which the <code>AppInstanceUser</code> is automatically deleted.</p>
+     */
+    ExpirationSettings?: ExpirationSettings;
 }
 /**
  * @public
@@ -589,6 +746,15 @@ export interface DeleteAppInstanceAdminRequest {
      */
     AppInstanceArn: string | undefined;
 }
+/**
+ * @public
+ */
+export interface DeleteAppInstanceBotRequest {
+    /**
+     * <p>The ARN of the <code>AppInstanceBot</code> being deleted.</p>
+     */
+    AppInstanceBotArn: string | undefined;
+}
 /**
  * @public
  */
@@ -654,6 +820,38 @@ export interface DescribeAppInstanceAdminResponse {
      */
     AppInstanceAdmin?: AppInstanceAdmin;
 }
+/**
+ * @public
+ */
+export interface DescribeAppInstanceBotRequest {
+    /**
+     * <p>The ARN of the <code>AppInstanceBot</code>.</p>
+     */
+    AppInstanceBotArn: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DescribeAppInstanceBotResponse {
+    /**
+     * <p>The detials of the <code>AppInstanceBot</code>.</p>
+     */
+    AppInstanceBot?: AppInstanceBot;
+}
+/**
+ * @public
+ * <p>One or more of the resources in the request does not exist in the system.</p>
+ */
+export declare class NotFoundException extends __BaseException {
+    readonly name: "NotFoundException";
+    readonly $fault: "client";
+    Code?: ErrorCode | string;
+    Message?: string;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
+}
 /**
  * @public
  */
@@ -754,6 +952,40 @@ export interface ListAppInstanceAdminsResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
+export interface ListAppInstanceBotsRequest {
+    /**
+     * <p>The ARN of the <code>AppInstance</code>.</p>
+     */
+    AppInstanceArn: string | undefined;
+    /**
+     * <p>The maximum number of requests to return.</p>
+     */
+    MaxResults?: number;
+    /**
+     * <p>The token passed by previous API calls until all requested bots are returned.</p>
+     */
+    NextToken?: string;
+}
+/**
+ * @public
+ */
+export interface ListAppInstanceBotsResponse {
+    /**
+     * <p>The ARN of the AppInstance.</p>
+     */
+    AppInstanceArn?: string;
+    /**
+     * <p>The information for each requested <code>AppInstanceBot</code>.</p>
+     */
+    AppInstanceBots?: AppInstanceBotSummary[];
+    /**
+     * <p>The token passed by previous API calls until all requested bots are returned.</p>
+     */
+    NextToken?: string;
+}
 /**
  * @public
  */
@@ -890,6 +1122,32 @@ export interface PutAppInstanceRetentionSettingsResponse {
      */
     InitiateDeletionTimestamp?: Date;
 }
+/**
+ * @public
+ */
+export interface PutAppInstanceUserExpirationSettingsRequest {
+    /**
+     * <p>The ARN of the <code>AppInstanceUser</code>.</p>
+     */
+    AppInstanceUserArn: string | undefined;
+    /**
+     * <p>Settings that control the interval after which an <code>AppInstanceUser</code> is automatically deleted.</p>
+     */
+    ExpirationSettings?: ExpirationSettings;
+}
+/**
+ * @public
+ */
+export interface PutAppInstanceUserExpirationSettingsResponse {
+    /**
+     * <p>The ARN of the <code>AppInstanceUser</code>.</p>
+     */
+    AppInstanceUserArn?: string;
+    /**
+     * <p>Settings that control the interval after which an <code>AppInstanceUser</code> is automatically deleted.</p>
+     */
+    ExpirationSettings?: ExpirationSettings;
+}
 /**
  * @public
  */
@@ -930,7 +1188,7 @@ export interface RegisterAppInstanceUserEndpointRequest {
      */
     EndpointAttributes: EndpointAttributes | undefined;
     /**
-     * <p>The idempotency token for each client request. </p>
+     * <p>The unique ID assigned to the request. Use different tokens to register other endpoints.</p>
      */
     ClientRequestToken?: string;
     /**
@@ -1004,6 +1262,32 @@ export interface UpdateAppInstanceResponse {
      */
     AppInstanceArn?: string;
 }
+/**
+ * @public
+ */
+export interface UpdateAppInstanceBotRequest {
+    /**
+     * <p>The ARN of the <code>AppInstanceBot</code>.</p>
+     */
+    AppInstanceBotArn: string | undefined;
+    /**
+     * <p>The name of the <code>AppInstanceBot</code>.</p>
+     */
+    Name: string | undefined;
+    /**
+     * <p>The metadata of the <code>AppInstanceBot</code>.</p>
+     */
+    Metadata: string | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateAppInstanceBotResponse {
+    /**
+     * <p>The ARN of the <code>AppInstanceBot</code>.</p>
+     */
+    AppInstanceBotArn?: string;
+}
 /**
  * @public
  */
@@ -1084,15 +1368,15 @@ export declare const AppInstanceAdminSummaryFilterSensitiveLog: (obj: AppInstanc
 /**
  * @internal
  */
-export declare const AppInstanceSummaryFilterSensitiveLog: (obj: AppInstanceSummary) => any;
+export declare const AppInstanceBotFilterSensitiveLog: (obj: AppInstanceBot) => any;
 /**
  * @internal
  */
-export declare const ChannelRetentionSettingsFilterSensitiveLog: (obj: ChannelRetentionSettings) => any;
+export declare const AppInstanceBotSummaryFilterSensitiveLog: (obj: AppInstanceBotSummary) => any;
 /**
  * @internal
  */
-export declare const AppInstanceRetentionSettingsFilterSensitiveLog: (obj: AppInstanceRetentionSettings) => any;
+export declare const AppInstanceSummaryFilterSensitiveLog: (obj: AppInstanceSummary) => any;
 /**
  * @internal
  */
@@ -1101,10 +1385,6 @@ export declare const AppInstanceUserFilterSensitiveLog: (obj: AppInstanceUser) =
  * @internal
  */
 export declare const EndpointAttributesFilterSensitiveLog: (obj: EndpointAttributes) => any;
-/**
- * @internal
- */
-export declare const EndpointStateFilterSensitiveLog: (obj: EndpointState) => any;
 /**
  * @internal
  */
@@ -1125,14 +1405,6 @@ export declare const TagFilterSensitiveLog: (obj: Tag) => any;
  * @internal
  */
 export declare const CreateAppInstanceRequestFilterSensitiveLog: (obj: CreateAppInstanceRequest) => any;
-/**
- * @internal
- */
-export declare const CreateAppInstanceResponseFilterSensitiveLog: (obj: CreateAppInstanceResponse) => any;
-/**
- * @internal
- */
-export declare const CreateAppInstanceAdminRequestFilterSensitiveLog: (obj: CreateAppInstanceAdminRequest) => any;
 /**
  * @internal
  */
@@ -1140,39 +1412,19 @@ export declare const CreateAppInstanceAdminResponseFilterSensitiveLog: (obj: Cre
 /**
  * @internal
  */
-export declare const CreateAppInstanceUserRequestFilterSensitiveLog: (obj: CreateAppInstanceUserRequest) => any;
-/**
- * @internal
- */
-export declare const CreateAppInstanceUserResponseFilterSensitiveLog: (obj: CreateAppInstanceUserResponse) => any;
+export declare const CreateAppInstanceBotRequestFilterSensitiveLog: (obj: CreateAppInstanceBotRequest) => any;
 /**
  * @internal
  */
-export declare const DeleteAppInstanceRequestFilterSensitiveLog: (obj: DeleteAppInstanceRequest) => any;
-/**
- * @internal
- */
-export declare const DeleteAppInstanceAdminRequestFilterSensitiveLog: (obj: DeleteAppInstanceAdminRequest) => any;
-/**
- * @internal
- */
-export declare const DeleteAppInstanceUserRequestFilterSensitiveLog: (obj: DeleteAppInstanceUserRequest) => any;
+export declare const CreateAppInstanceUserRequestFilterSensitiveLog: (obj: CreateAppInstanceUserRequest) => any;
 /**
  * @internal
  */
 export declare const DeregisterAppInstanceUserEndpointRequestFilterSensitiveLog: (obj: DeregisterAppInstanceUserEndpointRequest) => any;
-/**
- * @internal
- */
-export declare const DescribeAppInstanceRequestFilterSensitiveLog: (obj: DescribeAppInstanceRequest) => any;
 /**
  * @internal
  */
 export declare const DescribeAppInstanceResponseFilterSensitiveLog: (obj: DescribeAppInstanceResponse) => any;
-/**
- * @internal
- */
-export declare const DescribeAppInstanceAdminRequestFilterSensitiveLog: (obj: DescribeAppInstanceAdminRequest) => any;
 /**
  * @internal
  */
@@ -1180,7 +1432,7 @@ export declare const DescribeAppInstanceAdminResponseFilterSensitiveLog: (obj: D
 /**
  * @internal
  */
-export declare const DescribeAppInstanceUserRequestFilterSensitiveLog: (obj: DescribeAppInstanceUserRequest) => any;
+export declare const DescribeAppInstanceBotResponseFilterSensitiveLog: (obj: DescribeAppInstanceBotResponse) => any;
 /**
  * @internal
  */
@@ -1196,19 +1448,19 @@ export declare const DescribeAppInstanceUserEndpointResponseFilterSensitiveLog:
 /**
  * @internal
  */
-export declare const GetAppInstanceRetentionSettingsRequestFilterSensitiveLog: (obj: GetAppInstanceRetentionSettingsRequest) => any;
+export declare const ListAppInstanceAdminsRequestFilterSensitiveLog: (obj: ListAppInstanceAdminsRequest) => any;
 /**
  * @internal
  */
-export declare const GetAppInstanceRetentionSettingsResponseFilterSensitiveLog: (obj: GetAppInstanceRetentionSettingsResponse) => any;
+export declare const ListAppInstanceAdminsResponseFilterSensitiveLog: (obj: ListAppInstanceAdminsResponse) => any;
 /**
  * @internal
  */
-export declare const ListAppInstanceAdminsRequestFilterSensitiveLog: (obj: ListAppInstanceAdminsRequest) => any;
+export declare const ListAppInstanceBotsRequestFilterSensitiveLog: (obj: ListAppInstanceBotsRequest) => any;
 /**
  * @internal
  */
-export declare const ListAppInstanceAdminsResponseFilterSensitiveLog: (obj: ListAppInstanceAdminsResponse) => any;
+export declare const ListAppInstanceBotsResponseFilterSensitiveLog: (obj: ListAppInstanceBotsResponse) => any;
 /**
  * @internal
  */
@@ -1233,22 +1485,10 @@ export declare const ListAppInstanceUsersRequestFilterSensitiveLog: (obj: ListAp
  * @internal
  */
 export declare const ListAppInstanceUsersResponseFilterSensitiveLog: (obj: ListAppInstanceUsersResponse) => any;
-/**
- * @internal
- */
-export declare const ListTagsForResourceRequestFilterSensitiveLog: (obj: ListTagsForResourceRequest) => any;
 /**
  * @internal
  */
 export declare const ListTagsForResourceResponseFilterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
-/**
- * @internal
- */
-export declare const PutAppInstanceRetentionSettingsRequestFilterSensitiveLog: (obj: PutAppInstanceRetentionSettingsRequest) => any;
-/**
- * @internal
- */
-export declare const PutAppInstanceRetentionSettingsResponseFilterSensitiveLog: (obj: PutAppInstanceRetentionSettingsResponse) => any;
 /**
  * @internal
  */
@@ -1272,15 +1512,11 @@ export declare const UpdateAppInstanceRequestFilterSensitiveLog: (obj: UpdateApp
 /**
  * @internal
  */
-export declare const UpdateAppInstanceResponseFilterSensitiveLog: (obj: UpdateAppInstanceResponse) => any;
+export declare const UpdateAppInstanceBotRequestFilterSensitiveLog: (obj: UpdateAppInstanceBotRequest) => any;
 /**
  * @internal
  */
 export declare const UpdateAppInstanceUserRequestFilterSensitiveLog: (obj: UpdateAppInstanceUserRequest) => any;
-/**
- * @internal
- */
-export declare const UpdateAppInstanceUserResponseFilterSensitiveLog: (obj: UpdateAppInstanceUserResponse) => any;
 /**
  * @internal
  */

package/dist-types/pagination/ListAppInstanceBotsPaginator.d.ts

@@ -0,0 +1,7 @@
+import { Paginator } from "@aws-sdk/types";
+import { ListAppInstanceBotsCommandInput, ListAppInstanceBotsCommandOutput } from "../commands/ListAppInstanceBotsCommand";
+import { ChimeSDKIdentityPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare function paginateListAppInstanceBots(config: ChimeSDKIdentityPaginationConfiguration, input: ListAppInstanceBotsCommandInput, ...additionalArguments: any): Paginator<ListAppInstanceBotsCommandOutput>;

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

@@ -1,5 +1,6 @@
 export * from "./Interfaces";
 export * from "./ListAppInstanceAdminsPaginator";
+export * from "./ListAppInstanceBotsPaginator";
 export * from "./ListAppInstanceUserEndpointsPaginator";
 export * from "./ListAppInstanceUsersPaginator";
 export * from "./ListAppInstancesPaginator";