com.amazonaws.services.chimesdkidentity

Class AbstractAmazonChimeSDKIdentity

java.lang.Object

com.amazonaws.services.chimesdkidentity.AbstractAmazonChimeSDKIdentity

All Implemented Interfaces:

AmazonChimeSDKIdentity

Direct Known Subclasses:

AbstractAmazonChimeSDKIdentityAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonChimeSDKIdentity
extends Object
implements AmazonChimeSDKIdentity

Abstract implementation of AmazonChimeSDKIdentity. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

Fields inherited from interface com.amazonaws.services.chimesdkidentity.AmazonChimeSDKIdentity

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
CreateAppInstanceResult	createAppInstance(CreateAppInstanceRequest request) Creates an Amazon Chime SDK messaging AppInstance under an AWS account.
CreateAppInstanceAdminResult	createAppInstanceAdmin(CreateAppInstanceAdminRequest request) Promotes an AppInstanceUser or AppInstanceBot to an AppInstanceAdmin.
CreateAppInstanceBotResult	createAppInstanceBot(CreateAppInstanceBotRequest request) Creates a bot under an Amazon Chime AppInstance.
CreateAppInstanceUserResult	createAppInstanceUser(CreateAppInstanceUserRequest request) Creates a user under an Amazon Chime AppInstance.
DeleteAppInstanceResult	deleteAppInstance(DeleteAppInstanceRequest request) Deletes an AppInstance and all associated data asynchronously.
DeleteAppInstanceAdminResult	deleteAppInstanceAdmin(DeleteAppInstanceAdminRequest request) Demotes an AppInstanceAdmin to an AppInstanceUser or AppInstanceBot.
DeleteAppInstanceBotResult	deleteAppInstanceBot(DeleteAppInstanceBotRequest request) Deletes an AppInstanceBot.
DeleteAppInstanceUserResult	deleteAppInstanceUser(DeleteAppInstanceUserRequest request) Deletes an AppInstanceUser.
DeregisterAppInstanceUserEndpointResult	deregisterAppInstanceUserEndpoint(DeregisterAppInstanceUserEndpointRequest request) Deregisters an AppInstanceUserEndpoint.
DescribeAppInstanceResult	describeAppInstance(DescribeAppInstanceRequest request) Returns the full details of an AppInstance.
DescribeAppInstanceAdminResult	describeAppInstanceAdmin(DescribeAppInstanceAdminRequest request) Returns the full details of an AppInstanceAdmin.
DescribeAppInstanceBotResult	describeAppInstanceBot(DescribeAppInstanceBotRequest request) The AppInstanceBot's information.
DescribeAppInstanceUserResult	describeAppInstanceUser(DescribeAppInstanceUserRequest request) Returns the full details of an AppInstanceUser.
DescribeAppInstanceUserEndpointResult	describeAppInstanceUserEndpoint(DescribeAppInstanceUserEndpointRequest request) Returns the full details of an AppInstanceUserEndpoint.
GetAppInstanceRetentionSettingsResult	getAppInstanceRetentionSettings(GetAppInstanceRetentionSettingsRequest request) Gets the retention settings for an AppInstance.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
ListAppInstanceAdminsResult	listAppInstanceAdmins(ListAppInstanceAdminsRequest request) Returns a list of the administrators in the AppInstance.
ListAppInstanceBotsResult	listAppInstanceBots(ListAppInstanceBotsRequest request) Lists all AppInstanceBots created under a single AppInstance.
ListAppInstancesResult	listAppInstances(ListAppInstancesRequest request) Lists all Amazon Chime AppInstances created under a single AWS account.
ListAppInstanceUserEndpointsResult	listAppInstanceUserEndpoints(ListAppInstanceUserEndpointsRequest request) Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.
ListAppInstanceUsersResult	listAppInstanceUsers(ListAppInstanceUsersRequest request) List all AppInstanceUsers created under a single AppInstance.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists the tags applied to an Amazon Chime SDK identity resource.
PutAppInstanceRetentionSettingsResult	putAppInstanceRetentionSettings(PutAppInstanceRetentionSettingsRequest request) Sets the amount of time in days that a given AppInstance retains data.
PutAppInstanceUserExpirationSettingsResult	putAppInstanceUserExpirationSettings(PutAppInstanceUserExpirationSettingsRequest request) Sets the number of days before the AppInstanceUser is automatically deleted.
RegisterAppInstanceUserEndpointResult	registerAppInstanceUserEndpoint(RegisterAppInstanceUserEndpointRequest request) Registers an endpoint under an Amazon Chime AppInstanceUser.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) Applies the specified tags to the specified Amazon Chime SDK identity resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes the specified tags from the specified Amazon Chime SDK identity resource.
UpdateAppInstanceResult	updateAppInstance(UpdateAppInstanceRequest request) Updates AppInstance metadata.
UpdateAppInstanceBotResult	updateAppInstanceBot(UpdateAppInstanceBotRequest request) Updates the name and metadata of an AppInstanceBot.
UpdateAppInstanceUserResult	updateAppInstanceUser(UpdateAppInstanceUserRequest request) Updates the details of an AppInstanceUser.
UpdateAppInstanceUserEndpointResult	updateAppInstanceUserEndpoint(UpdateAppInstanceUserEndpointRequest request) Updates the details of an AppInstanceUserEndpoint.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createAppInstance

