class Aws::IoT1ClickProjects::Client

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](/sdk-for-ruby/v3/developer-guide/setup-config.html).

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

Attributes

identifier[R]

@api private

Public Class Methods

errors_module() click to toggle source

@api private

# File lib/aws-sdk-iot1clickprojects/client.rb, line 924
def errors_module
  Errors
end
new(*args) click to toggle source

@overload initialize(options)

@param [Hash] options
@option options [required, Aws::CredentialProvider] :credentials
  Your AWS credentials. This can be an instance of any one of the
  following classes:

  * `Aws::Credentials` - Used for configuring static, non-refreshing
    credentials.

  * `Aws::SharedCredentials` - Used for loading static credentials from a
    shared file, such as `~/.aws/config`.

  * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.

  * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
    assume a role after providing credentials via the web.

  * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
    access token generated from `aws login`.

  * `Aws::ProcessCredentials` - Used for loading credentials from a
    process that outputs to stdout.

  * `Aws::InstanceProfileCredentials` - Used for loading credentials
    from an EC2 IMDS on an EC2 instance.

  * `Aws::ECSCredentials` - Used for loading credentials from
    instances running in ECS.

  * `Aws::CognitoIdentityCredentials` - Used for loading credentials
    from the Cognito Identity service.

  When `:credentials` are not configured directly, the following
  locations will be searched for credentials:

  * `Aws.config[:credentials]`
  * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
  * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
  * `~/.aws/credentials`
  * `~/.aws/config`
  * EC2/ECS IMDS instance profile - When used by default, the timeouts
    are very aggressive. Construct and pass an instance of
    `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
    enable retries and extended timeouts.

@option options [required, String] :region
  The AWS region to connect to.  The configured `:region` is
  used to determine the service `:endpoint`. When not passed,
  a default `:region` is searched for in the following locations:

  * `Aws.config[:region]`
  * `ENV['AWS_REGION']`
  * `ENV['AMAZON_REGION']`
  * `ENV['AWS_DEFAULT_REGION']`
  * `~/.aws/credentials`
  * `~/.aws/config`

@option options [String] :access_key_id

@option options [Boolean] :active_endpoint_cache (false)
  When set to `true`, a thread polling for endpoints will be running in
  the background every 60 secs (default). Defaults to `false`.

@option options [Boolean] :adaptive_retry_wait_to_fill (true)
  Used only in `adaptive` retry mode.  When true, the request will sleep
  until there is sufficent client side capacity to retry the request.
  When false, the request will raise a `RetryCapacityNotAvailableError` and will
  not retry instead of sleeping.

@option options [Boolean] :client_side_monitoring (false)
  When `true`, client-side metrics will be collected for all API requests from
  this client.

@option options [String] :client_side_monitoring_client_id ("")
  Allows you to provide an identifier for this client which will be attached to
  all generated client side metrics. Defaults to an empty string.

@option options [String] :client_side_monitoring_host ("127.0.0.1")
  Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
  side monitoring agent is running on, where client metrics will be published via UDP.

@option options [Integer] :client_side_monitoring_port (31000)
  Required for publishing client metrics. The port that the client side monitoring
  agent is running on, where client metrics will be published via UDP.

@option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
  Allows you to provide a custom client-side monitoring publisher class. By default,
  will use the Client Side Monitoring Agent Publisher.

@option options [Boolean] :convert_params (true)
  When `true`, an attempt is made to coerce request parameters into
  the required types.

@option options [Boolean] :correct_clock_skew (true)
  Used only in `standard` and adaptive retry modes. Specifies whether to apply
  a clock skew correction and retry requests with skewed client clocks.

@option options [Boolean] :disable_host_prefix_injection (false)
  Set to true to disable SDK automatically adding host prefix
  to default service endpoint when available.

@option options [String] :endpoint
  The client endpoint is normally constructed from the `:region`
  option. You should only configure an `:endpoint` when connecting
  to test or custom endpoints. This should be a valid HTTP(S) URI.

@option options [Integer] :endpoint_cache_max_entries (1000)
  Used for the maximum size limit of the LRU cache storing endpoints data
  for endpoint discovery enabled operations. Defaults to 1000.

@option options [Integer] :endpoint_cache_max_threads (10)
  Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

@option options [Integer] :endpoint_cache_poll_interval (60)
  When :endpoint_discovery and :active_endpoint_cache is enabled,
  Use this option to config the time interval in seconds for making
  requests fetching endpoints information. Defaults to 60 sec.

@option options [Boolean] :endpoint_discovery (false)
  When set to `true`, endpoint discovery will be enabled for operations when available.

@option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
  The log formatter.

@option options [Symbol] :log_level (:info)
  The log level to send messages to the `:logger` at.

@option options [Logger] :logger
  The Logger instance to send log messages to.  If this option
  is not set, logging will be disabled.

@option options [Integer] :max_attempts (3)
  An integer representing the maximum number attempts that will be made for
  a single request, including the initial attempt.  For example,
  setting this value to 5 will result in a request being retried up to
  4 times. Used in `standard` and `adaptive` retry modes.

@option options [String] :profile ("default")
  Used when loading credentials from the shared credentials file
  at HOME/.aws/credentials.  When not specified, 'default' is used.

@option options [Proc] :retry_backoff
  A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
  This option is only used in the `legacy` retry mode.

@option options [Float] :retry_base_delay (0.3)
  The base delay in seconds used by the default backoff function. This option
  is only used in the `legacy` retry mode.

@option options [Symbol] :retry_jitter (:none)
  A delay randomiser function used by the default backoff function.
  Some predefined functions can be referenced by name - :none, :equal, :full,
  otherwise a Proc that takes and returns a number. This option is only used
  in the `legacy` retry mode.

  @see https://www.awsarchitectureblog.com/2015/03/backoff.html

@option options [Integer] :retry_limit (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, auth errors,
  endpoint discovery, and errors from expired credentials.
  This option is only used in the `legacy` retry mode.

@option options [Integer] :retry_max_delay (0)
  The maximum number of seconds to delay between retries (0 for no limit)
  used by the default backoff function. This option is only used in the
  `legacy` retry mode.

@option options [String] :retry_mode ("legacy")
  Specifies which retry algorithm to use. Values are:

  * `legacy` - The pre-existing retry behavior.  This is default value if
    no retry mode is provided.

  * `standard` - A standardized set of retry rules across the AWS SDKs.
    This includes support for retry quotas, which limit the number of
    unsuccessful retries a client can make.

  * `adaptive` - An experimental retry mode that includes all the
    functionality of `standard` mode along with automatic client side
    throttling.  This is a provisional mode that may change behavior
    in the future.

@option options [String] :secret_access_key

@option options [String] :session_token

@option options [Boolean] :stub_responses (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.

@option options [Boolean] :validate_params (true)
  When `true`, request parameters are validated before
  sending the request.

@option options [URI::HTTP,String] :http_proxy A proxy to send
  requests through.  Formatted like 'http://proxy.com:123'.

@option options [Float] :http_open_timeout (15) The number of
  seconds to wait when opening a HTTP session before raising a
  `Timeout::Error`.

@option options [Integer] :http_read_timeout (60) The default
  number of seconds to wait for response data.  This value can
  safely be set per-request on the session.

@option options [Float] :http_idle_timeout (5) The number of
  seconds a connection is allowed to sit idle before it is
  considered stale.  Stale connections are closed and removed
  from the pool before making a request.

@option options [Float] :http_continue_timeout (1) The number of
  seconds to wait for a 100-continue response before sending the
  request body.  This option has no effect unless the request has
  "Expect" header set to "100-continue".  Defaults to `nil` which
  disables this behaviour.  This value can safely be set per
  request on the session.

@option options [Boolean] :http_wire_trace (false) When `true`,
  HTTP debug output will be sent to the `:logger`.

@option options [Boolean] :ssl_verify_peer (true) When `true`,
  SSL peer certificates are verified when establishing a
  connection.

@option options [String] :ssl_ca_bundle Full path to the SSL
  certificate authority bundle file that should be used when
  verifying peer certificates.  If you do not pass
  `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
  will be used if available.

