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.
446 447 448 |
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 446 def initialize(*args) super end |
Instance Method Details
#associate_device_with_placement(params = {}) ⇒ Struct
Associates a physical device with a placement.
482 483 484 485 |
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 482 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.
513 514 515 516 |
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 513 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.
571 572 573 574 |
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 571 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.
601 602 603 604 |
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 601 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.
626 627 628 629 |
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 626 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.
661 662 663 664 |
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 661 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.
699 700 701 702 |
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 699 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.
727 728 729 730 |
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 727 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.
758 759 760 761 |
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 758 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.
801 802 803 804 |
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 801 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.
843 844 845 846 |
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 843 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.
871 872 873 874 |
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 871 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.
909 910 911 912 |
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 909 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.
933 934 935 936 |
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 933 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., "").
965 966 967 968 |
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 965 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., ""
).
1012 1013 1014 1015 |
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 1012 def update_project(params = {}, = {}) req = build_request(:update_project, params) req.send_request() end |