View Source AWS.ChimeSDKIdentity (aws-elixir v0.13.1)
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.
Link to this section Summary
Functions
Creates an Amazon Chime SDK messaging AppInstance
under an AWS account.
Promotes an AppInstanceUser
to an AppInstanceAdmin
.
Creates a user under an Amazon Chime AppInstance
.
Deletes an AppInstance
and all associated data asynchronously.
Demotes an AppInstanceAdmin
to an AppInstanceUser
.
Deletes an AppInstanceUser
.
Deregisters an AppInstanceUserEndpoint
.
Returns the full details of an AppInstance
.
Returns the full details of an AppInstanceAdmin
.
Returns the full details of an AppInstanceUser
.
Returns the full details of an AppInstanceUserEndpoint
.
Gets the retention settings for an AppInstance
.
Returns a list of the administrators in the AppInstance
.
Lists all the AppInstanceUserEndpoints
created under a single
AppInstanceUser
.
List all AppInstanceUsers
created under a single AppInstance
.
Lists all Amazon Chime AppInstance
s created under a single AWS account.
Lists the tags applied to an Amazon Chime SDK identity resource.
Sets the amount of time in days that a given AppInstance
retains data.
Registers an endpoint under an Amazon Chime AppInstanceUser
.
Applies the specified tags to the specified Amazon Chime SDK identity resource.
Removes the specified tags from the specified Amazon Chime SDK identity resource.
Updates AppInstance
metadata.
Updates the details of an AppInstanceUser
.
Updates the details of an AppInstanceUserEndpoint
.
Link to this section Functions
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
create_app_instance_admin(client, app_instance_arn, input, options \\ [])
View SourcePromotes an AppInstanceUser
to an AppInstanceAdmin
.
The promoted user can perform the following actions.
ChannelModerator
actions across all channels in theAppInstance
.DeleteChannelMessage
actions.
Only an AppInstanceUser
can be promoted to an AppInstanceAdmin
role.
Creates a user under an Amazon Chime AppInstance
.
The request consists of a unique appInstanceUserId
and Name
for that user.
delete_app_instance(client, app_instance_arn, input, options \\ [])
View SourceDeletes an AppInstance
and all associated data asynchronously.
delete_app_instance_admin(client, app_instance_admin_arn, app_instance_arn, input, options \\ [])
View SourceDemotes an AppInstanceAdmin
to an AppInstanceUser
.
This action does not delete the user.
delete_app_instance_user(client, app_instance_user_arn, input, options \\ [])
View SourceDeletes an AppInstanceUser
.
deregister_app_instance_user_endpoint( client, app_instance_user_arn, endpoint_id, input, options \\ [] )
View SourceDeregisters an AppInstanceUserEndpoint
.
Returns the full details of an AppInstance
.
describe_app_instance_admin(client, app_instance_admin_arn, app_instance_arn, options \\ [])
View SourceReturns the full details of an AppInstanceAdmin
.
describe_app_instance_user(client, app_instance_user_arn, options \\ [])
View SourceReturns the full details of an AppInstanceUser
.
describe_app_instance_user_endpoint(client, app_instance_user_arn, endpoint_id, options \\ [])
View SourceReturns the full details of an AppInstanceUserEndpoint
.
get_app_instance_retention_settings(client, app_instance_arn, options \\ [])
View SourceGets the retention settings for an AppInstance
.
list_app_instance_admins( client, app_instance_arn, max_results \\ nil, next_token \\ nil, options \\ [] )
View SourceReturns a list of the administrators in the AppInstance
.
list_app_instance_user_endpoints( client, app_instance_user_arn, max_results \\ nil, next_token \\ nil, options \\ [] )
View SourceLists all the AppInstanceUserEndpoints
created under a single
AppInstanceUser
.
list_app_instance_users( client, app_instance_arn, max_results \\ nil, next_token \\ nil, options \\ [] )
View SourceList all AppInstanceUsers
created under a single AppInstance
.
list_app_instances(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists all Amazon Chime AppInstance
s created under a single AWS account.
Lists the tags applied to an Amazon Chime SDK identity resource.
put_app_instance_retention_settings(client, app_instance_arn, input, options \\ [])
View SourceSets the amount of time in days that a given AppInstance
retains data.
register_app_instance_user_endpoint(client, app_instance_user_arn, input, options \\ [])
View SourceRegisters 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.
Applies the specified tags to the specified Amazon Chime SDK identity resource.
Removes the specified tags from the specified Amazon Chime SDK identity resource.
update_app_instance(client, app_instance_arn, input, options \\ [])
View SourceUpdates AppInstance
metadata.
update_app_instance_user(client, app_instance_user_arn, input, options \\ [])
View SourceUpdates the details of an AppInstanceUser
.
You can update names and metadata.
update_app_instance_user_endpoint( client, app_instance_user_arn, endpoint_id, input, options \\ [] )
View SourceUpdates the details of an AppInstanceUserEndpoint
.
You can update the name and AllowMessage
values.