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.
440 441 442 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 440 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
495 496 497 498 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 495 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.
539 540 541 542 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 539 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.
608 609 610 611 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 608 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.
674 675 676 677 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 674 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.
696 697 698 699 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 696 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.
723 724 725 726 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 723 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
.
745 746 747 748 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 745 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
.
767 768 769 770 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 767 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
.
793 794 795 796 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 793 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
.
825 826 827 828 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 825 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
.
860 861 862 863 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 860 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.
898 899 900 901 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 898 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
.
932 933 934 935 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 932 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
.
975 976 977 978 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 975 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
.
1005 1006 1007 1008 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1005 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.
1050 1051 1052 1053 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1050 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.
1096 1097 1098 1099 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1096 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.
1145 1146 1147 1148 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1145 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.
1191 1192 1193 1194 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1191 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.
1232 1233 1234 1235 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1232 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.
1262 1263 1264 1265 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1262 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.
1301 1302 1303 1304 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1301 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.
1350 1351 1352 1353 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1350 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.
1425 1426 1427 1428 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1425 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.
1457 1458 1459 1460 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1457 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.
1484 1485 1486 1487 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1484 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_app_instance(params = {}) ⇒ Types::UpdateAppInstanceResponse
Updates AppInstance
metadata.
1520 1521 1522 1523 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1520 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
.
1571 1572 1573 1574 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1571 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.
1608 1609 1610 1611 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1608 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.
1653 1654 1655 1656 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1653 def update_app_instance_user_endpoint(params = {}, = {}) req = build_request(:update_app_instance_user_endpoint, params) req.send_request() end |