aws v0.5.0

View Source aws_chime_sdk_identity (aws v0.5.0)

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

create_app_instance(Client, Input)

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

create_app_instance(Client, Input0, Options0)
create_app_instance_admin(Client, AppInstanceArn, Input)

Promotes an AppInstanceUser to an AppInstanceAdmin.

create_app_instance_admin(Client, AppInstanceArn, Input0, Options0)
create_app_instance_user(Client, Input)

Creates a user under an Amazon Chime AppInstance.

create_app_instance_user(Client, Input0, Options0)
delete_app_instance(Client, AppInstanceArn, Input)
Deletes an AppInstance and all associated data asynchronously.
delete_app_instance(Client, AppInstanceArn, Input0, Options0)
delete_app_instance_admin(Client, AppInstanceAdminArn, AppInstanceArn, Input)

Demotes an AppInstanceAdmin to an AppInstanceUser.

delete_app_instance_admin(Client, AppInstanceAdminArn, AppInstanceArn, Input0, Options0)
delete_app_instance_user(Client, AppInstanceUserArn, Input)
Deletes an AppInstanceUser.
delete_app_instance_user(Client, AppInstanceUserArn, Input0, Options0)
deregister_app_instance_user_endpoint(Client, AppInstanceUserArn, EndpointId, Input)
Deregisters an AppInstanceUserEndpoint.
deregister_app_instance_user_endpoint(Client, AppInstanceUserArn, EndpointId, Input0, Options0)
describe_app_instance(Client, AppInstanceArn)
Returns the full details of an AppInstance.
describe_app_instance(Client, AppInstanceArn, QueryMap, HeadersMap)
describe_app_instance(Client, AppInstanceArn, QueryMap, HeadersMap, Options0)
describe_app_instance_admin(Client, AppInstanceAdminArn, AppInstanceArn)
Returns the full details of an AppInstanceAdmin.
describe_app_instance_admin(Client, AppInstanceAdminArn, AppInstanceArn, QueryMap, HeadersMap)
describe_app_instance_admin(Client, AppInstanceAdminArn, AppInstanceArn, QueryMap, HeadersMap, Options0)
describe_app_instance_user(Client, AppInstanceUserArn)
Returns the full details of an AppInstanceUser.
describe_app_instance_user(Client, AppInstanceUserArn, QueryMap, HeadersMap)
describe_app_instance_user(Client, AppInstanceUserArn, QueryMap, HeadersMap, Options0)
describe_app_instance_user_endpoint(Client, AppInstanceUserArn, EndpointId)
Returns the full details of an AppInstanceUserEndpoint.
describe_app_instance_user_endpoint(Client, AppInstanceUserArn, EndpointId, QueryMap, HeadersMap)
describe_app_instance_user_endpoint(Client, AppInstanceUserArn, EndpointId, QueryMap, HeadersMap, Options0)
get_app_instance_retention_settings(Client, AppInstanceArn)
Gets the retention settings for an AppInstance.
get_app_instance_retention_settings(Client, AppInstanceArn, QueryMap, HeadersMap)
get_app_instance_retention_settings(Client, AppInstanceArn, QueryMap, HeadersMap, Options0)
list_app_instance_admins(Client, AppInstanceArn)
Returns a list of the administrators in the AppInstance.
list_app_instance_admins(Client, AppInstanceArn, QueryMap, HeadersMap)
list_app_instance_admins(Client, AppInstanceArn, QueryMap, HeadersMap, Options0)
list_app_instance_user_endpoints(Client, AppInstanceUserArn)
Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.
list_app_instance_user_endpoints(Client, AppInstanceUserArn, QueryMap, HeadersMap)
list_app_instance_user_endpoints(Client, AppInstanceUserArn, QueryMap, HeadersMap, Options0)
list_app_instance_users(Client, AppInstanceArn)
List all AppInstanceUsers created under a single AppInstance.
list_app_instance_users(Client, AppInstanceArn, QueryMap, HeadersMap)
list_app_instance_users(Client, AppInstanceArn, QueryMap, HeadersMap, Options0)
list_app_instances(Client)
Lists all Amazon Chime AppInstances created under a single AWS account.
list_app_instances(Client, QueryMap, HeadersMap)
list_app_instances(Client, QueryMap, HeadersMap, Options0)
list_tags_for_resource(Client, ResourceARN)
Lists the tags applied to an Amazon Chime SDK identity resource.
list_tags_for_resource(Client, ResourceARN, QueryMap, HeadersMap)
list_tags_for_resource(Client, ResourceARN, QueryMap, HeadersMap, Options0)
put_app_instance_retention_settings(Client, AppInstanceArn, Input)
Sets the amount of time in days that a given AppInstance retains data.
put_app_instance_retention_settings(Client, AppInstanceArn, Input0, Options0)
register_app_instance_user_endpoint(Client, AppInstanceUserArn, Input)

