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 to an AppInstanceAdmin.
CreateAppInstanceUserResult	createAppInstanceUser(CreateAppInstanceUserRequest request) Creates a user under an Amazon Chime AppInstance.
DeleteAppInstanceResult	deleteAppInstance(DeleteAppInstanceRequest request) Deletes an AppInstance and all associated data asynchronously.
DeleteAppInstanceAdminResult	deleteAppInstanceAdmin(DeleteAppInstanceAdminRequest request) Demotes an AppInstanceAdmin to an AppInstanceUser.
DeleteAppInstanceUserResult	deleteAppInstanceUser(DeleteAppInstanceUserRequest request) Deletes an AppInstanceUser.
DescribeAppInstanceResult	describeAppInstance(DescribeAppInstanceRequest request) Returns the full details of an AppInstance.
DescribeAppInstanceAdminResult	describeAppInstanceAdmin(DescribeAppInstanceAdminRequest request) Returns the full details of an AppInstanceAdmin.
DescribeAppInstanceUserResult	describeAppInstanceUser(DescribeAppInstanceUserRequest request) Returns the full details of an AppInstanceUser.
GetAppInstanceRetentionSettingsResult	getAppInstanceRetentionSettings(GetAppInstanceRetentionSettingsRequest request) Gets the retention settings for an AppInstance.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
ListAppInstanceAdminsResult	listAppInstanceAdmins(ListAppInstanceAdminsRequest request) Returns a list of the administrators in the AppInstance.
ListAppInstancesResult	listAppInstances(ListAppInstancesRequest request) Lists all Amazon Chime AppInstances created under a single AWS account.
ListAppInstanceUsersResult	listAppInstanceUsers(ListAppInstanceUsersRequest request) List all AppInstanceUsers created under a single AppInstance.
PutAppInstanceRetentionSettingsResult	putAppInstanceRetentionSettings(PutAppInstanceRetentionSettingsRequest request) Sets the amount of time in days that a given AppInstance retains data.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateAppInstanceResult	updateAppInstance(UpdateAppInstanceRequest request) Updates AppInstance metadata.
UpdateAppInstanceUserResult	updateAppInstanceUser(UpdateAppInstanceUserRequest request) Updates the details of an AppInstanceUser.

Methods inherited from class 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 to an AppInstanceAdmin. The promoted user can perform the following actions.

• ChannelModerator actions across all channels in the AppInstance.

• DeleteChannelMessage actions.

Only an AppInstanceUser can be promoted to an AppInstanceAdmin role.

Specified by:

createAppInstanceAdmin in interface AmazonChimeSDKIdentity

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

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

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

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

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

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

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

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

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

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

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