Interface ChimeSdkIdentityClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface ChimeSdkIdentityClient
extends AwsClient

Service client for accessing Amazon Chime SDK Identity. This can be created using the static 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

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static ChimeSdkIdentityClientBuilder	builder()	Create a builder that can be used to configure and create a ChimeSdkIdentityClient.
static ChimeSdkIdentityClient	create()	Create a ChimeSdkIdentityClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateAppInstanceResponse	createAppInstance(Consumer<CreateAppInstanceRequest.Builder> createAppInstanceRequest)	Creates an Amazon Chime SDK messaging AppInstance under an AWS account.
default CreateAppInstanceResponse	createAppInstance(CreateAppInstanceRequest createAppInstanceRequest)	Creates an Amazon Chime SDK messaging AppInstance under an AWS account.
default CreateAppInstanceAdminResponse	createAppInstanceAdmin(Consumer<CreateAppInstanceAdminRequest.Builder> createAppInstanceAdminRequest)	Promotes an AppInstanceUser or AppInstanceBot to an AppInstanceAdmin.
default CreateAppInstanceAdminResponse	createAppInstanceAdmin(CreateAppInstanceAdminRequest createAppInstanceAdminRequest)	Promotes an AppInstanceUser or AppInstanceBot to an AppInstanceAdmin.
default CreateAppInstanceBotResponse	createAppInstanceBot(Consumer<CreateAppInstanceBotRequest.Builder> createAppInstanceBotRequest)	Creates a bot under an Amazon Chime AppInstance.
default CreateAppInstanceBotResponse	createAppInstanceBot(CreateAppInstanceBotRequest createAppInstanceBotRequest)	Creates a bot under an Amazon Chime AppInstance.
default CreateAppInstanceUserResponse	createAppInstanceUser(Consumer<CreateAppInstanceUserRequest.Builder> createAppInstanceUserRequest)	Creates a user under an Amazon Chime AppInstance.
default CreateAppInstanceUserResponse	createAppInstanceUser(CreateAppInstanceUserRequest createAppInstanceUserRequest)	Creates a user under an Amazon Chime AppInstance.
default DeleteAppInstanceResponse	deleteAppInstance(Consumer<DeleteAppInstanceRequest.Builder> deleteAppInstanceRequest)	Deletes an AppInstance and all associated data asynchronously.
default DeleteAppInstanceResponse	deleteAppInstance(DeleteAppInstanceRequest deleteAppInstanceRequest)	Deletes an AppInstance and all associated data asynchronously.
default DeleteAppInstanceAdminResponse	deleteAppInstanceAdmin(Consumer<DeleteAppInstanceAdminRequest.Builder> deleteAppInstanceAdminRequest)	Demotes an AppInstanceAdmin to an AppInstanceUser or AppInstanceBot.
default DeleteAppInstanceAdminResponse	deleteAppInstanceAdmin(DeleteAppInstanceAdminRequest deleteAppInstanceAdminRequest)	Demotes an AppInstanceAdmin to an AppInstanceUser or AppInstanceBot.
default DeleteAppInstanceBotResponse	deleteAppInstanceBot(Consumer<DeleteAppInstanceBotRequest.Builder> deleteAppInstanceBotRequest)	Deletes an AppInstanceBot.
default DeleteAppInstanceBotResponse	deleteAppInstanceBot(DeleteAppInstanceBotRequest deleteAppInstanceBotRequest)	Deletes an AppInstanceBot.
default DeleteAppInstanceUserResponse	deleteAppInstanceUser(Consumer<DeleteAppInstanceUserRequest.Builder> deleteAppInstanceUserRequest)	Deletes an AppInstanceUser.
default DeleteAppInstanceUserResponse	deleteAppInstanceUser(DeleteAppInstanceUserRequest deleteAppInstanceUserRequest)	Deletes an AppInstanceUser.
default DeregisterAppInstanceUserEndpointResponse	deregisterAppInstanceUserEndpoint(Consumer<DeregisterAppInstanceUserEndpointRequest.Builder> deregisterAppInstanceUserEndpointRequest)	Deregisters an AppInstanceUserEndpoint.
default DeregisterAppInstanceUserEndpointResponse	deregisterAppInstanceUserEndpoint(DeregisterAppInstanceUserEndpointRequest deregisterAppInstanceUserEndpointRequest)	Deregisters an AppInstanceUserEndpoint.
default DescribeAppInstanceResponse	describeAppInstance(Consumer<DescribeAppInstanceRequest.Builder> describeAppInstanceRequest)	Returns the full details of an AppInstance.
default DescribeAppInstanceResponse	describeAppInstance(DescribeAppInstanceRequest describeAppInstanceRequest)	Returns the full details of an AppInstance.
default DescribeAppInstanceAdminResponse	describeAppInstanceAdmin(Consumer<DescribeAppInstanceAdminRequest.Builder> describeAppInstanceAdminRequest)	Returns the full details of an AppInstanceAdmin.
default DescribeAppInstanceAdminResponse	describeAppInstanceAdmin(DescribeAppInstanceAdminRequest describeAppInstanceAdminRequest)	Returns the full details of an AppInstanceAdmin.
default DescribeAppInstanceBotResponse	describeAppInstanceBot(Consumer<DescribeAppInstanceBotRequest.Builder> describeAppInstanceBotRequest)	The AppInstanceBot's information.
default DescribeAppInstanceBotResponse	describeAppInstanceBot(DescribeAppInstanceBotRequest describeAppInstanceBotRequest)	The AppInstanceBot's information.
default DescribeAppInstanceUserResponse	describeAppInstanceUser(Consumer<DescribeAppInstanceUserRequest.Builder> describeAppInstanceUserRequest)	Returns the full details of an AppInstanceUser.
default DescribeAppInstanceUserResponse	describeAppInstanceUser(DescribeAppInstanceUserRequest describeAppInstanceUserRequest)	Returns the full details of an AppInstanceUser.
default DescribeAppInstanceUserEndpointResponse	describeAppInstanceUserEndpoint(Consumer<DescribeAppInstanceUserEndpointRequest.Builder> describeAppInstanceUserEndpointRequest)	Returns the full details of an AppInstanceUserEndpoint.
default DescribeAppInstanceUserEndpointResponse	describeAppInstanceUserEndpoint(DescribeAppInstanceUserEndpointRequest describeAppInstanceUserEndpointRequest)	Returns the full details of an AppInstanceUserEndpoint.
default GetAppInstanceRetentionSettingsResponse	getAppInstanceRetentionSettings(Consumer<GetAppInstanceRetentionSettingsRequest.Builder> getAppInstanceRetentionSettingsRequest)	Gets the retention settings for an AppInstance.
default GetAppInstanceRetentionSettingsResponse	getAppInstanceRetentionSettings(GetAppInstanceRetentionSettingsRequest getAppInstanceRetentionSettingsRequest)	Gets the retention settings for an AppInstance.
default ListAppInstanceAdminsResponse	listAppInstanceAdmins(Consumer<ListAppInstanceAdminsRequest.Builder> listAppInstanceAdminsRequest)	Returns a list of the administrators in the AppInstance.
default ListAppInstanceAdminsResponse	listAppInstanceAdmins(ListAppInstanceAdminsRequest listAppInstanceAdminsRequest)	Returns a list of the administrators in the AppInstance.
default ListAppInstanceAdminsIterable	listAppInstanceAdminsPaginator(Consumer<ListAppInstanceAdminsRequest.Builder> listAppInstanceAdminsRequest)	This is a variant of listAppInstanceAdmins(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceAdminsRequest) operation.
default ListAppInstanceAdminsIterable	listAppInstanceAdminsPaginator(ListAppInstanceAdminsRequest listAppInstanceAdminsRequest)	This is a variant of listAppInstanceAdmins(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceAdminsRequest) operation.
default ListAppInstanceBotsResponse	listAppInstanceBots(Consumer<ListAppInstanceBotsRequest.Builder> listAppInstanceBotsRequest)	Lists all AppInstanceBots created under a single AppInstance.
default ListAppInstanceBotsResponse	listAppInstanceBots(ListAppInstanceBotsRequest listAppInstanceBotsRequest)	Lists all AppInstanceBots created under a single AppInstance.
default ListAppInstanceBotsIterable	listAppInstanceBotsPaginator(Consumer<ListAppInstanceBotsRequest.Builder> listAppInstanceBotsRequest)	This is a variant of listAppInstanceBots(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceBotsRequest) operation.
default ListAppInstanceBotsIterable	listAppInstanceBotsPaginator(ListAppInstanceBotsRequest listAppInstanceBotsRequest)	This is a variant of listAppInstanceBots(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceBotsRequest) operation.
default ListAppInstancesResponse	listAppInstances(Consumer<ListAppInstancesRequest.Builder> listAppInstancesRequest)	Lists all Amazon Chime AppInstances created under a single AWS account.
default ListAppInstancesResponse	listAppInstances(ListAppInstancesRequest listAppInstancesRequest)	Lists all Amazon Chime AppInstances created under a single AWS account.
default ListAppInstancesIterable	listAppInstancesPaginator(Consumer<ListAppInstancesRequest.Builder> listAppInstancesRequest)	This is a variant of listAppInstances(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstancesRequest) operation.
default ListAppInstancesIterable	listAppInstancesPaginator(ListAppInstancesRequest listAppInstancesRequest)	This is a variant of listAppInstances(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstancesRequest) operation.
default ListAppInstanceUserEndpointsResponse	listAppInstanceUserEndpoints(Consumer<ListAppInstanceUserEndpointsRequest.Builder> listAppInstanceUserEndpointsRequest)	Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.
default ListAppInstanceUserEndpointsResponse	listAppInstanceUserEndpoints(ListAppInstanceUserEndpointsRequest listAppInstanceUserEndpointsRequest)	Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.
default ListAppInstanceUserEndpointsIterable	listAppInstanceUserEndpointsPaginator(Consumer<ListAppInstanceUserEndpointsRequest.Builder> listAppInstanceUserEndpointsRequest)	This is a variant of listAppInstanceUserEndpoints(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUserEndpointsRequest) operation.
default ListAppInstanceUserEndpointsIterable	listAppInstanceUserEndpointsPaginator(ListAppInstanceUserEndpointsRequest listAppInstanceUserEndpointsRequest)	This is a variant of listAppInstanceUserEndpoints(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUserEndpointsRequest) operation.
default ListAppInstanceUsersResponse	listAppInstanceUsers(Consumer<ListAppInstanceUsersRequest.Builder> listAppInstanceUsersRequest)	List all AppInstanceUsers created under a single AppInstance.
default ListAppInstanceUsersResponse	listAppInstanceUsers(ListAppInstanceUsersRequest listAppInstanceUsersRequest)	List all AppInstanceUsers created under a single AppInstance.
default ListAppInstanceUsersIterable	listAppInstanceUsersPaginator(Consumer<ListAppInstanceUsersRequest.Builder> listAppInstanceUsersRequest)	This is a variant of listAppInstanceUsers(software.amazon.awssdk.services.chimesdkidentity.model.ListAppInstanceUsersRequest) operation.
default ListAppInstanceUsersIterable	listAppInstanceUsersPaginator(ListAppInstanceUsersRequest listAppInstanceUsersRequest)	This is a variant of listAppInstanceUsers(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.
default PutAppInstanceRetentionSettingsResponse	putAppInstanceRetentionSettings(Consumer<PutAppInstanceRetentionSettingsRequest.Builder> putAppInstanceRetentionSettingsRequest)	Sets the amount of time in days that a given AppInstance retains data.
default PutAppInstanceRetentionSettingsResponse	putAppInstanceRetentionSettings(PutAppInstanceRetentionSettingsRequest putAppInstanceRetentionSettingsRequest)	Sets the amount of time in days that a given AppInstance retains data.
default PutAppInstanceUserExpirationSettingsResponse	putAppInstanceUserExpirationSettings(Consumer<PutAppInstanceUserExpirationSettingsRequest.Builder> putAppInstanceUserExpirationSettingsRequest)	Sets the number of days before the AppInstanceUser is automatically deleted.
default PutAppInstanceUserExpirationSettingsResponse	putAppInstanceUserExpirationSettings(PutAppInstanceUserExpirationSettingsRequest putAppInstanceUserExpirationSettingsRequest)	Sets the number of days before the AppInstanceUser is automatically deleted.
default RegisterAppInstanceUserEndpointResponse	registerAppInstanceUserEndpoint(Consumer<RegisterAppInstanceUserEndpointRequest.Builder> registerAppInstanceUserEndpointRequest)	Registers an endpoint under an Amazon Chime AppInstanceUser.
default RegisterAppInstanceUserEndpointResponse	registerAppInstanceUserEndpoint(RegisterAppInstanceUserEndpointRequest registerAppInstanceUserEndpointRequest)	Registers an endpoint under an Amazon Chime AppInstanceUser.
default ChimeSdkIdentityServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	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)	Updates AppInstance metadata.
default UpdateAppInstanceResponse	updateAppInstance(UpdateAppInstanceRequest updateAppInstanceRequest)	Updates AppInstance metadata.
default UpdateAppInstanceBotResponse	updateAppInstanceBot(Consumer<UpdateAppInstanceBotRequest.Builder> updateAppInstanceBotRequest)	Updates the name and metadata of an AppInstanceBot.
default UpdateAppInstanceBotResponse	updateAppInstanceBot(UpdateAppInstanceBotRequest updateAppInstanceBotRequest)	Updates the name and metadata of an AppInstanceBot.
default UpdateAppInstanceUserResponse	updateAppInstanceUser(Consumer<UpdateAppInstanceUserRequest.Builder> updateAppInstanceUserRequest)	Updates the details of an AppInstanceUser.
default UpdateAppInstanceUserResponse	updateAppInstanceUser(UpdateAppInstanceUserRequest updateAppInstanceUserRequest)	Updates the details of an AppInstanceUser.
default UpdateAppInstanceUserEndpointResponse	updateAppInstanceUserEndpoint(Consumer<UpdateAppInstanceUserEndpointRequest.Builder> updateAppInstanceUserEndpointRequest)	Updates the details of an AppInstanceUserEndpoint.
default UpdateAppInstanceUserEndpointResponse	updateAppInstanceUserEndpoint(UpdateAppInstanceUserEndpointRequest updateAppInstanceUserEndpointRequest)	Updates the details of an AppInstanceUserEndpoint.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

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:

