You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IoT1ClickProjects::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

An API client for AWS IoT 1-Click Projects Service. To construct a client, you need to configure a :region and :credentials.

iot1clickprojects = Aws::IoT1ClickProjects::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::IoT1ClickProjects::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::IoT1ClickProjects::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials)

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :endpoint (String)

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :http_continue_timeout (Float) — default: 1

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter)

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String)

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String)

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials. See Plugins::RetryErrors for more details.

  • :secret_access_key (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :ssl_ca_bundle (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#associate_device_with_placement(options = {}) ⇒ Struct

Associates a physical device with a placement.

Examples:

Request syntax with placeholder values


resp = client.associate_device_with_placement({
  project_name: "ProjectName", # required
  placement_name: "PlacementName", # required
  device_id: "DeviceId", # required
  device_template_name: "DeviceTemplateName", # required
})

Options Hash (options):

  • :project_name (required, String)

    The name of the project containing the placement in which to associate the device.

  • :placement_name (required, String)

    The name of the placement in which to associate the device.

  • :device_id (required, String)

    The ID of the physical device to be associated with the given placement in the project. Note that a mandatory 4 character prefix is required for all deviceId values.

  • :device_template_name (required, String)

    The device template name to associate with the device ID.

Returns:

  • (Struct)

    Returns an empty response.

#create_placement(options = {}) ⇒ Struct

Creates an empty placement.

Examples:

Request syntax with placeholder values


resp = client.create_placement({
  placement_name: "PlacementName", # required
  project_name: "ProjectName", # required
  attributes: {
    "AttributeName" => "AttributeValue",
  },
})

Options Hash (options):

  • :placement_name (required, String)

    The name of the placement to be created.

  • :project_name (required, String)

    The name of the project in which to create the placement.

  • :attributes (Hash<String,String>)

    Optional user-defined key/value pairs providing contextual data (such as location or function) for the placement.

Returns:

  • (Struct)

    Returns an empty response.

#create_project(options = {}) ⇒ 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.

Examples:

Request syntax with placeholder values


resp = client.create_project({
  project_name: "ProjectName", # required
  description: "Description",
  placement_template: {
    default_attributes: {
      "AttributeName" => "AttributeDefaultValue",
    },
    device_templates: {
      "DeviceTemplateName" => {
        device_type: "DeviceType",
        callback_overrides: {
          "DeviceCallbackKey" => "DeviceCallbackValue",
        },
      },
    },
  },
})

Options Hash (options):

  • :project_name (required, String)

    The name of the project to create.

  • :description (String)

    An optional description for the project.

  • :placement_template (Types::PlacementTemplate)

    The schema defining the placement to be created. A placement template defines placement default attributes and device templates. You cannot add or remove device templates after the project has been created. However, you can update callbackOverrides for the device templates using the UpdateProject API.

Returns:

  • (Struct)

    Returns an empty response.

#delete_placement(options = {}) ⇒ Struct

Deletes a placement. To delete a placement, it must not have any devices associated with it.

When you delete a placement, all associated data becomes irretrievable.

Examples:

Request syntax with placeholder values


resp = client.delete_placement({
  placement_name: "PlacementName", # required
  project_name: "ProjectName", # required
})

Options Hash (options):

  • :placement_name (required, String)

    The name of the empty placement to delete.

  • :project_name (required, String)

    The project containing the empty placement to delete.

Returns:

  • (Struct)

    Returns an empty response.

#delete_project(options = {}) ⇒ Struct

Deletes a project. To delete a project, it must not have any placements associated with it.

When you delete a project, all associated data becomes irretrievable.

Examples:

Request syntax with placeholder values


resp = client.delete_project({
  project_name: "ProjectName", # required
})

Options Hash (options):

  • :project_name (required, String)

    The name of the empty project to delete.

Returns:

  • (Struct)

    Returns an empty response.

#describe_placement(options = {}) ⇒ Types::DescribePlacementResponse

Describes a placement in a project.

Examples:

Request syntax with placeholder values


resp = client.describe_placement({
  placement_name: "PlacementName", # required
  project_name: "ProjectName", # required
})

Response structure


resp.placement.project_name #=> String
resp.placement.placement_name #=> String
resp.placement.attributes #=> Hash
resp.placement.attributes["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.placement.created_date #=> Time
resp.placement.updated_date #=> Time

Options Hash (options):

  • :placement_name (required, String)

    The name of the placement within a project.

  • :project_name (required, String)

    The project containing the placement to be described.

Returns:

#describe_project(options = {}) ⇒ Types::DescribeProjectResponse

Returns an object describing a project.

Examples:

Request syntax with placeholder values


resp = client.describe_project({
  project_name: "ProjectName", # required
})

Response structure


resp.project.project_name #=> String
resp.project.description #=> String
resp.project.created_date #=> Time
resp.project.updated_date #=> Time
resp.project.placement_template.default_attributes #=> Hash
resp.project.placement_template.default_attributes["AttributeName"] #=> String
resp.project.placement_template.device_templates #=> Hash
resp.project.placement_template.device_templates["DeviceTemplateName"].device_type #=> String
resp.project.placement_template.device_templates["DeviceTemplateName"].callback_overrides #=> Hash
resp.project.placement_template.device_templates["DeviceTemplateName"].callback_overrides["DeviceCallbackKey"] #=> String

Options Hash (options):

  • :project_name (required, String)

    The name of the project to be described.

Returns:

#disassociate_device_from_placement(options = {}) ⇒ Struct

Removes a physical device from a placement.

Examples:

Request syntax with placeholder values


resp = client.disassociate_device_from_placement({
  project_name: "ProjectName", # required
  placement_name: "PlacementName", # required
  device_template_name: "DeviceTemplateName", # required
})

Options Hash (options):

  • :project_name (required, String)

    The name of the project that contains the placement.

  • :placement_name (required, String)

    The name of the placement that the device should be removed from.

  • :device_template_name (required, String)

    The device ID that should be removed from the placement.

Returns:

  • (Struct)

    Returns an empty response.

#get_devices_in_placement(options = {}) ⇒ Types::GetDevicesInPlacementResponse

Returns an object enumerating the devices in a placement.

Examples:

Request syntax with placeholder values


resp = client.get_devices_in_placement({
  project_name: "ProjectName", # required
  placement_name: "PlacementName", # required
})

Response structure


resp.devices #=> Hash
resp.devices["DeviceTemplateName"] #=> String

Options Hash (options):

  • :project_name (required, String)

    The name of the project containing the placement.

  • :placement_name (required, String)

    The name of the placement to get the devices from.

Returns:

#list_placements(options = {}) ⇒ Types::ListPlacementsResponse

Lists the placement(s) of a project.

Examples:

Request syntax with placeholder values


resp = client.list_placements({
  project_name: "ProjectName", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.placements #=> Array
resp.placements[0].project_name #=> String
resp.placements[0].placement_name #=> String
resp.placements[0].created_date #=> Time
resp.placements[0].updated_date #=> Time
resp.next_token #=> String

Options Hash (options):

  • :project_name (required, String)

    The project containing the placements to be listed.

  • :next_token (String)

    The token to retrieve the next set of results.

  • :max_results (Integer)

    The maximum number of results to return per request. If not set, a default value of 100 is used.

Returns:

#list_projects(options = {}) ⇒ Types::ListProjectsResponse

Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.

Examples:

Request syntax with placeholder values


resp = client.list_projects({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.projects #=> Array
resp.projects[0].project_name #=> String
resp.projects[0].created_date #=> Time
resp.projects[0].updated_date #=> Time
resp.next_token #=> String

Options Hash (options):

  • :next_token (String)

    The token to retrieve the next set of results.

  • :max_results (Integer)

    The maximum number of results to return per request. If not set, a default value of 100 is used.

Returns:

#update_placement(options = {}) ⇒ Struct

Updates a placement with the given attributes. To clear an attribute, pass an empty value (i.e., "").

Examples:

Request syntax with placeholder values


resp = client.update_placement({
  placement_name: "PlacementName", # required
  project_name: "ProjectName", # required
  attributes: {
    "AttributeName" => "AttributeValue",
  },
})

Options Hash (options):

  • :placement_name (required, String)

    The name of the placement to update.

  • :project_name (required, String)

    The name of the project containing the placement to be updated.

  • :attributes (Hash<String,String>)

    The user-defined object of attributes used to update the placement. The maximum number of key/value pairs is 50.

Returns:

  • (Struct)

    Returns an empty response.

#update_project(options = {}) ⇒ 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., "").

Examples:

Request syntax with placeholder values


resp = client.update_project({
  project_name: "ProjectName", # required
  description: "Description",
  placement_template: {
    default_attributes: {
      "AttributeName" => "AttributeDefaultValue",
    },
    device_templates: {
      "DeviceTemplateName" => {
        device_type: "DeviceType",
        callback_overrides: {
          "DeviceCallbackKey" => "DeviceCallbackValue",
        },
      },
    },
  },
})

Options Hash (options):

  • :project_name (required, String)

    The name of the project to be updated.

  • :description (String)

    An optional user-defined description for the project.

  • :placement_template (Types::PlacementTemplate)

    An object defining the project update. Once a project has been created, you cannot add device template names to the project. However, for a given placementTemplate, you can update the associated callbackOverrides for the device definition using this API.

Returns:

  • (Struct)

    Returns an empty response.

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol)

    The name of the waiter. See #waiter_names for a full list of supported waiters.

  • params (Hash) (defaults to: {})

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean)

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError)

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError)

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError)

    Raised when you request to wait for an unknown state.

#waiter_namesArray<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:

Returns:

  • (Array<Symbol>)

    the list of supported waiters.