public CreateAppInstanceResult createAppInstance(CreateAppInstanceRequest request)

Description copied from interface: AmazonChimeSDKIdentity

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

Specified by:

createAppInstance in interface AmazonChimeSDKIdentity

Returns:

Result of the CreateAppInstance operation returned by the service.

See Also:

AWS API Documentation

createAppInstanceAdmin

public CreateAppInstanceAdminResult createAppInstanceAdmin(CreateAppInstanceAdminRequest request)

Description copied from interface: AmazonChimeSDKIdentity

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.

Specified by:

createAppInstanceAdmin in interface AmazonChimeSDKIdentity

Returns:

Result of the CreateAppInstanceAdmin operation returned by the service.

See Also:

AWS API Documentation

createAppInstanceBot

public CreateAppInstanceBotResult createAppInstanceBot(CreateAppInstanceBotRequest request)

Description copied from interface: AmazonChimeSDKIdentity

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

Specified by:

createAppInstanceBot in interface AmazonChimeSDKIdentity

Returns:

Result of the CreateAppInstanceBot operation returned by the service.

See Also:

AWS API Documentation

createAppInstanceUser

public CreateAppInstanceUserResult createAppInstanceUser(CreateAppInstanceUserRequest request)

Description copied from interface: AmazonChimeSDKIdentity

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

Specified by:

createAppInstanceUser in interface AmazonChimeSDKIdentity

Returns:

Result of the CreateAppInstanceUser operation returned by the service.

See Also:

AWS API Documentation

deleteAppInstance

public DeleteAppInstanceResult deleteAppInstance(DeleteAppInstanceRequest request)

Description copied from interface: AmazonChimeSDKIdentity

Deletes an AppInstance and all associated data asynchronously.

Specified by:

deleteAppInstance in interface AmazonChimeSDKIdentity

Returns:

Result of the DeleteAppInstance operation returned by the service.

See Also:

AWS API Documentation

deleteAppInstanceAdmin

public DeleteAppInstanceAdminResult deleteAppInstanceAdmin(DeleteAppInstanceAdminRequest request)

Description copied from interface: AmazonChimeSDKIdentity

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

Specified by:

deleteAppInstanceAdmin in interface AmazonChimeSDKIdentity

Returns:

Result of the DeleteAppInstanceAdmin operation returned by the service.

See Also:

AWS API Documentation

deleteAppInstanceBot

public DeleteAppInstanceBotResult deleteAppInstanceBot(DeleteAppInstanceBotRequest request)

Description copied from interface: AmazonChimeSDKIdentity

Deletes an AppInstanceBot.

Specified by:

deleteAppInstanceBot in interface AmazonChimeSDKIdentity

Returns:

Result of the DeleteAppInstanceBot operation returned by the service.

See Also:

AWS API Documentation

deleteAppInstanceUser

public DeleteAppInstanceUserResult deleteAppInstanceUser(DeleteAppInstanceUserRequest request)

Description copied from interface: AmazonChimeSDKIdentity

Deletes an AppInstanceUser.

Specified by:

deleteAppInstanceUser in interface AmazonChimeSDKIdentity

Returns:

Result of the DeleteAppInstanceUser operation returned by the service.

See Also:

AWS API Documentation

deregisterAppInstanceUserEndpoint

public DeregisterAppInstanceUserEndpointResult deregisterAppInstanceUserEndpoint(DeregisterAppInstanceUserEndpointRequest request)

