Chime Sdk Identity
This page documents function available when using the Chime_Sdk_Identity module, created with @service Chime_Sdk_Identity.
Index
Main.Chime_Sdk_Identity.create_app_instanceMain.Chime_Sdk_Identity.create_app_instance_adminMain.Chime_Sdk_Identity.create_app_instance_userMain.Chime_Sdk_Identity.delete_app_instanceMain.Chime_Sdk_Identity.delete_app_instance_adminMain.Chime_Sdk_Identity.delete_app_instance_userMain.Chime_Sdk_Identity.describe_app_instanceMain.Chime_Sdk_Identity.describe_app_instance_adminMain.Chime_Sdk_Identity.describe_app_instance_userMain.Chime_Sdk_Identity.get_app_instance_retention_settingsMain.Chime_Sdk_Identity.list_app_instance_adminsMain.Chime_Sdk_Identity.list_app_instance_usersMain.Chime_Sdk_Identity.list_app_instancesMain.Chime_Sdk_Identity.put_app_instance_retention_settingsMain.Chime_Sdk_Identity.update_app_instanceMain.Chime_Sdk_Identity.update_app_instance_user
Documentation
Main.Chime_Sdk_Identity.create_app_instance — Methodcreate_app_instance(client_request_token, name)
create_app_instance(client_request_token, name, params::Dict{String,<:Any})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
Arguments
client_request_token: The ClientRequestToken of the AppInstance.name: The name of the AppInstance.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"Metadata": The metadata of the AppInstance. Limited to a 1KB string in UTF-8."Tags": Tags assigned to the AppInstanceUser.
Main.Chime_Sdk_Identity.create_app_instance_admin — Methodcreate_app_instance_admin(app_instance_admin_arn, app_instance_arn)
create_app_instance_admin(app_instance_admin_arn, app_instance_arn, params::Dict{String,<:Any})Promotes an AppInstanceUser to an AppInstanceAdmin. The promoted user can perform the following actions. ChannelModerator actions across all channels in the AppInstance. DeleteChannelMessage actions. Only an AppInstanceUser can be promoted to an AppInstanceAdmin role.
Arguments
app_instance_admin_arn: The ARN of the administrator of the current AppInstance.app_instance_arn: The ARN of the AppInstance.
Main.Chime_Sdk_Identity.create_app_instance_user — Methodcreate_app_instance_user(app_instance_arn, app_instance_user_id, client_request_token, name)
create_app_instance_user(app_instance_arn, app_instance_user_id, client_request_token, name, params::Dict{String,<:Any})Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and Name for that user.
Arguments
app_instance_arn: The ARN of the AppInstance request.app_instance_user_id: The user ID of the AppInstance.client_request_token: The token assigned to the user requesting an AppInstance.name: The user's name.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"Metadata": The request's metadata. Limited to a 1KB string in UTF-8."Tags": Tags assigned to the AppInstanceUser.
Main.Chime_Sdk_Identity.delete_app_instance — Methoddelete_app_instance(app_instance_arn)
delete_app_instance(app_instance_arn, params::Dict{String,<:Any})Deletes an AppInstance and all associated data asynchronously.
Arguments
app_instance_arn: The ARN of the AppInstance.
Main.Chime_Sdk_Identity.delete_app_instance_admin — Methoddelete_app_instance_admin(app_instance_admin_arn, app_instance_arn)
delete_app_instance_admin(app_instance_admin_arn, app_instance_arn, params::Dict{String,<:Any})Demotes an AppInstanceAdmin to an AppInstanceUser. This action does not delete the user.
Arguments
app_instance_admin_arn: The ARN of the AppInstance's administrator.app_instance_arn: The ARN of the AppInstance.
Main.Chime_Sdk_Identity.delete_app_instance_user — Methoddelete_app_instance_user(app_instance_user_arn)
delete_app_instance_user(app_instance_user_arn, params::Dict{String,<:Any})Deletes an AppInstanceUser.
Arguments
app_instance_user_arn: The ARN of the user request being deleted.
Main.Chime_Sdk_Identity.describe_app_instance — Methoddescribe_app_instance(app_instance_arn)
describe_app_instance(app_instance_arn, params::Dict{String,<:Any})Returns the full details of an AppInstance.
Arguments
app_instance_arn: The ARN of the AppInstance.
Main.Chime_Sdk_Identity.describe_app_instance_admin — Methoddescribe_app_instance_admin(app_instance_admin_arn, app_instance_arn)
describe_app_instance_admin(app_instance_admin_arn, app_instance_arn, params::Dict{String,<:Any})Returns the full details of an AppInstanceAdmin.
Arguments
app_instance_admin_arn: The ARN of the AppInstanceAdmin.app_instance_arn: The ARN of the AppInstance.
Main.Chime_Sdk_Identity.describe_app_instance_user — Methoddescribe_app_instance_user(app_instance_user_arn)
describe_app_instance_user(app_instance_user_arn, params::Dict{String,<:Any})Returns the full details of an AppInstanceUser.
Arguments
app_instance_user_arn: The ARN of the AppInstanceUser.
Main.Chime_Sdk_Identity.get_app_instance_retention_settings — Methodget_app_instance_retention_settings(app_instance_arn)
get_app_instance_retention_settings(app_instance_arn, params::Dict{String,<:Any})Gets the retention settings for an AppInstance.
Arguments
app_instance_arn: The ARN of the AppInstance.
Main.Chime_Sdk_Identity.list_app_instance_admins — Methodlist_app_instance_admins(app_instance_arn)
list_app_instance_admins(app_instance_arn, params::Dict{String,<:Any})Returns a list of the administrators in the AppInstance.
Arguments
app_instance_arn: The ARN of the AppInstance.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"max-results": The maximum number of administrators that you want to return."next-token": The token returned from previous API requests until the number of administrators is reached.
Main.Chime_Sdk_Identity.list_app_instance_users — Methodlist_app_instance_users(app-instance-arn)
list_app_instance_users(app-instance-arn, params::Dict{String,<:Any})List all AppInstanceUsers created under a single AppInstance.
Arguments
app-instance-arn: The ARN of the AppInstance.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"max-results": The maximum number of requests that you want returned."next-token": The token passed by previous API calls until all requested users are returned.
Main.Chime_Sdk_Identity.list_app_instances — Methodlist_app_instances()
list_app_instances(params::Dict{String,<:Any})Lists all Amazon Chime AppInstances created under a single AWS account.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"max-results": The maximum number of AppInstances that you want to return."next-token": The token passed by previous API requests until you reach the maximum number of AppInstances.
Main.Chime_Sdk_Identity.put_app_instance_retention_settings — Methodput_app_instance_retention_settings(app_instance_retention_settings, app_instance_arn)
put_app_instance_retention_settings(app_instance_retention_settings, app_instance_arn, params::Dict{String,<:Any})Sets the amount of time in days that a given AppInstance retains data.
Arguments
app_instance_retention_settings: The time in days to retain data. Data type: number.app_instance_arn: The ARN of the AppInstance.
Main.Chime_Sdk_Identity.update_app_instance — Methodupdate_app_instance(metadata, name, app_instance_arn)
update_app_instance(metadata, name, app_instance_arn, params::Dict{String,<:Any})Updates AppInstance metadata.
Arguments
metadata: The metadata that you want to change.name: The name that you want to change.app_instance_arn: The ARN of the AppInstance.
Main.Chime_Sdk_Identity.update_app_instance_user — Methodupdate_app_instance_user(metadata, name, app_instance_user_arn)
update_app_instance_user(metadata, name, app_instance_user_arn, params::Dict{String,<:Any})Updates the details of an AppInstanceUser. You can update names and metadata.
Arguments
metadata: The metadata of the AppInstanceUser.name: The name of the AppInstanceUser.app_instance_user_arn: The ARN of the AppInstanceUser.