com.amazonaws.services.chimesdkidentity

Class AmazonChimeSDKIdentityClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.chimesdkidentity.AmazonChimeSDKIdentityClient

All Implemented Interfaces:

AmazonChimeSDKIdentity

Direct Known Subclasses:

AmazonChimeSDKIdentityAsyncClient

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

Client for accessing Amazon Chime SDK Identity. All service calls made using this client are blocking, and will not return until the service call completes.

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.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonChimeSDKIdentityClientBuilder	builder()
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 com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static AmazonChimeSDKIdentityClientBuilder builder()

createAppInstance

public CreateAppInstanceResult createAppInstance(CreateAppInstanceRequest request)

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

Parameters:

createAppInstanceRequest -

Returns:

Result of the CreateAppInstance operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ConflictException - The request could not be processed because of conflict in the current state of the resource.

ForbiddenException - The client is permanently forbidden from making the request.

ResourceLimitExceededException - The request exceeds the resource limit.

ThrottledClientException - The client exceeded its request rate limit.

UnauthorizedClientException - The client is not currently authorized to make the request.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

createAppInstanceAdmin

public CreateAppInstanceAdminResult createAppInstanceAdmin(CreateAppInstanceAdminRequest request)

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

Parameters:

createAppInstanceAdminRequest -

Returns:

Result of the CreateAppInstanceAdmin operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ConflictException - The request could not be processed because of conflict in the current state of the resource.

ForbiddenException - The client is permanently forbidden from making the request.

ResourceLimitExceededException - The request exceeds the resource limit.

ThrottledClientException - The client exceeded its request rate limit.

UnauthorizedClientException - The client is not currently authorized to make the request.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

createAppInstanceBot

public CreateAppInstanceBotResult createAppInstanceBot(CreateAppInstanceBotRequest request)

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

Parameters:

createAppInstanceBotRequest -

Returns:

Result of the CreateAppInstanceBot operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ConflictException - The request could not be processed because of conflict in the current state of the resource.

ForbiddenException - The client is permanently forbidden from making the request.

ResourceLimitExceededException - The request exceeds the resource limit.

ThrottledClientException - The client exceeded its request rate limit.

UnauthorizedClientException - The client is not currently authorized to make the request.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

createAppInstanceUser

public CreateAppInstanceUserResult createAppInstanceUser(CreateAppInstanceUserRequest request)

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

Parameters:

createAppInstanceUserRequest -

Returns:

Result of the CreateAppInstanceUser operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ConflictException - The request could not be processed because of conflict in the current state of the resource.

ForbiddenException - The client is permanently forbidden from making the request.

ResourceLimitExceededException - The request exceeds the resource limit.

ThrottledClientException - The client exceeded its request rate limit.

UnauthorizedClientException - The client is not currently authorized to make the request.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

deleteAppInstance

public DeleteAppInstanceResult deleteAppInstance(DeleteAppInstanceRequest request)

Deletes an AppInstance and all associated data asynchronously.

Specified by:

deleteAppInstance in interface AmazonChimeSDKIdentity

Parameters:

deleteAppInstanceRequest -

Returns:

Result of the DeleteAppInstance operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request.

ResourceLimitExceededException - The request exceeds the resource limit.

ThrottledClientException - The client exceeded its request rate limit.

UnauthorizedClientException - The client is not currently authorized to make the request.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

deleteAppInstanceAdmin

public DeleteAppInstanceAdminResult deleteAppInstanceAdmin(DeleteAppInstanceAdminRequest request)

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

Specified by:

deleteAppInstanceAdmin in interface AmazonChimeSDKIdentity

Parameters:

deleteAppInstanceAdminRequest -

Returns:

Result of the DeleteAppInstanceAdmin operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ConflictException - The request could not be processed because of conflict in the current state of the resource.

ForbiddenException - The client is permanently forbidden from making the request.

ResourceLimitExceededException - The request exceeds the resource limit.

ThrottledClientException - The client exceeded its request rate limit.

UnauthorizedClientException - The client is not currently authorized to make the request.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

deleteAppInstanceBot

public DeleteAppInstanceBotResult deleteAppInstanceBot(DeleteAppInstanceBotRequest request)

Deletes an AppInstanceBot.

Specified by:

deleteAppInstanceBot in interface AmazonChimeSDKIdentity

