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

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

@@ -1,10 +1,14 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { ChimeSDKIdentityServiceException as __BaseException } from "./ChimeSDKIdentityServiceException";
+/**
+ * @public
+ */
 export declare enum AllowMessages {
     ALL = "ALL",
     NONE = "NONE"
 }
 /**
+ * @public
  * <p>The details of an <code>AppInstance</code>, an instance of an Amazon Chime SDK messaging
  *          application.</p>
  */
@@ -31,6 +35,7 @@ export interface AppInstance {
     Metadata?: string;
 }
 /**
+ * @public
  * <p>The details of a user.</p>
  */
 export interface Identity {
@@ -44,6 +49,7 @@ export interface Identity {
     Name?: string;
 }
 /**
+ * @public
  * <p>The details of an <code>AppInstanceAdmin</code>.</p>
  */
 export interface AppInstanceAdmin {
@@ -61,6 +67,7 @@ export interface AppInstanceAdmin {
     CreatedTimestamp?: Date;
 }
 /**
+ * @public
  * <p>Summary of the details of an <code>AppInstanceAdmin</code>.</p>
  */
 export interface AppInstanceAdminSummary {
@@ -70,6 +77,7 @@ export interface AppInstanceAdminSummary {
     Admin?: Identity;
 }
 /**
+ * @public
  * <p>Summary of the data for an <code>AppInstance</code>.</p>
  */
 export interface AppInstanceSummary {
@@ -87,6 +95,7 @@ export interface AppInstanceSummary {
     Metadata?: string;
 }
 /**
+ * @public
  * <p>The details of the retention settings for a channel.</p>
  */
 export interface ChannelRetentionSettings {
@@ -96,6 +105,7 @@ export interface ChannelRetentionSettings {
     RetentionDays?: number;
 }
 /**
+ * @public
  * <p>The details of the data-retention settings for an <code>AppInstance</code>.</p>
  */
 export interface AppInstanceRetentionSettings {
@@ -105,6 +115,7 @@ export interface AppInstanceRetentionSettings {
     ChannelRetentionSettings?: ChannelRetentionSettings;
 }
 /**
+ * @public
  * <p>The details of an <code>AppInstanceUser</code>.</p>
  */
 export interface AppInstanceUser {
@@ -130,6 +141,7 @@ export interface AppInstanceUser {
     LastUpdatedTimestamp?: Date;
 }
 /**
+ * @public
  * <p>The attributes of an <code>Endpoint</code>.</p>
  */
 export interface EndpointAttributes {
@@ -142,15 +154,22 @@ export interface EndpointAttributes {
      */
     VoipDeviceToken?: string;
 }
+/**
+ * @public
+ */
 export declare enum EndpointStatus {
     ACTIVE = "ACTIVE",
     INACTIVE = "INACTIVE"
 }
+/**
+ * @public
+ */
 export declare enum EndpointStatusReason {
     INVALID_DEVICE_TOKEN = "INVALID_DEVICE_TOKEN",
     INVALID_PINPOINT_ARN = "INVALID_PINPOINT_ARN"
 }
 /**
+ * @public
  * <p>A read-only field that represents the state of an <code>AppInstanceUserEndpoint</code>. Supported values:</p>
  *          <ul>
  *             <li>
@@ -183,12 +202,16 @@ export interface EndpointState {
      */
     StatusReason?: EndpointStatusReason | string;
 }
+/**
+ * @public
+ */
 export declare enum AppInstanceUserEndpointType {
     APNS = "APNS",
     APNS_SANDBOX = "APNS_SANDBOX",
     GCM = "GCM"
 }
 /**
+ * @public
  * <p>An endpoint under an Amazon Chime <code>AppInstanceUser</code> that receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.</p>
  */
 export interface AppInstanceUserEndpoint {
@@ -255,6 +278,7 @@ export interface AppInstanceUserEndpoint {
     EndpointState?: EndpointState;
 }
 /**
+ * @public
  * <p>Summary of the details of an <code>AppInstanceUserEndpoint</code>.</p>
  */
 export interface AppInstanceUserEndpointSummary {
@@ -285,6 +309,7 @@ export interface AppInstanceUserEndpointSummary {
     EndpointState?: EndpointState;
 }
 /**
+ * @public
  * <p>Summary of the details of an <code>AppInstanceUser</code>.</p>
  */
 export interface AppInstanceUserSummary {
@@ -301,6 +326,9 @@ export interface AppInstanceUserSummary {
      */
     Metadata?: string;
 }
+/**
+ * @public
+ */
 export declare enum ErrorCode {
     AccessDenied = "AccessDenied",
     BadRequest = "BadRequest",
@@ -319,6 +347,7 @@ export declare enum ErrorCode {
     VoiceConnectorGroupAssociationsExist = "VoiceConnectorGroupAssociationsExist"
 }
 /**
+ * @public
  * <p>The input parameters don't match the service's restrictions.</p>
  */
 export declare class BadRequestException extends __BaseException {
@@ -332,6 +361,7 @@ export declare class BadRequestException extends __BaseException {
     constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request could not be processed because of conflict in the current state of the
  *          resource.</p>
  */
@@ -346,6 +376,7 @@ export declare class ConflictException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
 }
 /**
+ * @public
  * <p>A tag object containing a key-value pair.</p>
  */
 export interface Tag {
@@ -358,6 +389,9 @@ export interface Tag {
      */
     Value: string | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateAppInstanceRequest {
     /**
      * <p>The name of the <code>AppInstance</code>.</p>
@@ -376,6 +410,9 @@ export interface CreateAppInstanceRequest {
      */
     Tags?: Tag[];
 }
+/**
+ * @public
+ */
 export interface CreateAppInstanceResponse {
     /**
      * <p>The Amazon Resource Number (ARN) of the <code>AppInstance</code>.</p>
@@ -383,6 +420,7 @@ export interface CreateAppInstanceResponse {
     AppInstanceArn?: string;
 }
 /**
+ * @public
  * <p>The client is permanently forbidden from making the request.</p>
  */
 export declare class ForbiddenException extends __BaseException {
@@ -396,6 +434,7 @@ export declare class ForbiddenException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ForbiddenException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request exceeds the resource limit.</p>
  */
 export declare class ResourceLimitExceededException extends __BaseException {
@@ -409,6 +448,7 @@ export declare class ResourceLimitExceededException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceLimitExceededException, __BaseException>);
 }
 /**
+ * @public
  * <p>The service encountered an unexpected error.</p>
  */
 export declare class ServiceFailureException extends __BaseException {
@@ -422,6 +462,7 @@ export declare class ServiceFailureException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ServiceFailureException, __BaseException>);
 }
 /**
+ * @public
  * <p>The service is currently unavailable.</p>
  */
 export declare class ServiceUnavailableException extends __BaseException {
@@ -435,6 +476,7 @@ export declare class ServiceUnavailableException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
 }
 /**
+ * @public
  * <p>The client exceeded its request rate limit.</p>
  */
 export declare class ThrottledClientException extends __BaseException {
@@ -448,6 +490,7 @@ export declare class ThrottledClientException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ThrottledClientException, __BaseException>);
 }
 /**
+ * @public
  * <p>The client is not currently authorized to make the request.</p>
  */
 export declare class UnauthorizedClientException extends __BaseException {
@@ -460,6 +503,9 @@ export declare class UnauthorizedClientException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<UnauthorizedClientException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface CreateAppInstanceAdminRequest {
     /**
      * <p>The ARN of the administrator of the current <code>AppInstance</code>.</p>
@@ -470,6 +516,9 @@ export interface CreateAppInstanceAdminRequest {
      */
     AppInstanceArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateAppInstanceAdminResponse {
     /**
      * <p>The name and ARN of the admin for the <code>AppInstance</code>.</p>
@@ -480,6 +529,9 @@ export interface CreateAppInstanceAdminResponse {
      */
     AppInstanceArn?: string;
 }
+/**
+ * @public
+ */
 export interface CreateAppInstanceUserRequest {
     /**
      * <p>The ARN of the <code>AppInstance</code> request.</p>
@@ -506,18 +558,27 @@ export interface CreateAppInstanceUserRequest {
      */
     Tags?: Tag[];
 }
+/**
+ * @public
+ */
 export interface CreateAppInstanceUserResponse {
     /**
      * <p>The user's ARN.</p>
      */
     AppInstanceUserArn?: string;
 }
+/**
+ * @public
+ */
 export interface DeleteAppInstanceRequest {
     /**
      * <p>The ARN of the <code>AppInstance</code>.</p>
      */
     AppInstanceArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteAppInstanceAdminRequest {
     /**
      * <p>The ARN of the <code>AppInstance</code>'s administrator.</p>
@@ -528,12 +589,18 @@ export interface DeleteAppInstanceAdminRequest {
      */
     AppInstanceArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteAppInstanceUserRequest {
     /**
      * <p>The ARN of the user request being deleted.</p>
      */
     AppInstanceUserArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeregisterAppInstanceUserEndpointRequest {
     /**
      * <p>The ARN of the <code>AppInstanceUser</code>.</p>
@@ -544,12 +611,18 @@ export interface DeregisterAppInstanceUserEndpointRequest {
      */
     EndpointId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeAppInstanceRequest {
     /**
      * <p>The ARN of the <code>AppInstance</code>.</p>
      */
     AppInstanceArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeAppInstanceResponse {
     /**
      * <p>The ARN, metadata, created and last-updated timestamps, and the name of the
@@ -557,6 +630,9 @@ export interface DescribeAppInstanceResponse {
      */
     AppInstance?: AppInstance;
 }
+/**
+ * @public
+ */
 export interface DescribeAppInstanceAdminRequest {
     /**
      * <p>The ARN of the <code>AppInstanceAdmin</code>.</p>
@@ -567,6 +643,9 @@ export interface DescribeAppInstanceAdminRequest {
      */
     AppInstanceArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeAppInstanceAdminResponse {
     /**
      * <p>The ARN and name of the <code>AppInstanceUser</code>, the ARN of the
@@ -575,18 +654,27 @@ export interface DescribeAppInstanceAdminResponse {
      */
     AppInstanceAdmin?: AppInstanceAdmin;
 }
+/**
+ * @public
+ */
 export interface DescribeAppInstanceUserRequest {
     /**
      * <p>The ARN of the <code>AppInstanceUser</code>.</p>
      */
     AppInstanceUserArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeAppInstanceUserResponse {
     /**
      * <p>The name of the <code>AppInstanceUser</code>.</p>
      */
     AppInstanceUser?: AppInstanceUser;
 }
+/**
+ * @public
+ */
 export interface DescribeAppInstanceUserEndpointRequest {
     /**
      * <p>The ARN of the <code>AppInstanceUser</code>.</p>
@@ -597,6 +685,9 @@ export interface DescribeAppInstanceUserEndpointRequest {
      */
     EndpointId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeAppInstanceUserEndpointResponse {
     /**
      * <p>The full details of an <code>AppInstanceUserEndpoint</code>: the <code>AppInstanceUserArn</code>, ID, name, type, resource ARN, attributes,
@@ -604,12 +695,18 @@ export interface DescribeAppInstanceUserEndpointResponse {
      */
     AppInstanceUserEndpoint?: AppInstanceUserEndpoint;
 }
+/**
+ * @public
+ */
 export interface GetAppInstanceRetentionSettingsRequest {
     /**
      * <p>The ARN of the <code>AppInstance</code>.</p>
      */
     AppInstanceArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetAppInstanceRetentionSettingsResponse {
     /**
      * <p>The retention settings for the <code>AppInstance</code>.</p>
@@ -621,6 +718,9 @@ export interface GetAppInstanceRetentionSettingsResponse {
      */
     InitiateDeletionTimestamp?: Date;
 }
+/**
+ * @public
+ */
 export interface ListAppInstanceAdminsRequest {
     /**
      * <p>The ARN of the <code>AppInstance</code>.</p>
@@ -636,6 +736,9 @@ export interface ListAppInstanceAdminsRequest {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListAppInstanceAdminsResponse {
     /**
      * <p>The ARN of the <code>AppInstance</code>.</p>
@@ -651,6 +754,9 @@ export interface ListAppInstanceAdminsResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListAppInstancesRequest {
     /**
      * <p>The maximum number of <code>AppInstance</code>s that you want to return.</p>
@@ -662,6 +768,9 @@ export interface ListAppInstancesRequest {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListAppInstancesResponse {
     /**
      * <p>The information for each <code>AppInstance</code>.</p>
@@ -673,6 +782,9 @@ export interface ListAppInstancesResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListAppInstanceUserEndpointsRequest {
     /**
      * <p>The ARN of the <code>AppInstanceUser</code>.</p>
@@ -687,6 +799,9 @@ export interface ListAppInstanceUserEndpointsRequest {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListAppInstanceUserEndpointsResponse {
     /**
      * <p>The information for each requested <code>AppInstanceUserEndpoint</code>.</p>
@@ -697,6 +812,9 @@ export interface ListAppInstanceUserEndpointsResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListAppInstanceUsersRequest {
     /**
      * <p>The ARN of the <code>AppInstance</code>.</p>
@@ -711,6 +829,9 @@ export interface ListAppInstanceUsersRequest {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListAppInstanceUsersResponse {
     /**
      * <p>The ARN of the <code>AppInstance</code>.</p>
@@ -725,18 +846,27 @@ export interface ListAppInstanceUsersResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceRequest {
     /**
      * <p>The ARN of the resource.</p>
      */
     ResourceARN: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceResponse {
     /**
      * <p>The tag key-value pairs.</p>
      */
     Tags?: Tag[];
 }
+/**
+ * @public
+ */
 export interface PutAppInstanceRetentionSettingsRequest {
     /**
      * <p>The ARN of the <code>AppInstance</code>.</p>
@@ -747,6 +877,9 @@ export interface PutAppInstanceRetentionSettingsRequest {
      */
     AppInstanceRetentionSettings: AppInstanceRetentionSettings | undefined;
 }
+/**
+ * @public
+ */
 export interface PutAppInstanceRetentionSettingsResponse {
     /**
      * <p>The time in days to retain data. Data type: number.</p>
@@ -757,6 +890,9 @@ export interface PutAppInstanceRetentionSettingsResponse {
      */
     InitiateDeletionTimestamp?: Date;
 }
+/**
+ * @public
+ */
 export interface RegisterAppInstanceUserEndpointRequest {
     /**
      * <p>The ARN of the <code>AppInstanceUser</code>.</p>
@@ -803,6 +939,9 @@ export interface RegisterAppInstanceUserEndpointRequest {
      */
     AllowMessages?: AllowMessages | string;
 }
+/**
+ * @public
+ */
 export interface RegisterAppInstanceUserEndpointResponse {
     /**
      * <p>The ARN of the <code>AppInstanceUser</code>.</p>
@@ -813,6 +952,9 @@ export interface RegisterAppInstanceUserEndpointResponse {
      */
     EndpointId?: string;
 }
+/**
+ * @public
+ */
 export interface TagResourceRequest {
     /**
      * <p>The resource ARN.</p>
@@ -823,6 +965,9 @@ export interface TagResourceRequest {
      */
     Tags: Tag[] | undefined;
 }
+/**
+ * @public
+ */
 export interface UntagResourceRequest {
     /**
      * <p>The resource ARN.</p>
@@ -833,6 +978,9 @@ export interface UntagResourceRequest {
      */
     TagKeys: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdateAppInstanceRequest {
     /**
      * <p>The ARN of the <code>AppInstance</code>.</p>
@@ -847,12 +995,18 @@ export interface UpdateAppInstanceRequest {
      */
     Metadata: string | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdateAppInstanceResponse {
     /**
      * <p>The ARN of the <code>AppInstance</code>.</p>
      */
     AppInstanceArn?: string;
 }
+/**
+ * @public
+ */
 export interface UpdateAppInstanceUserRequest {
     /**
      * <p>The ARN of the <code>AppInstanceUser</code>.</p>
@@ -867,12 +1021,18 @@ export interface UpdateAppInstanceUserRequest {
      */
     Metadata: string | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdateAppInstanceUserResponse {
     /**
      * <p>The ARN of the <code>AppInstanceUser</code>.</p>
      */
     AppInstanceUserArn?: string;
 }
+/**
+ * @public
+ */
 export interface UpdateAppInstanceUserEndpointRequest {
     /**
      * <p>The ARN of the <code>AppInstanceUser</code>.</p>
@@ -892,6 +1052,9 @@ export interface UpdateAppInstanceUserEndpointRequest {
      */
     AllowMessages?: AllowMessages | string;
 }
+/**
+ * @public
+ */
 export interface UpdateAppInstanceUserEndpointResponse {
     /**
      * <p>The ARN of the <code>AppInstanceUser</code>.</p>

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

@@ -1,5 +1,8 @@
 import { PaginationConfiguration } from "@aws-sdk/types";
 import { ChimeSDKIdentityClient } from "../ChimeSDKIdentityClient";
+/**
+ * @public
+ */
 export interface ChimeSDKIdentityPaginationConfiguration extends PaginationConfiguration {
     client: ChimeSDKIdentityClient;
 }

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

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListAppInstanceAdminsCommandInput, ListAppInstanceAdminsCommandOutput } from "../commands/ListAppInstanceAdminsCommand";
 import { ChimeSDKIdentityPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListAppInstanceAdmins(config: ChimeSDKIdentityPaginationConfiguration, input: ListAppInstanceAdminsCommandInput, ...additionalArguments: any): Paginator<ListAppInstanceAdminsCommandOutput>;

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

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListAppInstanceUserEndpointsCommandInput, ListAppInstanceUserEndpointsCommandOutput } from "../commands/ListAppInstanceUserEndpointsCommand";
 import { ChimeSDKIdentityPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListAppInstanceUserEndpoints(config: ChimeSDKIdentityPaginationConfiguration, input: ListAppInstanceUserEndpointsCommandInput, ...additionalArguments: any): Paginator<ListAppInstanceUserEndpointsCommandOutput>;

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

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListAppInstanceUsersCommandInput, ListAppInstanceUsersCommandOutput } from "../commands/ListAppInstanceUsersCommand";
 import { ChimeSDKIdentityPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListAppInstanceUsers(config: ChimeSDKIdentityPaginationConfiguration, input: ListAppInstanceUsersCommandInput, ...additionalArguments: any): Paginator<ListAppInstanceUsersCommandOutput>;

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

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListAppInstancesCommandInput, ListAppInstancesCommandOutput } from "../commands/ListAppInstancesCommand";
 import { ChimeSDKIdentityPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListAppInstances(config: ChimeSDKIdentityPaginationConfiguration, input: ListAppInstancesCommandInput, ...additionalArguments: any): Paginator<ListAppInstancesCommandOutput>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-chime-sdk-identity",
   "description": "AWS SDK for JavaScript Chime Sdk Identity Client for Node.js, Browser and React Native",
-  "version": "3.296.0",
+  "version": "3.297.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,9 +20,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.296.0",
+    "@aws-sdk/client-sts": "3.297.0",
     "@aws-sdk/config-resolver": "3.296.0",
-    "@aws-sdk/credential-provider-node": "3.296.0",
+    "@aws-sdk/credential-provider-node": "3.297.0",
     "@aws-sdk/fetch-http-handler": "3.296.0",
     "@aws-sdk/hash-node": "3.296.0",
     "@aws-sdk/invalid-dependency": "3.296.0",