class Aws::IoTFleetHub::Client

An API client for IoTFleetHub. To construct a client, you need to configure a `:region` and `:credentials`.

client = Aws::IoTFleetHub::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-iotfleethub/client.rb, line 690
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-iotfleethub/client.rb, line 324
def initialize(*args)
  super
end

Public Instance Methods

build_request(operation_name, params = {}) click to toggle source

@param params ({}) @api private

# File lib/aws-sdk-iotfleethub/client.rb, line 665
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-iotfleethub'
  context[:gem_version] = '1.5.0'
  Seahorse::Client::Request.new(handlers, context)
end
create_application(params = {}, options = {}) click to toggle source

Creates a Fleet Hub for AWS IoT Device Management web application.

<note markdown=“1”> Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

</note>

@option params [required, String] :application_name

The name of the web application.

@option params [String] :application_description

An optional description of the web application.

@option params [String] :client_token

A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new
idempotent request is required.

**A suitable default value is auto-generated.** You should normally
not need to pass this option.**

@option params [required, String] :role_arn

The ARN of the role that the web application assumes when it interacts
with AWS IoT Core.

<note markdown="1"> The name of the role must be in the form `AWSIotFleetHub_random_string
`.

 </note>

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

A set of key/value pairs that you can use to manage the web
application resource.

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

* {Types::CreateApplicationResponse#application_id #application_id} => String
* {Types::CreateApplicationResponse#application_arn #application_arn} => String

@example Request syntax with placeholder values

resp = client.create_application({
  application_name: "Name", # required
  application_description: "Description",
  client_token: "ClientRequestToken",
  role_arn: "Arn", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

@example Response structure

resp.application_id #=> String
resp.application_arn #=> String

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

# File lib/aws-sdk-iotfleethub/client.rb, line 388
def create_application(params = {}, options = {})
  req = build_request(:create_application, params)
  req.send_request(options)
end
delete_application(params = {}, options = {}) click to toggle source

Deletes a Fleet Hub for AWS IoT Device Management web application.

<note markdown=“1”> Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

</note>

@option params [required, String] :application_id

The unique Id of the web application.

@option params [String] :client_token

A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new
idempotent request is required.

**A suitable default value is auto-generated.** You should normally
not need to pass this option.**

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

@example Request syntax with placeholder values

resp = client.delete_application({
  application_id: "Id", # required
  client_token: "ClientRequestToken",
})

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

# File lib/aws-sdk-iotfleethub/client.rb, line 422
def delete_application(params = {}, options = {})
  req = build_request(:delete_application, params)
  req.send_request(options)
end
describe_application(params = {}, options = {}) click to toggle source

Gets information about a Fleet Hub for AWS IoT Device Management web application.

<note markdown=“1”> Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

</note>

@option params [required, String] :application_id

The unique Id of the web application.

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

* {Types::DescribeApplicationResponse#application_id #application_id} => String
* {Types::DescribeApplicationResponse#application_arn #application_arn} => String
* {Types::DescribeApplicationResponse#application_name #application_name} => String
* {Types::DescribeApplicationResponse#application_description #application_description} => String
* {Types::DescribeApplicationResponse#application_url #application_url} => String
* {Types::DescribeApplicationResponse#application_state #application_state} => String
* {Types::DescribeApplicationResponse#application_creation_date #application_creation_date} => Integer
* {Types::DescribeApplicationResponse#application_last_update_date #application_last_update_date} => Integer
* {Types::DescribeApplicationResponse#role_arn #role_arn} => String
* {Types::DescribeApplicationResponse#sso_client_id #sso_client_id} => String
* {Types::DescribeApplicationResponse#error_message #error_message} => String
* {Types::DescribeApplicationResponse#tags #tags} => Hash&lt;String,String&gt;

@example Request syntax with placeholder values

resp = client.describe_application({
  application_id: "Id", # required
})

@example Response structure

resp.application_id #=> String
resp.application_arn #=> String
resp.application_name #=> String
resp.application_description #=> String
resp.application_url #=> String
resp.application_state #=> String, one of "CREATING", "DELETING", "ACTIVE", "CREATE_FAILED", "DELETE_FAILED"
resp.application_creation_date #=> Integer
resp.application_last_update_date #=> Integer
resp.role_arn #=> String
resp.sso_client_id #=> String
resp.error_message #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

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

# File lib/aws-sdk-iotfleethub/client.rb, line 477
def describe_application(params = {}, options = {})
  req = build_request(:describe_application, params)
  req.send_request(options)
end
list_applications(params = {}, options = {}) click to toggle source

Gets a list of Fleet Hub for AWS IoT Device Management web applications for the current account.

<note markdown=“1”> Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

</note>

@option params [String] :next_token

A token used to get the next set of results.

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

* {Types::ListApplicationsResponse#application_summaries #application_summaries} => Array&lt;Types::ApplicationSummary&gt;
* {Types::ListApplicationsResponse#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_applications({
  next_token: "NextToken",
})

@example Response structure

resp.application_summaries #=> Array
resp.application_summaries[0].application_id #=> String
resp.application_summaries[0].application_name #=> String
resp.application_summaries[0].application_description #=> String
resp.application_summaries[0].application_url #=> String
resp.application_summaries[0].application_creation_date #=> Integer
resp.application_summaries[0].application_last_update_date #=> Integer
resp.application_summaries[0].application_state #=> String, one of "CREATING", "DELETING", "ACTIVE", "CREATE_FAILED", "DELETE_FAILED"
resp.next_token #=> String

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

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

Lists the tags for the specified resource.

<note markdown=“1”> Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

</note>

@option params [required, String] :resource_arn

The ARN of the resource.

@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: "ResourceArn", # required
})

@example Response structure

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

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

# File lib/aws-sdk-iotfleethub/client.rb, line 552
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

Adds to or modifies the tags of the specified resource. Tags are metadata which can be used to manage a resource.

<note markdown=“1”> Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

</note>

@option params [required, String] :resource_arn

The ARN of the resource.

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

The new or modified tags for the resource.

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

@example Request syntax with placeholder values

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

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

# File lib/aws-sdk-iotfleethub/client.rb, line 584
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 the specified tags (metadata) from the resource.

<note markdown=“1”> Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

</note>

@option params [required, String] :resource_arn

The ARN of the resource.

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

A list of the keys of the tags to be removed from the resource.

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

@example Request syntax with placeholder values

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

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

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

Updates information about a Fleet Hub for a AWS IoT Device Management web application.

<note markdown=“1”> Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

</note>

@option params [required, String] :application_id

The unique Id of the web application.

@option params [String] :application_name

The name of the web application.

@option params [String] :application_description

An optional description of the web application.

@option params [String] :client_token

A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new
idempotent request is required.

**A suitable default value is auto-generated.** You should normally
not need to pass this option.**

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

@example Request syntax with placeholder values

resp = client.update_application({
  application_id: "Id", # required
  application_name: "Name",
  application_description: "Description",
  client_token: "ClientRequestToken",
})

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

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

@api private @deprecated

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