ChimeSDKIdentity

import { ChimeSDKIdentity } from "https://aws-api-bqtgftz736ft.deno.dev/v0.5/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 createAppInstanceBot(params: CreateAppInstanceBotRequest, opts?: client.RequestOptions): Promise<CreateAppInstanceBotResponse>;

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 deleteAppInstanceBot(params: DeleteAppInstanceBotRequest, opts?: client.RequestOptions): Promise<void>;

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

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

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

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

async describeAppInstanceBot(params: DescribeAppInstanceBotRequest, opts?: client.RequestOptions): Promise<DescribeAppInstanceBotResponse>;

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

async describeAppInstanceUserEndpoint(params: DescribeAppInstanceUserEndpointRequest, opts?: client.RequestOptions): Promise<DescribeAppInstanceUserEndpointResponse>;

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

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

async listAppInstanceBots(params: ListAppInstanceBotsRequest, opts?: client.RequestOptions): Promise<ListAppInstanceBotsResponse>;

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

async listAppInstanceUserEndpoints(params: ListAppInstanceUserEndpointsRequest, opts?: client.RequestOptions): Promise<ListAppInstanceUserEndpointsResponse>;

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

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

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

async putAppInstanceUserExpirationSettings(params: PutAppInstanceUserExpirationSettingsRequest, opts?: client.RequestOptions): Promise<PutAppInstanceUserExpirationSettingsResponse>;

async registerAppInstanceUserEndpoint(params: RegisterAppInstanceUserEndpointRequest, opts?: client.RequestOptions): Promise<RegisterAppInstanceUserEndpointResponse>;

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

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

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

async updateAppInstanceBot(params: UpdateAppInstanceBotRequest, opts?: client.RequestOptions): Promise<UpdateAppInstanceBotResponse>;

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

async updateAppInstanceUserEndpoint(params: UpdateAppInstanceUserEndpointRequest, opts?: client.RequestOptions): Promise<UpdateAppInstanceUserEndpointResponse>;

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 or AppInstanceBot to an AppInstanceAdmin. The promoted entity can perform the following actions.

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

Only an AppInstanceUser and AppInstanceBot can be promoted to an AppInstanceAdmin role.

createAppInstanceBot(params: CreateAppInstanceBotRequest, opts?: client.RequestOptions): Promise<CreateAppInstanceBotResponse>

[src]

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

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 or AppInstanceBot. This action does not delete the user.

deleteAppInstanceBot(params: DeleteAppInstanceBotRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes an AppInstanceBot.

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

[src]

Deletes an AppInstanceUser.

deregisterAppInstanceUserEndpoint(params: DeregisterAppInstanceUserEndpointRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deregisters an AppInstanceUserEndpoint.

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.

describeAppInstanceBot(params: DescribeAppInstanceBotRequest, opts?: client.RequestOptions): Promise<DescribeAppInstanceBotResponse>

[src]

The AppInstanceBot's information.

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

[src]

Returns the full details of an AppInstanceUser.

describeAppInstanceUserEndpoint(params: DescribeAppInstanceUserEndpointRequest, opts?: client.RequestOptions): Promise<DescribeAppInstanceUserEndpointResponse>

[src]

Returns the full details of an AppInstanceUserEndpoint.

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.

listAppInstanceBots(params: ListAppInstanceBotsRequest, opts?: client.RequestOptions): Promise<ListAppInstanceBotsResponse>

[src]

Lists all AppInstanceBots created under a single AppInstance.

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

[src]

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

listAppInstanceUserEndpoints(params: ListAppInstanceUserEndpointsRequest, opts?: client.RequestOptions): Promise<ListAppInstanceUserEndpointsResponse>

[src]

Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.

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

[src]

List all AppInstanceUsers created under a single AppInstance.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

Lists the tags applied to an Amazon Chime SDK identity resource.

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

[src]

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

putAppInstanceUserExpirationSettings(params: PutAppInstanceUserExpirationSettingsRequest, opts?: client.RequestOptions): Promise<PutAppInstanceUserExpirationSettingsResponse>

[src]

Sets the number of days before the AppInstanceUser is automatically deleted.

Note: A background process deletes expired AppInstanceUsers within 6 hours of expiration. Actual deletion times may vary. Expired AppInstanceUsers that have not yet been deleted appear as active, and you can update their expiration settings. The system honors the new settings.

registerAppInstanceUserEndpoint(params: RegisterAppInstanceUserEndpointRequest, opts?: client.RequestOptions): Promise<RegisterAppInstanceUserEndpointResponse>

[src]

Registers an endpoint under an Amazon Chime AppInstanceUser. The endpoint receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Applies the specified tags to the specified Amazon Chime SDK identity resource.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Removes the specified tags from the specified Amazon Chime SDK identity resource.

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

[src]

Updates AppInstance metadata.

updateAppInstanceBot(params: UpdateAppInstanceBotRequest, opts?: client.RequestOptions): Promise<UpdateAppInstanceBotResponse>

[src]

Updates the name and metadata of an AppInstanceBot.

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

[src]

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

updateAppInstanceUserEndpoint(params: UpdateAppInstanceUserEndpointRequest, opts?: client.RequestOptions): Promise<UpdateAppInstanceUserEndpointResponse>

[src]

Updates the details of an AppInstanceUserEndpoint. You can update the name and AllowMessage values.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]