ChimeSDKIdentity

import { ChimeSDKIdentity } from "https://aws-api.deno.dev/v0.2/services/chimesdkidentity.ts?docs=full";

class ChimeSDKIdentity {

constructor(apiFactory: client.ApiFactory);

async createAppInstance(params: CreateAppInstanceRequest, opts?: client.RequestOptions): Promise<CreateAppInstanceResponse>;

async createAppInstanceAdmin(params: CreateAppInstanceAdminRequest, opts?: client.RequestOptions): Promise<CreateAppInstanceAdminResponse>;

async createAppInstanceUser(params: CreateAppInstanceUserRequest, opts?: client.RequestOptions): Promise<CreateAppInstanceUserResponse>;

async deleteAppInstance(params: DeleteAppInstanceRequest, opts?: client.RequestOptions): Promise<void>;

async deleteAppInstanceAdmin(params: DeleteAppInstanceAdminRequest, opts?: client.RequestOptions): Promise<void>;

async deleteAppInstanceUser(params: DeleteAppInstanceUserRequest, opts?: client.RequestOptions): Promise<void>;

async describeAppInstance(params: DescribeAppInstanceRequest, opts?: client.RequestOptions): Promise<DescribeAppInstanceResponse>;

async describeAppInstanceAdmin(params: DescribeAppInstanceAdminRequest, opts?: client.RequestOptions): Promise<DescribeAppInstanceAdminResponse>;

async describeAppInstanceUser(params: DescribeAppInstanceUserRequest, opts?: client.RequestOptions): Promise<DescribeAppInstanceUserResponse>;

async getAppInstanceRetentionSettings(params: GetAppInstanceRetentionSettingsRequest, opts?: client.RequestOptions): Promise<GetAppInstanceRetentionSettingsResponse>;

async listAppInstanceAdmins(params: ListAppInstanceAdminsRequest, opts?: client.RequestOptions): Promise<ListAppInstanceAdminsResponse>;

async listAppInstances(params?: ListAppInstancesRequest, opts?: client.RequestOptions): Promise<ListAppInstancesResponse>;

async listAppInstanceUsers(params: ListAppInstanceUsersRequest, opts?: client.RequestOptions): Promise<ListAppInstanceUsersResponse>;

async putAppInstanceRetentionSettings(params: PutAppInstanceRetentionSettingsRequest, opts?: client.RequestOptions): Promise<PutAppInstanceRetentionSettingsResponse>;

async updateAppInstance(params: UpdateAppInstanceRequest, opts?: client.RequestOptions): Promise<UpdateAppInstanceResponse>;

async updateAppInstanceUser(params: UpdateAppInstanceUserRequest, opts?: client.RequestOptions): Promise<UpdateAppInstanceUserResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new ChimeSDKIdentity(apiFactory: client.ApiFactory)

[src]

§Methods

createAppInstance(params: CreateAppInstanceRequest, opts?: client.RequestOptions): Promise<CreateAppInstanceResponse>

[src]

Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard.

identity

createAppInstanceAdmin(params: CreateAppInstanceAdminRequest, opts?: client.RequestOptions): Promise<CreateAppInstanceAdminResponse>

[src]

Promotes an AppInstanceUser to an AppInstanceAdmin. The promoted user can perform the following actions.

ChannelModerator actions across all channels in the AppInstance.
DeleteChannelMessage actions.

Only an AppInstanceUser can be promoted to an AppInstanceAdmin role.

createAppInstanceUser(params: CreateAppInstanceUserRequest, opts?: client.RequestOptions): Promise<CreateAppInstanceUserResponse>

[src]

Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and Name for that user.

deleteAppInstance(params: DeleteAppInstanceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes an AppInstance and all associated data asynchronously.

deleteAppInstanceAdmin(params: DeleteAppInstanceAdminRequest, opts?: client.RequestOptions): Promise<void>

[src]

Demotes an AppInstanceAdmin to an AppInstanceUser. This action does not delete the user.

deleteAppInstanceUser(params: DeleteAppInstanceUserRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes an AppInstanceUser.

describeAppInstance(params: DescribeAppInstanceRequest, opts?: client.RequestOptions): Promise<DescribeAppInstanceResponse>

[src]

Returns the full details of an AppInstance.

describeAppInstanceAdmin(params: DescribeAppInstanceAdminRequest, opts?: client.RequestOptions): Promise<DescribeAppInstanceAdminResponse>

[src]

Returns the full details of an AppInstanceAdmin.

describeAppInstanceUser(params: DescribeAppInstanceUserRequest, opts?: client.RequestOptions): Promise<DescribeAppInstanceUserResponse>

[src]

Returns the full details of an AppInstanceUser.

getAppInstanceRetentionSettings(params: GetAppInstanceRetentionSettingsRequest, opts?: client.RequestOptions): Promise<GetAppInstanceRetentionSettingsResponse>

[src]

Gets the retention settings for an AppInstance.

listAppInstanceAdmins(params: ListAppInstanceAdminsRequest, opts?: client.RequestOptions): Promise<ListAppInstanceAdminsResponse>

[src]

Returns a list of the administrators in the AppInstance.

listAppInstances(params?: ListAppInstancesRequest, opts?: client.RequestOptions): Promise<ListAppInstancesResponse>

[src]

Lists all Amazon Chime AppInstances created under a single AWS account.

listAppInstanceUsers(params: ListAppInstanceUsersRequest, opts?: client.RequestOptions): Promise<ListAppInstanceUsersResponse>

[src]

List all AppInstanceUsers created under a single AppInstance.

putAppInstanceRetentionSettings(params: PutAppInstanceRetentionSettingsRequest, opts?: client.RequestOptions): Promise<PutAppInstanceRetentionSettingsResponse>

[src]

Sets the amount of time in days that a given AppInstance retains data.

updateAppInstance(params: UpdateAppInstanceRequest, opts?: client.RequestOptions): Promise<UpdateAppInstanceResponse>

[src]

Updates AppInstance metadata.

updateAppInstanceUser(params: UpdateAppInstanceUserRequest, opts?: client.RequestOptions): Promise<UpdateAppInstanceUserResponse>

[src]

Updates the details of an AppInstanceUser. You can update names and metadata.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]