• AWS API Documentation

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 via CreateAppInstanceRequest.builder()

Parameters:

createAppInstanceRequest - A Consumer that will call methods on CreateAppInstanceRequest.Builder to create a request.

Returns:

Result of the CreateAppInstance operation returned by the service.

See Also:

• AWS API Documentation

createAppInstanceAdmin

default CreateAppInstanceAdminResponse createAppInstanceAdmin(CreateAppInstanceAdminRequest createAppInstanceAdminRequest)
                                                       throws BadRequestException,
ConflictException,
ForbiddenException,
ResourceLimitExceededException,
ThrottledClientException,
UnauthorizedClientException,
ServiceUnavailableException,
ServiceFailureException,
AwsServiceException,
SdkClientException,
ChimeSdkIdentityException

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

• ChannelModerator actions across all channels in the AppInstance.

• DeleteChannelMessage actions.

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

Parameters:

createAppInstanceAdminRequest -

Returns:

Result of the CreateAppInstanceAdmin operation returned by the service.

See Also:

• AWS API Documentation

createAppInstanceAdmin

default CreateAppInstanceAdminResponse createAppInstanceAdmin(Consumer<CreateAppInstanceAdminRequest.Builder> createAppInstanceAdminRequest)
                                                       throws BadRequestException,
ConflictException,
ForbiddenException,
ResourceLimitExceededException,
ThrottledClientException,
UnauthorizedClientException,
ServiceUnavailableException,
ServiceFailureException,
AwsServiceException,
SdkClientException,
ChimeSdkIdentityException

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.