Description copied from interface: AmazonChimeSDKIdentity

Deregisters an AppInstanceUserEndpoint.

Specified by:

deregisterAppInstanceUserEndpoint in interface AmazonChimeSDKIdentity

Returns:

Result of the DeregisterAppInstanceUserEndpoint operation returned by the service.

See Also:

AWS API Documentation

describeAppInstance

public DescribeAppInstanceResult describeAppInstance(DescribeAppInstanceRequest request)

Description copied from interface: AmazonChimeSDKIdentity

Returns the full details of an AppInstance.

Specified by:

describeAppInstance in interface AmazonChimeSDKIdentity

Returns:

Result of the DescribeAppInstance operation returned by the service.

See Also:

AWS API Documentation

describeAppInstanceAdmin

public DescribeAppInstanceAdminResult describeAppInstanceAdmin(DescribeAppInstanceAdminRequest request)

Description copied from interface: AmazonChimeSDKIdentity

Returns the full details of an AppInstanceAdmin.

Specified by:

describeAppInstanceAdmin in interface AmazonChimeSDKIdentity

Returns:

Result of the DescribeAppInstanceAdmin operation returned by the service.

See Also:

AWS API Documentation

describeAppInstanceBot

public DescribeAppInstanceBotResult describeAppInstanceBot(DescribeAppInstanceBotRequest request)

Description copied from interface: AmazonChimeSDKIdentity

The AppInstanceBot's information.

Specified by:

describeAppInstanceBot in interface AmazonChimeSDKIdentity

Returns:

Result of the DescribeAppInstanceBot operation returned by the service.

See Also:

AWS API Documentation

describeAppInstanceUser

public DescribeAppInstanceUserResult describeAppInstanceUser(DescribeAppInstanceUserRequest request)

Description copied from interface: AmazonChimeSDKIdentity

Returns the full details of an AppInstanceUser.

Specified by:

describeAppInstanceUser in interface AmazonChimeSDKIdentity

Returns:

Result of the DescribeAppInstanceUser operation returned by the service.

See Also:

AWS API Documentation

describeAppInstanceUserEndpoint

public DescribeAppInstanceUserEndpointResult describeAppInstanceUserEndpoint(DescribeAppInstanceUserEndpointRequest request)

Description copied from interface: AmazonChimeSDKIdentity

Returns the full details of an AppInstanceUserEndpoint.

Specified by:

describeAppInstanceUserEndpoint in interface AmazonChimeSDKIdentity

Returns:

Result of the DescribeAppInstanceUserEndpoint operation returned by the service.

See Also:

AWS API Documentation

getAppInstanceRetentionSettings

public GetAppInstanceRetentionSettingsResult getAppInstanceRetentionSettings(GetAppInstanceRetentionSettingsRequest request)

Description copied from interface: AmazonChimeSDKIdentity

Gets the retention settings for an AppInstance.

Specified by:

getAppInstanceRetentionSettings in interface AmazonChimeSDKIdentity

Returns:

Result of the GetAppInstanceRetentionSettings operation returned by the service.

See Also:

AWS API Documentation

listAppInstanceAdmins

public ListAppInstanceAdminsResult listAppInstanceAdmins(ListAppInstanceAdminsRequest request)

Description copied from interface: AmazonChimeSDKIdentity

Returns a list of the administrators in the AppInstance.

Specified by:

listAppInstanceAdmins in interface AmazonChimeSDKIdentity

Returns:

Result of the ListAppInstanceAdmins operation returned by the service.

See Also:

AWS API Documentation

listAppInstanceBots

public ListAppInstanceBotsResult listAppInstanceBots(ListAppInstanceBotsRequest request)

Description copied from interface: AmazonChimeSDKIdentity

Lists all AppInstanceBots created under a single AppInstance.

Specified by:

listAppInstanceBots in interface AmazonChimeSDKIdentity

Returns:

Result of the ListAppInstanceBots operation returned by the service.

See Also:

AWS API Documentation

listAppInstanceUserEndpoints

public ListAppInstanceUserEndpointsResult listAppInstanceUserEndpoints(ListAppInstanceUserEndpointsRequest request)

Description copied from interface: AmazonChimeSDKIdentity

Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.

Specified by:

listAppInstanceUserEndpoints in interface AmazonChimeSDKIdentity

Returns:

Result of the ListAppInstanceUserEndpoints operation returned by the service.

See Also:

AWS API Documentation

listAppInstanceUsers

