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 .

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 to an AppInstanceAdmin.
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.
DeleteAppInstanceUserResult	deleteAppInstanceUser(DeleteAppInstanceUserRequest deleteAppInstanceUserRequest) Deletes an AppInstanceUser.
DescribeAppInstanceResult	describeAppInstance(DescribeAppInstanceRequest describeAppInstanceRequest) Returns the full details of an AppInstance.
DescribeAppInstanceAdminResult	describeAppInstanceAdmin(DescribeAppInstanceAdminRequest describeAppInstanceAdminRequest) Returns the full details of an AppInstanceAdmin.
DescribeAppInstanceUserResult	describeAppInstanceUser(DescribeAppInstanceUserRequest describeAppInstanceUserRequest) Returns the full details of an AppInstanceUser.
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.
ListAppInstancesResult	listAppInstances(ListAppInstancesRequest listAppInstancesRequest) Lists all Amazon Chime AppInstances created under a single AWS account.
ListAppInstanceUsersResult	listAppInstanceUsers(ListAppInstanceUsersRequest listAppInstanceUsersRequest) List all AppInstanceUsers created under a single AppInstance.
PutAppInstanceRetentionSettingsResult	putAppInstanceRetentionSettings(PutAppInstanceRetentionSettingsRequest putAppInstanceRetentionSettingsRequest) 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 updateAppInstanceRequest) Updates AppInstance metadata.
UpdateAppInstanceUserResult	updateAppInstanceUser(UpdateAppInstanceUserRequest updateAppInstanceUserRequest) Updates the details of an AppInstanceUser.

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

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

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

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

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

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

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

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

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

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

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

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.