chimesdkidentity/aws.sdk.kotlin.services.chimesdkidentity

Package-level declarations

Types

Link copied to clipboard
interface ChimeSdkIdentityClient : SdkClient

The Amazon Chime SDK Identity APIs in this section allow software developers to create and manage unique instances of their messaging applications. These APIs provide the overarching framework for creating and sending messages. For more information about the identity APIs, refer to Amazon Chime SDK identity.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard
inline suspend fun ChimeSdkIdentityClient.createAppInstance(crossinline block: CreateAppInstanceRequest.Builder.() -> Unit): CreateAppInstanceResponse

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.

Link copied to clipboard
inline suspend fun ChimeSdkIdentityClient.createAppInstanceAdmin(crossinline block: CreateAppInstanceAdminRequest.Builder.() -> Unit): CreateAppInstanceAdminResponse

Promotes an AppInstanceUser or AppInstanceBot to an AppInstanceAdmin. The promoted entity can perform the following actions.

Link copied to clipboard
inline suspend fun ChimeSdkIdentityClient.createAppInstanceBot(crossinline block: CreateAppInstanceBotRequest.Builder.() -> Unit): CreateAppInstanceBotResponse

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

Link copied to clipboard
inline suspend fun ChimeSdkIdentityClient.createAppInstanceUser(crossinline block: CreateAppInstanceUserRequest.Builder.() -> Unit): CreateAppInstanceUserResponse

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

Link copied to clipboard
inline suspend fun ChimeSdkIdentityClient.deleteAppInstance(crossinline block: DeleteAppInstanceRequest.Builder.() -> Unit): DeleteAppInstanceResponse

Deletes an AppInstance and all associated data asynchronously.

Link copied to clipboard
inline suspend fun ChimeSdkIdentityClient.deleteAppInstanceAdmin(crossinline block: DeleteAppInstanceAdminRequest.Builder.() -> Unit): DeleteAppInstanceAdminResponse

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

Link copied to clipboard
inline suspend fun ChimeSdkIdentityClient.deleteAppInstanceBot(crossinline block: DeleteAppInstanceBotRequest.Builder.() -> Unit): DeleteAppInstanceBotResponse

Deletes an AppInstanceBot.

Link copied to clipboard
inline suspend fun ChimeSdkIdentityClient.deleteAppInstanceUser(crossinline block: DeleteAppInstanceUserRequest.Builder.() -> Unit): DeleteAppInstanceUserResponse

Deletes an AppInstanceUser.

Link copied to clipboard
Link copied to clipboard
inline suspend fun ChimeSdkIdentityClient.describeAppInstance(crossinline block: DescribeAppInstanceRequest.Builder.() -> Unit): DescribeAppInstanceResponse

Returns the full details of an AppInstance.

Link copied to clipboard
inline suspend fun ChimeSdkIdentityClient.describeAppInstanceAdmin(crossinline block: DescribeAppInstanceAdminRequest.Builder.() -> Unit): DescribeAppInstanceAdminResponse

Returns the full details of an AppInstanceAdmin.

Link copied to clipboard
inline suspend fun ChimeSdkIdentityClient.describeAppInstanceBot(crossinline block: DescribeAppInstanceBotRequest.Builder.() -> Unit): DescribeAppInstanceBotResponse

The AppInstanceBot's information.

Link copied to clipboard
inline suspend fun ChimeSdkIdentityClient.describeAppInstanceUser(crossinline block: DescribeAppInstanceUserRequest.Builder.() -> Unit): DescribeAppInstanceUserResponse

Returns the full details of an AppInstanceUser.

Link copied to clipboard
inline suspend fun ChimeSdkIdentityClient.describeAppInstanceUserEndpoint(crossinline block: DescribeAppInstanceUserEndpointRequest.Builder.() -> Unit): DescribeAppInstanceUserEndpointResponse

Returns the full details of an AppInstanceUserEndpoint.