Registers an endpoint under an Amazon Chime AppInstanceUser.

register_app_instance_user_endpoint(Client, AppInstanceUserArn, Input0, Options0)
tag_resource(Client, Input)
Applies the specified tags to the specified Amazon Chime SDK identity resource.
tag_resource(Client, Input0, Options0)
untag_resource(Client, Input)
Removes the specified tags from the specified Amazon Chime SDK identity resource.
untag_resource(Client, Input0, Options0)
update_app_instance(Client, AppInstanceArn, Input)
Updates AppInstance metadata.
update_app_instance(Client, AppInstanceArn, Input0, Options0)
update_app_instance_user(Client, AppInstanceUserArn, Input)

Updates the details of an AppInstanceUser.

update_app_instance_user(Client, AppInstanceUserArn, Input0, Options0)
update_app_instance_user_endpoint(Client, AppInstanceUserArn, EndpointId, Input)

Updates the details of an AppInstanceUserEndpoint.

update_app_instance_user_endpoint(Client, AppInstanceUserArn, EndpointId, Input0, Options0)

Link to this section Functions

Link to this function

create_app_instance(Client, Input)

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(Client, Input0, Options0)

View Source
Link to this function

create_app_instance_admin(Client, AppInstanceArn, Input)

View Source

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.
Link to this function

create_app_instance_admin(Client, AppInstanceArn, Input0, Options0)

View Source
Link to this function

create_app_instance_user(Client, Input)

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

create_app_instance_user(Client, Input0, Options0)

View Source
Link to this function

delete_app_instance(Client, AppInstanceArn, Input)

View Source
Deletes an AppInstance and all associated data asynchronously.
Link to this function

delete_app_instance(Client, AppInstanceArn, Input0, Options0)

View Source
Link to this function

delete_app_instance_admin(Client, AppInstanceAdminArn, AppInstanceArn, Input)

View Source

Demotes an AppInstanceAdmin to an AppInstanceUser.

This action does not delete the user.
Link to this function

delete_app_instance_admin(Client, AppInstanceAdminArn, AppInstanceArn, Input0, Options0)

View Source
Link to this function

delete_app_instance_user(Client, AppInstanceUserArn, Input)

View Source
Deletes an AppInstanceUser.
Link to this function

delete_app_instance_user(Client, AppInstanceUserArn, Input0, Options0)

View Source
Link to this function

deregister_app_instance_user_endpoint(Client, AppInstanceUserArn, EndpointId, Input)

View Source
Deregisters an AppInstanceUserEndpoint.
Link to this function

deregister_app_instance_user_endpoint(Client, AppInstanceUserArn, EndpointId, Input0, Options0)

View Source
Link to this function

describe_app_instance(Client, AppInstanceArn)

View Source
Returns the full details of an AppInstance.
Link to this function

describe_app_instance(Client, AppInstanceArn, QueryMap, HeadersMap)

View Source
Link to this function