This is a convenience which creates an instance of the CreateAppInstanceAdminRequest.Builder avoiding the need to create one manually via CreateAppInstanceAdminRequest.builder()

Parameters:

createAppInstanceAdminRequest - A Consumer that will call methods on CreateAppInstanceAdminRequest.Builder to create a request.

Returns:

Result of the CreateAppInstanceAdmin operation returned by the service.

See Also:

• AWS API Documentation

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 unique Configuration and Name for that bot.

Parameters:

createAppInstanceBotRequest -

Returns:

Result of the CreateAppInstanceBot operation returned by the service.

See Also:

• AWS API Documentation

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 unique Configuration and Name for that bot.

This is a convenience which creates an instance of the CreateAppInstanceBotRequest.Builder avoiding the need to create one manually via CreateAppInstanceBotRequest.builder()

Parameters:

createAppInstanceBotRequest - A Consumer that will call methods on CreateAppInstanceBotRequest.Builder to create a request.

Returns:

Result of the CreateAppInstanceBot operation returned by the service.

See Also:

• AWS API Documentation

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 unique appInstanceUserId and Name for that user.

Parameters:

createAppInstanceUserRequest -

Returns:

Result of the CreateAppInstanceUser operation returned by the service.

See Also:

• AWS API Documentation

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 unique appInstanceUserId and Name for that user.