@option options [String] :ssl_ca_directory Full path of the
  directory that contains the unbundled SSL certificate
  authority files for verifying peer certificates.  If you do
  not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
  system default will be used if available.
Calls superclass method
# File lib/aws-sdk-iot1clickprojects/client.rb, line 324
def initialize(*args)
  super
end

Public Instance Methods

associate_device_with_placement(params = {}, options = {}) click to toggle source

Associates a physical device with a placement.

@option params [required, String] :project_name

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

@option params [required, String] :placement_name

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

@option params [required, String] :device_id

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.

@option params [required, String] :device_template_name

The device template name to associate with the device ID.

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example 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
})

@overload associate_device_with_placement(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-iot1clickprojects/client.rb, line 360
def associate_device_with_placement(params = {}, options = {})
  req = build_request(:associate_device_with_placement, params)
  req.send_request(options)
end
build_request(operation_name, params = {}) click to toggle source

@param params ({}) @api private

# File lib/aws-sdk-iot1clickprojects/client.rb, line 899
def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config)
  context[:gem_name] = 'aws-sdk-iot1clickprojects'
  context[:gem_version] = '1.31.0'
  Seahorse::Client::Request.new(handlers, context)
end
create_placement(params = {}, options = {}) click to toggle source

Creates an empty placement.

