Class: Aws::ChimeSDKIdentity::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ChimeSDKIdentity::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb
Overview
An API client for ChimeSDKIdentity. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::ChimeSDKIdentity::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_app_instance(params = {}) ⇒ Types::CreateAppInstanceResponse
Creates an Amazon Chime SDK messaging
AppInstance
under an AWS account. -
#create_app_instance_admin(params = {}) ⇒ Types::CreateAppInstanceAdminResponse
Promotes an
AppInstanceUser
orAppInstanceBot
to anAppInstanceAdmin
. -
#create_app_instance_bot(params = {}) ⇒ Types::CreateAppInstanceBotResponse
Creates a bot under an Amazon Chime
AppInstance
. -
#create_app_instance_user(params = {}) ⇒ Types::CreateAppInstanceUserResponse
Creates a user under an Amazon Chime
AppInstance
. -
#delete_app_instance(params = {}) ⇒ Struct
Deletes an
AppInstance
and all associated data asynchronously. -
#delete_app_instance_admin(params = {}) ⇒ Struct
Demotes an
AppInstanceAdmin
to anAppInstanceUser
orAppInstanceBot
. -
#delete_app_instance_bot(params = {}) ⇒ Struct
Deletes an
AppInstanceBot
. -
#delete_app_instance_user(params = {}) ⇒ Struct
Deletes an
AppInstanceUser
. -
#deregister_app_instance_user_endpoint(params = {}) ⇒ Struct
Deregisters an
AppInstanceUserEndpoint
. -
#describe_app_instance(params = {}) ⇒ Types::DescribeAppInstanceResponse
Returns the full details of an
AppInstance
. -
#describe_app_instance_admin(params = {}) ⇒ Types::DescribeAppInstanceAdminResponse
Returns the full details of an
AppInstanceAdmin
. -
#describe_app_instance_bot(params = {}) ⇒ Types::DescribeAppInstanceBotResponse
The
AppInstanceBot's
information. -
#describe_app_instance_user(params = {}) ⇒ Types::DescribeAppInstanceUserResponse
Returns the full details of an
AppInstanceUser
. -
#describe_app_instance_user_endpoint(params = {}) ⇒ Types::DescribeAppInstanceUserEndpointResponse
Returns the full details of an
AppInstanceUserEndpoint
. -
#get_app_instance_retention_settings(params = {}) ⇒ Types::GetAppInstanceRetentionSettingsResponse
Gets the retention settings for an
AppInstance
. -
#list_app_instance_admins(params = {}) ⇒ Types::ListAppInstanceAdminsResponse
Returns a list of the administrators in the
AppInstance
. -
#list_app_instance_bots(params = {}) ⇒ Types::ListAppInstanceBotsResponse
Lists all
AppInstanceBots
created under a singleAppInstance
. -
#list_app_instance_user_endpoints(params = {}) ⇒ Types::ListAppInstanceUserEndpointsResponse
Lists all the
AppInstanceUserEndpoints
created under a singleAppInstanceUser
. -
#list_app_instance_users(params = {}) ⇒ Types::ListAppInstanceUsersResponse
List all
AppInstanceUsers
created under a singleAppInstance
. -
#list_app_instances(params = {}) ⇒ Types::ListAppInstancesResponse
Lists all Amazon Chime
AppInstance
s created under a single AWS account. -
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags applied to an Amazon Chime SDK identity resource.
-
#put_app_instance_retention_settings(params = {}) ⇒ Types::PutAppInstanceRetentionSettingsResponse
Sets the amount of time in days that a given
AppInstance
retains data. -
#put_app_instance_user_expiration_settings(params = {}) ⇒ Types::PutAppInstanceUserExpirationSettingsResponse
Sets the number of days before the
AppInstanceUser
is automatically deleted. -
#register_app_instance_user_endpoint(params = {}) ⇒ Types::RegisterAppInstanceUserEndpointResponse
Registers an endpoint under an Amazon Chime
AppInstanceUser
. -
#tag_resource(params = {}) ⇒ Struct
Applies the specified tags to the specified Amazon Chime SDK identity resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags from the specified Amazon Chime SDK identity resource.
-
#update_app_instance(params = {}) ⇒ Types::UpdateAppInstanceResponse
Updates
AppInstance
metadata. -
#update_app_instance_bot(params = {}) ⇒ Types::UpdateAppInstanceBotResponse
Updates the name and metadata of an
AppInstanceBot
. -
#update_app_instance_user(params = {}) ⇒ Types::UpdateAppInstanceUserResponse
Updates the details of an
AppInstanceUser
. -
#update_app_instance_user_endpoint(params = {}) ⇒ Types::UpdateAppInstanceUserEndpointResponse
Updates the details of an
AppInstanceUserEndpoint
.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from Aws::ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
385 386 387 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 385 def initialize(*args) super end |
Instance Method Details
#create_app_instance(params = {}) ⇒ Types::CreateAppInstanceResponse
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
440 441 442 443 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 440 def create_app_instance(params = {}, = {}) req = build_request(:create_app_instance, params) req.send_request() end |
#create_app_instance_admin(params = {}) ⇒ Types::CreateAppInstanceAdminResponse
Promotes an AppInstanceUser
or AppInstanceBot
to an
AppInstanceAdmin
. The promoted entity can perform the following
actions.
ChannelModerator
actions across all channels in theAppInstance
.DeleteChannelMessage
actions.
Only an AppInstanceUser
and AppInstanceBot
can be promoted to an
AppInstanceAdmin
role.
484 485 486 487 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 484 def create_app_instance_admin(params = {}, = {}) req = build_request(:create_app_instance_admin, params) req.send_request() end |
#create_app_instance_bot(params = {}) ⇒ Types::CreateAppInstanceBotResponse
Creates a bot under an Amazon Chime AppInstance
. The request
consists of a unique Configuration
and Name
for that bot.
553 554 555 556 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 553 def create_app_instance_bot(params = {}, = {}) req = build_request(:create_app_instance_bot, params) req.send_request() end |
#create_app_instance_user(params = {}) ⇒ Types::CreateAppInstanceUserResponse
Creates a user under an Amazon Chime AppInstance
. The request
consists of a unique appInstanceUserId
and Name
for that user.
619 620 621 622 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 619 def create_app_instance_user(params = {}, = {}) req = build_request(:create_app_instance_user, params) req.send_request() end |
#delete_app_instance(params = {}) ⇒ Struct
Deletes an AppInstance
and all associated data asynchronously.
641 642 643 644 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 641 def delete_app_instance(params = {}, = {}) req = build_request(:delete_app_instance, params) req.send_request() end |
#delete_app_instance_admin(params = {}) ⇒ Struct
Demotes an AppInstanceAdmin
to an AppInstanceUser
or
AppInstanceBot
. This action does not delete the user.
668 669 670 671 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 668 def delete_app_instance_admin(params = {}, = {}) req = build_request(:delete_app_instance_admin, params) req.send_request() end |
#delete_app_instance_bot(params = {}) ⇒ Struct
Deletes an AppInstanceBot
.
690 691 692 693 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 690 def delete_app_instance_bot(params = {}, = {}) req = build_request(:delete_app_instance_bot, params) req.send_request() end |
#delete_app_instance_user(params = {}) ⇒ Struct
Deletes an AppInstanceUser
.
712 713 714 715 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 712 def delete_app_instance_user(params = {}, = {}) req = build_request(:delete_app_instance_user, params) req.send_request() end |
#deregister_app_instance_user_endpoint(params = {}) ⇒ Struct
Deregisters an AppInstanceUserEndpoint
.
738 739 740 741 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 738 def deregister_app_instance_user_endpoint(params = {}, = {}) req = build_request(:deregister_app_instance_user_endpoint, params) req.send_request() end |
#describe_app_instance(params = {}) ⇒ Types::DescribeAppInstanceResponse
Returns the full details of an AppInstance
.
770 771 772 773 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 770 def describe_app_instance(params = {}, = {}) req = build_request(:describe_app_instance, params) req.send_request() end |
#describe_app_instance_admin(params = {}) ⇒ Types::DescribeAppInstanceAdminResponse
Returns the full details of an AppInstanceAdmin
.
805 806 807 808 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 805 def describe_app_instance_admin(params = {}, = {}) req = build_request(:describe_app_instance_admin, params) req.send_request() end |
#describe_app_instance_bot(params = {}) ⇒ Types::DescribeAppInstanceBotResponse
The AppInstanceBot's
information.
843 844 845 846 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 843 def describe_app_instance_bot(params = {}, = {}) req = build_request(:describe_app_instance_bot, params) req.send_request() end |
#describe_app_instance_user(params = {}) ⇒ Types::DescribeAppInstanceUserResponse
Returns the full details of an AppInstanceUser
.
877 878 879 880 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 877 def describe_app_instance_user(params = {}, = {}) req = build_request(:describe_app_instance_user, params) req.send_request() end |
#describe_app_instance_user_endpoint(params = {}) ⇒ Types::DescribeAppInstanceUserEndpointResponse
Returns the full details of an AppInstanceUserEndpoint
.
920 921 922 923 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 920 def describe_app_instance_user_endpoint(params = {}, = {}) req = build_request(:describe_app_instance_user_endpoint, params) req.send_request() end |
#get_app_instance_retention_settings(params = {}) ⇒ Types::GetAppInstanceRetentionSettingsResponse
Gets the retention settings for an AppInstance
.
950 951 952 953 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 950 def get_app_instance_retention_settings(params = {}, = {}) req = build_request(:get_app_instance_retention_settings, params) req.send_request() end |
#list_app_instance_admins(params = {}) ⇒ Types::ListAppInstanceAdminsResponse
Returns a list of the administrators in the AppInstance
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
995 996 997 998 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 995 def list_app_instance_admins(params = {}, = {}) req = build_request(:list_app_instance_admins, params) req.send_request() end |
#list_app_instance_bots(params = {}) ⇒ Types::ListAppInstanceBotsResponse
Lists all AppInstanceBots
created under a single AppInstance
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1041 1042 1043 1044 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1041 def list_app_instance_bots(params = {}, = {}) req = build_request(:list_app_instance_bots, params) req.send_request() end |
#list_app_instance_user_endpoints(params = {}) ⇒ Types::ListAppInstanceUserEndpointsResponse
Lists all the AppInstanceUserEndpoints
created under a single
AppInstanceUser
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1090 1091 1092 1093 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1090 def list_app_instance_user_endpoints(params = {}, = {}) req = build_request(:list_app_instance_user_endpoints, params) req.send_request() end |
#list_app_instance_users(params = {}) ⇒ Types::ListAppInstanceUsersResponse
List all AppInstanceUsers
created under a single AppInstance
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1136 1137 1138 1139 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1136 def list_app_instance_users(params = {}, = {}) req = build_request(:list_app_instance_users, params) req.send_request() end |
#list_app_instances(params = {}) ⇒ Types::ListAppInstancesResponse
Lists all Amazon Chime AppInstance
s created under a single AWS
account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1177 1178 1179 1180 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1177 def list_app_instances(params = {}, = {}) req = build_request(:list_app_instances, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags applied to an Amazon Chime SDK identity resource.
1207 1208 1209 1210 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1207 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_app_instance_retention_settings(params = {}) ⇒ Types::PutAppInstanceRetentionSettingsResponse
Sets the amount of time in days that a given AppInstance
retains
data.
1246 1247 1248 1249 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1246 def put_app_instance_retention_settings(params = {}, = {}) req = build_request(:put_app_instance_retention_settings, params) req.send_request() end |
#put_app_instance_user_expiration_settings(params = {}) ⇒ Types::PutAppInstanceUserExpirationSettingsResponse
Sets the number of days before the AppInstanceUser
is automatically
deleted.
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.
1295 1296 1297 1298 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1295 def put_app_instance_user_expiration_settings(params = {}, = {}) req = build_request(:put_app_instance_user_expiration_settings, params) req.send_request() end |
#register_app_instance_user_endpoint(params = {}) ⇒ Types::RegisterAppInstanceUserEndpointResponse
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.
1370 1371 1372 1373 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1370 def register_app_instance_user_endpoint(params = {}, = {}) req = build_request(:register_app_instance_user_endpoint, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Applies the specified tags to the specified Amazon Chime SDK identity resource.
1402 1403 1404 1405 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1402 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags from the specified Amazon Chime SDK identity resource.
1429 1430 1431 1432 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1429 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_app_instance(params = {}) ⇒ Types::UpdateAppInstanceResponse
Updates AppInstance
metadata.
1465 1466 1467 1468 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1465 def update_app_instance(params = {}, = {}) req = build_request(:update_app_instance, params) req.send_request() end |
#update_app_instance_bot(params = {}) ⇒ Types::UpdateAppInstanceBotResponse
Updates the name and metadata of an AppInstanceBot
.
1516 1517 1518 1519 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1516 def update_app_instance_bot(params = {}, = {}) req = build_request(:update_app_instance_bot, params) req.send_request() end |
#update_app_instance_user(params = {}) ⇒ Types::UpdateAppInstanceUserResponse
Updates the details of an AppInstanceUser
. You can update names and
metadata.
1553 1554 1555 1556 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1553 def update_app_instance_user(params = {}, = {}) req = build_request(:update_app_instance_user, params) req.send_request() end |
#update_app_instance_user_endpoint(params = {}) ⇒ Types::UpdateAppInstanceUserEndpointResponse
Updates the details of an AppInstanceUserEndpoint
. You can update
the name and AllowMessage
values.
1598 1599 1600 1601 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1598 def update_app_instance_user_endpoint(params = {}, = {}) req = build_request(:update_app_instance_user_endpoint, params) req.send_request() end |