This is a convenience which creates an instance of the CreateAppInstanceUserRequest.Builder avoiding the need to create one manually via CreateAppInstanceUserRequest.builder()

Parameters:

createAppInstanceUserRequest - A Consumer that will call methods on CreateAppInstanceUserRequest.Builder to create a request.

Returns:

Result of the CreateAppInstanceUser operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via DeleteAppInstanceRequest.builder()

Parameters:

deleteAppInstanceRequest - A Consumer that will call methods on DeleteAppInstanceRequest.Builder to create a request.

Returns:

Result of the DeleteAppInstance operation returned by the service.

See Also:

• AWS API Documentation

deleteAppInstanceAdmin

default DeleteAppInstanceAdminResponse deleteAppInstanceAdmin(DeleteAppInstanceAdminRequest deleteAppInstanceAdminRequest)
                                                       throws BadRequestException,
ConflictException,
ForbiddenException,
ResourceLimitExceededException,
ThrottledClientException,
UnauthorizedClientException,
ServiceUnavailableException,
ServiceFailureException,
AwsServiceException,
SdkClientException,
ChimeSdkIdentityException

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

Parameters:

deleteAppInstanceAdminRequest -

Returns:

Result of the DeleteAppInstanceAdmin operation returned by the service.

See Also:

• AWS API Documentation

