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

Class: Aws::IoT1ClickProjects::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

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

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    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::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

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

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

    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 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
  • :region (required, String)

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is search for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :client_side_monitoring (Boolean) — default: false

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: ""

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "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.

  • :client_side_monitoring_port (Integer) — default: 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.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test endpoints. This should be avalid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 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.

  • :endpoint_discovery (Boolean) — default: false

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default

    The log formatter.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the :logger at.

  • :logger (Logger)

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function.

  • :retry_jitter (Symbol) — default: :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.

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

  • :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.

  • :retry_max_delay (Integer) — default: 0

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.

  • :secret_access_key (String)
  • :session_token (String)
  • :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.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before rasing a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60

    The default number of seconds to wait for response data. This value can safely be set per-request on the session yeidled by #session_for.

  • :http_idle_timeout (Float) — default: 5

    The number of seconds a connection is allowed to sit idble before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 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 yeidled by #session_for.

  • :http_wire_trace (Boolean) — default: false

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String)

    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.

  • :ssl_ca_directory (String)

    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.



251
252
253
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 251

def initialize(*args)
  super
end

Instance Method Details

#associate_device_with_placement(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

  • :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.



287
288
289
290
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 287

def associate_device_with_placement(params = {}, options = {})
  req = build_request(:associate_device_with_placement, params)
  req.send_request(options)
end

#create_placement(params = {}) ⇒ 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",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :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.



318
319
320
321
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 318

def create_placement(params = {}, options = {})
  req = build_request(:create_placement, params)
  req.send_request(options)
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.

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

Parameters:

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

    ({})

Options Hash (params):

  • :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.

  • :tags (Hash<String,String>)

    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.

Returns:

  • (Struct)

    Returns an empty response.



376
377
378
379
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 376

def create_project(params = {}, options = {})
  req = build_request(:create_project, params)
  req.send_request(options)
end

#delete_placement(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

  • :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.



406
407
408
409
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 406

def delete_placement(params = {}, options = {})
  req = build_request(:delete_placement, params)
  req.send_request(options)
end

#delete_project(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

  • :project_name (required, String)

    The name of the empty project to delete.

Returns:

  • (Struct)

    Returns an empty response.



431
432
433
434
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 431

def delete_project(params = {}, options = {})
  req = build_request(:delete_project, params)
  req.send_request(options)
end

#describe_placement(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



466
467
468
469
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 466

def describe_placement(params = {}, options = {})
  req = build_request(:describe_placement, params)
  req.send_request(options)
end

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

Parameters:

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

    ({})

Options Hash (params):

  • :project_name (required, String)

    The name of the project to be described.

Returns:



504
505
506
507
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 504

def describe_project(params = {}, options = {})
  req = build_request(:describe_project, params)
  req.send_request(options)
end

#disassociate_device_from_placement(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

  • :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.



532
533
534
535
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 532

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 = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



563
564
565
566
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 563

def get_devices_in_placement(params = {}, options = {})
  req = build_request(:get_devices_in_placement, params)
  req.send_request(options)
end

#list_placements(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



604
605
606
607
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 604

def list_placements(params = {}, options = {})
  req = build_request(:list_placements, params)
  req.send_request(options)
end

#list_projects(params = {}) ⇒ 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].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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



644
645
646
647
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 644

def list_projects(params = {}, options = {})
  req = build_request(:list_projects, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

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

Returns:



672
673
674
675
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 672

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

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

  • :tags (required, Hash<String,String>)

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

Returns:

  • (Struct)

    Returns an empty response.



710
711
712
713
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 710

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

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

  • :tag_keys (required, Array<String>)

    The keys of those tags which you want to remove.

Returns:

  • (Struct)

    Returns an empty response.



734
735
736
737
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 734

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_placement(params = {}) ⇒ 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",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :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.



766
767
768
769
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 766

def update_placement(params = {}, options = {})
  req = build_request(:update_placement, params)
  req.send_request(options)
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., "").

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

Parameters:

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

    ({})

Options Hash (params):

  • :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.



813
814
815
816
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/client.rb', line 813

def update_project(params = {}, options = {})
  req = build_request(:update_project, params)
  req.send_request(options)
end