Class: Aws::IoT1ClickProjects::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::IoT1ClickProjects::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb
Overview
An API client for IoT1ClickProjects. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::IoT1ClickProjects::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
-
#associate_device_with_placement(params = {}) ⇒ Struct
Associates a physical device with a placement.
-
#create_placement(params = {}) ⇒ Struct
Creates an empty placement.
-
#create_project(params = {}) ⇒ Struct
Creates an empty project with a placement template.
-
#delete_placement(params = {}) ⇒ Struct
Deletes a placement.
-
#delete_project(params = {}) ⇒ Struct
Deletes a project.
-
#describe_placement(params = {}) ⇒ Types::DescribePlacementResponse
Describes a placement in a project.
-
#describe_project(params = {}) ⇒ Types::DescribeProjectResponse
Returns an object describing a project.
-
#disassociate_device_from_placement(params = {}) ⇒ Struct
Removes a physical device from a placement.
-
#get_devices_in_placement(params = {}) ⇒ Types::GetDevicesInPlacementResponse
Returns an object enumerating the devices in a placement.
-
#list_placements(params = {}) ⇒ Types::ListPlacementsResponse
Lists the placement(s) of a project.
-
#list_projects(params = {}) ⇒ Types::ListProjectsResponse
Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags (metadata key/value pairs) which you have assigned to the resource.
-
#tag_resource(params = {}) ⇒ Struct
Creates or modifies tags for a resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags (metadata key/value pairs) from a resource.
-
#update_placement(params = {}) ⇒ Struct
Updates a placement with the given attributes.
-
#update_project(params = {}) ⇒ Struct
Updates a project associated with your AWS account and region.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from 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.
410 411 412 |
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 410 def initialize(*args) super end |
Instance Method Details
#associate_device_with_placement(params = {}) ⇒ Struct
Associates a physical device with a placement.
446 447 448 449 |
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 446 def associate_device_with_placement(params = {}, = {}) req = build_request(:associate_device_with_placement, params) req.send_request() end |
#create_placement(params = {}) ⇒ Struct
Creates an empty placement.
477 478 479 480 |
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 477 def create_placement(params = {}, = {}) req = build_request(:create_placement, params) req.send_request() end |
#create_project(params = {}) ⇒ Struct
Creates an empty project with a placement template. A project contains zero or more placements that adhere to the placement template defined in the project.
535 536 537 538 |
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 535 def create_project(params = {}, = {}) req = build_request(:create_project, params) req.send_request() end |
#delete_placement(params = {}) ⇒ Struct
Deletes a placement. To delete a placement, it must not have any devices associated with it.
565 566 567 568 |
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 565 def delete_placement(params = {}, = {}) req = build_request(:delete_placement, params) req.send_request() end |
#delete_project(params = {}) ⇒ Struct
Deletes a project. To delete a project, it must not have any placements associated with it.
590 591 592 593 |
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 590 def delete_project(params = {}, = {}) req = build_request(:delete_project, params) req.send_request() end |
#describe_placement(params = {}) ⇒ Types::DescribePlacementResponse
Describes a placement in a project.
625 626 627 628 |
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 625 def describe_placement(params = {}, = {}) req = build_request(:describe_placement, params) req.send_request() end |
#describe_project(params = {}) ⇒ Types::DescribeProjectResponse
Returns an object describing a project.
663 664 665 666 |
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 663 def describe_project(params = {}, = {}) req = build_request(:describe_project, params) req.send_request() end |
#disassociate_device_from_placement(params = {}) ⇒ Struct
Removes a physical device from a placement.
691 692 693 694 |
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 691 def disassociate_device_from_placement(params = {}, = {}) req = build_request(:disassociate_device_from_placement, params) req.send_request() end |
#get_devices_in_placement(params = {}) ⇒ Types::GetDevicesInPlacementResponse
Returns an object enumerating the devices in a placement.
722 723 724 725 |
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 722 def get_devices_in_placement(params = {}, = {}) req = build_request(:get_devices_in_placement, params) req.send_request() end |
#list_placements(params = {}) ⇒ Types::ListPlacementsResponse
Lists the placement(s) of a project.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
765 766 767 768 |
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 765 def list_placements(params = {}, = {}) req = build_request(:list_placements, params) req.send_request() end |
#list_projects(params = {}) ⇒ Types::ListProjectsResponse
Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
807 808 809 810 |
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 807 def list_projects(params = {}, = {}) req = build_request(:list_projects, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags (metadata key/value pairs) which you have assigned to the resource.
835 836 837 838 |
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 835 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Creates or modifies tags for a resource. Tags are key/value pairs (metadata) that can be used to manage a resource. For more information, see AWS Tagging Strategies.
873 874 875 876 |
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 873 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags (metadata key/value pairs) from a resource.
897 898 899 900 |
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 897 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_placement(params = {}) ⇒ Struct
Updates a placement with the given attributes. To clear an attribute, pass an empty value (i.e., "").
929 930 931 932 |
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 929 def update_placement(params = {}, = {}) req = build_request(:update_placement, params) req.send_request() end |
#update_project(params = {}) ⇒ Struct
Updates a project associated with your AWS account and region. With
the exception of device template names, you can pass just the values
that need to be updated because the update request will change only
the values that are provided. To clear a value, pass the empty string
(i.e., ""
).
976 977 978 979 |
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 976 def update_project(params = {}, = {}) req = build_request(:update_project, params) req.send_request() end |