deleteAppInstanceAdmin

default DeleteAppInstanceAdminResponse deleteAppInstanceAdmin(Consumer<DeleteAppInstanceAdminRequest.Builder> deleteAppInstanceAdminRequest)
                                                       throws BadRequestException,
ConflictException,
ForbiddenException,
ResourceLimitExceededException,
ThrottledClientException,
UnauthorizedClientException,
ServiceUnavailableException,
ServiceFailureException,
AwsServiceException,
SdkClientException,
ChimeSdkIdentityException

Demotes an AppInstanceAdmin to an AppInstanceUser or AppInstanceBot. 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 via DeleteAppInstanceAdminRequest.builder()

Parameters:

deleteAppInstanceAdminRequest - A Consumer that will call methods on DeleteAppInstanceAdminRequest.Builder to create a request.

Returns:

Result of the DeleteAppInstanceAdmin operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via DeleteAppInstanceBotRequest.builder()

Parameters:

deleteAppInstanceBotRequest - A Consumer that will call methods on DeleteAppInstanceBotRequest.Builder to create a request.

Returns:

Result of the DeleteAppInstanceBot operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via DeleteAppInstanceUserRequest.builder()

Parameters:

deleteAppInstanceUserRequest - A Consumer that will call methods on DeleteAppInstanceUserRequest.Builder to create a request.

