com.amazonaws.services.chimesdkidentity

Interface AmazonChimeSDKIdentity

All Known Subinterfaces:

AmazonChimeSDKIdentityAsync

All Known Implementing Classes:

AbstractAmazonChimeSDKIdentity, AbstractAmazonChimeSDKIdentityAsync, AmazonChimeSDKIdentityAsyncClient, AmazonChimeSDKIdentityClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonChimeSDKIdentity

Interface for accessing Amazon Chime SDK Identity.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonChimeSDKIdentity 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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateAppInstanceResult	createAppInstance(CreateAppInstanceRequest createAppInstanceRequest) Creates an Amazon Chime SDK messaging AppInstance under an AWS account.
CreateAppInstanceAdminResult	createAppInstanceAdmin(CreateAppInstanceAdminRequest createAppInstanceAdminRequest) Promotes an AppInstanceUser or AppInstanceBot to an AppInstanceAdmin.
CreateAppInstanceBotResult	createAppInstanceBot(CreateAppInstanceBotRequest createAppInstanceBotRequest) Creates a bot under an Amazon Chime AppInstance.
CreateAppInstanceUserResult	createAppInstanceUser(CreateAppInstanceUserRequest createAppInstanceUserRequest) Creates a user under an Amazon Chime AppInstance.
DeleteAppInstanceResult	deleteAppInstance(DeleteAppInstanceRequest deleteAppInstanceRequest) Deletes an AppInstance and all associated data asynchronously.
DeleteAppInstanceAdminResult	deleteAppInstanceAdmin(DeleteAppInstanceAdminRequest deleteAppInstanceAdminRequest) Demotes an AppInstanceAdmin to an AppInstanceUser or AppInstanceBot.
DeleteAppInstanceBotResult	deleteAppInstanceBot(DeleteAppInstanceBotRequest deleteAppInstanceBotRequest) Deletes an AppInstanceBot.
DeleteAppInstanceUserResult	deleteAppInstanceUser(DeleteAppInstanceUserRequest deleteAppInstanceUserRequest) Deletes an AppInstanceUser.
DeregisterAppInstanceUserEndpointResult	deregisterAppInstanceUserEndpoint(DeregisterAppInstanceUserEndpointRequest deregisterAppInstanceUserEndpointRequest) Deregisters an AppInstanceUserEndpoint.
DescribeAppInstanceResult	describeAppInstance(DescribeAppInstanceRequest describeAppInstanceRequest) Returns the full details of an AppInstance.
DescribeAppInstanceAdminResult	describeAppInstanceAdmin(DescribeAppInstanceAdminRequest describeAppInstanceAdminRequest) Returns the full details of an AppInstanceAdmin.
DescribeAppInstanceBotResult	describeAppInstanceBot(DescribeAppInstanceBotRequest describeAppInstanceBotRequest) The AppInstanceBot's information.
DescribeAppInstanceUserResult	describeAppInstanceUser(DescribeAppInstanceUserRequest describeAppInstanceUserRequest) Returns the full details of an AppInstanceUser.
DescribeAppInstanceUserEndpointResult	describeAppInstanceUserEndpoint(DescribeAppInstanceUserEndpointRequest describeAppInstanceUserEndpointRequest) Returns the full details of an AppInstanceUserEndpoint.
GetAppInstanceRetentionSettingsResult	getAppInstanceRetentionSettings(GetAppInstanceRetentionSettingsRequest getAppInstanceRetentionSettingsRequest) 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 listAppInstanceAdminsRequest) Returns a list of the administrators in the AppInstance.
ListAppInstanceBotsResult	listAppInstanceBots(ListAppInstanceBotsRequest listAppInstanceBotsRequest) Lists all AppInstanceBots created under a single AppInstance.
ListAppInstancesResult	listAppInstances(ListAppInstancesRequest listAppInstancesRequest) Lists all Amazon Chime AppInstances created under a single AWS account.
ListAppInstanceUserEndpointsResult	listAppInstanceUserEndpoints(ListAppInstanceUserEndpointsRequest listAppInstanceUserEndpointsRequest) Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.
ListAppInstanceUsersResult	listAppInstanceUsers(ListAppInstanceUsersRequest listAppInstanceUsersRequest) List all AppInstanceUsers created under a single AppInstance.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags applied to an Amazon Chime SDK identity resource.
PutAppInstanceRetentionSettingsResult	putAppInstanceRetentionSettings(PutAppInstanceRetentionSettingsRequest putAppInstanceRetentionSettingsRequest) Sets the amount of time in days that a given AppInstance retains data.
PutAppInstanceUserExpirationSettingsResult	putAppInstanceUserExpirationSettings(PutAppInstanceUserExpirationSettingsRequest putAppInstanceUserExpirationSettingsRequest) Sets the number of days before the AppInstanceUser is automatically deleted.
RegisterAppInstanceUserEndpointResult	registerAppInstanceUserEndpoint(RegisterAppInstanceUserEndpointRequest registerAppInstanceUserEndpointRequest) 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 tagResourceRequest) Applies the specified tags to the specified Amazon Chime SDK identity resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes the specified tags from the specified Amazon Chime SDK identity resource.
UpdateAppInstanceResult	updateAppInstance(UpdateAppInstanceRequest updateAppInstanceRequest) Updates AppInstance metadata.
UpdateAppInstanceBotResult	updateAppInstanceBot(UpdateAppInstanceBotRequest updateAppInstanceBotRequest) Updates the name and metadata of an AppInstanceBot.
UpdateAppInstanceUserResult	updateAppInstanceUser(UpdateAppInstanceUserRequest updateAppInstanceUserRequest) Updates the details of an AppInstanceUser.
UpdateAppInstanceUserEndpointResult	updateAppInstanceUserEndpoint(UpdateAppInstanceUserEndpointRequest updateAppInstanceUserEndpointRequest) Updates the details of an AppInstanceUserEndpoint.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createAppInstance

