Class: Aws::IoT1ClickProjects::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
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](/sdk-for-ruby/v3/developer-guide/setup-config.html).

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

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

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

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ENV, ENV, ENV, and ENV

    • ‘~/.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::InstanceProfileCredentials` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV to true.

  • :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 searched for in the following locations:

  • :access_key_id (String)
  • :account_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`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: 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.

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

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

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

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :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.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

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

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

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

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

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :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. This option is only used in the ‘legacy` retry mode.

    @see 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, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :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. This option is only used in the ‘legacy` retry mode.

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

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

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

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

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

  • :endpoint_provider (Aws::IoT1ClickProjects::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::IoT1ClickProjects::EndpointParameters`.

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

  • :http_idle_timeout (Float) — default: 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.

  • :http_open_timeout (Float) — default: 15 —

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

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

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

  • :http_wire_trace (Boolean) — default: false —

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

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

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

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

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



444
445
446
 
# File 'lib/aws-sdk-iot1clickprojects/client.rb', line 444

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1046
1047
1048
 
# File 'lib/aws-sdk-iot1clickprojects/client.rb', line 1046

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1049
1050
1051
 
# File 'lib/aws-sdk-iot1clickprojects/client.rb', line 1049

def errors_module
  Errors
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.



480
481
482
483
 
# File 'lib/aws-sdk-iot1clickprojects/client.rb', line 480

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

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

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


1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
 
# File 'lib/aws-sdk-iot1clickprojects/client.rb', line 1019

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::IoT1ClickProjects')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-iot1clickprojects'
  context[:gem_version] = '1.64.0'
  Seahorse::Client::Request.new(handlers, context)
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.



511
512
513
514
 
# File 'lib/aws-sdk-iot1clickprojects/client.rb', line 511

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, ‘{ “value1”, “key2”: “value2” }`. For more information, see [AWS Tagging Strategies].

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

Returns:

  • (Struct) —

    Returns an empty response.



569
570
571
572
 
# File 'lib/aws-sdk-iot1clickprojects/client.rb', line 569

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.

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

</note>

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.



599
600
601
602
 
# File 'lib/aws-sdk-iot1clickprojects/client.rb', line 599

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.

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

</note>

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.



624
625
626
627
 
# File 'lib/aws-sdk-iot1clickprojects/client.rb', line 624

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:



659
660
661
662
 
# File 'lib/aws-sdk-iot1clickprojects/client.rb', line 659

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:



697
698
699
700
 
# File 'lib/aws-sdk-iot1clickprojects/client.rb', line 697

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.



725
726
727
728
 
# File 'lib/aws-sdk-iot1clickprojects/client.rb', line 725

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:



756
757
758
759
 
# File 'lib/aws-sdk-iot1clickprojects/client.rb', line 756

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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:



799
800
801
802
 
# File 'lib/aws-sdk-iot1clickprojects/client.rb', line 799

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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:



841
842
843
844
 
# File 'lib/aws-sdk-iot1clickprojects/client.rb', line 841

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:



869
870
871
872
 
# File 'lib/aws-sdk-iot1clickprojects/client.rb', line 869

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

[1]: aws.amazon.com/answers/account-management/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):

Returns:

  • (Struct) —

    Returns an empty response.



907
908
909
910
 
# File 'lib/aws-sdk-iot1clickprojects/client.rb', line 907

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.



931
932
933
934
 
# File 'lib/aws-sdk-iot1clickprojects/client.rb', line 931

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.



963
964
965
966
 
# File 'lib/aws-sdk-iot1clickprojects/client.rb', line 963

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.



1010
1011
1012
1013
 
# File 'lib/aws-sdk-iot1clickprojects/client.rb', line 1010

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

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1039
1040
1041
 
# File 'lib/aws-sdk-iot1clickprojects/client.rb', line 1039

def waiter_names
  []
end