Returns:

Result of the DeleteAppInstanceUser operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via DeregisterAppInstanceUserEndpointRequest.builder()

Parameters:

deregisterAppInstanceUserEndpointRequest - A Consumer that will call methods on DeregisterAppInstanceUserEndpointRequest.Builder to create a request.

Returns:

Result of the DeregisterAppInstanceUserEndpoint operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via DescribeAppInstanceRequest.builder()

Parameters:

describeAppInstanceRequest - A Consumer that will call methods on DescribeAppInstanceRequest.Builder to create a request.

Returns:

Result of the DescribeAppInstance operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via DescribeAppInstanceAdminRequest.builder()

Parameters:

describeAppInstanceAdminRequest - A Consumer that will call methods on DescribeAppInstanceAdminRequest.Builder to create a request.

Returns:

Result of the DescribeAppInstanceAdmin operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via DescribeAppInstanceBotRequest.builder()

Parameters:

describeAppInstanceBotRequest - A Consumer that will call methods on DescribeAppInstanceBotRequest.Builder to create a request.

Returns:

Result of the DescribeAppInstanceBot operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via DescribeAppInstanceUserRequest.builder()

Parameters:

describeAppInstanceUserRequest - A Consumer that will call methods on DescribeAppInstanceUserRequest.Builder to create a request.

Returns:

Result of the DescribeAppInstanceUser operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via DescribeAppInstanceUserEndpointRequest.builder()

Parameters:

describeAppInstanceUserEndpointRequest - A Consumer that will call methods on DescribeAppInstanceUserEndpointRequest.Builder to create a request.

Returns:

Result of the DescribeAppInstanceUserEndpoint operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via GetAppInstanceRetentionSettingsRequest.builder()

Parameters:

getAppInstanceRetentionSettingsRequest - A Consumer that will call methods on GetAppInstanceRetentionSettingsRequest.Builder to create a request.

Returns:

Result of the GetAppInstanceRetentionSettings operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via ListAppInstanceAdminsRequest.builder()

Parameters:

listAppInstanceAdminsRequest - A Consumer that will call methods on ListAppInstanceAdminsRequest.Builder to create a request.

Returns:

Result of the ListAppInstanceAdmins operation returned by the service.

See Also:

• AWS API Documentation

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 Stream

 
 software.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceAdminsIterable responses = client.listAppInstanceAdminsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

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

• AWS API Documentation

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 Stream

 
 software.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceAdminsIterable responses = client.listAppInstanceAdminsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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 via ListAppInstanceAdminsRequest.builder()

Parameters:

listAppInstanceAdminsRequest - A Consumer that will call methods on ListAppInstanceAdminsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAppInstanceBots

default ListAppInstanceBotsResponse listAppInstanceBots(ListAppInstanceBotsRequest listAppInstanceBotsRequest)
                                                 throws BadRequestException,
ForbiddenException,
ResourceLimitExceededException,
ThrottledClientException,
UnauthorizedClientException,
ServiceUnavailableException,
ServiceFailureException,
AwsServiceException,
SdkClientException,
ChimeSdkIdentityException

Lists all AppInstanceBots created under a single AppInstance.

Parameters:

listAppInstanceBotsRequest -

Returns:

Result of the ListAppInstanceBots operation returned by the service.

See Also:

• AWS API Documentation

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

This is a convenience which creates an instance of the ListAppInstanceBotsRequest.Builder avoiding the need to create one manually via ListAppInstanceBotsRequest.builder()

Parameters:

listAppInstanceBotsRequest - A Consumer that will call methods on ListAppInstanceBotsRequest.Builder to create a request.

Returns:

Result of the ListAppInstanceBots operation returned by the service.

See Also:

• AWS API Documentation

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 Stream

 
 software.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceBotsIterable responses = client.listAppInstanceBotsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

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