Parameters:

deleteAppInstanceBotRequest -

Returns:

Result of the DeleteAppInstanceBot operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ConflictException - The request could not be processed because of conflict in the current state of the resource.

ForbiddenException - The client is permanently forbidden from making the request.

ResourceLimitExceededException - The request exceeds the resource limit.

ThrottledClientException - The client exceeded its request rate limit.

UnauthorizedClientException - The client is not currently authorized to make the request.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

deleteAppInstanceUser

public DeleteAppInstanceUserResult deleteAppInstanceUser(DeleteAppInstanceUserRequest request)

Deletes an AppInstanceUser.

Specified by:

deleteAppInstanceUser in interface AmazonChimeSDKIdentity

Parameters:

deleteAppInstanceUserRequest -

Returns:

Result of the DeleteAppInstanceUser operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ConflictException - The request could not be processed because of conflict in the current state of the resource.

ForbiddenException - The client is permanently forbidden from making the request.

ResourceLimitExceededException - The request exceeds the resource limit.

ThrottledClientException - The client exceeded its request rate limit.

UnauthorizedClientException - The client is not currently authorized to make the request.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

deregisterAppInstanceUserEndpoint

public DeregisterAppInstanceUserEndpointResult deregisterAppInstanceUserEndpoint(DeregisterAppInstanceUserEndpointRequest request)

Deregisters an AppInstanceUserEndpoint.

Specified by:

deregisterAppInstanceUserEndpoint in interface AmazonChimeSDKIdentity

Parameters:

deregisterAppInstanceUserEndpointRequest -

Returns:

Result of the DeregisterAppInstanceUserEndpoint operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request.

ThrottledClientException - The client exceeded its request rate limit.

UnauthorizedClientException - The client is not currently authorized to make the request.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

describeAppInstance

public DescribeAppInstanceResult describeAppInstance(DescribeAppInstanceRequest request)

Returns the full details of an AppInstance.

Specified by:

describeAppInstance in interface AmazonChimeSDKIdentity

Parameters:

describeAppInstanceRequest -

Returns:

Result of the DescribeAppInstance operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request.

ThrottledClientException - The client exceeded its request rate limit.

UnauthorizedClientException - The client is not currently authorized to make the request.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

describeAppInstanceAdmin

public DescribeAppInstanceAdminResult describeAppInstanceAdmin(DescribeAppInstanceAdminRequest request)

Returns the full details of an AppInstanceAdmin.

Specified by:

describeAppInstanceAdmin in interface AmazonChimeSDKIdentity

Parameters:

describeAppInstanceAdminRequest -

Returns:

Result of the DescribeAppInstanceAdmin operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request.

ThrottledClientException - The client exceeded its request rate limit.

UnauthorizedClientException - The client is not currently authorized to make the request.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

describeAppInstanceBot

public DescribeAppInstanceBotResult describeAppInstanceBot(DescribeAppInstanceBotRequest request)

The AppInstanceBot's information.

Specified by:

describeAppInstanceBot in interface AmazonChimeSDKIdentity

Parameters:

describeAppInstanceBotRequest -

Returns:

Result of the DescribeAppInstanceBot operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request.

ThrottledClientException - The client exceeded its request rate limit.

UnauthorizedClientException - The client is not currently authorized to make the request.

NotFoundException - One or more of the resources in the request does not exist in the system.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

describeAppInstanceUser

public DescribeAppInstanceUserResult describeAppInstanceUser(DescribeAppInstanceUserRequest request)

Returns the full details of an AppInstanceUser.

Specified by:

describeAppInstanceUser in interface AmazonChimeSDKIdentity

Parameters:

describeAppInstanceUserRequest -

Returns:

Result of the DescribeAppInstanceUser operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request.

ThrottledClientException - The client exceeded its request rate limit.

UnauthorizedClientException - The client is not currently authorized to make the request.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

describeAppInstanceUserEndpoint

public DescribeAppInstanceUserEndpointResult describeAppInstanceUserEndpoint(DescribeAppInstanceUserEndpointRequest request)

Returns the full details of an AppInstanceUserEndpoint.

Specified by:

describeAppInstanceUserEndpoint in interface AmazonChimeSDKIdentity

Parameters:

describeAppInstanceUserEndpointRequest -

Returns:

Result of the DescribeAppInstanceUserEndpoint operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request.

ThrottledClientException - The client exceeded its request rate limit.

UnauthorizedClientException - The client is not currently authorized to make the request.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

getAppInstanceRetentionSettings

public GetAppInstanceRetentionSettingsResult getAppInstanceRetentionSettings(GetAppInstanceRetentionSettingsRequest request)

Gets the retention settings for an AppInstance.

Specified by:

getAppInstanceRetentionSettings in interface AmazonChimeSDKIdentity

Parameters:

getAppInstanceRetentionSettingsRequest -

Returns:

Result of the GetAppInstanceRetentionSettings operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request.

ThrottledClientException - The client exceeded its request rate limit.

UnauthorizedClientException - The client is not currently authorized to make the request.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

listAppInstanceAdmins

public ListAppInstanceAdminsResult listAppInstanceAdmins(ListAppInstanceAdminsRequest request)

Returns a list of the administrators in the AppInstance.

Specified by:

listAppInstanceAdmins in interface AmazonChimeSDKIdentity

Parameters:

listAppInstanceAdminsRequest -

Returns:

Result of the ListAppInstanceAdmins operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request.

ResourceLimitExceededException - The request exceeds the resource limit.

ThrottledClientException - The client exceeded its request rate limit.

UnauthorizedClientException - The client is not currently authorized to make the request.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

listAppInstanceBots

public ListAppInstanceBotsResult listAppInstanceBots(ListAppInstanceBotsRequest request)

Lists all AppInstanceBots created under a single AppInstance.

Specified by:

listAppInstanceBots in interface AmazonChimeSDKIdentity

Parameters:

listAppInstanceBotsRequest -

Returns:

Result of the ListAppInstanceBots operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request.

ResourceLimitExceededException - The request exceeds the resource limit.

ThrottledClientException - The client exceeded its request rate limit.

UnauthorizedClientException - The client is not currently authorized to make the request.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

listAppInstanceUserEndpoints

public ListAppInstanceUserEndpointsResult listAppInstanceUserEndpoints(ListAppInstanceUserEndpointsRequest request)

Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.

Specified by:

listAppInstanceUserEndpoints in interface AmazonChimeSDKIdentity

Parameters:

listAppInstanceUserEndpointsRequest -

Returns:

Result of the ListAppInstanceUserEndpoints operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request.

ThrottledClientException - The client exceeded its request rate limit.

UnauthorizedClientException - The client is not currently authorized to make the request.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

listAppInstanceUsers

public ListAppInstanceUsersResult listAppInstanceUsers(ListAppInstanceUsersRequest request)

List all AppInstanceUsers created under a single AppInstance.

Specified by:

listAppInstanceUsers in interface AmazonChimeSDKIdentity

Parameters:

listAppInstanceUsersRequest -

Returns:

Result of the ListAppInstanceUsers operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request.

ThrottledClientException - The client exceeded its request rate limit.

UnauthorizedClientException - The client is not currently authorized to make the request.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

listAppInstances

public ListAppInstancesResult listAppInstances(ListAppInstancesRequest request)

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

Specified by:

listAppInstances in interface AmazonChimeSDKIdentity

Parameters:

listAppInstancesRequest -

Returns:

Result of the ListAppInstances operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request.

ThrottledClientException - The client exceeded its request rate limit.

UnauthorizedClientException - The client is not currently authorized to make the request.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

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

Specified by:

listTagsForResource in interface AmazonChimeSDKIdentity

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request.

UnauthorizedClientException - The client is not currently authorized to make the request.

ThrottledClientException - The client exceeded its request rate limit.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

putAppInstanceRetentionSettings

public PutAppInstanceRetentionSettingsResult putAppInstanceRetentionSettings(PutAppInstanceRetentionSettingsRequest request)

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

Specified by:

putAppInstanceRetentionSettings in interface AmazonChimeSDKIdentity

Parameters:

putAppInstanceRetentionSettingsRequest -

Returns:

Result of the PutAppInstanceRetentionSettings operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request.

ThrottledClientException - The client exceeded its request rate limit.

UnauthorizedClientException - The client is not currently authorized to make the request.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

putAppInstanceUserExpirationSettings

public PutAppInstanceUserExpirationSettingsResult putAppInstanceUserExpirationSettings(PutAppInstanceUserExpirationSettingsRequest request)

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

