@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonChimeSDKIdentityClient extends AmazonWebServiceClient implements AmazonChimeSDKIdentity
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
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
public static AmazonChimeSDKIdentityClientBuilder builder()
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
createAppInstance
in interface AmazonChimeSDKIdentity
createAppInstanceRequest
- 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.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.
createAppInstanceAdmin
in interface AmazonChimeSDKIdentity
createAppInstanceAdminRequest
- 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.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.
createAppInstanceBot
in interface AmazonChimeSDKIdentity
createAppInstanceBotRequest
- 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.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.
createAppInstanceUser
in interface AmazonChimeSDKIdentity
createAppInstanceUserRequest
- 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.public DeleteAppInstanceResult deleteAppInstance(DeleteAppInstanceRequest request)
Deletes an AppInstance
and all associated data asynchronously.
deleteAppInstance
in interface AmazonChimeSDKIdentity
deleteAppInstanceRequest
- 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.public DeleteAppInstanceAdminResult deleteAppInstanceAdmin(DeleteAppInstanceAdminRequest request)
Demotes an AppInstanceAdmin
to an AppInstanceUser
or AppInstanceBot
. This
action does not delete the user.
deleteAppInstanceAdmin
in interface AmazonChimeSDKIdentity
deleteAppInstanceAdminRequest
- 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.public DeleteAppInstanceBotResult deleteAppInstanceBot(DeleteAppInstanceBotRequest request)
Deletes an AppInstanceBot
.
deleteAppInstanceBot
in interface AmazonChimeSDKIdentity
deleteAppInstanceBotRequest
- 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.public DeleteAppInstanceUserResult deleteAppInstanceUser(DeleteAppInstanceUserRequest request)
Deletes an AppInstanceUser
.
deleteAppInstanceUser
in interface AmazonChimeSDKIdentity
deleteAppInstanceUserRequest
- 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.public DeregisterAppInstanceUserEndpointResult deregisterAppInstanceUserEndpoint(DeregisterAppInstanceUserEndpointRequest request)
Deregisters an AppInstanceUserEndpoint
.
deregisterAppInstanceUserEndpoint
in interface AmazonChimeSDKIdentity
deregisterAppInstanceUserEndpointRequest
- 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.public DescribeAppInstanceResult describeAppInstance(DescribeAppInstanceRequest request)
Returns the full details of an AppInstance
.
describeAppInstance
in interface AmazonChimeSDKIdentity
describeAppInstanceRequest
- 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.public DescribeAppInstanceAdminResult describeAppInstanceAdmin(DescribeAppInstanceAdminRequest request)
Returns the full details of an AppInstanceAdmin
.
describeAppInstanceAdmin
in interface AmazonChimeSDKIdentity
describeAppInstanceAdminRequest
- 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.public DescribeAppInstanceBotResult describeAppInstanceBot(DescribeAppInstanceBotRequest request)
The AppInstanceBot's
information.
describeAppInstanceBot
in interface AmazonChimeSDKIdentity
describeAppInstanceBotRequest
- 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.public DescribeAppInstanceUserResult describeAppInstanceUser(DescribeAppInstanceUserRequest request)
Returns the full details of an AppInstanceUser
.
describeAppInstanceUser
in interface AmazonChimeSDKIdentity
describeAppInstanceUserRequest
- 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.public DescribeAppInstanceUserEndpointResult describeAppInstanceUserEndpoint(DescribeAppInstanceUserEndpointRequest request)
Returns the full details of an AppInstanceUserEndpoint
.
describeAppInstanceUserEndpoint
in interface AmazonChimeSDKIdentity
describeAppInstanceUserEndpointRequest
- 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.public GetAppInstanceRetentionSettingsResult getAppInstanceRetentionSettings(GetAppInstanceRetentionSettingsRequest request)
Gets the retention settings for an AppInstance
.
getAppInstanceRetentionSettings
in interface AmazonChimeSDKIdentity
getAppInstanceRetentionSettingsRequest
- 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.public ListAppInstanceAdminsResult listAppInstanceAdmins(ListAppInstanceAdminsRequest request)
Returns a list of the administrators in the AppInstance
.
listAppInstanceAdmins
in interface AmazonChimeSDKIdentity
listAppInstanceAdminsRequest
- 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.public ListAppInstanceBotsResult listAppInstanceBots(ListAppInstanceBotsRequest request)
Lists all AppInstanceBots
created under a single AppInstance
.
listAppInstanceBots
in interface AmazonChimeSDKIdentity
listAppInstanceBotsRequest
- 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.public ListAppInstanceUserEndpointsResult listAppInstanceUserEndpoints(ListAppInstanceUserEndpointsRequest request)
Lists all the AppInstanceUserEndpoints
created under a single AppInstanceUser
.
listAppInstanceUserEndpoints
in interface AmazonChimeSDKIdentity
listAppInstanceUserEndpointsRequest
- 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.public ListAppInstanceUsersResult listAppInstanceUsers(ListAppInstanceUsersRequest request)
List all AppInstanceUsers
created under a single AppInstance
.
listAppInstanceUsers
in interface AmazonChimeSDKIdentity
listAppInstanceUsersRequest
- 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.public ListAppInstancesResult listAppInstances(ListAppInstancesRequest request)
Lists all Amazon Chime AppInstance
s created under a single AWS account.
listAppInstances
in interface AmazonChimeSDKIdentity
listAppInstancesRequest
- 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.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists the tags applied to an Amazon Chime SDK identity resource.
listTagsForResource
in interface AmazonChimeSDKIdentity
listTagsForResourceRequest
- 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.public PutAppInstanceRetentionSettingsResult putAppInstanceRetentionSettings(PutAppInstanceRetentionSettingsRequest request)
Sets the amount of time in days that a given AppInstance
retains data.
putAppInstanceRetentionSettings
in interface AmazonChimeSDKIdentity
putAppInstanceRetentionSettingsRequest
- 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.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.
putAppInstanceUserExpirationSettings
in interface AmazonChimeSDKIdentity
putAppInstanceUserExpirationSettingsRequest
- 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.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.
registerAppInstanceUserEndpoint
in interface AmazonChimeSDKIdentity
registerAppInstanceUserEndpointRequest
- 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.public TagResourceResult tagResource(TagResourceRequest request)
Applies the specified tags to the specified Amazon Chime SDK identity resource.
tagResource
in interface AmazonChimeSDKIdentity
tagResourceRequest
- 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.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes the specified tags from the specified Amazon Chime SDK identity resource.
untagResource
in interface AmazonChimeSDKIdentity
untagResourceRequest
- 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.public UpdateAppInstanceResult updateAppInstance(UpdateAppInstanceRequest request)
Updates AppInstance
metadata.
updateAppInstance
in interface AmazonChimeSDKIdentity
updateAppInstanceRequest
- 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.public UpdateAppInstanceBotResult updateAppInstanceBot(UpdateAppInstanceBotRequest request)
Updates the name and metadata of an AppInstanceBot
.
updateAppInstanceBot
in interface AmazonChimeSDKIdentity
updateAppInstanceBotRequest
- 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.public UpdateAppInstanceUserResult updateAppInstanceUser(UpdateAppInstanceUserRequest request)
Updates the details of an AppInstanceUser
. You can update names and metadata.
updateAppInstanceUser
in interface AmazonChimeSDKIdentity
updateAppInstanceUserRequest
- 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.public UpdateAppInstanceUserEndpointResult updateAppInstanceUserEndpoint(UpdateAppInstanceUserEndpointRequest request)
Updates the details of an AppInstanceUserEndpoint
. You can update the name and
AllowMessage
values.
updateAppInstanceUserEndpoint
in interface AmazonChimeSDKIdentity
updateAppInstanceUserEndpointRequest
- 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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata
in interface AmazonChimeSDKIdentity
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AmazonChimeSDKIdentity
shutdown
in class AmazonWebServiceClient