Class: Aws::IoTFleetHub::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::IoTFleetHub::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-iotfleethub/client.rb
Overview
An API client for IoTFleetHub. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::IoTFleetHub::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#create_application(params = {}) ⇒ Types::CreateApplicationResponse
Creates a Fleet Hub for IoT Device Management web application.
-
#delete_application(params = {}) ⇒ Struct
Deletes a Fleet Hub for IoT Device Management web application.
-
#describe_application(params = {}) ⇒ Types::DescribeApplicationResponse
Gets information about a Fleet Hub for IoT Device Management web application.
-
#list_applications(params = {}) ⇒ Types::ListApplicationsResponse
Gets a list of Fleet Hub for IoT Device Management web applications for the current account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for the specified resource.
-
#tag_resource(params = {}) ⇒ Struct
Adds to or modifies the tags of the specified resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags (metadata) from the resource.
-
#update_application(params = {}) ⇒ Struct
Updates information about a Fleet Hub for IoT Device Management web application.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
473 474 475 |
# File 'lib/aws-sdk-iotfleethub/client.rb', line 473 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
813 814 815 |
# File 'lib/aws-sdk-iotfleethub/client.rb', line 813 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
816 817 818 |
# File 'lib/aws-sdk-iotfleethub/client.rb', line 816 def errors_module Errors end |
Instance Method Details
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 |
# File 'lib/aws-sdk-iotfleethub/client.rb', line 786 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) tracer = config.telemetry_provider.tracer_provider.tracer( Aws::Telemetry.module_to_tracer_name('Aws::IoTFleetHub') ) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config, tracer: tracer ) context[:gem_name] = 'aws-sdk-iotfleethub' context[:gem_version] = '1.51.0' Seahorse::Client::Request.new(handlers, context) end |
#create_application(params = {}) ⇒ Types::CreateApplicationResponse
Creates a Fleet Hub for IoT Device Management web application.
When creating a Fleet Hub application, you must create an organization instance of IAM Identity Center if you don’t already have one. The Fleet Hub application you create must also be in the same Amazon Web Services Region of the organization instance of IAM Identity Center. For more information see [Enabling IAM Identity Center] and [Organization instances of IAM Identity Center].
[1]: docs.aws.amazon.com/singlesignon/latest/userguide/get-set-up-for-idc.html [2]: docs.aws.amazon.com/singlesignon/latest/userguide/organization-instances-identity-center.html
544 545 546 547 |
# File 'lib/aws-sdk-iotfleethub/client.rb', line 544 def create_application(params = {}, = {}) req = build_request(:create_application, params) req.send_request() end |
#delete_application(params = {}) ⇒ Struct
Deletes a Fleet Hub for IoT Device Management web application.
573 574 575 576 |
# File 'lib/aws-sdk-iotfleethub/client.rb', line 573 def delete_application(params = {}, = {}) req = build_request(:delete_application, params) req.send_request() end |
#describe_application(params = {}) ⇒ Types::DescribeApplicationResponse
Gets information about a Fleet Hub for IoT Device Management web application.
623 624 625 626 |
# File 'lib/aws-sdk-iotfleethub/client.rb', line 623 def describe_application(params = {}, = {}) req = build_request(:describe_application, params) req.send_request() end |
#list_applications(params = {}) ⇒ Types::ListApplicationsResponse
Gets a list of Fleet Hub for IoT Device Management web applications for the current account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
661 662 663 664 |
# File 'lib/aws-sdk-iotfleethub/client.rb', line 661 def list_applications(params = {}, = {}) req = build_request(:list_applications, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for the specified resource.
688 689 690 691 |
# File 'lib/aws-sdk-iotfleethub/client.rb', line 688 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds to or modifies the tags of the specified resource. Tags are metadata which can be used to manage a resource.
715 716 717 718 |
# File 'lib/aws-sdk-iotfleethub/client.rb', line 715 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags (metadata) from the resource.
739 740 741 742 |
# File 'lib/aws-sdk-iotfleethub/client.rb', line 739 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_application(params = {}) ⇒ Struct
Updates information about a Fleet Hub for IoT Device Management web application.
777 778 779 780 |
# File 'lib/aws-sdk-iotfleethub/client.rb', line 777 def update_application(params = {}, = {}) req = build_request(:update_application, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
806 807 808 |
# File 'lib/aws-sdk-iotfleethub/client.rb', line 806 def waiter_names [] end |