CreateAppInstanceResult createAppInstance(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

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

CreateAppInstanceAdminResult createAppInstanceAdmin(CreateAppInstanceAdminRequest createAppInstanceAdminRequest)

Promotes an AppInstanceUser or AppInstanceBot to an AppInstanceAdmin. The promoted entity can perform the following actions.

• ChannelModerator actions across all channels in the AppInstance.

• DeleteChannelMessage actions.

Only an AppInstanceUser and AppInstanceBot can be promoted to an AppInstanceAdmin role.

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

CreateAppInstanceBotResult createAppInstanceBot(CreateAppInstanceBotRequest createAppInstanceBotRequest)

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

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

CreateAppInstanceUserResult createAppInstanceUser(CreateAppInstanceUserRequest createAppInstanceUserRequest)

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

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

DeleteAppInstanceResult deleteAppInstance(DeleteAppInstanceRequest deleteAppInstanceRequest)

Deletes an AppInstance and all associated data asynchronously.

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

DeleteAppInstanceAdminResult deleteAppInstanceAdmin(DeleteAppInstanceAdminRequest deleteAppInstanceAdminRequest)

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

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

DeleteAppInstanceBotResult deleteAppInstanceBot(DeleteAppInstanceBotRequest deleteAppInstanceBotRequest)

Deletes an AppInstanceBot.

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

DeleteAppInstanceUserResult deleteAppInstanceUser(DeleteAppInstanceUserRequest deleteAppInstanceUserRequest)

Deletes an AppInstanceUser.

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

DeregisterAppInstanceUserEndpointResult deregisterAppInstanceUserEndpoint(DeregisterAppInstanceUserEndpointRequest deregisterAppInstanceUserEndpointRequest)

Deregisters an AppInstanceUserEndpoint.

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

DescribeAppInstanceResult describeAppInstance(DescribeAppInstanceRequest describeAppInstanceRequest)

Returns the full details of an AppInstance.

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

DescribeAppInstanceAdminResult describeAppInstanceAdmin(DescribeAppInstanceAdminRequest describeAppInstanceAdminRequest)

Returns the full details of an AppInstanceAdmin.

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

DescribeAppInstanceBotResult describeAppInstanceBot(DescribeAppInstanceBotRequest describeAppInstanceBotRequest)

The AppInstanceBot's information.

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

DescribeAppInstanceUserResult describeAppInstanceUser(DescribeAppInstanceUserRequest describeAppInstanceUserRequest)

Returns the full details of an AppInstanceUser.

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

DescribeAppInstanceUserEndpointResult describeAppInstanceUserEndpoint(DescribeAppInstanceUserEndpointRequest describeAppInstanceUserEndpointRequest)

Returns the full details of an AppInstanceUserEndpoint.

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

GetAppInstanceRetentionSettingsResult getAppInstanceRetentionSettings(GetAppInstanceRetentionSettingsRequest getAppInstanceRetentionSettingsRequest)

Gets the retention settings for an AppInstance.

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

ListAppInstanceAdminsResult listAppInstanceAdmins(ListAppInstanceAdminsRequest listAppInstanceAdminsRequest)

Returns a list of the administrators in the AppInstance.

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

ListAppInstanceBotsResult listAppInstanceBots(ListAppInstanceBotsRequest listAppInstanceBotsRequest)

Lists all AppInstanceBots created under a single AppInstance.

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

ListAppInstanceUserEndpointsResult listAppInstanceUserEndpoints(ListAppInstanceUserEndpointsRequest listAppInstanceUserEndpointsRequest)

Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.

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

ListAppInstanceUsersResult listAppInstanceUsers(ListAppInstanceUsersRequest listAppInstanceUsersRequest)

List all AppInstanceUsers created under a single AppInstance.

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

ListAppInstancesResult listAppInstances(ListAppInstancesRequest listAppInstancesRequest)

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

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

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

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

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

PutAppInstanceRetentionSettingsResult putAppInstanceRetentionSettings(PutAppInstanceRetentionSettingsRequest putAppInstanceRetentionSettingsRequest)

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

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

PutAppInstanceUserExpirationSettingsResult putAppInstanceUserExpirationSettings(PutAppInstanceUserExpirationSettingsRequest putAppInstanceUserExpirationSettingsRequest)

Sets the number of days before the AppInstanceUser is automatically deleted.

A background process deletes expired AppInstanceUsers within 6 hours of expiration. Actual deletion times may vary.

Expired AppInstanceUsers that have not yet been deleted appear as active, and you can update their expiration settings. The system honors the new settings.

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

RegisterAppInstanceUserEndpointResult registerAppInstanceUserEndpoint(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.

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

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

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

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

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

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

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

UpdateAppInstanceResult updateAppInstance(UpdateAppInstanceRequest updateAppInstanceRequest)

Updates AppInstance metadata.

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

UpdateAppInstanceBotResult updateAppInstanceBot(UpdateAppInstanceBotRequest updateAppInstanceBotRequest)

Updates the name and metadata of an AppInstanceBot.

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

UpdateAppInstanceUserResult updateAppInstanceUser(UpdateAppInstanceUserRequest updateAppInstanceUserRequest)

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

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

UpdateAppInstanceUserEndpointResult updateAppInstanceUserEndpoint(UpdateAppInstanceUserEndpointRequest updateAppInstanceUserEndpointRequest)

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

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

shutdown

void shutdown()

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.

getCachedResponseMetadata

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

Parameters:

request - The originally executed request.

Returns:

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