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.
446 447 448 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 446 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
501 502 503 504 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 501 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.
545 546 547 548 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 545 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.
614 615 616 617 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 614 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.
680 681 682 683 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 680 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.
702 703 704 705 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 702 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.
729 730 731 732 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 729 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
.
751 752 753 754 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 751 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
.
773 774 775 776 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 773 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
.
799 800 801 802 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 799 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
.
831 832 833 834 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 831 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
.
866 867 868 869 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 866 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.
904 905 906 907 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 904 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
.
938 939 940 941 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 938 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
.
981 982 983 984 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 981 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
.
1011 1012 1013 1014 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1011 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.
1056 1057 1058 1059 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1056 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.
1102 1103 1104 1105 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1102 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.
1151 1152 1153 1154 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1151 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.
1197 1198 1199 1200 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1197 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.
1238 1239 1240 1241 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1238 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.
1268 1269 1270 1271 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1268 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.
1307 1308 1309 1310 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1307 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.
1356 1357 1358 1359 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1356 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.
1431 1432 1433 1434 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1431 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.
1463 1464 1465 1466 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1463 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.
1490 1491 1492 1493 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1490 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_app_instance(params = {}) ⇒ Types::UpdateAppInstanceResponse
Updates AppInstance
metadata.
1526 1527 1528 1529 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1526 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
.
1577 1578 1579 1580 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1577 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.
1614 1615 1616 1617 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1614 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.
1659 1660 1661 1662 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/client.rb', line 1659 def update_app_instance_user_endpoint(params = {}, = {}) req = build_request(:update_app_instance_user_endpoint, params) req.send_request() end |