describe_app_instance(Client, AppInstanceArn, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_app_instance_admin(Client, AppInstanceAdminArn, AppInstanceArn)

View Source
Returns the full details of an AppInstanceAdmin.
Link to this function

describe_app_instance_admin(Client, AppInstanceAdminArn, AppInstanceArn, QueryMap, HeadersMap)

View Source
Link to this function

describe_app_instance_admin(Client, AppInstanceAdminArn, AppInstanceArn, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_app_instance_user(Client, AppInstanceUserArn)

View Source
Returns the full details of an AppInstanceUser.
Link to this function

describe_app_instance_user(Client, AppInstanceUserArn, QueryMap, HeadersMap)

View Source
Link to this function

describe_app_instance_user(Client, AppInstanceUserArn, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_app_instance_user_endpoint(Client, AppInstanceUserArn, EndpointId)

View Source
Returns the full details of an AppInstanceUserEndpoint.
Link to this function

describe_app_instance_user_endpoint(Client, AppInstanceUserArn, EndpointId, QueryMap, HeadersMap)

View Source
Link to this function

describe_app_instance_user_endpoint(Client, AppInstanceUserArn, EndpointId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_app_instance_retention_settings(Client, AppInstanceArn)

View Source
Gets the retention settings for an AppInstance.
Link to this function

get_app_instance_retention_settings(Client, AppInstanceArn, QueryMap, HeadersMap)

View Source
Link to this function

get_app_instance_retention_settings(Client, AppInstanceArn, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_app_instance_admins(Client, AppInstanceArn)

View Source
Returns a list of the administrators in the AppInstance.
Link to this function

list_app_instance_admins(Client, AppInstanceArn, QueryMap, HeadersMap)

View Source
Link to this function

list_app_instance_admins(Client, AppInstanceArn, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_app_instance_user_endpoints(Client, AppInstanceUserArn)

View Source
Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.
Link to this function

list_app_instance_user_endpoints(Client, AppInstanceUserArn, QueryMap, HeadersMap)

View Source
Link to this function

list_app_instance_user_endpoints(Client, AppInstanceUserArn, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_app_instance_users(Client, AppInstanceArn)

View Source
List all AppInstanceUsers created under a single AppInstance.
Link to this function

list_app_instance_users(Client, AppInstanceArn, QueryMap, HeadersMap)

View Source
Link to this function

list_app_instance_users(Client, AppInstanceArn, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_app_instances(Client)

View Source
Lists all Amazon Chime AppInstances created under a single AWS account.
Link to this function

list_app_instances(Client, QueryMap, HeadersMap)

View Source
Link to this function

list_app_instances(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_tags_for_resource(Client, ResourceARN)

View Source
Lists the tags applied to an Amazon Chime SDK identity resource.
Link to this function

list_tags_for_resource(Client, ResourceARN, QueryMap, HeadersMap)

View Source
Link to this function

list_tags_for_resource(Client, ResourceARN, QueryMap, HeadersMap, Options0)

View Source
Link to this function

put_app_instance_retention_settings(Client, AppInstanceArn, Input)

View Source
Sets the amount of time in days that a given AppInstance retains data.
Link to this function

put_app_instance_retention_settings(Client, AppInstanceArn, Input0, Options0)

View Source
Link to this function

register_app_instance_user_endpoint(Client, AppInstanceUserArn, Input)

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

register_app_instance_user_endpoint(Client, AppInstanceUserArn, Input0, Options0)

View Source
Link to this function

tag_resource(Client, Input)

View Source
Applies the specified tags to the specified Amazon Chime SDK identity resource.
Link to this function

tag_resource(Client, Input0, Options0)

View Source
Link to this function

untag_resource(Client, Input)

View Source
Removes the specified tags from the specified Amazon Chime SDK identity resource.
Link to this function

untag_resource(Client, Input0, Options0)

View Source
Link to this function

update_app_instance(Client, AppInstanceArn, Input)

View Source
Updates AppInstance metadata.
Link to this function

update_app_instance(Client, AppInstanceArn, Input0, Options0)

View Source
Link to this function

update_app_instance_user(Client, AppInstanceUserArn, Input)

View Source

Updates the details of an AppInstanceUser.

You can update names and metadata.
Link to this function

update_app_instance_user(Client, AppInstanceUserArn, Input0, Options0)

View Source
Link to this function

update_app_instance_user_endpoint(Client, AppInstanceUserArn, EndpointId, Input)

View Source

Updates the details of an AppInstanceUserEndpoint.

You can update the name and AllowMessage values.
Link to this function

update_app_instance_user_endpoint(Client, AppInstanceUserArn, EndpointId, Input0, Options0)

View Source