• AWS API Documentation

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 Stream

 
 software.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceBotsIterable responses = client.listAppInstanceBotsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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 via ListAppInstanceBotsRequest.builder()

Parameters:

listAppInstanceBotsRequest - A Consumer that will call methods on ListAppInstanceBotsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAppInstanceUserEndpoints

default ListAppInstanceUserEndpointsResponse listAppInstanceUserEndpoints(ListAppInstanceUserEndpointsRequest listAppInstanceUserEndpointsRequest)
                                                                   throws BadRequestException,
ForbiddenException,
ThrottledClientException,
UnauthorizedClientException,
ServiceUnavailableException,
ServiceFailureException,
AwsServiceException,
SdkClientException,
ChimeSdkIdentityException

Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.

Parameters:

listAppInstanceUserEndpointsRequest -

Returns:

Result of the ListAppInstanceUserEndpoints operation returned by the service.

See Also:

• AWS API Documentation

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

This is a convenience which creates an instance of the ListAppInstanceUserEndpointsRequest.Builder avoiding the need to create one manually via ListAppInstanceUserEndpointsRequest.builder()

Parameters:

listAppInstanceUserEndpointsRequest - A Consumer that will call methods on ListAppInstanceUserEndpointsRequest.Builder to create a request.

Returns:

Result of the ListAppInstanceUserEndpoints operation returned by the service.

See Also:

• AWS API Documentation

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 Stream

 
 software.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceUserEndpointsIterable responses = client.listAppInstanceUserEndpointsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

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

• AWS API Documentation

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 Stream

 
 software.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceUserEndpointsIterable responses = client.listAppInstanceUserEndpointsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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 via ListAppInstanceUserEndpointsRequest.builder()

Parameters:

listAppInstanceUserEndpointsRequest - A Consumer that will call methods on ListAppInstanceUserEndpointsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAppInstanceUsers

default ListAppInstanceUsersResponse listAppInstanceUsers(ListAppInstanceUsersRequest listAppInstanceUsersRequest)
                                                   throws BadRequestException,
ForbiddenException,
ThrottledClientException,
UnauthorizedClientException,
ServiceUnavailableException,
ServiceFailureException,
AwsServiceException,
SdkClientException,
ChimeSdkIdentityException

List all AppInstanceUsers created under a single AppInstance.

Parameters:

listAppInstanceUsersRequest -

Returns:

Result of the ListAppInstanceUsers operation returned by the service.

See Also:

• AWS API Documentation

listAppInstanceUsers

default ListAppInstanceUsersResponse listAppInstanceUsers(Consumer<ListAppInstanceUsersRequest.Builder> listAppInstanceUsersRequest)
                                                   throws BadRequestException,
ForbiddenException,
ThrottledClientException,
UnauthorizedClientException,
ServiceUnavailableException,
ServiceFailureException,
AwsServiceException,
SdkClientException,
ChimeSdkIdentityException

List all AppInstanceUsers created under a single AppInstance.

This is a convenience which creates an instance of the ListAppInstanceUsersRequest.Builder avoiding the need to create one manually via ListAppInstanceUsersRequest.builder()

Parameters:

listAppInstanceUsersRequest - A Consumer that will call methods on ListAppInstanceUsersRequest.Builder to create a request.

Returns:

Result of the ListAppInstanceUsers operation returned by the service.

See Also:

• AWS API Documentation

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 Stream

 
 software.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceUsersIterable responses = client.listAppInstanceUsersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

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

• AWS API Documentation

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 Stream

 
 software.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstanceUsersIterable responses = client.listAppInstanceUsersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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 via ListAppInstanceUsersRequest.builder()

Parameters:

listAppInstanceUsersRequest - A Consumer that will call methods on ListAppInstanceUsersRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAppInstances

default ListAppInstancesResponse listAppInstances(ListAppInstancesRequest listAppInstancesRequest)
                                           throws BadRequestException,
ForbiddenException,
ThrottledClientException,
UnauthorizedClientException,
ServiceUnavailableException,
ServiceFailureException,
AwsServiceException,
SdkClientException,
ChimeSdkIdentityException

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

