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.
467 468 469 |
# File 'lib/aws-sdk-iotfleethub/client.rb', line 467 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.
807 808 809 |
# File 'lib/aws-sdk-iotfleethub/client.rb', line 807 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.
810 811 812 |
# File 'lib/aws-sdk-iotfleethub/client.rb', line 810 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.
780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 |
# File 'lib/aws-sdk-iotfleethub/client.rb', line 780 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.41.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
538 539 540 541 |
# File 'lib/aws-sdk-iotfleethub/client.rb', line 538 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.
567 568 569 570 |
# File 'lib/aws-sdk-iotfleethub/client.rb', line 567 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.
617 618 619 620 |
# File 'lib/aws-sdk-iotfleethub/client.rb', line 617 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.
655 656 657 658 |
# File 'lib/aws-sdk-iotfleethub/client.rb', line 655 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.
682 683 684 685 |
# File 'lib/aws-sdk-iotfleethub/client.rb', line 682 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.
709 710 711 712 |
# File 'lib/aws-sdk-iotfleethub/client.rb', line 709 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.
733 734 735 736 |
# File 'lib/aws-sdk-iotfleethub/client.rb', line 733 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.
771 772 773 774 |
# File 'lib/aws-sdk-iotfleethub/client.rb', line 771 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.
800 801 802 |
# File 'lib/aws-sdk-iotfleethub/client.rb', line 800 def waiter_names [] end |