public ListAppInstanceUsersResult listAppInstanceUsers(ListAppInstanceUsersRequest request)

Description copied from interface: AmazonChimeSDKIdentity

List all AppInstanceUsers created under a single AppInstance.

Specified by:

listAppInstanceUsers in interface AmazonChimeSDKIdentity

Returns:

Result of the ListAppInstanceUsers operation returned by the service.

See Also:

AWS API Documentation

listAppInstances

public ListAppInstancesResult listAppInstances(ListAppInstancesRequest request)

Description copied from interface: AmazonChimeSDKIdentity

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

Specified by:

listAppInstances in interface AmazonChimeSDKIdentity

Returns:

Result of the ListAppInstances operation returned by the service.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Description copied from interface: AmazonChimeSDKIdentity

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

Specified by:

listTagsForResource in interface AmazonChimeSDKIdentity

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

putAppInstanceRetentionSettings

public PutAppInstanceRetentionSettingsResult putAppInstanceRetentionSettings(PutAppInstanceRetentionSettingsRequest request)

Description copied from interface: AmazonChimeSDKIdentity

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

Specified by:

putAppInstanceRetentionSettings in interface AmazonChimeSDKIdentity

Returns:

Result of the PutAppInstanceRetentionSettings operation returned by the service.

See Also:

AWS API Documentation

putAppInstanceUserExpirationSettings

public PutAppInstanceUserExpirationSettingsResult putAppInstanceUserExpirationSettings(PutAppInstanceUserExpirationSettingsRequest request)

Description copied from interface: AmazonChimeSDKIdentity

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.

Specified by:

putAppInstanceUserExpirationSettings in interface AmazonChimeSDKIdentity

Returns:

Result of the PutAppInstanceUserExpirationSettings operation returned by the service.

See Also:

AWS API Documentation

registerAppInstanceUserEndpoint

public RegisterAppInstanceUserEndpointResult registerAppInstanceUserEndpoint(RegisterAppInstanceUserEndpointRequest request)

Description copied from interface: AmazonChimeSDKIdentity

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.

Specified by:

registerAppInstanceUserEndpoint in interface AmazonChimeSDKIdentity

Returns:

Result of the RegisterAppInstanceUserEndpoint operation returned by the service.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Description copied from interface: AmazonChimeSDKIdentity

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

Specified by:

tagResource in interface AmazonChimeSDKIdentity

Returns:

Result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Description copied from interface: AmazonChimeSDKIdentity

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

Specified by:

untagResource in interface AmazonChimeSDKIdentity

Returns:

Result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

updateAppInstance

public UpdateAppInstanceResult updateAppInstance(UpdateAppInstanceRequest request)

Description copied from interface: AmazonChimeSDKIdentity

Updates AppInstance metadata.

Specified by:

updateAppInstance in interface AmazonChimeSDKIdentity

Returns:

Result of the UpdateAppInstance operation returned by the service.

See Also:

AWS API Documentation

updateAppInstanceBot

public UpdateAppInstanceBotResult updateAppInstanceBot(UpdateAppInstanceBotRequest request)

Description copied from interface: AmazonChimeSDKIdentity

Updates the name and metadata of an AppInstanceBot.

Specified by:

updateAppInstanceBot in interface AmazonChimeSDKIdentity

Returns:

Result of the UpdateAppInstanceBot operation returned by the service.

See Also:

AWS API Documentation

updateAppInstanceUser

public UpdateAppInstanceUserResult updateAppInstanceUser(UpdateAppInstanceUserRequest request)

Description copied from interface: AmazonChimeSDKIdentity

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

Specified by:

updateAppInstanceUser in interface AmazonChimeSDKIdentity

Returns:

Result of the UpdateAppInstanceUser operation returned by the service.

See Also:

AWS API Documentation

updateAppInstanceUserEndpoint

public UpdateAppInstanceUserEndpointResult updateAppInstanceUserEndpoint(UpdateAppInstanceUserEndpointRequest request)

Description copied from interface: AmazonChimeSDKIdentity

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

Specified by:

updateAppInstanceUserEndpoint in interface AmazonChimeSDKIdentity

Returns:

Result of the UpdateAppInstanceUserEndpoint operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: AmazonChimeSDKIdentity

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonChimeSDKIdentity

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AmazonChimeSDKIdentity

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Specified by:

getCachedResponseMetadata in interface AmazonChimeSDKIdentity

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.