Parameters:

listAppInstancesRequest -

Returns:

Result of the ListAppInstances operation returned by the service.

See Also:

• AWS API Documentation

listAppInstances

default ListAppInstancesResponse listAppInstances(Consumer<ListAppInstancesRequest.Builder> listAppInstancesRequest)
                                           throws BadRequestException,
ForbiddenException,
ThrottledClientException,
UnauthorizedClientException,
ServiceUnavailableException,
ServiceFailureException,
AwsServiceException,
SdkClientException,
ChimeSdkIdentityException

Lists all Amazon Chime AppInstances 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 via ListAppInstancesRequest.builder()

Parameters:

listAppInstancesRequest - A Consumer that will call methods on ListAppInstancesRequest.Builder to create a request.

Returns:

Result of the ListAppInstances operation returned by the service.

See Also:

• AWS API Documentation

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 Stream

 
 software.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstancesIterable responses = client.listAppInstancesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

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

• AWS API Documentation

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 Stream

 
 software.amazon.awssdk.services.chimesdkidentity.paginators.ListAppInstancesIterable responses = client.listAppInstancesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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 via ListAppInstancesRequest.builder()

Parameters:

listAppInstancesRequest - A Consumer that will call methods on ListAppInstancesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via PutAppInstanceRetentionSettingsRequest.builder()

Parameters:

putAppInstanceRetentionSettingsRequest - A Consumer that will call methods on PutAppInstanceRetentionSettingsRequest.Builder to create a request.

Returns:

Result of the PutAppInstanceRetentionSettings operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via PutAppInstanceUserExpirationSettingsRequest.builder()

Parameters:

putAppInstanceUserExpirationSettingsRequest - A Consumer that will call methods on PutAppInstanceUserExpirationSettingsRequest.Builder to create a request.

Returns:

Result of the PutAppInstanceUserExpirationSettings operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via RegisterAppInstanceUserEndpointRequest.builder()

Parameters:

registerAppInstanceUserEndpointRequest - A Consumer that will call methods on RegisterAppInstanceUserEndpointRequest.Builder to create a request.

Returns:

Result of the RegisterAppInstanceUserEndpoint operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via UpdateAppInstanceRequest.builder()

Parameters:

updateAppInstanceRequest - A Consumer that will call methods on UpdateAppInstanceRequest.Builder to create a request.

Returns:

Result of the UpdateAppInstance operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via UpdateAppInstanceBotRequest.builder()

Parameters:

updateAppInstanceBotRequest - A Consumer that will call methods on UpdateAppInstanceBotRequest.Builder to create a request.

Returns:

Result of the UpdateAppInstanceBot operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via UpdateAppInstanceUserRequest.builder()

Parameters:

updateAppInstanceUserRequest - A Consumer that will call methods on UpdateAppInstanceUserRequest.Builder to create a request.

Returns:

Result of the UpdateAppInstanceUser operation returned by the service.

See Also:

• AWS API Documentation

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 and AllowMessage values.

Parameters:

updateAppInstanceUserEndpointRequest -

Returns:

Result of the UpdateAppInstanceUserEndpoint operation returned by the service.

See Also:

• AWS API Documentation

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 and AllowMessage values.

This is a convenience which creates an instance of the UpdateAppInstanceUserEndpointRequest.Builder avoiding the need to create one manually via UpdateAppInstanceUserEndpointRequest.builder()

Parameters:

updateAppInstanceUserEndpointRequest - A Consumer that will call methods on UpdateAppInstanceUserEndpointRequest.Builder to create a request.

Returns:

Result of the UpdateAppInstanceUserEndpoint operation returned by the service.

See Also:

• AWS API Documentation

create

static ChimeSdkIdentityClient create()

Create a ChimeSdkIdentityClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static ChimeSdkIdentityClientBuilder builder()

Create a builder that can be used to configure and create a ChimeSdkIdentityClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default ChimeSdkIdentityServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration