View Source AWS.ChimeSDKIdentity (aws-elixir v0.14.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.

Summary

Functions

create_app_instance(client, input, options \\ [])

Creates an Amazon Chime SDK messaging AppInstance under an AWS account.

create_app_instance_admin(client, app_instance_arn, input, options \\ [])

Promotes an AppInstanceUser or AppInstanceBot to an AppInstanceAdmin.

create_app_instance_bot(client, input, options \\ [])

Creates a bot under an Amazon Chime AppInstance.

create_app_instance_user(client, input, options \\ [])

Creates a user under an Amazon Chime AppInstance.

delete_app_instance(client, app_instance_arn, input, options \\ [])

Deletes an AppInstance and all associated data asynchronously.

delete_app_instance_admin(client, app_instance_admin_arn, app_instance_arn, input, options \\ [])

Demotes an AppInstanceAdmin to an AppInstanceUser or AppInstanceBot.

delete_app_instance_bot(client, app_instance_bot_arn, input, options \\ [])

Deletes an AppInstanceBot.

delete_app_instance_user(client, app_instance_user_arn, input, options \\ [])

Deletes an AppInstanceUser.

deregister_app_instance_user_endpoint(client, app_instance_user_arn, endpoint_id, input, options \\ [])

Deregisters an AppInstanceUserEndpoint.

describe_app_instance(client, app_instance_arn, options \\ [])

Returns the full details of an AppInstance.

describe_app_instance_admin(client, app_instance_admin_arn, app_instance_arn, options \\ [])

Returns the full details of an AppInstanceAdmin.

describe_app_instance_bot(client, app_instance_bot_arn, options \\ [])

The AppInstanceBot's information.

describe_app_instance_user(client, app_instance_user_arn, options \\ [])

Returns the full details of an AppInstanceUser.

describe_app_instance_user_endpoint(client, app_instance_user_arn, endpoint_id, options \\ [])

Returns the full details of an AppInstanceUserEndpoint.

get_app_instance_retention_settings(client, app_instance_arn, options \\ [])

Gets the retention settings for an AppInstance.

list_app_instance_admins(client, app_instance_arn, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of the administrators in the AppInstance.

list_app_instance_bots(client, app_instance_arn, max_results \\ nil, next_token \\ nil, options \\ [])

Lists all AppInstanceBots created under a single AppInstance.

list_app_instance_user_endpoints(client, app_instance_user_arn, max_results \\ nil, next_token \\ nil, options \\ [])

Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.

list_app_instance_users(client, app_instance_arn, max_results \\ nil, next_token \\ nil, options \\ [])

List all AppInstanceUsers created under a single AppInstance.

list_app_instances(client, max_results \\ nil, next_token \\ nil, options \\ [])

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

list_tags_for_resource(client, resource_arn, options \\ [])

Lists the tags applied to an Amazon Chime SDK identity resource.

metadata()
put_app_instance_retention_settings(client, app_instance_arn, input, options \\ [])

Sets the amount of time in days that a given AppInstance retains data.

put_app_instance_user_expiration_settings(client, app_instance_user_arn, input, options \\ [])

Sets the number of days before the AppInstanceUser is automatically deleted.

register_app_instance_user_endpoint(client, app_instance_user_arn, input, options \\ [])

Registers an endpoint under an Amazon Chime AppInstanceUser.

tag_resource(client, input, options \\ [])

Applies the specified tags to the specified Amazon Chime SDK identity resource.

untag_resource(client, input, options \\ [])

Removes the specified tags from the specified Amazon Chime SDK identity resource.

update_app_instance(client, app_instance_arn, input, options \\ [])

Updates AppInstance metadata.

update_app_instance_bot(client, app_instance_bot_arn, input, options \\ [])

Updates the name and metadata of an AppInstanceBot.

update_app_instance_user(client, app_instance_user_arn, input, options \\ [])

Updates the details of an AppInstanceUser.

update_app_instance_user_endpoint(client, app_instance_user_arn, endpoint_id, input, options \\ [])

Updates the details of an AppInstanceUserEndpoint.

Functions

Link to this function

create_app_instance(client, input, options \\ [])

View Source

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

Link to this function

create_app_instance_admin(client, app_instance_arn, input, options \\ [])

View Source

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.

Link to this function

create_app_instance_bot(client, input, options \\ [])

View Source

Creates a bot under an Amazon Chime AppInstance.

The request consists of a unique Configuration and Name for that bot.

Link to this function

create_app_instance_user(client, input, options \\ [])

View Source

Creates a user under an Amazon Chime AppInstance.

The request consists of a unique appInstanceUserId and Name for that user.

Link to this function

delete_app_instance(client, app_instance_arn, input, options \\ [])

View Source

Deletes an AppInstance and all associated data asynchronously.

Link to this function

delete_app_instance_admin(client, app_instance_admin_arn, app_instance_arn, input, options \\ [])

View Source

Demotes an AppInstanceAdmin to an AppInstanceUser or AppInstanceBot.

This action does not delete the user.

Link to this function

delete_app_instance_bot(client, app_instance_bot_arn, input, options \\ [])

View Source

Deletes an AppInstanceBot.

Link to this function

delete_app_instance_user(client, app_instance_user_arn, input, options \\ [])

View Source

Deletes an AppInstanceUser.

Link to this function

deregister_app_instance_user_endpoint(client, app_instance_user_arn, endpoint_id, input, options \\ [])

View Source

Deregisters an AppInstanceUserEndpoint.

Link to this function

describe_app_instance(client, app_instance_arn, options \\ [])

View Source

Returns the full details of an AppInstance.

Link to this function

describe_app_instance_admin(client, app_instance_admin_arn, app_instance_arn, options \\ [])

View Source

Returns the full details of an AppInstanceAdmin.

Link to this function

describe_app_instance_bot(client, app_instance_bot_arn, options \\ [])

View Source

The AppInstanceBot's information.

Link to this function

describe_app_instance_user(client, app_instance_user_arn, options \\ [])

View Source

Returns the full details of an AppInstanceUser.

Link to this function

describe_app_instance_user_endpoint(client, app_instance_user_arn, endpoint_id, options \\ [])

View Source

Returns the full details of an AppInstanceUserEndpoint.

Link to this function

get_app_instance_retention_settings(client, app_instance_arn, options \\ [])

View Source

Gets the retention settings for an AppInstance.

Link to this function

list_app_instance_admins(client, app_instance_arn, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of the administrators in the AppInstance.

Link to this function

list_app_instance_bots(client, app_instance_arn, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists all AppInstanceBots created under a single AppInstance.

Link to this function

list_app_instance_user_endpoints(client, app_instance_user_arn, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.

Link to this function

list_app_instance_users(client, app_instance_arn, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

List all AppInstanceUsers created under a single AppInstance.

Link to this function

list_app_instances(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Lists the tags applied to an Amazon Chime SDK identity resource.

Link to this function

metadata()

View Source
Link to this function

put_app_instance_retention_settings(client, app_instance_arn, input, options \\ [])

View Source

Sets the amount of time in days that a given AppInstance retains data.

Link to this function

put_app_instance_user_expiration_settings(client, app_instance_user_arn, input, options \\ [])

View Source

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.

Link to this function

register_app_instance_user_endpoint(client, app_instance_user_arn, input, options \\ [])

View Source

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.

Link to this function

tag_resource(client, input, options \\ [])

View Source

Applies the specified tags to the specified Amazon Chime SDK identity resource.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Removes the specified tags from the specified Amazon Chime SDK identity resource.

Link to this function

update_app_instance(client, app_instance_arn, input, options \\ [])

View Source

Updates AppInstance metadata.

Link to this function

update_app_instance_bot(client, app_instance_bot_arn, input, options \\ [])

View Source

Updates the name and metadata of an AppInstanceBot.

Link to this function

update_app_instance_user(client, app_instance_user_arn, input, options \\ [])

View Source

Updates the details of an AppInstanceUser.

You can update names and metadata.

Link to this function

update_app_instance_user_endpoint(client, app_instance_user_arn, endpoint_id, input, options \\ [])

View Source

Updates the details of an AppInstanceUserEndpoint.

You can update the name and AllowMessage values.