IAmazonChimeSDKIdentity Interface

Interface for accessing ChimeSDKIdentity

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.

Inheritance Hierarchy

Amazon.ChimeSDKIdentity.IAmazonChimeSDKIdentity

Namespace: Amazon.ChimeSDKIdentity
Assembly: AWSSDK.ChimeSDKIdentity.dll
Version: 3.x.y.z

Syntax

public interface IAmazonChimeSDKIdentity
         IAmazonService, IDisposable

The IAmazonChimeSDKIdentity type exposes the following members

Properties

	Name	Type	Description
	Paginators	Amazon.ChimeSDKIdentity.Model.IChimeSDKIdentityPaginatorFactory	Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

	Name	Description
	CreateAppInstance(CreateAppInstanceRequest)	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(CreateAppInstanceAdminRequest)	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.
	CreateAppInstanceAdminAsync(CreateAppInstanceAdminRequest, CancellationToken)	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.
	CreateAppInstanceAsync(CreateAppInstanceRequest, CancellationToken)	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
	CreateAppInstanceBot(CreateAppInstanceBotRequest)	Creates a bot under an Amazon Chime `AppInstance`. The request consists of a unique `Configuration` and `Name` for that bot.
	CreateAppInstanceBotAsync(CreateAppInstanceBotRequest, CancellationToken)	Creates a bot under an Amazon Chime `AppInstance`. The request consists of a unique `Configuration` and `Name` for that bot.
	CreateAppInstanceUser(CreateAppInstanceUserRequest)	Creates a user under an Amazon Chime `AppInstance`. The request consists of a unique `appInstanceUserId` and `Name` for that user.
	CreateAppInstanceUserAsync(CreateAppInstanceUserRequest, CancellationToken)	Creates a user under an Amazon Chime `AppInstance`. The request consists of a unique `appInstanceUserId` and `Name` for that user.
	DeleteAppInstance(DeleteAppInstanceRequest)	Deletes an `AppInstance` and all associated data asynchronously.
	DeleteAppInstanceAdmin(DeleteAppInstanceAdminRequest)	Demotes an `AppInstanceAdmin` to an `AppInstanceUser` or `AppInstanceBot`. This action does not delete the user.
	DeleteAppInstanceAdminAsync(DeleteAppInstanceAdminRequest, CancellationToken)	Demotes an `AppInstanceAdmin` to an `AppInstanceUser` or `AppInstanceBot`. This action does not delete the user.
	DeleteAppInstanceAsync(DeleteAppInstanceRequest, CancellationToken)	Deletes an `AppInstance` and all associated data asynchronously.
	DeleteAppInstanceBot(DeleteAppInstanceBotRequest)	Deletes an `AppInstanceBot`.
	DeleteAppInstanceBotAsync(DeleteAppInstanceBotRequest, CancellationToken)	Deletes an `AppInstanceBot`.
	DeleteAppInstanceUser(DeleteAppInstanceUserRequest)	Deletes an `AppInstanceUser`.
	DeleteAppInstanceUserAsync(DeleteAppInstanceUserRequest, CancellationToken)	Deletes an `AppInstanceUser`.
	DeregisterAppInstanceUserEndpoint(DeregisterAppInstanceUserEndpointRequest)	Deregisters an `AppInstanceUserEndpoint`.
	DeregisterAppInstanceUserEndpointAsync(DeregisterAppInstanceUserEndpointRequest, CancellationToken)	Deregisters an `AppInstanceUserEndpoint`.
	DescribeAppInstance(DescribeAppInstanceRequest)	Returns the full details of an `AppInstance`.
	DescribeAppInstanceAdmin(DescribeAppInstanceAdminRequest)	Returns the full details of an `AppInstanceAdmin`.
	DescribeAppInstanceAdminAsync(DescribeAppInstanceAdminRequest, CancellationToken)	Returns the full details of an `AppInstanceAdmin`.
	DescribeAppInstanceAsync(DescribeAppInstanceRequest, CancellationToken)	Returns the full details of an `AppInstance`.
	DescribeAppInstanceBot(DescribeAppInstanceBotRequest)	The `AppInstanceBot's` information.
	DescribeAppInstanceBotAsync(DescribeAppInstanceBotRequest, CancellationToken)	The `AppInstanceBot's` information.
	DescribeAppInstanceUser(DescribeAppInstanceUserRequest)	Returns the full details of an `AppInstanceUser`.
	DescribeAppInstanceUserAsync(DescribeAppInstanceUserRequest, CancellationToken)	Returns the full details of an `AppInstanceUser`.
	DescribeAppInstanceUserEndpoint(DescribeAppInstanceUserEndpointRequest)	Returns the full details of an `AppInstanceUserEndpoint`.
	DescribeAppInstanceUserEndpointAsync(DescribeAppInstanceUserEndpointRequest, CancellationToken)	Returns the full details of an `AppInstanceUserEndpoint`.
	DetermineServiceOperationEndpoint(AmazonWebServiceRequest)	Returns the endpoint that will be used for a particular request.
	GetAppInstanceRetentionSettings(GetAppInstanceRetentionSettingsRequest)	Gets the retention settings for an `AppInstance`.
	GetAppInstanceRetentionSettingsAsync(GetAppInstanceRetentionSettingsRequest, CancellationToken)	Gets the retention settings for an `AppInstance`.
	ListAppInstanceAdmins(ListAppInstanceAdminsRequest)	Returns a list of the administrators in the `AppInstance`.
	ListAppInstanceAdminsAsync(ListAppInstanceAdminsRequest, CancellationToken)	Returns a list of the administrators in the `AppInstance`.
	ListAppInstanceBots(ListAppInstanceBotsRequest)	Lists all `AppInstanceBots` created under a single `AppInstance`.
	ListAppInstanceBotsAsync(ListAppInstanceBotsRequest, CancellationToken)	Lists all `AppInstanceBots` created under a single `AppInstance`.
	ListAppInstances(ListAppInstancesRequest)	Lists all Amazon Chime `AppInstance`s created under a single AWS account.
	ListAppInstancesAsync(ListAppInstancesRequest, CancellationToken)	Lists all Amazon Chime `AppInstance`s created under a single AWS account.
	ListAppInstanceUserEndpoints(ListAppInstanceUserEndpointsRequest)	Lists all the `AppInstanceUserEndpoints` created under a single `AppInstanceUser`.
	ListAppInstanceUserEndpointsAsync(ListAppInstanceUserEndpointsRequest, CancellationToken)	Lists all the `AppInstanceUserEndpoints` created under a single `AppInstanceUser`.
	ListAppInstanceUsers(ListAppInstanceUsersRequest)	List all `AppInstanceUsers` created under a single `AppInstance`.
	ListAppInstanceUsersAsync(ListAppInstanceUsersRequest, CancellationToken)	List all `AppInstanceUsers` created under a single `AppInstance`.
	ListTagsForResource(ListTagsForResourceRequest)	Lists the tags applied to an Amazon Chime SDK identity resource.
	ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)	Lists the tags applied to an Amazon Chime SDK identity resource.
	PutAppInstanceRetentionSettings(PutAppInstanceRetentionSettingsRequest)	Sets the amount of time in days that a given `AppInstance` retains data.
	PutAppInstanceRetentionSettingsAsync(PutAppInstanceRetentionSettingsRequest, CancellationToken)	Sets the amount of time in days that a given `AppInstance` retains data.
	PutAppInstanceUserExpirationSettings(PutAppInstanceUserExpirationSettingsRequest)	Sets the number of days before the `AppInstanceUser` is automatically deleted. 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.
	PutAppInstanceUserExpirationSettingsAsync(PutAppInstanceUserExpirationSettingsRequest, CancellationToken)	Sets the number of days before the `AppInstanceUser` is automatically deleted. 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(RegisterAppInstanceUserEndpointRequest)	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.
	RegisterAppInstanceUserEndpointAsync(RegisterAppInstanceUserEndpointRequest, CancellationToken)	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(TagResourceRequest)	Applies the specified tags to the specified Amazon Chime SDK identity resource.
	TagResourceAsync(TagResourceRequest, CancellationToken)	Applies the specified tags to the specified Amazon Chime SDK identity resource.
	UntagResource(UntagResourceRequest)	Removes the specified tags from the specified Amazon Chime SDK identity resource.
	UntagResourceAsync(UntagResourceRequest, CancellationToken)	Removes the specified tags from the specified Amazon Chime SDK identity resource.
	UpdateAppInstance(UpdateAppInstanceRequest)	Updates `AppInstance` metadata.
	UpdateAppInstanceAsync(UpdateAppInstanceRequest, CancellationToken)	Updates `AppInstance` metadata.
	UpdateAppInstanceBot(UpdateAppInstanceBotRequest)	Updates the name and metadata of an `AppInstanceBot`.
	UpdateAppInstanceBotAsync(UpdateAppInstanceBotRequest, CancellationToken)	Updates the name and metadata of an `AppInstanceBot`.
	UpdateAppInstanceUser(UpdateAppInstanceUserRequest)	Updates the details of an `AppInstanceUser`. You can update names and metadata.
	UpdateAppInstanceUserAsync(UpdateAppInstanceUserRequest, CancellationToken)	Updates the details of an `AppInstanceUser`. You can update names and metadata.
	UpdateAppInstanceUserEndpoint(UpdateAppInstanceUserEndpointRequest)	Updates the details of an `AppInstanceUserEndpoint`. You can update the name and `AllowMessage` values.
	UpdateAppInstanceUserEndpointAsync(UpdateAppInstanceUserEndpointRequest, CancellationToken)	Updates the details of an `AppInstanceUserEndpoint`. You can update the name and `AllowMessage` values.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5