Parameters:

putAppInstanceUserExpirationSettingsRequest -

Returns:

Result of the PutAppInstanceUserExpirationSettings operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ConflictException - The request could not be processed because of conflict in the current state of the resource.

ForbiddenException - The client is permanently forbidden from making the request.

ThrottledClientException - The client exceeded its request rate limit.

UnauthorizedClientException - The client is not currently authorized to make the request.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

registerAppInstanceUserEndpoint

public RegisterAppInstanceUserEndpointResult registerAppInstanceUserEndpoint(RegisterAppInstanceUserEndpointRequest request)

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

Parameters:

registerAppInstanceUserEndpointRequest -

Returns:

Result of the RegisterAppInstanceUserEndpoint operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ConflictException - The request could not be processed because of conflict in the current state of the resource.

ForbiddenException - The client is permanently forbidden from making the request.

ResourceLimitExceededException - The request exceeds the resource limit.

ThrottledClientException - The client exceeded its request rate limit.

UnauthorizedClientException - The client is not currently authorized to make the request.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

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

Specified by:

tagResource in interface AmazonChimeSDKIdentity

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request.

UnauthorizedClientException - The client is not currently authorized to make the request.

ResourceLimitExceededException - The request exceeds the resource limit.

ThrottledClientException - The client exceeded its request rate limit.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

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

Specified by:

untagResource in interface AmazonChimeSDKIdentity

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request.

UnauthorizedClientException - The client is not currently authorized to make the request.

ThrottledClientException - The client exceeded its request rate limit.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

updateAppInstance

public UpdateAppInstanceResult updateAppInstance(UpdateAppInstanceRequest request)

Updates AppInstance metadata.

Specified by:

updateAppInstance in interface AmazonChimeSDKIdentity

Parameters:

updateAppInstanceRequest -

Returns:

Result of the UpdateAppInstance operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ConflictException - The request could not be processed because of conflict in the current state of the resource.

ForbiddenException - The client is permanently forbidden from making the request.

ThrottledClientException - The client exceeded its request rate limit.

UnauthorizedClientException - The client is not currently authorized to make the request.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

updateAppInstanceBot

public UpdateAppInstanceBotResult updateAppInstanceBot(UpdateAppInstanceBotRequest request)

Updates the name and metadata of an AppInstanceBot.

Specified by:

updateAppInstanceBot in interface AmazonChimeSDKIdentity

Parameters:

updateAppInstanceBotRequest -

Returns:

Result of the UpdateAppInstanceBot operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ConflictException - The request could not be processed because of conflict in the current state of the resource.

ForbiddenException - The client is permanently forbidden from making the request.

ResourceLimitExceededException - The request exceeds the resource limit.

ThrottledClientException - The client exceeded its request rate limit.

UnauthorizedClientException - The client is not currently authorized to make the request.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

updateAppInstanceUser

public UpdateAppInstanceUserResult updateAppInstanceUser(UpdateAppInstanceUserRequest request)

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

Specified by:

updateAppInstanceUser in interface AmazonChimeSDKIdentity

Parameters:

updateAppInstanceUserRequest -

Returns:

Result of the UpdateAppInstanceUser operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ConflictException - The request could not be processed because of conflict in the current state of the resource.

ForbiddenException - The client is permanently forbidden from making the request.

ResourceLimitExceededException - The request exceeds the resource limit.

ThrottledClientException - The client exceeded its request rate limit.

UnauthorizedClientException - The client is not currently authorized to make the request.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

updateAppInstanceUserEndpoint

public UpdateAppInstanceUserEndpointResult updateAppInstanceUserEndpoint(UpdateAppInstanceUserEndpointRequest request)

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

Specified by:

updateAppInstanceUserEndpoint in interface AmazonChimeSDKIdentity

Parameters:

updateAppInstanceUserEndpointRequest -

Returns:

Result of the UpdateAppInstanceUserEndpoint operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ConflictException - The request could not be processed because of conflict in the current state of the resource.

ForbiddenException - The client is permanently forbidden from making the request.

ThrottledClientException - The client exceeded its request rate limit.

UnauthorizedClientException - The client is not currently authorized to make the request.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

getCachedResponseMetadata

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

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonChimeSDKIdentity

Overrides:

shutdown in class AmazonWebServiceClient