View Source aws_chime_sdk_identity (aws v0.7.15)
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
.
AppInstance
and all associated data asynchronously.Demotes an AppInstanceAdmin
to an AppInstanceUser
.
AppInstanceUser
.AppInstanceUserEndpoint
.AppInstance
.AppInstanceAdmin
.AppInstanceUser
.AppInstanceUserEndpoint
.AppInstance
.AppInstance
.AppInstanceUserEndpoints
created under a single AppInstanceUser
.AppInstanceUsers
created under a single AppInstance
.AppInstance
s created under a single AWS account.AppInstance
retains data.Registers an endpoint under an Amazon Chime AppInstanceUser
.
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.
Promotes an AppInstanceUser
to an AppInstanceAdmin
.
The promoted user can perform the following actions.
ChannelModerator
actions across all channels in theAppInstance
.DeleteChannelMessage
actions.
AppInstanceUser
can be promoted to an AppInstanceAdmin
role.
create_app_instance_admin(Client, AppInstanceArn, Input0, Options0)
View SourceCreates a user under an Amazon Chime AppInstance
.
appInstanceUserId
and Name
for that user.
AppInstance
and all associated data asynchronously.
delete_app_instance_admin(Client, AppInstanceAdminArn, AppInstanceArn, Input)
View SourceDemotes an AppInstanceAdmin
to an AppInstanceUser
.
delete_app_instance_admin(Client, AppInstanceAdminArn, AppInstanceArn, Input0, Options0)
View SourceAppInstanceUser
.
delete_app_instance_user(Client, AppInstanceUserArn, Input0, Options0)
View Sourcederegister_app_instance_user_endpoint(Client, AppInstanceUserArn, EndpointId, Input)
View SourceAppInstanceUserEndpoint
.
deregister_app_instance_user_endpoint(Client, AppInstanceUserArn, EndpointId, Input0, Options0)
View SourceAppInstance
.
describe_app_instance(Client, AppInstanceArn, QueryMap, HeadersMap)
View Sourcedescribe_app_instance(Client, AppInstanceArn, QueryMap, HeadersMap, Options0)
View Sourcedescribe_app_instance_admin(Client, AppInstanceAdminArn, AppInstanceArn)
View SourceAppInstanceAdmin
.
describe_app_instance_admin(Client, AppInstanceAdminArn, AppInstanceArn, QueryMap, HeadersMap)
View Sourcedescribe_app_instance_admin(Client, AppInstanceAdminArn, AppInstanceArn, QueryMap, HeadersMap, Options0)
View SourceAppInstanceUser
.
describe_app_instance_user(Client, AppInstanceUserArn, QueryMap, HeadersMap)
View Sourcedescribe_app_instance_user(Client, AppInstanceUserArn, QueryMap, HeadersMap, Options0)
View Sourcedescribe_app_instance_user_endpoint(Client, AppInstanceUserArn, EndpointId)
View SourceAppInstanceUserEndpoint
.
describe_app_instance_user_endpoint(Client, AppInstanceUserArn, EndpointId, QueryMap, HeadersMap)
View Sourcedescribe_app_instance_user_endpoint(Client, AppInstanceUserArn, EndpointId, QueryMap, HeadersMap, Options0)
View SourceAppInstance
.
get_app_instance_retention_settings(Client, AppInstanceArn, QueryMap, HeadersMap)
View Sourceget_app_instance_retention_settings(Client, AppInstanceArn, QueryMap, HeadersMap, Options0)
View SourceAppInstance
.
list_app_instance_admins(Client, AppInstanceArn, QueryMap, HeadersMap)
View Sourcelist_app_instance_admins(Client, AppInstanceArn, QueryMap, HeadersMap, Options0)
View SourceAppInstanceUserEndpoints
created under a single AppInstanceUser
.
list_app_instance_user_endpoints(Client, AppInstanceUserArn, QueryMap, HeadersMap)
View Sourcelist_app_instance_user_endpoints(Client, AppInstanceUserArn, QueryMap, HeadersMap, Options0)
View SourceAppInstanceUsers
created under a single AppInstance
.
list_app_instance_users(Client, AppInstanceArn, QueryMap, HeadersMap)
View Sourcelist_app_instance_users(Client, AppInstanceArn, QueryMap, HeadersMap, Options0)
View SourceAppInstance
s created under a single AWS account.
list_tags_for_resource(Client, ResourceARN, QueryMap, HeadersMap, Options0)
View Sourceput_app_instance_retention_settings(Client, AppInstanceArn, Input)
View SourceAppInstance
retains data.
put_app_instance_retention_settings(Client, AppInstanceArn, Input0, Options0)
View Sourceregister_app_instance_user_endpoint(Client, AppInstanceUserArn, Input)
View SourceRegisters an endpoint under an Amazon Chime AppInstanceUser
.
register_app_instance_user_endpoint(Client, AppInstanceUserArn, Input0, Options0)
View SourceAppInstance
metadata.
Updates the details of an AppInstanceUser
.
update_app_instance_user(Client, AppInstanceUserArn, Input0, Options0)
View Sourceupdate_app_instance_user_endpoint(Client, AppInstanceUserArn, EndpointId, Input)
View SourceUpdates the details of an AppInstanceUserEndpoint
.
AllowMessage
values.