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 to an AppInstanceAdmin.
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.
DeleteAppInstanceUserResult	deleteAppInstanceUser(DeleteAppInstanceUserRequest request) Deletes an AppInstanceUser.
DescribeAppInstanceResult	describeAppInstance(DescribeAppInstanceRequest request) Returns the full details of an AppInstance.
DescribeAppInstanceAdminResult	describeAppInstanceAdmin(DescribeAppInstanceAdminRequest request) Returns the full details of an AppInstanceAdmin.
DescribeAppInstanceUserResult	describeAppInstanceUser(DescribeAppInstanceUserRequest request) Returns the full details of an AppInstanceUser.
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.
ListAppInstancesResult	listAppInstances(ListAppInstancesRequest request) Lists all Amazon Chime AppInstances created under a single AWS account.
ListAppInstanceUsersResult	listAppInstanceUsers(ListAppInstanceUsersRequest request) List all AppInstanceUsers created under a single AppInstance.
PutAppInstanceRetentionSettingsResult	putAppInstanceRetentionSettings(PutAppInstanceRetentionSettingsRequest request) Sets the amount of time in days that a given AppInstance retains data.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateAppInstanceResult	updateAppInstance(UpdateAppInstanceRequest request) Updates AppInstance metadata.
UpdateAppInstanceUserResult	updateAppInstanceUser(UpdateAppInstanceUserRequest request) Updates the details of an AppInstanceUser.

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 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.

Specified by:

createAppInstanceAdmin in interface AmazonChimeSDKIdentity

Returns:

Result of the CreateAppInstanceAdmin 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. 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

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

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

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

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

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

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

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

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

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.