Link copied to clipboard
inline suspend fun ChimeSdkIdentityClient.getAppInstanceRetentionSettings(crossinline block: GetAppInstanceRetentionSettingsRequest.Builder.() -> Unit): GetAppInstanceRetentionSettingsResponse

Gets the retention settings for an AppInstance.

Link copied to clipboard
inline suspend fun ChimeSdkIdentityClient.listAppInstanceAdmins(crossinline block: ListAppInstanceAdminsRequest.Builder.() -> Unit): ListAppInstanceAdminsResponse

Returns a list of the administrators in the AppInstance.

Link copied to clipboard
inline suspend fun ChimeSdkIdentityClient.listAppInstanceBots(crossinline block: ListAppInstanceBotsRequest.Builder.() -> Unit): ListAppInstanceBotsResponse

Lists all AppInstanceBots created under a single AppInstance.

Link copied to clipboard
inline suspend fun ChimeSdkIdentityClient.listAppInstances(crossinline block: ListAppInstancesRequest.Builder.() -> Unit): ListAppInstancesResponse

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

Link copied to clipboard
inline suspend fun ChimeSdkIdentityClient.listAppInstanceUserEndpoints(crossinline block: ListAppInstanceUserEndpointsRequest.Builder.() -> Unit): ListAppInstanceUserEndpointsResponse

Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.

Link copied to clipboard
inline suspend fun ChimeSdkIdentityClient.listAppInstanceUsers(crossinline block: ListAppInstanceUsersRequest.Builder.() -> Unit): ListAppInstanceUsersResponse

List all AppInstanceUsers created under a single AppInstance.

Link copied to clipboard
inline suspend fun ChimeSdkIdentityClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

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

Link copied to clipboard
inline suspend fun ChimeSdkIdentityClient.putAppInstanceRetentionSettings(crossinline block: PutAppInstanceRetentionSettingsRequest.Builder.() -> Unit): PutAppInstanceRetentionSettingsResponse

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

Link copied to clipboard
inline suspend fun ChimeSdkIdentityClient.putAppInstanceUserExpirationSettings(crossinline block: PutAppInstanceUserExpirationSettingsRequest.Builder.() -> Unit): PutAppInstanceUserExpirationSettingsResponse

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

Link copied to clipboard
inline suspend fun ChimeSdkIdentityClient.registerAppInstanceUserEndpoint(crossinline block: RegisterAppInstanceUserEndpointRequest.Builder.() -> Unit): RegisterAppInstanceUserEndpointResponse

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.

Link copied to clipboard
inline suspend fun ChimeSdkIdentityClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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

Link copied to clipboard
inline suspend fun ChimeSdkIdentityClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

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

Link copied to clipboard
inline suspend fun ChimeSdkIdentityClient.updateAppInstance(crossinline block: UpdateAppInstanceRequest.Builder.() -> Unit): UpdateAppInstanceResponse

Updates AppInstance metadata.

Link copied to clipboard
inline suspend fun ChimeSdkIdentityClient.updateAppInstanceBot(crossinline block: UpdateAppInstanceBotRequest.Builder.() -> Unit): UpdateAppInstanceBotResponse

Updates the name and metadata of an AppInstanceBot.

Link copied to clipboard
inline suspend fun ChimeSdkIdentityClient.updateAppInstanceUser(crossinline block: UpdateAppInstanceUserRequest.Builder.() -> Unit): UpdateAppInstanceUserResponse

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

Link copied to clipboard
inline suspend fun ChimeSdkIdentityClient.updateAppInstanceUserEndpoint(crossinline block: UpdateAppInstanceUserEndpointRequest.Builder.() -> Unit): UpdateAppInstanceUserEndpointResponse

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

Link copied to clipboard
fun ChimeSdkIdentityClient.withConfig(block: ChimeSdkIdentityClient.Config.Builder.() -> Unit): ChimeSdkIdentityClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.