@option params [required, String] :placement_name

The name of the placement to be created.

@option params [required, String] :project_name

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

@option params [Hash<String,String>] :attributes

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

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example Request syntax with placeholder values

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

@overload create_placement(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-iot1clickprojects/client.rb, line 391
def create_placement(params = {}, options = {})
  req = build_request(:create_placement, params)
  req.send_request(options)
end
create_project(params = {}, options = {}) click to toggle source

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.

@option params [required, String] :project_name

The name of the project to create.

@option params [String] :description

An optional description for the project.

@option params [Types::PlacementTemplate] :placement_template

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.

@option params [Hash<String,String>] :tags

Optional tags (metadata key/value pairs) to be associated with the
project. For example, `\{ \{"key1": "value1", "key2": "value2"\} \}`.
For more information, see [AWS Tagging Strategies][1].

[1]: https://aws.amazon.com/answers/account-management/aws-tagging-strategies/

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example 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",
        },
      },
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

@overload create_project(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-iot1clickprojects/client.rb, line 449
def create_project(params = {}, options = {})
  req = build_request(:create_project, params)
  req.send_request(options)
end
delete_placement(params = {}, options = {}) click to toggle source

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

<note markdown=“1”> When you delete a placement, all associated data becomes irretrievable.

</note>

@option params [required, String] :placement_name

The name of the empty placement to delete.

@option params [required, String] :project_name

The project containing the empty placement to delete.

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example Request syntax with placeholder values

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

@overload delete_placement(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-iot1clickprojects/client.rb, line 479
def delete_placement(params = {}, options = {})
  req = build_request(:delete_placement, params)
  req.send_request(options)
end
delete_project(params = {}, options = {}) click to toggle source

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

<note markdown=“1”> When you delete a project, all associated data becomes irretrievable.

</note>

@option params [required, String] :project_name

The name of the empty project to delete.

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example Request syntax with placeholder values

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

@overload delete_project(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-iot1clickprojects/client.rb, line 504
def delete_project(params = {}, options = {})
  req = build_request(:delete_project, params)
  req.send_request(options)
end
describe_placement(params = {}, options = {}) click to toggle source

Describes a placement in a project.

@option params [required, String] :placement_name

The name of the placement within a project.

@option params [required, String] :project_name

The project containing the placement to be described.

@return [Types::DescribePlacementResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::DescribePlacementResponse#placement #placement} => Types::PlacementDescription

@example Request syntax with placeholder values

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

@example 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

@overload describe_placement(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-iot1clickprojects/client.rb, line 539
def describe_placement(params = {}, options = {})
  req = build_request(:describe_placement, params)
  req.send_request(options)
end
describe_project(params = {}, options = {}) click to toggle source

Returns an object describing a project.

@option params [required, String] :project_name

The name of the project to be described.

@return [Types::DescribeProjectResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::DescribeProjectResponse#project #project} => Types::ProjectDescription

@example Request syntax with placeholder values

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

@example Response structure

resp.project.arn #=> String
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
resp.project.tags #=> Hash
resp.project.tags["TagKey"] #=> String

@overload describe_project(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-iot1clickprojects/client.rb, line 577
def describe_project(params = {}, options = {})
  req = build_request(:describe_project, params)
  req.send_request(options)
end
disassociate_device_from_placement(params = {}, options = {}) click to toggle source

Removes a physical device from a placement.

@option params [required, String] :project_name

The name of the project that contains the placement.

@option params [required, String] :placement_name

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

@option params [required, String] :device_template_name

The device ID that should be removed from the placement.

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example Request syntax with placeholder values

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

@overload disassociate_device_from_placement(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-iot1clickprojects/client.rb, line 605
def disassociate_device_from_placement(params = {}, options = {})
  req = build_request(:disassociate_device_from_placement, params)
  req.send_request(options)
end
get_devices_in_placement(params = {}, options = {}) click to toggle source

Returns an object enumerating the devices in a placement.

@option params [required, String] :project_name

The name of the project containing the placement.

@option params [required, String] :placement_name

The name of the placement to get the devices from.

@return [Types::GetDevicesInPlacementResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::GetDevicesInPlacementResponse#devices #devices} => Hash&lt;String,String&gt;

@example Request syntax with placeholder values

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

@example Response structure

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

@overload get_devices_in_placement(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-iot1clickprojects/client.rb, line 636
def get_devices_in_placement(params = {}, options = {})
  req = build_request(:get_devices_in_placement, params)
  req.send_request(options)
end
list_placements(params = {}, options = {}) click to toggle source

Lists the placement(s) of a project.

@option params [required, String] :project_name

The project containing the placements to be listed.

@option params [String] :next_token

The token to retrieve the next set of results.

@option params [Integer] :max_results

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

@return [Types::ListPlacementsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::ListPlacementsResponse#placements #placements} => Array&lt;Types::PlacementSummary&gt;
* {Types::ListPlacementsResponse#next_token #next_token} => String

The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.

@example Request syntax with placeholder values

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

@example 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

@overload list_placements(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-iot1clickprojects/client.rb, line 679
def list_placements(params = {}, options = {})
  req = build_request(:list_placements, params)
  req.send_request(options)
end
list_projects(params = {}, options = {}) click to toggle source

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

@option params [String] :next_token

The token to retrieve the next set of results.

@option params [Integer] :max_results

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

@return [Types::ListProjectsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::ListProjectsResponse#projects #projects} => Array&lt;Types::ProjectSummary&gt;
* {Types::ListProjectsResponse#next_token #next_token} => String

The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.

@example Request syntax with placeholder values

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

@example Response structure

resp.projects #=> Array
resp.projects[0].arn #=> String
resp.projects[0].project_name #=> String
resp.projects[0].created_date #=> Time
resp.projects[0].updated_date #=> Time
resp.projects[0].tags #=> Hash
resp.projects[0].tags["TagKey"] #=> String
resp.next_token #=> String

@overload list_projects(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-iot1clickprojects/client.rb, line 721
def list_projects(params = {}, options = {})
  req = build_request(:list_projects, params)
  req.send_request(options)
end
list_tags_for_resource(params = {}, options = {}) click to toggle source

Lists the tags (metadata key/value pairs) which you have assigned to the resource.

@option params [required, String] :resource_arn

The ARN of the resource whose tags you want to list.

@return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::ListTagsForResourceResponse#tags #tags} => Hash&lt;String,String&gt;

@example Request syntax with placeholder values

resp = client.list_tags_for_resource({
  resource_arn: "ProjectArn", # required
})

@example Response structure

resp.tags #=> Hash
resp.tags["TagKey"] #=> String

@overload list_tags_for_resource(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-iot1clickprojects/client.rb, line 749
def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end
tag_resource(params = {}, options = {}) click to toggle source

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].

[1]: aws.amazon.com/answers/account-management/aws-tagging-strategies/

@option params [required, String] :resource_arn

The ARN of the resouce for which tag(s) should be added or modified.

@option params [required, Hash<String,String>] :tags

The new or modifying tag(s) for the resource. See [AWS IoT 1-Click
Service Limits][1] for the maximum number of tags allowed per
resource.

[1]: https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-appendix.html#1click-limits

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example Request syntax with placeholder values

resp = client.tag_resource({
  resource_arn: "ProjectArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

@overload tag_resource(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-iot1clickprojects/client.rb, line 787
def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end
untag_resource(params = {}, options = {}) click to toggle source

Removes one or more tags (metadata key/value pairs) from a resource.

@option params [required, String] :resource_arn

The ARN of the resource whose tag you want to remove.

@option params [required, Array<String>] :tag_keys

The keys of those tags which you want to remove.

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example Request syntax with placeholder values

resp = client.untag_resource({
  resource_arn: "ProjectArn", # required
  tag_keys: ["TagKey"], # required
})

@overload untag_resource(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-iot1clickprojects/client.rb, line 811
def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end
update_placement(params = {}, options = {}) click to toggle source

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

@option params [required, String] :placement_name

The name of the placement to update.

@option params [required, String] :project_name

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

@option params [Hash<String,String>] :attributes

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

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example Request syntax with placeholder values

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

@overload update_placement(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-iot1clickprojects/client.rb, line 843
def update_placement(params = {}, options = {})
  req = build_request(:update_placement, params)
  req.send_request(options)
end
update_project(params = {}, options = {}) click to toggle source

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., `“”`).

@option params [required, String] :project_name

The name of the project to be updated.

@option params [String] :description

An optional user-defined description for the project.

@option params [Types::PlacementTemplate] :placement_template

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.

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example 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",
        },
      },
    },
  },
})

@overload update_project(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-iot1clickprojects/client.rb, line 890
def update_project(params = {}, options = {})
  req = build_request(:update_project, params)
  req.send_request(options)
end
waiter_names() click to toggle source

@api private @deprecated

# File lib/aws-sdk-iot1clickprojects/client.rb, line 914
def waiter_names
  []
end