Interface ChimeSdkIdentityClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aChimeSdkIdentityClient
.static ChimeSdkIdentityClient
create()
Create aChimeSdkIdentityClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateAppInstanceResponse
createAppInstance
(Consumer<CreateAppInstanceRequest.Builder> createAppInstanceRequest) Creates an Amazon Chime SDK messagingAppInstance
under an AWS account.default CreateAppInstanceResponse
createAppInstance
(CreateAppInstanceRequest createAppInstanceRequest) Creates an Amazon Chime SDK messagingAppInstance
under an AWS account.default CreateAppInstanceAdminResponse
createAppInstanceAdmin
(Consumer<CreateAppInstanceAdminRequest.Builder> createAppInstanceAdminRequest) Promotes anAppInstanceUser
orAppInstanceBot
to anAppInstanceAdmin
.default CreateAppInstanceAdminResponse
createAppInstanceAdmin
(CreateAppInstanceAdminRequest createAppInstanceAdminRequest) Promotes anAppInstanceUser
orAppInstanceBot
to anAppInstanceAdmin
.default CreateAppInstanceBotResponse
createAppInstanceBot
(Consumer<CreateAppInstanceBotRequest.Builder> createAppInstanceBotRequest) Creates a bot under an Amazon ChimeAppInstance
.default CreateAppInstanceBotResponse
createAppInstanceBot
(CreateAppInstanceBotRequest createAppInstanceBotRequest) Creates a bot under an Amazon ChimeAppInstance
.default CreateAppInstanceUserResponse
createAppInstanceUser
(Consumer<CreateAppInstanceUserRequest.Builder> createAppInstanceUserRequest) Creates a user under an Amazon ChimeAppInstance
.default CreateAppInstanceUserResponse
createAppInstanceUser
(CreateAppInstanceUserRequest createAppInstanceUserRequest) Creates a user under an Amazon ChimeAppInstance
.default DeleteAppInstanceResponse
deleteAppInstance
(Consumer<DeleteAppInstanceRequest.Builder> deleteAppInstanceRequest) Deletes anAppInstance
and all associated data asynchronously.default DeleteAppInstanceResponse
deleteAppInstance
(DeleteAppInstanceRequest deleteAppInstanceRequest) Deletes anAppInstance
and all associated data asynchronously.default DeleteAppInstanceAdminResponse
deleteAppInstanceAdmin
(Consumer<DeleteAppInstanceAdminRequest.Builder> deleteAppInstanceAdminRequest) Demotes anAppInstanceAdmin
to anAppInstanceUser
orAppInstanceBot
.default DeleteAppInstanceAdminResponse
deleteAppInstanceAdmin
(DeleteAppInstanceAdminRequest deleteAppInstanceAdminRequest) Demotes anAppInstanceAdmin
to anAppInstanceUser
orAppInstanceBot
.default DeleteAppInstanceBotResponse
deleteAppInstanceBot
(Consumer<DeleteAppInstanceBotRequest.Builder> deleteAppInstanceBotRequest) Deletes anAppInstanceBot
.default DeleteAppInstanceBotResponse
deleteAppInstanceBot
(DeleteAppInstanceBotRequest deleteAppInstanceBotRequest) Deletes anAppInstanceBot
.default DeleteAppInstanceUserResponse
deleteAppInstanceUser
(Consumer<DeleteAppInstanceUserRequest.Builder> deleteAppInstanceUserRequest) Deletes anAppInstanceUser
.default DeleteAppInstanceUserResponse
deleteAppInstanceUser
(DeleteAppInstanceUserRequest deleteAppInstanceUserRequest) Deletes anAppInstanceUser
.deregisterAppInstanceUserEndpoint
(Consumer<DeregisterAppInstanceUserEndpointRequest.Builder> deregisterAppInstanceUserEndpointRequest) Deregisters anAppInstanceUserEndpoint
.deregisterAppInstanceUserEndpoint
(DeregisterAppInstanceUserEndpointRequest deregisterAppInstanceUserEndpointRequest) Deregisters anAppInstanceUserEndpoint
.default DescribeAppInstanceResponse
describeAppInstance
(Consumer<DescribeAppInstanceRequest.Builder> describeAppInstanceRequest) Returns the full details of anAppInstance
.default DescribeAppInstanceResponse
describeAppInstance
(DescribeAppInstanceRequest describeAppInstanceRequest) Returns the full details of anAppInstance
.default DescribeAppInstanceAdminResponse
describeAppInstanceAdmin
(Consumer<DescribeAppInstanceAdminRequest.Builder> describeAppInstanceAdminRequest) Returns the full details of anAppInstanceAdmin
.default DescribeAppInstanceAdminResponse
describeAppInstanceAdmin
(DescribeAppInstanceAdminRequest describeAppInstanceAdminRequest) Returns the full details of anAppInstanceAdmin
.default DescribeAppInstanceBotResponse
describeAppInstanceBot
(Consumer<DescribeAppInstanceBotRequest.Builder> describeAppInstanceBotRequest) TheAppInstanceBot's
information.default DescribeAppInstanceBotResponse
describeAppInstanceBot
(DescribeAppInstanceBotRequest describeAppInstanceBotRequest) TheAppInstanceBot's
information.default DescribeAppInstanceUserResponse
describeAppInstanceUser
(Consumer<DescribeAppInstanceUserRequest.Builder> describeAppInstanceUserRequest) Returns the full details of anAppInstanceUser
.default DescribeAppInstanceUserResponse
describeAppInstanceUser
(DescribeAppInstanceUserRequest describeAppInstanceUserRequest) Returns the full details of anAppInstanceUser
.describeAppInstanceUserEndpoint
(Consumer<DescribeAppInstanceUserEndpointRequest.Builder> describeAppInstanceUserEndpointRequest) Returns the full details of anAppInstanceUserEndpoint
.describeAppInstanceUserEndpoint
(DescribeAppInstanceUserEndpointRequest describeAppInstanceUserEndpointRequest) Returns the full details of anAppInstanceUserEndpoint
.getAppInstanceRetentionSettings
(Consumer<GetAppInstanceRetentionSettingsRequest.Builder> getAppInstanceRetentionSettingsRequest) Gets the retention settings for anAppInstance
.getAppInstanceRetentionSettings
(GetAppInstanceRetentionSettingsRequest getAppInstanceRetentionSettingsRequest) Gets the retention settings for anAppInstance
.default ListAppInstanceAdminsResponse
listAppInstanceAdmins
(Consumer<ListAppInstanceAdminsRequest.Builder> listAppInstanceAdminsRequest) Returns a list of the administrators in theAppInstance
.default ListAppInstanceAdminsResponse
listAppInstanceAdmins
(ListAppInstanceAdminsRequest listAppInstanceAdminsRequest) Returns a list of the administrators in theAppInstance
.default ListAppInstanceAdminsIterable
listAppInstanceAdminsPaginator
(Consumer<ListAppInstanceAdminsRequest.Builder> listAppInstanceAdminsRequest) This is a variant oflistAppInstanceAdmins(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceAdminsRequest)
operation.default ListAppInstanceAdminsIterable
listAppInstanceAdminsPaginator
(ListAppInstanceAdminsRequest listAppInstanceAdminsRequest) This is a variant oflistAppInstanceAdmins(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceAdminsRequest)
operation.default ListAppInstanceBotsResponse
listAppInstanceBots
(Consumer<ListAppInstanceBotsRequest.Builder> listAppInstanceBotsRequest) Lists allAppInstanceBots
created under a singleAppInstance
.default ListAppInstanceBotsResponse
listAppInstanceBots
(ListAppInstanceBotsRequest listAppInstanceBotsRequest) Lists allAppInstanceBots
created under a singleAppInstance
.default ListAppInstanceBotsIterable
listAppInstanceBotsPaginator
(Consumer<ListAppInstanceBotsRequest.Builder> listAppInstanceBotsRequest) This is a variant oflistAppInstanceBots(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceBotsRequest)
operation.default ListAppInstanceBotsIterable
listAppInstanceBotsPaginator
(ListAppInstanceBotsRequest listAppInstanceBotsRequest) This is a variant oflistAppInstanceBots(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceBotsRequest)
operation.default ListAppInstancesResponse
listAppInstances
(Consumer<ListAppInstancesRequest.Builder> listAppInstancesRequest) Lists all Amazon ChimeAppInstance
s created under a single AWS account.default ListAppInstancesResponse
listAppInstances
(ListAppInstancesRequest listAppInstancesRequest) Lists all Amazon ChimeAppInstance
s created under a single AWS account.default ListAppInstancesIterable
listAppInstancesPaginator
(Consumer<ListAppInstancesRequest.Builder> listAppInstancesRequest) This is a variant oflistAppInstances(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstancesRequest)
operation.default ListAppInstancesIterable
listAppInstancesPaginator
(ListAppInstancesRequest listAppInstancesRequest) This is a variant oflistAppInstances(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstancesRequest)
operation.listAppInstanceUserEndpoints
(Consumer<ListAppInstanceUserEndpointsRequest.Builder> listAppInstanceUserEndpointsRequest) Lists all theAppInstanceUserEndpoints
created under a singleAppInstanceUser
.listAppInstanceUserEndpoints
(ListAppInstanceUserEndpointsRequest listAppInstanceUserEndpointsRequest) Lists all theAppInstanceUserEndpoints
created under a singleAppInstanceUser
.listAppInstanceUserEndpointsPaginator
(Consumer<ListAppInstanceUserEndpointsRequest.Builder> listAppInstanceUserEndpointsRequest) This is a variant oflistAppInstanceUserEndpoints(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUserEndpointsRequest)
operation.listAppInstanceUserEndpointsPaginator
(ListAppInstanceUserEndpointsRequest listAppInstanceUserEndpointsRequest) This is a variant oflistAppInstanceUserEndpoints(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUserEndpointsRequest)
operation.default ListAppInstanceUsersResponse
listAppInstanceUsers
(Consumer<ListAppInstanceUsersRequest.Builder> listAppInstanceUsersRequest) List allAppInstanceUsers
created under a singleAppInstance
.default ListAppInstanceUsersResponse
listAppInstanceUsers
(ListAppInstanceUsersRequest listAppInstanceUsersRequest) List allAppInstanceUsers
created under a singleAppInstance
.default ListAppInstanceUsersIterable
listAppInstanceUsersPaginator
(Consumer<ListAppInstanceUsersRequest.Builder> listAppInstanceUsersRequest) This is a variant oflistAppInstanceUsers(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUsersRequest)
operation.default ListAppInstanceUsersIterable
listAppInstanceUsersPaginator
(ListAppInstanceUsersRequest listAppInstanceUsersRequest) This is a variant oflistAppInstanceUsers(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUsersRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags applied to an Amazon Chime SDK identity resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags applied to an Amazon Chime SDK identity resource.putAppInstanceRetentionSettings
(Consumer<PutAppInstanceRetentionSettingsRequest.Builder> putAppInstanceRetentionSettingsRequest) Sets the amount of time in days that a givenAppInstance
retains data.putAppInstanceRetentionSettings
(PutAppInstanceRetentionSettingsRequest putAppInstanceRetentionSettingsRequest) Sets the amount of time in days that a givenAppInstance
retains data.putAppInstanceUserExpirationSettings
(Consumer<PutAppInstanceUserExpirationSettingsRequest.Builder> putAppInstanceUserExpirationSettingsRequest) Sets the number of days before theAppInstanceUser
is automatically deleted.putAppInstanceUserExpirationSettings
(PutAppInstanceUserExpirationSettingsRequest putAppInstanceUserExpirationSettingsRequest) Sets the number of days before theAppInstanceUser
is automatically deleted.registerAppInstanceUserEndpoint
(Consumer<RegisterAppInstanceUserEndpointRequest.Builder> registerAppInstanceUserEndpointRequest) Registers an endpoint under an Amazon ChimeAppInstanceUser
.registerAppInstanceUserEndpoint
(RegisterAppInstanceUserEndpointRequest registerAppInstanceUserEndpointRequest) Registers an endpoint under an Amazon ChimeAppInstanceUser
.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Applies the specified tags to the specified Amazon Chime SDK identity resource.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Applies the specified tags to the specified Amazon Chime SDK identity resource.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the specified tags from the specified Amazon Chime SDK identity resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes the specified tags from the specified Amazon Chime SDK identity resource.default UpdateAppInstanceResponse
updateAppInstance
(Consumer<UpdateAppInstanceRequest.Builder> updateAppInstanceRequest) UpdatesAppInstance
metadata.default UpdateAppInstanceResponse
updateAppInstance
(UpdateAppInstanceRequest updateAppInstanceRequest) UpdatesAppInstance
metadata.default UpdateAppInstanceBotResponse
updateAppInstanceBot
(Consumer<UpdateAppInstanceBotRequest.Builder> updateAppInstanceBotRequest) Updates the name and metadata of anAppInstanceBot
.default UpdateAppInstanceBotResponse
updateAppInstanceBot
(UpdateAppInstanceBotRequest updateAppInstanceBotRequest) Updates the name and metadata of anAppInstanceBot
.default UpdateAppInstanceUserResponse
updateAppInstanceUser
(Consumer<UpdateAppInstanceUserRequest.Builder> updateAppInstanceUserRequest) Updates the details of anAppInstanceUser
.default UpdateAppInstanceUserResponse
updateAppInstanceUser
(UpdateAppInstanceUserRequest updateAppInstanceUserRequest) Updates the details of anAppInstanceUser
.updateAppInstanceUserEndpoint
(Consumer<UpdateAppInstanceUserEndpointRequest.Builder> updateAppInstanceUserEndpointRequest) Updates the details of anAppInstanceUserEndpoint
.updateAppInstanceUserEndpoint
(UpdateAppInstanceUserEndpointRequest updateAppInstanceUserEndpointRequest) Updates the details of anAppInstanceUserEndpoint
.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createAppInstance
default CreateAppInstanceResponse createAppInstance(CreateAppInstanceRequest createAppInstanceRequest) throws BadRequestException, ConflictException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException 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.
- See Also:
-
createAppInstance
default CreateAppInstanceResponse createAppInstance(Consumer<CreateAppInstanceRequest.Builder> createAppInstanceRequest) throws BadRequestException, ConflictException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException 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
This is a convenience which creates an instance of the
CreateAppInstanceRequest.Builder
avoiding the need to create one manually viaCreateAppInstanceRequest.builder()
- Parameters:
createAppInstanceRequest
- AConsumer
that will call methods onCreateAppInstanceRequest.Builder
to create a request.- Returns:
- Result of the CreateAppInstance operation returned by the service.
- See Also:
-
createAppInstanceAdmin
default CreateAppInstanceAdminResponse createAppInstanceAdmin(CreateAppInstanceAdminRequest createAppInstanceAdminRequest) throws BadRequestException, ConflictException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Promotes an
AppInstanceUser
orAppInstanceBot
to anAppInstanceAdmin
. The promoted entity can perform the following actions.-
ChannelModerator
actions across all channels in theAppInstance
. -
DeleteChannelMessage
actions.
Only an
AppInstanceUser
andAppInstanceBot
can be promoted to anAppInstanceAdmin
role.- Parameters:
createAppInstanceAdminRequest
-- Returns:
- Result of the CreateAppInstanceAdmin operation returned by the service.
- See Also:
-
-
createAppInstanceAdmin
default CreateAppInstanceAdminResponse createAppInstanceAdmin(Consumer<CreateAppInstanceAdminRequest.Builder> createAppInstanceAdminRequest) throws BadRequestException, ConflictException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Promotes an
AppInstanceUser
orAppInstanceBot
to anAppInstanceAdmin
. The promoted entity can perform the following actions.-
ChannelModerator
actions across all channels in theAppInstance
. -
DeleteChannelMessage
actions.
Only an
AppInstanceUser
andAppInstanceBot
can be promoted to anAppInstanceAdmin
role.
This is a convenience which creates an instance of the
CreateAppInstanceAdminRequest.Builder
avoiding the need to create one manually viaCreateAppInstanceAdminRequest.builder()
- Parameters:
createAppInstanceAdminRequest
- AConsumer
that will call methods onCreateAppInstanceAdminRequest.Builder
to create a request.- Returns:
- Result of the CreateAppInstanceAdmin operation returned by the service.
- See Also:
-
-
createAppInstanceBot
default CreateAppInstanceBotResponse createAppInstanceBot(CreateAppInstanceBotRequest createAppInstanceBotRequest) throws BadRequestException, ConflictException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Creates a bot under an Amazon Chime
AppInstance
. The request consists of a uniqueConfiguration
andName
for that bot.- Parameters:
createAppInstanceBotRequest
-- Returns:
- Result of the CreateAppInstanceBot operation returned by the service.
- See Also:
-
createAppInstanceBot
default CreateAppInstanceBotResponse createAppInstanceBot(Consumer<CreateAppInstanceBotRequest.Builder> createAppInstanceBotRequest) throws BadRequestException, ConflictException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Creates a bot under an Amazon Chime
AppInstance
. The request consists of a uniqueConfiguration
andName
for that bot.
This is a convenience which creates an instance of the
CreateAppInstanceBotRequest.Builder
avoiding the need to create one manually viaCreateAppInstanceBotRequest.builder()
- Parameters:
createAppInstanceBotRequest
- AConsumer
that will call methods onCreateAppInstanceBotRequest.Builder
to create a request.- Returns:
- Result of the CreateAppInstanceBot operation returned by the service.
- See Also:
-
createAppInstanceUser
default CreateAppInstanceUserResponse createAppInstanceUser(CreateAppInstanceUserRequest createAppInstanceUserRequest) throws BadRequestException, ConflictException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Creates a user under an Amazon Chime
AppInstance
. The request consists of a uniqueappInstanceUserId
andName
for that user.- Parameters:
createAppInstanceUserRequest
-- Returns:
- Result of the CreateAppInstanceUser operation returned by the service.
- See Also:
-
createAppInstanceUser
default CreateAppInstanceUserResponse createAppInstanceUser(Consumer<CreateAppInstanceUserRequest.Builder> createAppInstanceUserRequest) throws BadRequestException, ConflictException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Creates a user under an Amazon Chime
AppInstance
. The request consists of a uniqueappInstanceUserId
andName
for that user.
This is a convenience which creates an instance of the
CreateAppInstanceUserRequest.Builder
avoiding the need to create one manually viaCreateAppInstanceUserRequest.builder()
- Parameters:
createAppInstanceUserRequest
- AConsumer
that will call methods onCreateAppInstanceUserRequest.Builder
to create a request.- Returns:
- Result of the CreateAppInstanceUser operation returned by the service.
- See Also:
-
deleteAppInstance
default DeleteAppInstanceResponse deleteAppInstance(DeleteAppInstanceRequest deleteAppInstanceRequest) throws BadRequestException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Deletes an
AppInstance
and all associated data asynchronously.- Parameters:
deleteAppInstanceRequest
-- Returns:
- Result of the DeleteAppInstance operation returned by the service.
- See Also:
-
deleteAppInstance
default DeleteAppInstanceResponse deleteAppInstance(Consumer<DeleteAppInstanceRequest.Builder> deleteAppInstanceRequest) throws BadRequestException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Deletes an
AppInstance
and all associated data asynchronously.
This is a convenience which creates an instance of the
DeleteAppInstanceRequest.Builder
avoiding the need to create one manually viaDeleteAppInstanceRequest.builder()
- Parameters:
deleteAppInstanceRequest
- AConsumer
that will call methods onDeleteAppInstanceRequest.Builder
to create a request.- Returns:
- Result of the DeleteAppInstance operation returned by the service.
- See Also:
-
deleteAppInstanceAdmin
default DeleteAppInstanceAdminResponse deleteAppInstanceAdmin(DeleteAppInstanceAdminRequest deleteAppInstanceAdminRequest) throws BadRequestException, ConflictException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Demotes an
AppInstanceAdmin
to anAppInstanceUser
orAppInstanceBot
. This action does not delete the user.- Parameters:
deleteAppInstanceAdminRequest
-- Returns:
- Result of the DeleteAppInstanceAdmin operation returned by the service.
- See Also:
-
deleteAppInstanceAdmin
default DeleteAppInstanceAdminResponse deleteAppInstanceAdmin(Consumer<DeleteAppInstanceAdminRequest.Builder> deleteAppInstanceAdminRequest) throws BadRequestException, ConflictException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Demotes an
AppInstanceAdmin
to anAppInstanceUser
orAppInstanceBot
. This action does not delete the user.
This is a convenience which creates an instance of the
DeleteAppInstanceAdminRequest.Builder
avoiding the need to create one manually viaDeleteAppInstanceAdminRequest.builder()
- Parameters:
deleteAppInstanceAdminRequest
- AConsumer
that will call methods onDeleteAppInstanceAdminRequest.Builder
to create a request.- Returns:
- Result of the DeleteAppInstanceAdmin operation returned by the service.
- See Also:
-
deleteAppInstanceBot
default DeleteAppInstanceBotResponse deleteAppInstanceBot(DeleteAppInstanceBotRequest deleteAppInstanceBotRequest) throws BadRequestException, ConflictException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Deletes an
AppInstanceBot
.- Parameters:
deleteAppInstanceBotRequest
-- Returns:
- Result of the DeleteAppInstanceBot operation returned by the service.
- See Also:
-
deleteAppInstanceBot
default DeleteAppInstanceBotResponse deleteAppInstanceBot(Consumer<DeleteAppInstanceBotRequest.Builder> deleteAppInstanceBotRequest) throws BadRequestException, ConflictException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Deletes an
AppInstanceBot
.
This is a convenience which creates an instance of the
DeleteAppInstanceBotRequest.Builder
avoiding the need to create one manually viaDeleteAppInstanceBotRequest.builder()
- Parameters:
deleteAppInstanceBotRequest
- AConsumer
that will call methods onDeleteAppInstanceBotRequest.Builder
to create a request.- Returns:
- Result of the DeleteAppInstanceBot operation returned by the service.
- See Also:
-
deleteAppInstanceUser
default DeleteAppInstanceUserResponse deleteAppInstanceUser(DeleteAppInstanceUserRequest deleteAppInstanceUserRequest) throws BadRequestException, ConflictException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Deletes an
AppInstanceUser
.- Parameters:
deleteAppInstanceUserRequest
-- Returns:
- Result of the DeleteAppInstanceUser operation returned by the service.
- See Also:
-
deleteAppInstanceUser
default DeleteAppInstanceUserResponse deleteAppInstanceUser(Consumer<DeleteAppInstanceUserRequest.Builder> deleteAppInstanceUserRequest) throws BadRequestException, ConflictException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Deletes an
AppInstanceUser
.
This is a convenience which creates an instance of the
DeleteAppInstanceUserRequest.Builder
avoiding the need to create one manually viaDeleteAppInstanceUserRequest.builder()
- Parameters:
deleteAppInstanceUserRequest
- AConsumer
that will call methods onDeleteAppInstanceUserRequest.Builder
to create a request.- Returns:
- Result of the DeleteAppInstanceUser operation returned by the service.
- See Also:
-
deregisterAppInstanceUserEndpoint
default DeregisterAppInstanceUserEndpointResponse deregisterAppInstanceUserEndpoint(DeregisterAppInstanceUserEndpointRequest deregisterAppInstanceUserEndpointRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Deregisters an
AppInstanceUserEndpoint
.- Parameters:
deregisterAppInstanceUserEndpointRequest
-- Returns:
- Result of the DeregisterAppInstanceUserEndpoint operation returned by the service.
- See Also:
-
deregisterAppInstanceUserEndpoint
default DeregisterAppInstanceUserEndpointResponse deregisterAppInstanceUserEndpoint(Consumer<DeregisterAppInstanceUserEndpointRequest.Builder> deregisterAppInstanceUserEndpointRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Deregisters an
AppInstanceUserEndpoint
.
This is a convenience which creates an instance of the
DeregisterAppInstanceUserEndpointRequest.Builder
avoiding the need to create one manually viaDeregisterAppInstanceUserEndpointRequest.builder()
- Parameters:
deregisterAppInstanceUserEndpointRequest
- AConsumer
that will call methods onDeregisterAppInstanceUserEndpointRequest.Builder
to create a request.- Returns:
- Result of the DeregisterAppInstanceUserEndpoint operation returned by the service.
- See Also:
-
describeAppInstance
default DescribeAppInstanceResponse describeAppInstance(DescribeAppInstanceRequest describeAppInstanceRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Returns the full details of an
AppInstance
.- Parameters:
describeAppInstanceRequest
-- Returns:
- Result of the DescribeAppInstance operation returned by the service.
- See Also:
-
describeAppInstance
default DescribeAppInstanceResponse describeAppInstance(Consumer<DescribeAppInstanceRequest.Builder> describeAppInstanceRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Returns the full details of an
AppInstance
.
This is a convenience which creates an instance of the
DescribeAppInstanceRequest.Builder
avoiding the need to create one manually viaDescribeAppInstanceRequest.builder()
- Parameters:
describeAppInstanceRequest
- AConsumer
that will call methods onDescribeAppInstanceRequest.Builder
to create a request.- Returns:
- Result of the DescribeAppInstance operation returned by the service.
- See Also:
-
describeAppInstanceAdmin
default DescribeAppInstanceAdminResponse describeAppInstanceAdmin(DescribeAppInstanceAdminRequest describeAppInstanceAdminRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Returns the full details of an
AppInstanceAdmin
.- Parameters:
describeAppInstanceAdminRequest
-- Returns:
- Result of the DescribeAppInstanceAdmin operation returned by the service.
- See Also:
-
describeAppInstanceAdmin
default DescribeAppInstanceAdminResponse describeAppInstanceAdmin(Consumer<DescribeAppInstanceAdminRequest.Builder> describeAppInstanceAdminRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Returns the full details of an
AppInstanceAdmin
.
This is a convenience which creates an instance of the
DescribeAppInstanceAdminRequest.Builder
avoiding the need to create one manually viaDescribeAppInstanceAdminRequest.builder()
- Parameters:
describeAppInstanceAdminRequest
- AConsumer
that will call methods onDescribeAppInstanceAdminRequest.Builder
to create a request.- Returns:
- Result of the DescribeAppInstanceAdmin operation returned by the service.
- See Also:
-
describeAppInstanceBot
default DescribeAppInstanceBotResponse describeAppInstanceBot(DescribeAppInstanceBotRequest describeAppInstanceBotRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, NotFoundException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException The
AppInstanceBot's
information.- Parameters:
describeAppInstanceBotRequest
-- Returns:
- Result of the DescribeAppInstanceBot operation returned by the service.
- See Also:
-
describeAppInstanceBot
default DescribeAppInstanceBotResponse describeAppInstanceBot(Consumer<DescribeAppInstanceBotRequest.Builder> describeAppInstanceBotRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, NotFoundException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException The
AppInstanceBot's
information.
This is a convenience which creates an instance of the
DescribeAppInstanceBotRequest.Builder
avoiding the need to create one manually viaDescribeAppInstanceBotRequest.builder()
- Parameters:
describeAppInstanceBotRequest
- AConsumer
that will call methods onDescribeAppInstanceBotRequest.Builder
to create a request.- Returns:
- Result of the DescribeAppInstanceBot operation returned by the service.
- See Also:
-
describeAppInstanceUser
default DescribeAppInstanceUserResponse describeAppInstanceUser(DescribeAppInstanceUserRequest describeAppInstanceUserRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Returns the full details of an
AppInstanceUser
.- Parameters:
describeAppInstanceUserRequest
-- Returns:
- Result of the DescribeAppInstanceUser operation returned by the service.
- See Also:
-
describeAppInstanceUser
default DescribeAppInstanceUserResponse describeAppInstanceUser(Consumer<DescribeAppInstanceUserRequest.Builder> describeAppInstanceUserRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Returns the full details of an
AppInstanceUser
.
This is a convenience which creates an instance of the
DescribeAppInstanceUserRequest.Builder
avoiding the need to create one manually viaDescribeAppInstanceUserRequest.builder()
- Parameters:
describeAppInstanceUserRequest
- AConsumer
that will call methods onDescribeAppInstanceUserRequest.Builder
to create a request.- Returns:
- Result of the DescribeAppInstanceUser operation returned by the service.
- See Also:
-
describeAppInstanceUserEndpoint
default DescribeAppInstanceUserEndpointResponse describeAppInstanceUserEndpoint(DescribeAppInstanceUserEndpointRequest describeAppInstanceUserEndpointRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Returns the full details of an
AppInstanceUserEndpoint
.- Parameters:
describeAppInstanceUserEndpointRequest
-- Returns:
- Result of the DescribeAppInstanceUserEndpoint operation returned by the service.
- See Also:
-
describeAppInstanceUserEndpoint
default DescribeAppInstanceUserEndpointResponse describeAppInstanceUserEndpoint(Consumer<DescribeAppInstanceUserEndpointRequest.Builder> describeAppInstanceUserEndpointRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Returns the full details of an
AppInstanceUserEndpoint
.
This is a convenience which creates an instance of the
DescribeAppInstanceUserEndpointRequest.Builder
avoiding the need to create one manually viaDescribeAppInstanceUserEndpointRequest.builder()
- Parameters:
describeAppInstanceUserEndpointRequest
- AConsumer
that will call methods onDescribeAppInstanceUserEndpointRequest.Builder
to create a request.- Returns:
- Result of the DescribeAppInstanceUserEndpoint operation returned by the service.
- See Also:
-
getAppInstanceRetentionSettings
default GetAppInstanceRetentionSettingsResponse getAppInstanceRetentionSettings(GetAppInstanceRetentionSettingsRequest getAppInstanceRetentionSettingsRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Gets the retention settings for an
AppInstance
.- Parameters:
getAppInstanceRetentionSettingsRequest
-- Returns:
- Result of the GetAppInstanceRetentionSettings operation returned by the service.
- See Also:
-
getAppInstanceRetentionSettings
default GetAppInstanceRetentionSettingsResponse getAppInstanceRetentionSettings(Consumer<GetAppInstanceRetentionSettingsRequest.Builder> getAppInstanceRetentionSettingsRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Gets the retention settings for an
AppInstance
.
This is a convenience which creates an instance of the
GetAppInstanceRetentionSettingsRequest.Builder
avoiding the need to create one manually viaGetAppInstanceRetentionSettingsRequest.builder()
- Parameters:
getAppInstanceRetentionSettingsRequest
- AConsumer
that will call methods onGetAppInstanceRetentionSettingsRequest.Builder
to create a request.- Returns:
- Result of the GetAppInstanceRetentionSettings operation returned by the service.
- See Also:
-
listAppInstanceAdmins
default ListAppInstanceAdminsResponse listAppInstanceAdmins(ListAppInstanceAdminsRequest listAppInstanceAdminsRequest) throws BadRequestException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Returns a list of the administrators in the
AppInstance
.- Parameters:
listAppInstanceAdminsRequest
-- Returns:
- Result of the ListAppInstanceAdmins operation returned by the service.
- See Also:
-
listAppInstanceAdmins
default ListAppInstanceAdminsResponse listAppInstanceAdmins(Consumer<ListAppInstanceAdminsRequest.Builder> listAppInstanceAdminsRequest) throws BadRequestException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Returns a list of the administrators in the
AppInstance
.
This is a convenience which creates an instance of the
ListAppInstanceAdminsRequest.Builder
avoiding the need to create one manually viaListAppInstanceAdminsRequest.builder()
- Parameters:
listAppInstanceAdminsRequest
- AConsumer
that will call methods onListAppInstanceAdminsRequest.Builder
to create a request.- Returns:
- Result of the ListAppInstanceAdmins operation returned by the service.
- See Also:
-
listAppInstanceAdminsPaginator
default ListAppInstanceAdminsIterable listAppInstanceAdminsPaginator(ListAppInstanceAdminsRequest listAppInstanceAdminsRequest) throws BadRequestException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException This is a variant of
listAppInstanceAdmins(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceAdminsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceAdminsIterable responses = client.listAppInstanceAdminsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceAdminsIterable responses = client .listAppInstanceAdminsPaginator(request); for (software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceAdminsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceAdminsIterable responses = client.listAppInstanceAdminsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAppInstanceAdmins(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceAdminsRequest)
operation.- Parameters:
listAppInstanceAdminsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAppInstanceAdminsPaginator
default ListAppInstanceAdminsIterable listAppInstanceAdminsPaginator(Consumer<ListAppInstanceAdminsRequest.Builder> listAppInstanceAdminsRequest) throws BadRequestException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException This is a variant of
listAppInstanceAdmins(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceAdminsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceAdminsIterable responses = client.listAppInstanceAdminsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceAdminsIterable responses = client .listAppInstanceAdminsPaginator(request); for (software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceAdminsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceAdminsIterable responses = client.listAppInstanceAdminsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAppInstanceAdmins(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceAdminsRequest)
operation.
This is a convenience which creates an instance of the
ListAppInstanceAdminsRequest.Builder
avoiding the need to create one manually viaListAppInstanceAdminsRequest.builder()
- Parameters:
listAppInstanceAdminsRequest
- AConsumer
that will call methods onListAppInstanceAdminsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAppInstanceBots
default ListAppInstanceBotsResponse listAppInstanceBots(ListAppInstanceBotsRequest listAppInstanceBotsRequest) throws BadRequestException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Lists all
AppInstanceBots
created under a singleAppInstance
.- Parameters:
listAppInstanceBotsRequest
-- Returns:
- Result of the ListAppInstanceBots operation returned by the service.
- See Also:
-
listAppInstanceBots
default ListAppInstanceBotsResponse listAppInstanceBots(Consumer<ListAppInstanceBotsRequest.Builder> listAppInstanceBotsRequest) throws BadRequestException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Lists all
AppInstanceBots
created under a singleAppInstance
.
This is a convenience which creates an instance of the
ListAppInstanceBotsRequest.Builder
avoiding the need to create one manually viaListAppInstanceBotsRequest.builder()
- Parameters:
listAppInstanceBotsRequest
- AConsumer
that will call methods onListAppInstanceBotsRequest.Builder
to create a request.- Returns:
- Result of the ListAppInstanceBots operation returned by the service.
- See Also:
-
listAppInstanceBotsPaginator
default ListAppInstanceBotsIterable listAppInstanceBotsPaginator(ListAppInstanceBotsRequest listAppInstanceBotsRequest) throws BadRequestException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException This is a variant of
listAppInstanceBots(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceBotsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceBotsIterable responses = client.listAppInstanceBotsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceBotsIterable responses = client .listAppInstanceBotsPaginator(request); for (software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceBotsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceBotsIterable responses = client.listAppInstanceBotsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAppInstanceBots(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceBotsRequest)
operation.- Parameters:
listAppInstanceBotsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAppInstanceBotsPaginator
default ListAppInstanceBotsIterable listAppInstanceBotsPaginator(Consumer<ListAppInstanceBotsRequest.Builder> listAppInstanceBotsRequest) throws BadRequestException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException This is a variant of
listAppInstanceBots(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceBotsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceBotsIterable responses = client.listAppInstanceBotsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceBotsIterable responses = client .listAppInstanceBotsPaginator(request); for (software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceBotsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceBotsIterable responses = client.listAppInstanceBotsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAppInstanceBots(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceBotsRequest)
operation.
This is a convenience which creates an instance of the
ListAppInstanceBotsRequest.Builder
avoiding the need to create one manually viaListAppInstanceBotsRequest.builder()
- Parameters:
listAppInstanceBotsRequest
- AConsumer
that will call methods onListAppInstanceBotsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAppInstanceUserEndpoints
default ListAppInstanceUserEndpointsResponse listAppInstanceUserEndpoints(ListAppInstanceUserEndpointsRequest listAppInstanceUserEndpointsRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Lists all the
AppInstanceUserEndpoints
created under a singleAppInstanceUser
.- Parameters:
listAppInstanceUserEndpointsRequest
-- Returns:
- Result of the ListAppInstanceUserEndpoints operation returned by the service.
- See Also:
-
listAppInstanceUserEndpoints
default ListAppInstanceUserEndpointsResponse listAppInstanceUserEndpoints(Consumer<ListAppInstanceUserEndpointsRequest.Builder> listAppInstanceUserEndpointsRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Lists all the
AppInstanceUserEndpoints
created under a singleAppInstanceUser
.
This is a convenience which creates an instance of the
ListAppInstanceUserEndpointsRequest.Builder
avoiding the need to create one manually viaListAppInstanceUserEndpointsRequest.builder()
- Parameters:
listAppInstanceUserEndpointsRequest
- AConsumer
that will call methods onListAppInstanceUserEndpointsRequest.Builder
to create a request.- Returns:
- Result of the ListAppInstanceUserEndpoints operation returned by the service.
- See Also:
-
listAppInstanceUserEndpointsPaginator
default ListAppInstanceUserEndpointsIterable listAppInstanceUserEndpointsPaginator(ListAppInstanceUserEndpointsRequest listAppInstanceUserEndpointsRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException This is a variant of
listAppInstanceUserEndpoints(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUserEndpointsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceUserEndpointsIterable responses = client.listAppInstanceUserEndpointsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceUserEndpointsIterable responses = client .listAppInstanceUserEndpointsPaginator(request); for (software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUserEndpointsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceUserEndpointsIterable responses = client.listAppInstanceUserEndpointsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAppInstanceUserEndpoints(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUserEndpointsRequest)
operation.- Parameters:
listAppInstanceUserEndpointsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAppInstanceUserEndpointsPaginator
default ListAppInstanceUserEndpointsIterable listAppInstanceUserEndpointsPaginator(Consumer<ListAppInstanceUserEndpointsRequest.Builder> listAppInstanceUserEndpointsRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException This is a variant of
listAppInstanceUserEndpoints(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUserEndpointsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceUserEndpointsIterable responses = client.listAppInstanceUserEndpointsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceUserEndpointsIterable responses = client .listAppInstanceUserEndpointsPaginator(request); for (software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUserEndpointsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceUserEndpointsIterable responses = client.listAppInstanceUserEndpointsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAppInstanceUserEndpoints(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUserEndpointsRequest)
operation.
This is a convenience which creates an instance of the
ListAppInstanceUserEndpointsRequest.Builder
avoiding the need to create one manually viaListAppInstanceUserEndpointsRequest.builder()
- Parameters:
listAppInstanceUserEndpointsRequest
- AConsumer
that will call methods onListAppInstanceUserEndpointsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAppInstanceUsers
default ListAppInstanceUsersResponse listAppInstanceUsers(ListAppInstanceUsersRequest listAppInstanceUsersRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException List all
AppInstanceUsers
created under a singleAppInstance
.- Parameters:
listAppInstanceUsersRequest
-- Returns:
- Result of the ListAppInstanceUsers operation returned by the service.
- See Also:
-
listAppInstanceUsers
default ListAppInstanceUsersResponse listAppInstanceUsers(Consumer<ListAppInstanceUsersRequest.Builder> listAppInstanceUsersRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException List all
AppInstanceUsers
created under a singleAppInstance
.
This is a convenience which creates an instance of the
ListAppInstanceUsersRequest.Builder
avoiding the need to create one manually viaListAppInstanceUsersRequest.builder()
- Parameters:
listAppInstanceUsersRequest
- AConsumer
that will call methods onListAppInstanceUsersRequest.Builder
to create a request.- Returns:
- Result of the ListAppInstanceUsers operation returned by the service.
- See Also:
-
listAppInstanceUsersPaginator
default ListAppInstanceUsersIterable listAppInstanceUsersPaginator(ListAppInstanceUsersRequest listAppInstanceUsersRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException This is a variant of
listAppInstanceUsers(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUsersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceUsersIterable responses = client.listAppInstanceUsersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceUsersIterable responses = client .listAppInstanceUsersPaginator(request); for (software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUsersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceUsersIterable responses = client.listAppInstanceUsersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAppInstanceUsers(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUsersRequest)
operation.- Parameters:
listAppInstanceUsersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAppInstanceUsersPaginator
default ListAppInstanceUsersIterable listAppInstanceUsersPaginator(Consumer<ListAppInstanceUsersRequest.Builder> listAppInstanceUsersRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException This is a variant of
listAppInstanceUsers(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUsersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceUsersIterable responses = client.listAppInstanceUsersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceUsersIterable responses = client .listAppInstanceUsersPaginator(request); for (software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUsersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceUsersIterable responses = client.listAppInstanceUsersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAppInstanceUsers(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUsersRequest)
operation.
This is a convenience which creates an instance of the
ListAppInstanceUsersRequest.Builder
avoiding the need to create one manually viaListAppInstanceUsersRequest.builder()
- Parameters:
listAppInstanceUsersRequest
- AConsumer
that will call methods onListAppInstanceUsersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAppInstances
default ListAppInstancesResponse listAppInstances(ListAppInstancesRequest listAppInstancesRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Lists all Amazon Chime
AppInstance
s created under a single AWS account.- Parameters:
listAppInstancesRequest
-- Returns:
- Result of the ListAppInstances operation returned by the service.
- See Also:
-
listAppInstances
default ListAppInstancesResponse listAppInstances(Consumer<ListAppInstancesRequest.Builder> listAppInstancesRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Lists all Amazon Chime
AppInstance
s created under a single AWS account.
This is a convenience which creates an instance of the
ListAppInstancesRequest.Builder
avoiding the need to create one manually viaListAppInstancesRequest.builder()
- Parameters:
listAppInstancesRequest
- AConsumer
that will call methods onListAppInstancesRequest.Builder
to create a request.- Returns:
- Result of the ListAppInstances operation returned by the service.
- See Also:
-
listAppInstancesPaginator
default ListAppInstancesIterable listAppInstancesPaginator(ListAppInstancesRequest listAppInstancesRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException This is a variant of
listAppInstances(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstancesIterable responses = client.listAppInstancesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstancesIterable responses = client .listAppInstancesPaginator(request); for (software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstancesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstancesIterable responses = client.listAppInstancesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAppInstances(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstancesRequest)
operation.- Parameters:
listAppInstancesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAppInstancesPaginator
default ListAppInstancesIterable listAppInstancesPaginator(Consumer<ListAppInstancesRequest.Builder> listAppInstancesRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException This is a variant of
listAppInstances(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstancesIterable responses = client.listAppInstancesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstancesIterable responses = client .listAppInstancesPaginator(request); for (software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstancesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstancesIterable responses = client.listAppInstancesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAppInstances(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstancesRequest)
operation.
This is a convenience which creates an instance of the
ListAppInstancesRequest.Builder
avoiding the need to create one manually viaListAppInstancesRequest.builder()
- Parameters:
listAppInstancesRequest
- AConsumer
that will call methods onListAppInstancesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Lists the tags applied to an Amazon Chime SDK identity resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Lists the tags applied to an Amazon Chime SDK identity resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
putAppInstanceRetentionSettings
default PutAppInstanceRetentionSettingsResponse putAppInstanceRetentionSettings(PutAppInstanceRetentionSettingsRequest putAppInstanceRetentionSettingsRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException 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.
- See Also:
-
putAppInstanceRetentionSettings
default PutAppInstanceRetentionSettingsResponse putAppInstanceRetentionSettings(Consumer<PutAppInstanceRetentionSettingsRequest.Builder> putAppInstanceRetentionSettingsRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Sets the amount of time in days that a given
AppInstance
retains data.
This is a convenience which creates an instance of the
PutAppInstanceRetentionSettingsRequest.Builder
avoiding the need to create one manually viaPutAppInstanceRetentionSettingsRequest.builder()
- Parameters:
putAppInstanceRetentionSettingsRequest
- AConsumer
that will call methods onPutAppInstanceRetentionSettingsRequest.Builder
to create a request.- Returns:
- Result of the PutAppInstanceRetentionSettings operation returned by the service.
- See Also:
-
putAppInstanceUserExpirationSettings
default PutAppInstanceUserExpirationSettingsResponse putAppInstanceUserExpirationSettings(PutAppInstanceUserExpirationSettingsRequest putAppInstanceUserExpirationSettingsRequest) throws BadRequestException, ConflictException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException 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.
- See Also:
-
putAppInstanceUserExpirationSettings
default PutAppInstanceUserExpirationSettingsResponse putAppInstanceUserExpirationSettings(Consumer<PutAppInstanceUserExpirationSettingsRequest.Builder> putAppInstanceUserExpirationSettingsRequest) throws BadRequestException, ConflictException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException 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.
This is a convenience which creates an instance of the
PutAppInstanceUserExpirationSettingsRequest.Builder
avoiding the need to create one manually viaPutAppInstanceUserExpirationSettingsRequest.builder()
- Parameters:
putAppInstanceUserExpirationSettingsRequest
- AConsumer
that will call methods onPutAppInstanceUserExpirationSettingsRequest.Builder
to create a request.- Returns:
- Result of the PutAppInstanceUserExpirationSettings operation returned by the service.
- See Also:
-
registerAppInstanceUserEndpoint
default RegisterAppInstanceUserEndpointResponse registerAppInstanceUserEndpoint(RegisterAppInstanceUserEndpointRequest registerAppInstanceUserEndpointRequest) throws BadRequestException, ConflictException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException 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.
- See Also:
-
registerAppInstanceUserEndpoint
default RegisterAppInstanceUserEndpointResponse registerAppInstanceUserEndpoint(Consumer<RegisterAppInstanceUserEndpointRequest.Builder> registerAppInstanceUserEndpointRequest) throws BadRequestException, ConflictException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException 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.
This is a convenience which creates an instance of the
RegisterAppInstanceUserEndpointRequest.Builder
avoiding the need to create one manually viaRegisterAppInstanceUserEndpointRequest.builder()
- Parameters:
registerAppInstanceUserEndpointRequest
- AConsumer
that will call methods onRegisterAppInstanceUserEndpointRequest.Builder
to create a request.- Returns:
- Result of the RegisterAppInstanceUserEndpoint operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ResourceLimitExceededException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Applies the specified tags to the specified Amazon Chime SDK identity resource.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ResourceLimitExceededException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Applies the specified tags to the specified Amazon Chime SDK identity resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Removes the specified tags from the specified Amazon Chime SDK identity resource.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Removes the specified tags from the specified Amazon Chime SDK identity resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateAppInstance
default UpdateAppInstanceResponse updateAppInstance(UpdateAppInstanceRequest updateAppInstanceRequest) throws BadRequestException, ConflictException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Updates
AppInstance
metadata.- Parameters:
updateAppInstanceRequest
-- Returns:
- Result of the UpdateAppInstance operation returned by the service.
- See Also:
-
updateAppInstance
default UpdateAppInstanceResponse updateAppInstance(Consumer<UpdateAppInstanceRequest.Builder> updateAppInstanceRequest) throws BadRequestException, ConflictException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Updates
AppInstance
metadata.
This is a convenience which creates an instance of the
UpdateAppInstanceRequest.Builder
avoiding the need to create one manually viaUpdateAppInstanceRequest.builder()
- Parameters:
updateAppInstanceRequest
- AConsumer
that will call methods onUpdateAppInstanceRequest.Builder
to create a request.- Returns:
- Result of the UpdateAppInstance operation returned by the service.
- See Also:
-
updateAppInstanceBot
default UpdateAppInstanceBotResponse updateAppInstanceBot(UpdateAppInstanceBotRequest updateAppInstanceBotRequest) throws BadRequestException, ConflictException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Updates the name and metadata of an
AppInstanceBot
.- Parameters:
updateAppInstanceBotRequest
-- Returns:
- Result of the UpdateAppInstanceBot operation returned by the service.
- See Also:
-
updateAppInstanceBot
default UpdateAppInstanceBotResponse updateAppInstanceBot(Consumer<UpdateAppInstanceBotRequest.Builder> updateAppInstanceBotRequest) throws BadRequestException, ConflictException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Updates the name and metadata of an
AppInstanceBot
.
This is a convenience which creates an instance of the
UpdateAppInstanceBotRequest.Builder
avoiding the need to create one manually viaUpdateAppInstanceBotRequest.builder()
- Parameters:
updateAppInstanceBotRequest
- AConsumer
that will call methods onUpdateAppInstanceBotRequest.Builder
to create a request.- Returns:
- Result of the UpdateAppInstanceBot operation returned by the service.
- See Also:
-
updateAppInstanceUser
default UpdateAppInstanceUserResponse updateAppInstanceUser(UpdateAppInstanceUserRequest updateAppInstanceUserRequest) throws BadRequestException, ConflictException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Updates the details of an
AppInstanceUser
. You can update names and metadata.- Parameters:
updateAppInstanceUserRequest
-- Returns:
- Result of the UpdateAppInstanceUser operation returned by the service.
- See Also:
-
updateAppInstanceUser
default UpdateAppInstanceUserResponse updateAppInstanceUser(Consumer<UpdateAppInstanceUserRequest.Builder> updateAppInstanceUserRequest) throws BadRequestException, ConflictException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Updates the details of an
AppInstanceUser
. You can update names and metadata.
This is a convenience which creates an instance of the
UpdateAppInstanceUserRequest.Builder
avoiding the need to create one manually viaUpdateAppInstanceUserRequest.builder()
- Parameters:
updateAppInstanceUserRequest
- AConsumer
that will call methods onUpdateAppInstanceUserRequest.Builder
to create a request.- Returns:
- Result of the UpdateAppInstanceUser operation returned by the service.
- See Also:
-
updateAppInstanceUserEndpoint
default UpdateAppInstanceUserEndpointResponse updateAppInstanceUserEndpoint(UpdateAppInstanceUserEndpointRequest updateAppInstanceUserEndpointRequest) throws BadRequestException, ConflictException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Updates the details of an
AppInstanceUserEndpoint
. You can update the name andAllowMessage
values.- Parameters:
updateAppInstanceUserEndpointRequest
-- Returns:
- Result of the UpdateAppInstanceUserEndpoint operation returned by the service.
- See Also:
-
updateAppInstanceUserEndpoint
default UpdateAppInstanceUserEndpointResponse updateAppInstanceUserEndpoint(Consumer<UpdateAppInstanceUserEndpointRequest.Builder> updateAppInstanceUserEndpointRequest) throws BadRequestException, ConflictException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkIdentityException Updates the details of an
AppInstanceUserEndpoint
. You can update the name andAllowMessage
values.
This is a convenience which creates an instance of the
UpdateAppInstanceUserEndpointRequest.Builder
avoiding the need to create one manually viaUpdateAppInstanceUserEndpointRequest.builder()
- Parameters:
updateAppInstanceUserEndpointRequest
- AConsumer
that will call methods onUpdateAppInstanceUserEndpointRequest.Builder
to create a request.- Returns:
- Result of the UpdateAppInstanceUserEndpoint operation returned by the service.
- See Also:
-
create
Create aChimeSdkIdentityClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aChimeSdkIdentityClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-