@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonChimeSDKIdentityAsync extends AmazonChimeSDKIdentity
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonChimeSDKIdentityAsync instead.
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.
ENDPOINT_PREFIXcreateAppInstance, createAppInstanceAdmin, createAppInstanceUser, deleteAppInstance, deleteAppInstanceAdmin, deleteAppInstanceUser, deregisterAppInstanceUserEndpoint, describeAppInstance, describeAppInstanceAdmin, describeAppInstanceUser, describeAppInstanceUserEndpoint, getAppInstanceRetentionSettings, getCachedResponseMetadata, listAppInstanceAdmins, listAppInstances, listAppInstanceUserEndpoints, listAppInstanceUsers, listTagsForResource, putAppInstanceRetentionSettings, registerAppInstanceUserEndpoint, shutdown, tagResource, untagResource, updateAppInstance, updateAppInstanceUser, updateAppInstanceUserEndpointFuture<CreateAppInstanceResult> createAppInstanceAsync(CreateAppInstanceRequest 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
createAppInstanceRequest - Future<CreateAppInstanceResult> createAppInstanceAsync(CreateAppInstanceRequest createAppInstanceRequest, AsyncHandler<CreateAppInstanceRequest,CreateAppInstanceResult> asyncHandler)
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
createAppInstanceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateAppInstanceAdminResult> createAppInstanceAdminAsync(CreateAppInstanceAdminRequest createAppInstanceAdminRequest)
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.
createAppInstanceAdminRequest - Future<CreateAppInstanceAdminResult> createAppInstanceAdminAsync(CreateAppInstanceAdminRequest createAppInstanceAdminRequest, AsyncHandler<CreateAppInstanceAdminRequest,CreateAppInstanceAdminResult> asyncHandler)
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.
createAppInstanceAdminRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateAppInstanceUserResult> createAppInstanceUserAsync(CreateAppInstanceUserRequest createAppInstanceUserRequest)
Creates a user under an Amazon Chime AppInstance. The request consists of a unique
appInstanceUserId and Name for that user.
createAppInstanceUserRequest - Future<CreateAppInstanceUserResult> createAppInstanceUserAsync(CreateAppInstanceUserRequest createAppInstanceUserRequest, AsyncHandler<CreateAppInstanceUserRequest,CreateAppInstanceUserResult> asyncHandler)
Creates a user under an Amazon Chime AppInstance. The request consists of a unique
appInstanceUserId and Name for that user.
createAppInstanceUserRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteAppInstanceResult> deleteAppInstanceAsync(DeleteAppInstanceRequest deleteAppInstanceRequest)
Deletes an AppInstance and all associated data asynchronously.
deleteAppInstanceRequest - Future<DeleteAppInstanceResult> deleteAppInstanceAsync(DeleteAppInstanceRequest deleteAppInstanceRequest, AsyncHandler<DeleteAppInstanceRequest,DeleteAppInstanceResult> asyncHandler)
Deletes an AppInstance and all associated data asynchronously.
deleteAppInstanceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteAppInstanceAdminResult> deleteAppInstanceAdminAsync(DeleteAppInstanceAdminRequest deleteAppInstanceAdminRequest)
Demotes an AppInstanceAdmin to an AppInstanceUser. This action does not delete the
user.
deleteAppInstanceAdminRequest - Future<DeleteAppInstanceAdminResult> deleteAppInstanceAdminAsync(DeleteAppInstanceAdminRequest deleteAppInstanceAdminRequest, AsyncHandler<DeleteAppInstanceAdminRequest,DeleteAppInstanceAdminResult> asyncHandler)
Demotes an AppInstanceAdmin to an AppInstanceUser. This action does not delete the
user.
deleteAppInstanceAdminRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteAppInstanceUserResult> deleteAppInstanceUserAsync(DeleteAppInstanceUserRequest deleteAppInstanceUserRequest)
Deletes an AppInstanceUser.
deleteAppInstanceUserRequest - Future<DeleteAppInstanceUserResult> deleteAppInstanceUserAsync(DeleteAppInstanceUserRequest deleteAppInstanceUserRequest, AsyncHandler<DeleteAppInstanceUserRequest,DeleteAppInstanceUserResult> asyncHandler)
Deletes an AppInstanceUser.
deleteAppInstanceUserRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeregisterAppInstanceUserEndpointResult> deregisterAppInstanceUserEndpointAsync(DeregisterAppInstanceUserEndpointRequest deregisterAppInstanceUserEndpointRequest)
Deregisters an AppInstanceUserEndpoint.
deregisterAppInstanceUserEndpointRequest - Future<DeregisterAppInstanceUserEndpointResult> deregisterAppInstanceUserEndpointAsync(DeregisterAppInstanceUserEndpointRequest deregisterAppInstanceUserEndpointRequest, AsyncHandler<DeregisterAppInstanceUserEndpointRequest,DeregisterAppInstanceUserEndpointResult> asyncHandler)
Deregisters an AppInstanceUserEndpoint.
deregisterAppInstanceUserEndpointRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeAppInstanceResult> describeAppInstanceAsync(DescribeAppInstanceRequest describeAppInstanceRequest)
Returns the full details of an AppInstance.
describeAppInstanceRequest - Future<DescribeAppInstanceResult> describeAppInstanceAsync(DescribeAppInstanceRequest describeAppInstanceRequest, AsyncHandler<DescribeAppInstanceRequest,DescribeAppInstanceResult> asyncHandler)
Returns the full details of an AppInstance.
describeAppInstanceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeAppInstanceAdminResult> describeAppInstanceAdminAsync(DescribeAppInstanceAdminRequest describeAppInstanceAdminRequest)
Returns the full details of an AppInstanceAdmin.
describeAppInstanceAdminRequest - Future<DescribeAppInstanceAdminResult> describeAppInstanceAdminAsync(DescribeAppInstanceAdminRequest describeAppInstanceAdminRequest, AsyncHandler<DescribeAppInstanceAdminRequest,DescribeAppInstanceAdminResult> asyncHandler)
Returns the full details of an AppInstanceAdmin.
describeAppInstanceAdminRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeAppInstanceUserResult> describeAppInstanceUserAsync(DescribeAppInstanceUserRequest describeAppInstanceUserRequest)
Returns the full details of an AppInstanceUser.
describeAppInstanceUserRequest - Future<DescribeAppInstanceUserResult> describeAppInstanceUserAsync(DescribeAppInstanceUserRequest describeAppInstanceUserRequest, AsyncHandler<DescribeAppInstanceUserRequest,DescribeAppInstanceUserResult> asyncHandler)
Returns the full details of an AppInstanceUser.
describeAppInstanceUserRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeAppInstanceUserEndpointResult> describeAppInstanceUserEndpointAsync(DescribeAppInstanceUserEndpointRequest describeAppInstanceUserEndpointRequest)
Returns the full details of an AppInstanceUserEndpoint.
describeAppInstanceUserEndpointRequest - Future<DescribeAppInstanceUserEndpointResult> describeAppInstanceUserEndpointAsync(DescribeAppInstanceUserEndpointRequest describeAppInstanceUserEndpointRequest, AsyncHandler<DescribeAppInstanceUserEndpointRequest,DescribeAppInstanceUserEndpointResult> asyncHandler)
Returns the full details of an AppInstanceUserEndpoint.
describeAppInstanceUserEndpointRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetAppInstanceRetentionSettingsResult> getAppInstanceRetentionSettingsAsync(GetAppInstanceRetentionSettingsRequest getAppInstanceRetentionSettingsRequest)
Gets the retention settings for an AppInstance.
getAppInstanceRetentionSettingsRequest - Future<GetAppInstanceRetentionSettingsResult> getAppInstanceRetentionSettingsAsync(GetAppInstanceRetentionSettingsRequest getAppInstanceRetentionSettingsRequest, AsyncHandler<GetAppInstanceRetentionSettingsRequest,GetAppInstanceRetentionSettingsResult> asyncHandler)
Gets the retention settings for an AppInstance.
getAppInstanceRetentionSettingsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListAppInstanceAdminsResult> listAppInstanceAdminsAsync(ListAppInstanceAdminsRequest listAppInstanceAdminsRequest)
Returns a list of the administrators in the AppInstance.
listAppInstanceAdminsRequest - Future<ListAppInstanceAdminsResult> listAppInstanceAdminsAsync(ListAppInstanceAdminsRequest listAppInstanceAdminsRequest, AsyncHandler<ListAppInstanceAdminsRequest,ListAppInstanceAdminsResult> asyncHandler)
Returns a list of the administrators in the AppInstance.
listAppInstanceAdminsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListAppInstanceUserEndpointsResult> listAppInstanceUserEndpointsAsync(ListAppInstanceUserEndpointsRequest listAppInstanceUserEndpointsRequest)
Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.
listAppInstanceUserEndpointsRequest - Future<ListAppInstanceUserEndpointsResult> listAppInstanceUserEndpointsAsync(ListAppInstanceUserEndpointsRequest listAppInstanceUserEndpointsRequest, AsyncHandler<ListAppInstanceUserEndpointsRequest,ListAppInstanceUserEndpointsResult> asyncHandler)
Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.
listAppInstanceUserEndpointsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListAppInstanceUsersResult> listAppInstanceUsersAsync(ListAppInstanceUsersRequest listAppInstanceUsersRequest)
List all AppInstanceUsers created under a single AppInstance.
listAppInstanceUsersRequest - Future<ListAppInstanceUsersResult> listAppInstanceUsersAsync(ListAppInstanceUsersRequest listAppInstanceUsersRequest, AsyncHandler<ListAppInstanceUsersRequest,ListAppInstanceUsersResult> asyncHandler)
List all AppInstanceUsers created under a single AppInstance.
listAppInstanceUsersRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListAppInstancesResult> listAppInstancesAsync(ListAppInstancesRequest listAppInstancesRequest)
Lists all Amazon Chime AppInstances created under a single AWS account.
listAppInstancesRequest - Future<ListAppInstancesResult> listAppInstancesAsync(ListAppInstancesRequest listAppInstancesRequest, AsyncHandler<ListAppInstancesRequest,ListAppInstancesResult> asyncHandler)
Lists all Amazon Chime AppInstances created under a single AWS account.
listAppInstancesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags applied to an Amazon Chime SDK identity resource.
listTagsForResourceRequest - Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Lists the tags applied to an Amazon Chime SDK identity resource.
listTagsForResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutAppInstanceRetentionSettingsResult> putAppInstanceRetentionSettingsAsync(PutAppInstanceRetentionSettingsRequest putAppInstanceRetentionSettingsRequest)
Sets the amount of time in days that a given AppInstance retains data.
putAppInstanceRetentionSettingsRequest - Future<PutAppInstanceRetentionSettingsResult> putAppInstanceRetentionSettingsAsync(PutAppInstanceRetentionSettingsRequest putAppInstanceRetentionSettingsRequest, AsyncHandler<PutAppInstanceRetentionSettingsRequest,PutAppInstanceRetentionSettingsResult> asyncHandler)
Sets the amount of time in days that a given AppInstance retains data.
putAppInstanceRetentionSettingsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RegisterAppInstanceUserEndpointResult> registerAppInstanceUserEndpointAsync(RegisterAppInstanceUserEndpointRequest 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.
registerAppInstanceUserEndpointRequest - Future<RegisterAppInstanceUserEndpointResult> registerAppInstanceUserEndpointAsync(RegisterAppInstanceUserEndpointRequest registerAppInstanceUserEndpointRequest, AsyncHandler<RegisterAppInstanceUserEndpointRequest,RegisterAppInstanceUserEndpointResult> asyncHandler)
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.
registerAppInstanceUserEndpointRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Applies the specified tags to the specified Amazon Chime SDK identity resource.
tagResourceRequest - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Applies the specified tags to the specified Amazon Chime SDK identity resource.
tagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes the specified tags from the specified Amazon Chime SDK identity resource.
untagResourceRequest - Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes the specified tags from the specified Amazon Chime SDK identity resource.
untagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateAppInstanceResult> updateAppInstanceAsync(UpdateAppInstanceRequest updateAppInstanceRequest)
Updates AppInstance metadata.
updateAppInstanceRequest - Future<UpdateAppInstanceResult> updateAppInstanceAsync(UpdateAppInstanceRequest updateAppInstanceRequest, AsyncHandler<UpdateAppInstanceRequest,UpdateAppInstanceResult> asyncHandler)
Updates AppInstance metadata.
updateAppInstanceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateAppInstanceUserResult> updateAppInstanceUserAsync(UpdateAppInstanceUserRequest updateAppInstanceUserRequest)
Updates the details of an AppInstanceUser. You can update names and metadata.
updateAppInstanceUserRequest - Future<UpdateAppInstanceUserResult> updateAppInstanceUserAsync(UpdateAppInstanceUserRequest updateAppInstanceUserRequest, AsyncHandler<UpdateAppInstanceUserRequest,UpdateAppInstanceUserResult> asyncHandler)
Updates the details of an AppInstanceUser. You can update names and metadata.
updateAppInstanceUserRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateAppInstanceUserEndpointResult> updateAppInstanceUserEndpointAsync(UpdateAppInstanceUserEndpointRequest updateAppInstanceUserEndpointRequest)
Updates the details of an AppInstanceUserEndpoint. You can update the name and
AllowMessage values.
updateAppInstanceUserEndpointRequest - Future<UpdateAppInstanceUserEndpointResult> updateAppInstanceUserEndpointAsync(UpdateAppInstanceUserEndpointRequest updateAppInstanceUserEndpointRequest, AsyncHandler<UpdateAppInstanceUserEndpointRequest,UpdateAppInstanceUserEndpointResult> asyncHandler)
Updates the details of an AppInstanceUserEndpoint. You can update the name and
AllowMessage values.
updateAppInstanceUserEndpointRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.