Class: Aws::IoTManagedIntegrations::Client

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

Overview

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

client = Aws::IoTManagedIntegrations::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

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

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

  • :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 used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or 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, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.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['AWS_EC2_METADATA_DISABLED'] 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:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :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.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

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

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

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

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :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.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :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 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, 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 the 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 - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

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

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :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) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or 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::IoTManagedIntegrations::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::IoTManagedIntegrations::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 'http://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.



471
472
473
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 471

def initialize(*args)
  super
end

Instance Method Details

#create_account_association(params = {}) ⇒ Types::CreateAccountAssociationResponse

Creates a new account association via the destination id.

Examples:

Request syntax with placeholder values


resp = client.({
  client_token: "ClientToken",
  connector_destination_id: "ConnectorDestinationId", # required
  name: "AccountAssociationName",
  description: "AccountAssociationDescription",
  tags: {
    "TagKey" => "TagValue",
  },
  general_authorization: {
    auth_material_name: "AuthMaterialName",
  },
})

Response structure


resp.o_auth_authorization_url #=> String
resp. #=> String
resp.association_state #=> String, one of "ASSOCIATION_IN_PROGRESS", "ASSOCIATION_FAILED", "ASSOCIATION_SUCCEEDED", "ASSOCIATION_DELETING", "REFRESH_TOKEN_EXPIRED"
resp.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

    An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

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

  • :connector_destination_id (required, String) —

    The identifier of the connector destination.

  • :name (String) —

    The name of the destination for the new account association.

  • :description (String) —

    A description of the account association request.

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

    A set of key/value pairs that are used to manage the account association.

  • :general_authorization (Types::GeneralAuthorizationName) —

    The General Authorization reference by authorization material name.

Returns:



535
536
537
538
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 535

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

#create_cloud_connector(params = {}) ⇒ Types::CreateCloudConnectorResponse

Creates a C2C (cloud-to-cloud) connector.

Examples:

Example: CreateCloudConnector happy path for TP Link


resp = client.create_cloud_connector({
  client_token: "1234567890", 
  endpoint_config: {
    lambda: {
      arn: "arn:aws:lambda:us-east-1:111122223333:function:my-function:myVersion", 
    }, 
  }, 
  endpoint_type: "LAMBDA", 
  name: "Connector for TP Link Cloud", 
})

resp.to_h outputs the following:
{
  id: "TPLinkConnector1211", 
}

Example: CreateCloudConnector happy path for Ring


resp = client.create_cloud_connector({
  client_token: "12312321", 
  endpoint_config: {
    lambda: {
      arn: "arn:aws:lambda:us-east-1:111122223333:function:my-function:myVersion", 
    }, 
  }, 
  endpoint_type: "LAMBDA", 
  name: "Connector for Ring Cloud", 
})

resp.to_h outputs the following:
{
  id: "RingConnector1212", 
}

Example: CreateCloudConnector error path for Ring connector which already exists


resp = client.create_cloud_connector({
  client_token: "1213123123", 
  endpoint_config: {
    lambda: {
      arn: "arn:aws:lambda:us-east-1:111122223333:function:my-function:myVersion2", 
    }, 
  }, 
  endpoint_type: "LAMBDA", 
  name: "Connector for Ring Cloud", 
})

Request syntax with placeholder values


resp = client.create_cloud_connector({
  name: "DisplayName", # required
  endpoint_config: { # required
    lambda: {
      arn: "LambdaArn", # required
    },
  },
  description: "CloudConnectorDescription",
  endpoint_type: "LAMBDA", # accepts LAMBDA
  client_token: "ClientToken",
})

Response structure


resp.id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The display name of the C2C connector.

  • :endpoint_config (required, Types::EndpointConfig) —

    The configuration details for the cloud connector endpoint, including connection parameters and authentication requirements.

  • :description (String) —

    A description of the C2C connector.

  • :endpoint_type (String) —

    The type of endpoint used for the cloud connector, which defines how the connector communicates with external services.

  • :client_token (String) —

    An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

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

Returns:



639
640
641
642
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 639

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

#create_connector_destination(params = {}) ⇒ Types::CreateConnectorDestinationResponse

Create a connector destination for connecting a cloud-to-cloud (C2C) connector to the customer's Amazon Web Services account.

Examples:

Request syntax with placeholder values


resp = client.create_connector_destination({
  name: "ConnectorDestinationName",
  description: "ConnectorDestinationDescription",
  cloud_connector_id: "CloudConnectorId", # required
  auth_type: "OAUTH", # accepts OAUTH
  auth_config: { # required
    o_auth: {
      auth_url: "AuthUrl", # required
      token_url: "TokenUrl", # required
      scope: "String",
      token_endpoint_authentication_scheme: "HTTP_BASIC", # required, accepts HTTP_BASIC, REQUEST_BODY_CREDENTIALS
      o_auth_complete_redirect_url: "String",
      proactive_refresh_token_renewal: {
        enabled: false,
        days_before_renewal: 1,
      },
    },
    general_authorization: [
      {
        secrets_manager: { # required
          arn: "SecretsManagerArn", # required
          version_id: "SecretsManagerVersionId", # required
        },
        auth_material_name: "AuthMaterialName", # required
      },
    ],
  },
  secrets_manager: {
    arn: "SecretsManagerArn", # required
    version_id: "SecretsManagerVersionId", # required
  },
  client_token: "ClientToken",
})

Response structure


resp.id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (String) —

    The display name of the connector destination.

  • :description (String) —

    A description of the connector destination.

  • :cloud_connector_id (required, String) —

    The identifier of the C2C connector.

  • :auth_type (String) —

    The authentication type used for the connector destination, which determines how credentials and access are managed.

  • :auth_config (required, Types::AuthConfig) —

    The authentication configuration details for the connector destination, including OAuth settings and other authentication parameters.

  • :secrets_manager (Types::SecretsManager) —

    The AWS Secrets Manager configuration used to securely store and manage sensitive information for the connector destination.

  • :client_token (String) —

    An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

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

Returns:



724
725
726
727
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 724

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

#create_credential_locker(params = {}) ⇒ Types::CreateCredentialLockerResponse

Create a credential locker.

This operation will not trigger the creation of all the manufacturing resources.

Examples:

Request syntax with placeholder values


resp = client.create_credential_locker({
  name: "CredentialLockerName",
  client_token: "ClientToken",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.id #=> String
resp.arn #=> String
resp.created_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :name (String) —

    The name of the credential locker.

  • :client_token (String) —

    An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

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

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

    A set of key/value pairs that are used to manage the credential locker.

Returns:



776
777
778
779
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 776

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

#create_destination(params = {}) ⇒ Types::CreateDestinationResponse

Create a notification destination such as Kinesis Data Streams that receive events and notifications from Managed integrations. Managed integrations uses the destination to determine where to deliver notifications.

Examples:

Request syntax with placeholder values


resp = client.create_destination({
  delivery_destination_arn: "DeliveryDestinationArn", # required
  delivery_destination_type: "KINESIS", # required, accepts KINESIS
  name: "DestinationName", # required
  role_arn: "DeliveryDestinationRoleArn", # required
  client_token: "ClientToken",
  description: "DestinationDescription",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :delivery_destination_arn (required, String) —

    The Amazon Resource Name (ARN) of the customer-managed destination.

  • :delivery_destination_type (required, String) —

    The destination type for the customer-managed destination.

  • :name (required, String) —

    The name of the customer-managed destination.

  • :role_arn (required, String) —

    The Amazon Resource Name (ARN) of the delivery destination role.

  • :client_token (String) —

    An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

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

  • :description (String) —

    The description of the customer-managed destination.

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

    A set of key/value pairs that are used to manage the destination.

Returns:



837
838
839
840
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 837

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

#create_event_log_configuration(params = {}) ⇒ Types::CreateEventLogConfigurationResponse

Set the event log configuration for the account, resource type, or specific resource.

Examples:

Request syntax with placeholder values


resp = client.create_event_log_configuration({
  resource_type: "SmartHomeResourceType", # required
  resource_id: "SmartHomeResourceId",
  event_log_level: "DEBUG", # required, accepts DEBUG, ERROR, INFO, WARN
  client_token: "ClientToken",
})

Response structure


resp.id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_type (required, String) —

    The type of resource for the event log configuration.

  • :resource_id (String) —

    The identifier of the resource for the event log configuration.

  • :event_log_level (required, String) —

    The logging level for the event log configuration.

  • :client_token (String) —

    An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

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

Returns:



882
883
884
885
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 882

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

#create_managed_thing(params = {}) ⇒ Types::CreateManagedThingResponse

Creates a managed thing. A managed thing contains the device identifier, protocol supported, and capabilities of the device in a data model format defined by Managed integrations.

Examples:

Request syntax with placeholder values


resp = client.create_managed_thing({
  role: "CONTROLLER", # required, accepts CONTROLLER, DEVICE
  owner: "Owner",
  credential_locker_id: "CredentialLockerId",
  authentication_material: "AuthMaterialString", # required
  authentication_material_type: "CUSTOM_PROTOCOL_QR_BAR_CODE", # required, accepts CUSTOM_PROTOCOL_QR_BAR_CODE, WIFI_SETUP_QR_BAR_CODE, ZWAVE_QR_BAR_CODE, ZIGBEE_QR_BAR_CODE, DISCOVERED_DEVICE, PRE_ONBOARDED_CLOUD
  wi_fi_simple_setup_configuration: {
    enable_as_provisioner: false,
    enable_as_provisionee: false,
    timeout_in_minutes: 1,
  },
  serial_number: "SerialNumber",
  brand: "Brand",
  model: "Model",
  name: "Name",
  capability_report: {
    version: "CapabilityReportVersion", # required
    node_id: "NodeId",
    endpoints: [ # required
      {
        id: "EndpointId", # required
        device_types: ["DeviceType"], # required
        capabilities: [ # required
          {
            id: "SchemaVersionedId", # required
            name: "CapabilityName", # required
            version: "CapabilityVersion", # required
            properties: ["PropertyName"], # required
            actions: ["ActionName"], # required
            events: ["EventName"], # required
          },
        ],
      },
    ],
  },
  capability_schemas: [
    {
      format: "AWS", # required, accepts AWS, ZCL, CONNECTOR
      capability_id: "SchemaVersionedId", # required
      extrinsic_id: "ExtrinsicSchemaId", # required
      extrinsic_version: 1, # required
      schema: { # required
      },
    },
  ],
  capabilities: "Capabilities",
  client_token: "ClientToken",
  classification: "Classification",
  tags: {
    "TagKey" => "TagValue",
  },
  meta_data: {
    "AttributeName" => "AttributeValue",
  },
})

Response structure


resp.id #=> String
resp.arn #=> String
resp.created_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :role (required, String) —

    The type of device used. This will be the hub controller, cloud device, or AWS IoT device.

  • :owner (String) —

    Owner of the device, usually an indication of whom the device belongs to. This value should not contain personal identifiable information.

  • :credential_locker_id (String) —

    The identifier of the credential for the managed thing.

  • :authentication_material (required, String) —

    The authentication material defining the device connectivity setup requests. The authorization materials used are the device bar code.

  • :authentication_material_type (required, String) —

    The type of authentication material used for device connectivity setup requests.

  • :wi_fi_simple_setup_configuration (Types::WiFiSimpleSetupConfiguration) —

    The Wi-Fi Simple Setup configuration for the managed thing, which defines provisioning capabilities and timeout settings.

  • :serial_number (String) —

    The serial number of the device.

  • :brand (String) —

    The brand of the device.

  • :model (String) —

    The model of the device.

  • :name (String) —

    The name of the managed thing representing the physical device.

  • :capability_report (Types::CapabilityReport) —

    A report of the capabilities for the managed thing.

  • :capability_schemas (Array<Types::CapabilitySchemaItem>) —

    The capability schemas that define the functionality and features supported by the managed thing, including device capabilities and their associated properties.

  • :capabilities (String) —

    The capabilities of the device such as light bulb.

  • :client_token (String) —

    An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

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

  • :classification (String) —

    The classification of the managed thing such as light bulb or thermostat.

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

    A set of key/value pairs that are used to manage the managed thing.

  • :meta_data (Hash<String,String>) —

    The metadata for the managed thing.

    The managedThing metadata parameter is used for associating attributes with a managedThing that can be used for grouping over-the-air (OTA) tasks. Name value pairs in metadata can be used in the OtaTargetQueryString parameter for the CreateOtaTask API operation.

Returns:



1036
1037
1038
1039
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 1036

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

#create_notification_configuration(params = {}) ⇒ Types::CreateNotificationConfigurationResponse

Creates a notification configuration. A configuration is a connection between an event type and a destination that you have already created.

Examples:

Request syntax with placeholder values


resp = client.create_notification_configuration({
  event_type: "DEVICE_COMMAND", # required, accepts DEVICE_COMMAND, DEVICE_COMMAND_REQUEST, DEVICE_DISCOVERY_STATUS, DEVICE_EVENT, DEVICE_LIFE_CYCLE, DEVICE_STATE, DEVICE_OTA, DEVICE_WSS, CONNECTOR_ASSOCIATION, ACCOUNT_ASSOCIATION, CONNECTOR_ERROR_REPORT
  destination_name: "DestinationName", # required
  client_token: "ClientToken",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.event_type #=> String, one of "DEVICE_COMMAND", "DEVICE_COMMAND_REQUEST", "DEVICE_DISCOVERY_STATUS", "DEVICE_EVENT", "DEVICE_LIFE_CYCLE", "DEVICE_STATE", "DEVICE_OTA", "DEVICE_WSS", "CONNECTOR_ASSOCIATION", "ACCOUNT_ASSOCIATION", "CONNECTOR_ERROR_REPORT"

Parameters:

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

    ({})

Options Hash (params):

  • :event_type (required, String) —

    The type of event triggering a device notification to the customer-managed destination.

  • :destination_name (required, String) —

    The name of the destination for the notification configuration.

  • :client_token (String) —

    An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

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

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

    A set of key/value pairs that are used to manage the notification configuration.

Returns:



1085
1086
1087
1088
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 1085

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

#create_ota_task(params = {}) ⇒ Types::CreateOtaTaskResponse

Create an over-the-air (OTA) task to target a device.

Examples:

Request syntax with placeholder values


resp = client.create_ota_task({
  description: "OtaDescription",
  s3_url: "S3Url", # required
  protocol: "HTTP", # accepts HTTP
  target: ["String"],
  task_configuration_id: "OtaTaskConfigurationId",
  ota_mechanism: "PUSH", # accepts PUSH
  ota_type: "ONE_TIME", # required, accepts ONE_TIME, CONTINUOUS
  ota_target_query_string: "OtaTargetQueryString",
  client_token: "ClientToken",
  ota_scheduling_config: {
    end_behavior: "STOP_ROLLOUT", # accepts STOP_ROLLOUT, CANCEL, FORCE_CANCEL
    end_time: "EndTime",
    maintenance_windows: [
      {
        duration_in_minutes: 1,
        start_time: "StartTime",
      },
    ],
    start_time: "ScheduleStartTime",
  },
  ota_task_execution_retry_config: {
    retry_config_criteria: [
      {
        failure_type: "FAILED", # accepts FAILED, TIMED_OUT, ALL
        min_number_of_retries: 1,
      },
    ],
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.task_id #=> String
resp.task_arn #=> String
resp.description #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :description (String) —

    The description of the over-the-air (OTA) task.

  • :s3_url (required, String) —

    The URL to the Amazon S3 bucket where the over-the-air (OTA) task is stored.

  • :protocol (String) —

    The connection protocol the over-the-air (OTA) task uses to update the device.

  • :target (Array<String>) —

    The device targeted for the over-the-air (OTA) task.

  • :task_configuration_id (String) —

    The identifier for the over-the-air (OTA) task configuration.

  • :ota_mechanism (String) —

    The deployment mechanism for the over-the-air (OTA) task.

  • :ota_type (required, String) —

    The frequency type for the over-the-air (OTA) task.

  • :ota_target_query_string (String) —

    The query string to add things to the thing group.

  • :client_token (String) —

    An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

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

  • :ota_scheduling_config (Types::OtaTaskSchedulingConfig) —

    Over-the-air (OTA) task scheduling config.

  • :ota_task_execution_retry_config (Types::OtaTaskExecutionRetryConfig) —

    Over-the-air (OTA) task retry config.

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

    A set of key/value pairs that are used to manage the over-the-air (OTA) task.

Returns:



1187
1188
1189
1190
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 1187

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

#create_ota_task_configuration(params = {}) ⇒ Types::CreateOtaTaskConfigurationResponse

Create a configuraiton for the over-the-air (OTA) task.

Examples:

Request syntax with placeholder values


resp = client.create_ota_task_configuration({
  description: "OtaDescription",
  name: "OtaTaskConfigurationName",
  push_config: {
    abort_config: {
      abort_config_criteria_list: [
        {
          action: "CANCEL", # accepts CANCEL
          failure_type: "FAILED", # accepts FAILED, REJECTED, TIMED_OUT, ALL
          min_number_of_executed_things: 1,
          threshold_percentage: 1.0,
        },
      ],
    },
    rollout_config: {
      exponential_rollout_rate: {
        base_rate_per_minute: 1,
        increment_factor: 1.0,
        rate_increase_criteria: {
          number_of_notified_things: 1,
          number_of_succeeded_things: 1,
        },
      },
      maximum_per_minute: 1,
    },
    timeout_config: {
      in_progress_timeout_in_minutes: 1,
    },
  },
  client_token: "ClientToken",
})

Response structure


resp.task_configuration_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :description (String) —

    A description of the over-the-air (OTA) task configuration.

  • :name (String) —

    The name of the over-the-air (OTA) task.

  • :push_config (Types::PushConfig) —

    Describes the type of configuration used for the over-the-air (OTA) task.

  • :client_token (String) —

    An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

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

Returns:



1257
1258
1259
1260
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 1257

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

#create_provisioning_profile(params = {}) ⇒ Types::CreateProvisioningProfileResponse

Create a provisioning profile for executing device provisioning flows. The provisioning profile is a document that defines the set of resources and policies applied to a device during the provisioning process.

Examples:

Request syntax with placeholder values


resp = client.create_provisioning_profile({
  provisioning_type: "FLEET_PROVISIONING", # required, accepts FLEET_PROVISIONING, JITR
  ca_certificate: "CaCertificate",
  claim_certificate: "ClaimCertificate",
  name: "ProvisioningProfileName",
  client_token: "ClientToken",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.provisioning_type #=> String, one of "FLEET_PROVISIONING", "JITR"
resp.id #=> String
resp.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATED", "DELETE_IN_PROGRESS", "DELETE_FAILED"
resp.claim_certificate #=> String
resp.claim_certificate_private_key #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :provisioning_type (required, String) —

    The type of provisioning workflow the device uses for onboarding to IoT managed integrations.

  • :ca_certificate (String) —

    The body of the PEM-encoded certificate authority (CA) certificate.

  • :claim_certificate (String) —

    The body of the PEM-encoded claim certificate. If a claim certificate is provided, it will be used for the provisioning profile. Otherwise, a claim certificate will be generated.

  • :name (String) —

    The name of the provisioning profile.

  • :client_token (String) —

    An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

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

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

    A set of key/value pairs that are used to manage the provisioning profile.

Returns:



1330
1331
1332
1333
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 1330

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

#delete_account_association(params = {}) ⇒ Struct

Remove a third-party account association for an end user.

You must first call the DeregisterAccountAssociation to remove the connection between the managed thing and the third-party account before calling the DeleteAccountAssociation API.

Examples:

Request syntax with placeholder values


resp = client.({
  account_association_id: "AccountAssociationId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_association_id (required, String) —

    The unique identifier of the account association to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.



1356
1357
1358
1359
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 1356

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

#delete_cloud_connector(params = {}) ⇒ Struct

Delete a cloud connector.

Examples:

Request syntax with placeholder values


resp = client.delete_cloud_connector({
  identifier: "CloudConnectorId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The identifier of the cloud connector.

Returns:

  • (Struct) —

    Returns an empty response.



1376
1377
1378
1379
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 1376

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

#delete_connector_destination(params = {}) ⇒ Struct

Delete a connector destination linked to a cloud-to-cloud (C2C) connector.

Deletion can't be done if the account association has used this connector destination.

Examples:

Request syntax with placeholder values


resp = client.delete_connector_destination({
  identifier: "ConnectorDestinationId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The identifier of the connector destination.

Returns:

  • (Struct) —

    Returns an empty response.



1402
1403
1404
1405
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 1402

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

#delete_credential_locker(params = {}) ⇒ Struct

Delete a credential locker.

This operation can't be undone and any existing device won't be able to use IoT managed integrations.

Examples:

Request syntax with placeholder values


resp = client.delete_credential_locker({
  identifier: "CredentialLockerId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The identifier of the credential locker.

Returns:

  • (Struct) —

    Returns an empty response.



1427
1428
1429
1430
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 1427

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

#delete_destination(params = {}) ⇒ Struct

Deletes a notification destination specified by name.

Examples:

Request syntax with placeholder values


resp = client.delete_destination({
  name: "DestinationName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The id of the customer-managed destination.

Returns:

  • (Struct) —

    Returns an empty response.



1447
1448
1449
1450
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 1447

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

#delete_event_log_configuration(params = {}) ⇒ Struct

Delete an event log configuration.

Examples:

Request syntax with placeholder values


resp = client.delete_event_log_configuration({
  id: "LogConfigurationId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The identifier of the event log configuration.

Returns:

  • (Struct) —

    Returns an empty response.



1467
1468
1469
1470
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 1467

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

#delete_managed_thing(params = {}) ⇒ Struct

Delete a managed thing. For direct-connected and hub-connected devices connecting with Managed integrations via a controller, all of the devices connected to it will have their status changed to PENDING. It is not possible to remove a cloud-to-cloud device.

Examples:

Request syntax with placeholder values


resp = client.delete_managed_thing({
  identifier: "ManagedThingId", # required
  force: false,
})

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The id of the managed thing.

  • :force (Boolean) —

    When set to TRUE, a forceful deteletion of the managed thing will occur. When set to FALSE, a non-forceful deletion of the managed thing will occur.

Returns:

  • (Struct) —

    Returns an empty response.



1496
1497
1498
1499
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 1496

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

#delete_notification_configuration(params = {}) ⇒ Struct

Deletes a notification configuration.

Examples:

Request syntax with placeholder values


resp = client.delete_notification_configuration({
  event_type: "DEVICE_COMMAND", # required, accepts DEVICE_COMMAND, DEVICE_COMMAND_REQUEST, DEVICE_DISCOVERY_STATUS, DEVICE_EVENT, DEVICE_LIFE_CYCLE, DEVICE_STATE, DEVICE_OTA, DEVICE_WSS, CONNECTOR_ASSOCIATION, ACCOUNT_ASSOCIATION, CONNECTOR_ERROR_REPORT
})

Parameters:

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

    ({})

Options Hash (params):

  • :event_type (required, String) —

    The type of event triggering a device notification to the customer-managed destination.

Returns:

  • (Struct) —

    Returns an empty response.



1517
1518
1519
1520
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 1517

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

#delete_ota_task(params = {}) ⇒ Struct

Delete the over-the-air (OTA) task.

Examples:

Request syntax with placeholder values


resp = client.delete_ota_task({
  identifier: "OtaTaskId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The identifier of the over-the-air (OTA) task.

Returns:

  • (Struct) —

    Returns an empty response.



1537
1538
1539
1540
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 1537

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

#delete_ota_task_configuration(params = {}) ⇒ Struct

Delete the over-the-air (OTA) task configuration.

Examples:

Request syntax with placeholder values


resp = client.delete_ota_task_configuration({
  identifier: "OtaTaskConfigurationId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The identifier of the over-the-air (OTA) task configuration.

Returns:

  • (Struct) —

    Returns an empty response.



1557
1558
1559
1560
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 1557

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

#delete_provisioning_profile(params = {}) ⇒ Struct

Delete a provisioning profile.

Examples:

Request syntax with placeholder values


resp = client.delete_provisioning_profile({
  identifier: "ProvisioningProfileId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The id of the provisioning profile.

Returns:

  • (Struct) —

    Returns an empty response.



1577
1578
1579
1580
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 1577

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

#deregister_account_association(params = {}) ⇒ Struct

Deregister an account association from a managed thing.

Examples:

Request syntax with placeholder values


resp = client.({
  managed_thing_id: "ManagedThingId", # required
  account_association_id: "AccountAssociationId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :managed_thing_id (required, String) —

    The identifier of the managed thing to be deregistered from the account association.

  • :account_association_id (required, String) —

    The unique identifier of the account association to be deregistered.

Returns:

  • (Struct) —

    Returns an empty response.



1602
1603
1604
1605
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 1602

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

#get_account_association(params = {}) ⇒ Types::GetAccountAssociationResponse

Get an account association for an Amazon Web Services account linked to a customer-managed destination.

Examples:

Request syntax with placeholder values


resp = client.({
  account_association_id: "AccountAssociationId", # required
})

Response structure


resp. #=> String
resp.association_state #=> String, one of "ASSOCIATION_IN_PROGRESS", "ASSOCIATION_FAILED", "ASSOCIATION_SUCCEEDED", "ASSOCIATION_DELETING", "REFRESH_TOKEN_EXPIRED"
resp.error_message #=> String
resp.connector_destination_id #=> String
resp.name #=> String
resp.description #=> String
resp.arn #=> String
resp.o_auth_authorization_url #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.general_authorization.auth_material_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_association_id (required, String) —

    The unique identifier of the account association to retrieve.

Returns:



1648
1649
1650
1651
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 1648

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

#get_cloud_connector(params = {}) ⇒ Types::GetCloudConnectorResponse

Get configuration details for a cloud connector.

Examples:

Example: GetCloudConnector happy path for TP Link to get connector resource


resp = client.get_cloud_connector({
  identifier: "123456789012", 
})

resp.to_h outputs the following:
{
  endpoint_config: {
    lambda: {
      arn: "arn:aws:lambda:us-east-1:111122223333:function:my-function:myVersion", 
    }, 
  }, 
  endpoint_type: "LAMBDA", 
  id: "123456789012", 
  name: "Connector for TP Link Cloud V2", 
}

Example: GetCloudConnector happy path for Ring to pending status


resp = client.get_cloud_connector({
  identifier: "123456789012", 
})

resp.to_h outputs the following:
{
  endpoint_config: {
    lambda: {
      arn: "arn:aws:lambda:us-east-1:111122223333:function:my-function:myVersion", 
    }, 
  }, 
  name: "Connector for Ring Cloud", 
}

Example: GetCloudConnector error Id for Ring connector which does not exist


resp = client.get_cloud_connector({
  identifier: "123456789012", 
})

Request syntax with placeholder values


resp = client.get_cloud_connector({
  identifier: "CloudConnectorId", # required
})

Response structure


resp.name #=> String
resp.endpoint_config.lambda.arn #=> String
resp.description #=> String
resp.endpoint_type #=> String, one of "LAMBDA"
resp.id #=> String
resp.type #=> String, one of "LISTED", "UNLISTED"

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The identifier of the C2C connector.

Returns:



1725
1726
1727
1728
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 1725

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

#get_connector_destination(params = {}) ⇒ Types::GetConnectorDestinationResponse

Get connector destination details linked to a cloud-to-cloud (C2C) connector.

Examples:

Request syntax with placeholder values


resp = client.get_connector_destination({
  identifier: "ConnectorDestinationId", # required
})

Response structure


resp.name #=> String
resp.description #=> String
resp.cloud_connector_id #=> String
resp.id #=> String
resp.auth_type #=> String, one of "OAUTH"
resp.auth_config.o_auth.auth_url #=> String
resp.auth_config.o_auth.token_url #=> String
resp.auth_config.o_auth.scope #=> String
resp.auth_config.o_auth.token_endpoint_authentication_scheme #=> String, one of "HTTP_BASIC", "REQUEST_BODY_CREDENTIALS"
resp.auth_config.o_auth.o_auth_complete_redirect_url #=> String
resp.auth_config.o_auth.proactive_refresh_token_renewal.enabled #=> Boolean
resp.auth_config.o_auth.proactive_refresh_token_renewal.days_before_renewal #=> Integer
resp.auth_config.general_authorization #=> Array
resp.auth_config.general_authorization[0].secrets_manager.arn #=> String
resp.auth_config.general_authorization[0].secrets_manager.version_id #=> String
resp.auth_config.general_authorization[0].auth_material_name #=> String
resp.secrets_manager.arn #=> String
resp.secrets_manager.version_id #=> String
resp.o_auth_complete_redirect_url #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The identifier of the C2C connector destination.

Returns:



1777
1778
1779
1780
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 1777

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

#get_credential_locker(params = {}) ⇒ Types::GetCredentialLockerResponse

Get information on an existing credential locker

Examples:

Request syntax with placeholder values


resp = client.get_credential_locker({
  identifier: "CredentialLockerId", # required
})

Response structure


resp.id #=> String
resp.arn #=> String
resp.name #=> String
resp.created_at #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The identifier of the credential locker.

Returns:



1812
1813
1814
1815
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 1812

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

#get_custom_endpoint(params = {}) ⇒ Types::GetCustomEndpointResponse

Returns the IoT managed integrations custom endpoint.

Examples:

Response structure


resp.endpoint_address #=> String

Parameters:

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

    ({})

Returns:



1829
1830
1831
1832
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 1829

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

#get_default_encryption_configuration(params = {}) ⇒ Types::GetDefaultEncryptionConfigurationResponse

Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified region. For more information, see Key management in the AWS IoT SiteWise User Guide.

Examples:

Response structure


resp.configuration_status.error.code #=> String
resp.configuration_status.error.message #=> String
resp.configuration_status.state #=> String, one of "ENABLED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
resp.encryption_type #=> String, one of "MANAGED_INTEGRATIONS_DEFAULT_ENCRYPTION", "CUSTOMER_KEY_ENCRYPTION"
resp.kms_key_arn #=> String

Parameters:

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

    ({})

Returns:



1859
1860
1861
1862
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 1859

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

#get_destination(params = {}) ⇒ Types::GetDestinationResponse

Gets a destination by name.

Examples:

Request syntax with placeholder values


resp = client.get_destination({
  name: "DestinationName", # required
})

Response structure


resp.description #=> String
resp.delivery_destination_arn #=> String
resp.delivery_destination_type #=> String, one of "KINESIS"
resp.name #=> String
resp.role_arn #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the customer-managed destination.

Returns:



1900
1901
1902
1903
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 1900

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

#get_device_discovery(params = {}) ⇒ Types::GetDeviceDiscoveryResponse

Get the current state of a device discovery.

Examples:

Request syntax with placeholder values


resp = client.get_device_discovery({
  identifier: "DeviceDiscoveryId", # required
})

Response structure


resp.id #=> String
resp.arn #=> String
resp.discovery_type #=> String, one of "ZWAVE", "ZIGBEE", "CLOUD", "CUSTOM", "CONTROLLER_CAPABILITY_REDISCOVERY"
resp.status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "TIMED_OUT"
resp.started_at #=> Time
resp.controller_id #=> String
resp.connector_association_id #=> String
resp. #=> String
resp.finished_at #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The id of the device discovery job request.

Returns:



1945
1946
1947
1948
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 1945

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

#get_event_log_configuration(params = {}) ⇒ Types::GetEventLogConfigurationResponse

Get an event log configuration.

Examples:

Request syntax with placeholder values


resp = client.get_event_log_configuration({
  id: "LogConfigurationId", # required
})

Response structure


resp.id #=> String
resp.resource_type #=> String
resp.resource_id #=> String
resp.event_log_level #=> String, one of "DEBUG", "ERROR", "INFO", "WARN"

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The identifier of the event log configuration.

Returns:



1977
1978
1979
1980
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 1977

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

#get_hub_configuration(params = {}) ⇒ Types::GetHubConfigurationResponse

Get a hub configuration.

Examples:

Response structure


resp.hub_token_timer_expiry_setting_in_seconds #=> Integer
resp.updated_at #=> Time

Parameters:

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

    ({})

Returns:



1996
1997
1998
1999
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 1996

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

#get_managed_thing(params = {}) ⇒ Types::GetManagedThingResponse

Get details of a managed thing including its attributes and capabilities.

Examples:

Request syntax with placeholder values


resp = client.get_managed_thing({
  identifier: "ManagedThingId", # required
})

Response structure


resp.id #=> String
resp.arn #=> String
resp.owner #=> String
resp.credential_locker_id #=> String
resp.advertised_product_id #=> String
resp.role #=> String, one of "CONTROLLER", "DEVICE"
resp.provisioning_status #=> String, one of "UNASSOCIATED", "PRE_ASSOCIATED", "DISCOVERED", "ACTIVATED", "DELETION_FAILED", "DELETE_IN_PROGRESS", "ISOLATED", "DELETED"
resp.name #=> String
resp.model #=> String
resp.brand #=> String
resp.serial_number #=> String
resp.universal_product_code #=> String
resp.international_article_number #=> String
resp.connector_policy_id #=> String
resp.connector_destination_id #=> String
resp.connector_device_id #=> String
resp.device_specific_key #=> String
resp.mac_address #=> String
resp.parent_controller_id #=> String
resp.classification #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.activated_at #=> Time
resp.hub_network_mode #=> String, one of "STANDARD", "NETWORK_WIDE_EXCLUSION"
resp.meta_data #=> Hash
resp.meta_data["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.wi_fi_simple_setup_configuration.enable_as_provisioner #=> Boolean
resp.wi_fi_simple_setup_configuration.enable_as_provisionee #=> Boolean
resp.wi_fi_simple_setup_configuration.timeout_in_minutes #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The id of the managed thing.

Returns:



2079
2080
2081
2082
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 2079

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

#get_managed_thing_capabilities(params = {}) ⇒ Types::GetManagedThingCapabilitiesResponse

Get the capabilities for a managed thing using the device ID.

Examples:

Request syntax with placeholder values


resp = client.get_managed_thing_capabilities({
  identifier: "ManagedThingId", # required
})

Response structure


resp.managed_thing_id #=> String
resp.capabilities #=> String
resp.capability_report.version #=> String
resp.capability_report.node_id #=> String
resp.capability_report.endpoints #=> Array
resp.capability_report.endpoints[0].id #=> String
resp.capability_report.endpoints[0].device_types #=> Array
resp.capability_report.endpoints[0].device_types[0] #=> String
resp.capability_report.endpoints[0].capabilities #=> Array
resp.capability_report.endpoints[0].capabilities[0].id #=> String
resp.capability_report.endpoints[0].capabilities[0].name #=> String
resp.capability_report.endpoints[0].capabilities[0].version #=> String
resp.capability_report.endpoints[0].capabilities[0].properties #=> Array
resp.capability_report.endpoints[0].capabilities[0].properties[0] #=> String
resp.capability_report.endpoints[0].capabilities[0].actions #=> Array
resp.capability_report.endpoints[0].capabilities[0].actions[0] #=> String
resp.capability_report.endpoints[0].capabilities[0].events #=> Array
resp.capability_report.endpoints[0].capabilities[0].events[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The id of the device.

Returns:



2124
2125
2126
2127
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 2124

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

#get_managed_thing_certificate(params = {}) ⇒ Types::GetManagedThingCertificateResponse

Retrieves the certificate PEM for a managed IoT thing.

Examples:

Example: Get managed thing certificate


resp = client.get_managed_thing_certificate({
  identifier: "example-managed-thing-id", 
})

resp.to_h outputs the following:
{
  certificate_pem: "-----BEGIN CERTIFICATE-----\nMIIBkTCB+wIJAKHHH...\n-----END CERTIFICATE-----", 
  managed_thing_id: "example-managed-thing-id", 
}

Request syntax with placeholder values


resp = client.get_managed_thing_certificate({
  identifier: "ManagedThingId", # required
})

Response structure


resp.managed_thing_id #=> String
resp.certificate_pem #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The identifier of the managed thing.

Returns:



2165
2166
2167
2168
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 2165

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

#get_managed_thing_connectivity_data(params = {}) ⇒ Types::GetManagedThingConnectivityDataResponse

Get the connectivity status of a managed thing.

Examples:

Request syntax with placeholder values


resp = client.get_managed_thing_connectivity_data({
  identifier: "ManagedThingId", # required
})

Response structure


resp.managed_thing_id #=> String
resp.connected #=> Boolean
resp.timestamp #=> Time
resp.disconnect_reason #=> String, one of "AUTH_ERROR", "CLIENT_INITIATED_DISCONNECT", "CLIENT_ERROR", "CONNECTION_LOST", "DUPLICATE_CLIENTID", "FORBIDDEN_ACCESS", "MQTT_KEEP_ALIVE_TIMEOUT", "SERVER_ERROR", "SERVER_INITIATED_DISCONNECT", "THROTTLED", "WEBSOCKET_TTL_EXPIRATION", "CUSTOMAUTH_TTL_EXPIRATION", "UNKNOWN", "NONE"

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The identifier of a managed thing.

Returns:



2197
2198
2199
2200
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 2197

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

#get_managed_thing_meta_data(params = {}) ⇒ Types::GetManagedThingMetaDataResponse

Get the metadata information for a managed thing.

The managedThing metadata parameter is used for associating attributes with a managedThing that can be used for grouping over-the-air (OTA) tasks. Name value pairs in metadata can be used in the OtaTargetQueryString parameter for the CreateOtaTask API operation.

Examples:

Request syntax with placeholder values


resp = client.get_managed_thing_meta_data({
  identifier: "ManagedThingId", # required
})

Response structure


resp.managed_thing_id #=> String
resp.meta_data #=> Hash
resp.meta_data["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The managed thing id.

Returns:



2234
2235
2236
2237
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 2234

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

#get_managed_thing_state(params = {}) ⇒ Types::GetManagedThingStateResponse

Returns the managed thing state for the given device Id.

Examples:

Request syntax with placeholder values


resp = client.get_managed_thing_state({
  managed_thing_id: "ManagedThingId", # required
})

Response structure


resp.endpoints #=> Array
resp.endpoints[0].endpoint_id #=> String
resp.endpoints[0].capabilities #=> Array
resp.endpoints[0].capabilities[0].id #=> String
resp.endpoints[0].capabilities[0].name #=> String
resp.endpoints[0].capabilities[0].version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :managed_thing_id (required, String) —

    The id of the device.

Returns:



2265
2266
2267
2268
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 2265

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

#get_notification_configuration(params = {}) ⇒ Types::GetNotificationConfigurationResponse

Get a notification configuration for a specified event type.

Examples:

Request syntax with placeholder values


resp = client.get_notification_configuration({
  event_type: "DEVICE_COMMAND", # required, accepts DEVICE_COMMAND, DEVICE_COMMAND_REQUEST, DEVICE_DISCOVERY_STATUS, DEVICE_EVENT, DEVICE_LIFE_CYCLE, DEVICE_STATE, DEVICE_OTA, DEVICE_WSS, CONNECTOR_ASSOCIATION, ACCOUNT_ASSOCIATION, CONNECTOR_ERROR_REPORT
})

Response structure


resp.event_type #=> String, one of "DEVICE_COMMAND", "DEVICE_COMMAND_REQUEST", "DEVICE_DISCOVERY_STATUS", "DEVICE_EVENT", "DEVICE_LIFE_CYCLE", "DEVICE_STATE", "DEVICE_OTA", "DEVICE_WSS", "CONNECTOR_ASSOCIATION", "ACCOUNT_ASSOCIATION", "CONNECTOR_ERROR_REPORT"
resp.destination_name #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :event_type (required, String) —

    The type of event triggering a device notification to the customer-managed destination.

Returns:



2301
2302
2303
2304
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 2301

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

#get_ota_task(params = {}) ⇒ Types::GetOtaTaskResponse

Get details of the over-the-air (OTA) task by its task id.

Examples:

Request syntax with placeholder values


resp = client.get_ota_task({
  identifier: "OtaTaskId", # required
})

Response structure


resp.task_id #=> String
resp.task_arn #=> String
resp.description #=> String
resp.s3_url #=> String
resp.protocol #=> String, one of "HTTP"
resp.ota_type #=> String, one of "ONE_TIME", "CONTINUOUS"
resp.ota_target_query_string #=> String
resp.ota_mechanism #=> String, one of "PUSH"
resp.target #=> Array
resp.target[0] #=> String
resp.created_at #=> Time
resp.last_updated_at #=> Time
resp.task_configuration_id #=> String
resp.task_processing_details.number_of_canceled_things #=> Integer
resp.task_processing_details.number_of_failed_things #=> Integer
resp.task_processing_details.number_of_in_progress_things #=> Integer
resp.task_processing_details.number_of_queued_things #=> Integer
resp.task_processing_details.number_of_rejected_things #=> Integer
resp.task_processing_details.number_of_removed_things #=> Integer
resp.task_processing_details.number_of_succeeded_things #=> Integer
resp.task_processing_details.number_of_timed_out_things #=> Integer
resp.task_processing_details.processing_targets #=> Array
resp.task_processing_details.processing_targets[0] #=> String
resp.ota_scheduling_config.end_behavior #=> String, one of "STOP_ROLLOUT", "CANCEL", "FORCE_CANCEL"
resp.ota_scheduling_config.end_time #=> String
resp.ota_scheduling_config.maintenance_windows #=> Array
resp.ota_scheduling_config.maintenance_windows[0].duration_in_minutes #=> Integer
resp.ota_scheduling_config.maintenance_windows[0].start_time #=> String
resp.ota_scheduling_config.start_time #=> String
resp.ota_task_execution_retry_config.retry_config_criteria #=> Array
resp.ota_task_execution_retry_config.retry_config_criteria[0].failure_type #=> String, one of "FAILED", "TIMED_OUT", "ALL"
resp.ota_task_execution_retry_config.retry_config_criteria[0].min_number_of_retries #=> Integer
resp.status #=> String, one of "IN_PROGRESS", "CANCELED", "COMPLETED", "DELETION_IN_PROGRESS", "SCHEDULED"
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The over-the-air (OTA) task id.

Returns:



2377
2378
2379
2380
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 2377

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

#get_ota_task_configuration(params = {}) ⇒ Types::GetOtaTaskConfigurationResponse

Get a configuraiton for the over-the-air (OTA) task.

Examples:

Request syntax with placeholder values


resp = client.get_ota_task_configuration({
  identifier: "OtaTaskConfigurationId", # required
})

Response structure


resp.task_configuration_id #=> String
resp.name #=> String
resp.push_config.abort_config.abort_config_criteria_list #=> Array
resp.push_config.abort_config.abort_config_criteria_list[0].action #=> String, one of "CANCEL"
resp.push_config.abort_config.abort_config_criteria_list[0].failure_type #=> String, one of "FAILED", "REJECTED", "TIMED_OUT", "ALL"
resp.push_config.abort_config.abort_config_criteria_list[0].min_number_of_executed_things #=> Integer
resp.push_config.abort_config.abort_config_criteria_list[0].threshold_percentage #=> Float
resp.push_config.rollout_config.exponential_rollout_rate.base_rate_per_minute #=> Integer
resp.push_config.rollout_config.exponential_rollout_rate.increment_factor #=> Float
resp.push_config.rollout_config.exponential_rollout_rate.rate_increase_criteria.number_of_notified_things #=> Integer
resp.push_config.rollout_config.exponential_rollout_rate.rate_increase_criteria.number_of_succeeded_things #=> Integer
resp.push_config.rollout_config.maximum_per_minute #=> Integer
resp.push_config.timeout_config.in_progress_timeout_in_minutes #=> Integer
resp.description #=> String
resp.created_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The over-the-air (OTA) task configuration id.

Returns:



2421
2422
2423
2424
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 2421

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

#get_provisioning_profile(params = {}) ⇒ Types::GetProvisioningProfileResponse

Get details of a provisioning profile.

Examples:

Request syntax with placeholder values


resp = client.get_provisioning_profile({
  identifier: "ProvisioningProfileId", # required
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.provisioning_type #=> String, one of "FLEET_PROVISIONING", "JITR"
resp.id #=> String
resp.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATED", "DELETE_IN_PROGRESS", "DELETE_FAILED"
resp.claim_certificate #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The id of a provisioning profile.

Returns:



2460
2461
2462
2463
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 2460

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

#get_runtime_log_configuration(params = {}) ⇒ Types::GetRuntimeLogConfigurationResponse

Get the runtime log configuration for a specific managed thing.

Examples:

Request syntax with placeholder values


resp = client.get_runtime_log_configuration({
  managed_thing_id: "ManagedThingId", # required
})

Response structure


resp.managed_thing_id #=> String
resp.runtime_log_configurations.log_level #=> String, one of "DEBUG", "ERROR", "INFO", "WARN"
resp.runtime_log_configurations.log_flush_level #=> String, one of "DEBUG", "ERROR", "INFO", "WARN"
resp.runtime_log_configurations.local_store_location #=> String
resp.runtime_log_configurations.local_store_file_rotation_max_files #=> Integer
resp.runtime_log_configurations.local_store_file_rotation_max_bytes #=> Integer
resp.runtime_log_configurations.upload_log #=> Boolean
resp.runtime_log_configurations.upload_period_minutes #=> Integer
resp.runtime_log_configurations.delete_local_store_after_upload #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :managed_thing_id (required, String) —

    The id for a managed thing.

Returns:



2495
2496
2497
2498
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 2495

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

#get_schema_version(params = {}) ⇒ Types::GetSchemaVersionResponse

Gets a schema version with the provided information.

Examples:

Request syntax with placeholder values


resp = client.get_schema_version({
  type: "capability", # required, accepts capability, definition
  schema_versioned_id: "SchemaVersionedId", # required
  format: "AWS", # accepts AWS, ZCL, CONNECTOR
})

Response structure


resp.schema_id #=> String
resp.type #=> String, one of "capability", "definition"
resp.description #=> String
resp.namespace #=> String
resp.semantic_version #=> String
resp.visibility #=> String, one of "PUBLIC", "PRIVATE"

Parameters:

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

    ({})

Options Hash (params):

  • :type (required, String) —

    The type of schema version.

  • :schema_versioned_id (required, String) —

    Schema id with a version specified. If the version is missing, it defaults to latest version.

  • :format (String) —

    The format of the schema version.

Returns:



2541
2542
2543
2544
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 2541

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

#list_account_associations(params = {}) ⇒ Types::ListAccountAssociationsResponse

Lists all account associations, with optional filtering by connector destination ID.

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.items #=> Array
resp.items[0]. #=> String
resp.items[0].association_state #=> String, one of "ASSOCIATION_IN_PROGRESS", "ASSOCIATION_FAILED", "ASSOCIATION_SUCCEEDED", "ASSOCIATION_DELETING", "REFRESH_TOKEN_EXPIRED"
resp.items[0].error_message #=> String
resp.items[0].connector_destination_id #=> String
resp.items[0].name #=> String
resp.items[0].description #=> String
resp.items[0].arn #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :connector_destination_id (String) —

    The identifier of the connector destination to filter account associations by.

  • :max_results (Integer) —

    The maximum number of account associations to return in a single response.

  • :next_token (String) —

    A token used for pagination of results.

Returns:



2589
2590
2591
2592
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 2589

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

#list_cloud_connectors(params = {}) ⇒ Types::ListCloudConnectorsResponse

Returns a list of connectors filtered by its Lambda Amazon Resource Name (ARN) and type.

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

Examples:

Example: ListCloudConnectors happy path to get a list of connector resources


resp = client.list_cloud_connectors({
  max_results: 5, 
})

resp.to_h outputs the following:
{
  items: [
    {
      description: "Description for TP Link Cloud V2", 
      endpoint_config: {
        lambda: {
          arn: "arn:aws:lambda:us-east-1:111122223333:function:my-function:myVersion", 
        }, 
      }, 
      endpoint_type: "LAMBDA", 
      name: "Connector for TP Link Cloud V2", 
    }, 
    {
      description: "Description for Ring Cloud", 
      endpoint_config: {
        lambda: {
          arn: "arn:aws:lambda:us-east-1:111122223333:function:my-function:myVersion", 
        }, 
      }, 
      endpoint_type: "LAMBDA", 
      name: "Connector for Ring Cloud", 
    }, 
  ], 
}

Example: ListCloudConnectors error path for unauthorized user


resp = client.list_cloud_connectors({
  max_results: 5, 
})

Request syntax with placeholder values


resp = client.list_cloud_connectors({
  type: "LISTED", # accepts LISTED, UNLISTED
  lambda_arn: "LambdaArn",
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.items #=> Array
resp.items[0].name #=> String
resp.items[0].endpoint_config.lambda.arn #=> String
resp.items[0].description #=> String
resp.items[0].endpoint_type #=> String, one of "LAMBDA"
resp.items[0].id #=> String
resp.items[0].type #=> String, one of "LISTED", "UNLISTED"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :type (String) —

    The type of cloud connectors to filter by when listing available connectors.

  • :lambda_arn (String) —

    The Amazon Resource Name (ARN) of the Lambda function to filter cloud connectors by.

  • :max_results (Integer) —

    The maximum number of results to return at one time.

  • :next_token (String) —

    A token that can be used to retrieve the next set of results.

Returns:



2679
2680
2681
2682
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 2679

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

#list_connector_destinations(params = {}) ⇒ Types::ListConnectorDestinationsResponse

Lists all connector destinations, with optional filtering by cloud connector ID.

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_connector_destinations({
  cloud_connector_id: "CloudConnectorId",
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.connector_destination_list #=> Array
resp.connector_destination_list[0].name #=> String
resp.connector_destination_list[0].description #=> String
resp.connector_destination_list[0].cloud_connector_id #=> String
resp.connector_destination_list[0].id #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :cloud_connector_id (String) —

    The identifier of the cloud connector to filter connector destinations by.

  • :next_token (String) —

    A token used for pagination of results.

  • :max_results (Integer) —

    The maximum number of connector destinations to return in a single response.

Returns:



2724
2725
2726
2727
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 2724

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

#list_credential_lockers(params = {}) ⇒ Types::ListCredentialLockersResponse

List information on an existing credential locker.

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_credential_lockers({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].arn #=> String
resp.items[0].name #=> String
resp.items[0].created_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    A token that can be used to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return at one time.

Returns:



2762
2763
2764
2765
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 2762

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

#list_destinations(params = {}) ⇒ Types::ListDestinationsResponse

List all notification destinations.

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_destinations({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.destination_list #=> Array
resp.destination_list[0].description #=> String
resp.destination_list[0].delivery_destination_arn #=> String
resp.destination_list[0].delivery_destination_type #=> String, one of "KINESIS"
resp.destination_list[0].name #=> String
resp.destination_list[0].role_arn #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    A token that can be used to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return at one time.

Returns:



2801
2802
2803
2804
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 2801

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

#list_device_discoveries(params = {}) ⇒ Types::ListDeviceDiscoveriesResponse

Lists all device discovery tasks, with optional filtering by type and status.

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_device_discoveries({
  next_token: "NextToken",
  max_results: 1,
  type_filter: "ZWAVE", # accepts ZWAVE, ZIGBEE, CLOUD, CUSTOM, CONTROLLER_CAPABILITY_REDISCOVERY
  status_filter: "RUNNING", # accepts RUNNING, SUCCEEDED, FAILED, TIMED_OUT
})

Response structure


resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].discovery_type #=> String, one of "ZWAVE", "ZIGBEE", "CLOUD", "CUSTOM", "CONTROLLER_CAPABILITY_REDISCOVERY"
resp.items[0].status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "TIMED_OUT"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    A token used for pagination of results.

  • :max_results (Integer) —

    The maximum number of device discovery jobs to return in a single response.

  • :type_filter (String) —

    The discovery type to filter device discovery jobs by.

  • :status_filter (String) —

    The status to filter device discovery jobs by.

Returns:



2848
2849
2850
2851
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 2848

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

#list_discovered_devices(params = {}) ⇒ Types::ListDiscoveredDevicesResponse

Lists all devices discovered during a specific device discovery task.

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_discovered_devices({
  identifier: "DeviceDiscoveryId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.items #=> Array
resp.items[0].connector_device_id #=> String
resp.items[0].connector_device_name #=> String
resp.items[0].device_types #=> Array
resp.items[0].device_types[0] #=> String
resp.items[0].managed_thing_id #=> String
resp.items[0].modification #=> String, one of "DISCOVERED", "UPDATED", "NO_CHANGE"
resp.items[0].discovered_at #=> Time
resp.items[0].brand #=> String
resp.items[0].model #=> String
resp.items[0].authentication_material #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The identifier of the device discovery job to list discovered devices for.

  • :next_token (String) —

    A token used for pagination of results.

  • :max_results (Integer) —

    The maximum number of discovered devices to return in a single response.

Returns:



2898
2899
2900
2901
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 2898

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

#list_event_log_configurations(params = {}) ⇒ Types::ListEventLogConfigurationsResponse

List all event log configurations for an account.

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_event_log_configurations({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.event_log_configuration_list #=> Array
resp.event_log_configuration_list[0].id #=> String
resp.event_log_configuration_list[0].resource_type #=> String
resp.event_log_configuration_list[0].resource_id #=> String
resp.event_log_configuration_list[0].event_log_level #=> String, one of "DEBUG", "ERROR", "INFO", "WARN"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    A token that can be used to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return at one time.

Returns:



2936
2937
2938
2939
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 2936

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

#list_managed_thing_account_associations(params = {}) ⇒ Types::ListManagedThingAccountAssociationsResponse

Lists all account associations for a specific managed thing.

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

Examples:

Request syntax with placeholder values


resp = client.({
  managed_thing_id: "ManagedThingId",
  account_association_id: "AccountAssociationId",
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.items #=> Array
resp.items[0].managed_thing_id #=> String
resp.items[0]. #=> String
resp.items[0].managed_thing_association_status #=> String, one of "PRE_ASSOCIATED", "ASSOCIATED"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :managed_thing_id (String) —

    The identifier of the managed thing to list account associations for.

  • :account_association_id (String) —

    The identifier of the account association to filter results by. When specified, only associations with this account association ID will be returned.

  • :max_results (Integer) —

    The maximum number of account associations to return in a single response.

  • :next_token (String) —

    A token used for pagination of results.

Returns:



2984
2985
2986
2987
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 2984

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

#list_managed_thing_schemas(params = {}) ⇒ Types::ListManagedThingSchemasResponse

List schemas associated with a managed thing.

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_managed_thing_schemas({
  identifier: "ManagedThingId", # required
  endpoint_id_filter: "EndpointId",
  capability_id_filter: "CapabilityId",
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.items #=> Array
resp.items[0].endpoint_id #=> String
resp.items[0].capability_id #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The managed thing id.

  • :endpoint_id_filter (String) —

    Filter on an endpoint id.

  • :capability_id_filter (String) —

    Filter on a capability id.

  • :next_token (String) —

    A token that can be used to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return at one time.

Returns:



3032
3033
3034
3035
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 3032

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

#list_managed_things(params = {}) ⇒ Types::ListManagedThingsResponse

Listing all managed things with provision for filters.

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_managed_things({
  owner_filter: "Owner",
  credential_locker_filter: "CredentialLockerId",
  role_filter: "CONTROLLER", # accepts CONTROLLER, DEVICE
  parent_controller_identifier_filter: "ParentControllerId",
  connector_policy_id_filter: "ConnectorPolicyId",
  connector_destination_id_filter: "ConnectorDestinationId",
  connector_device_id_filter: "ConnectorDeviceId",
  serial_number_filter: "SerialNumber",
  provisioning_status_filter: "UNASSOCIATED", # accepts UNASSOCIATED, PRE_ASSOCIATED, DISCOVERED, ACTIVATED, DELETION_FAILED, DELETE_IN_PROGRESS, ISOLATED, DELETED
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].arn #=> String
resp.items[0].advertised_product_id #=> String
resp.items[0].brand #=> String
resp.items[0].classification #=> String
resp.items[0].connector_device_id #=> String
resp.items[0].connector_policy_id #=> String
resp.items[0].connector_destination_id #=> String
resp.items[0].model #=> String
resp.items[0].name #=> String
resp.items[0].owner #=> String
resp.items[0].credential_locker_id #=> String
resp.items[0].parent_controller_id #=> String
resp.items[0].provisioning_status #=> String, one of "UNASSOCIATED", "PRE_ASSOCIATED", "DISCOVERED", "ACTIVATED", "DELETION_FAILED", "DELETE_IN_PROGRESS", "ISOLATED", "DELETED"
resp.items[0].role #=> String, one of "CONTROLLER", "DEVICE"
resp.items[0].serial_number #=> String
resp.items[0].created_at #=> Time
resp.items[0].updated_at #=> Time
resp.items[0].activated_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :owner_filter (String) —

    Filter on device owners when listing managed things.

  • :credential_locker_filter (String) —

    Filter on a credential locker for a managed thing.

  • :role_filter (String) —

    Filter on the type of device used. This will be the Amazon Web Services hub controller, cloud device, or IoT device.

  • :parent_controller_identifier_filter (String) —

    Filter on a parent controller id for a managed thing.

  • :connector_policy_id_filter (String) —

    Filter on a connector policy id for a managed thing.

  • :connector_destination_id_filter (String) —

    Filter managed things by the connector destination ID they are associated with.

  • :connector_device_id_filter (String) —

    Filter managed things by the connector device ID they are associated with. When specified, only managed things with this connector device ID will be returned.

  • :serial_number_filter (String) —

    Filter on the serial number of the device.

  • :provisioning_status_filter (String) —

    Filter on the status of the device. For more information, see Device Provisioning.

  • :next_token (String) —

    A token that can be used to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return at one time.

Returns:



3130
3131
3132
3133
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 3130

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

#list_notification_configurations(params = {}) ⇒ Types::ListNotificationConfigurationsResponse

List all notification configurations.

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_notification_configurations({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.notification_configuration_list #=> Array
resp.notification_configuration_list[0].event_type #=> String, one of "DEVICE_COMMAND", "DEVICE_COMMAND_REQUEST", "DEVICE_DISCOVERY_STATUS", "DEVICE_EVENT", "DEVICE_LIFE_CYCLE", "DEVICE_STATE", "DEVICE_OTA", "DEVICE_WSS", "CONNECTOR_ASSOCIATION", "ACCOUNT_ASSOCIATION", "CONNECTOR_ERROR_REPORT"
resp.notification_configuration_list[0].destination_name #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to return at one time.

  • :next_token (String) —

    A token that can be used to retrieve the next set of results.

Returns:



3166
3167
3168
3169
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 3166

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

#list_ota_task_configurations(params = {}) ⇒ Types::ListOtaTaskConfigurationsResponse

List all of the over-the-air (OTA) task configurations.

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_ota_task_configurations({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.items #=> Array
resp.items[0].task_configuration_id #=> String
resp.items[0].name #=> String
resp.items[0].created_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    A token that can be used to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return at one time.

Returns:



3203
3204
3205
3206
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 3203

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

#list_ota_task_executions(params = {}) ⇒ Types::ListOtaTaskExecutionsResponse

List all of the over-the-air (OTA) task executions.

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_ota_task_executions({
  identifier: "OtaTaskId", # required
  next_token: "OtaNextToken",
  max_results: 1,
})

Response structure


resp.execution_summaries #=> Array
resp.execution_summaries[0].task_execution_summary.execution_number #=> Integer
resp.execution_summaries[0].task_execution_summary.last_updated_at #=> Time
resp.execution_summaries[0].task_execution_summary.queued_at #=> Time
resp.execution_summaries[0].task_execution_summary.retry_attempt #=> Integer
resp.execution_summaries[0].task_execution_summary.started_at #=> Time
resp.execution_summaries[0].task_execution_summary.status #=> String, one of "QUEUED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "TIMED_OUT", "REJECTED", "REMOVED", "CANCELED"
resp.execution_summaries[0].managed_thing_id #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The over-the-air (OTA) task id.

  • :next_token (String) —

    A token that can be used to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return at one time.

Returns:



3248
3249
3250
3251
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 3248

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

#list_ota_tasks(params = {}) ⇒ Types::ListOtaTasksResponse

List all of the over-the-air (OTA) tasks.

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_ota_tasks({
  next_token: "OtaNextToken",
  max_results: 1,
})

Response structure


resp.tasks #=> Array
resp.tasks[0].task_id #=> String
resp.tasks[0].task_arn #=> String
resp.tasks[0].created_at #=> Time
resp.tasks[0].last_updated_at #=> Time
resp.tasks[0].task_configuration_id #=> String
resp.tasks[0].status #=> String, one of "IN_PROGRESS", "CANCELED", "COMPLETED", "DELETION_IN_PROGRESS", "SCHEDULED"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    A token that can be used to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return at one time.

Returns:



3288
3289
3290
3291
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 3288

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

#list_provisioning_profiles(params = {}) ⇒ Types::ListProvisioningProfilesResponse

List the provisioning profiles within the Amazon Web Services account.

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_provisioning_profiles({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.items #=> Array
resp.items[0].name #=> String
resp.items[0].id #=> String
resp.items[0].arn #=> String
resp.items[0].provisioning_type #=> String, one of "FLEET_PROVISIONING", "JITR"
resp.items[0].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATED", "DELETE_IN_PROGRESS", "DELETE_FAILED"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    A token that can be used to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return at one time.

Returns:



3327
3328
3329
3330
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 3327

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

#list_schema_versions(params = {}) ⇒ Types::ListSchemaVersionsResponse

Lists schema versions with the provided information.

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

Examples:

Example: ListSchemaVersions happy path for an example schema version.


resp = client.list_schema_versions({
  schema_id: "example.ColorControl", 
  type: "capability", 
})

resp.to_h outputs the following:
{
  items: [
    {
      description: "The Color Control cluster defined as Harmony Capability.", 
      namespace: "matter", 
      schema_id: "example.ColorControl", 
      semantic_version: "1.4", 
      type: "capability", 
    }, 
  ], 
}

Example: ListSchemaVersions by version.


resp = client.list_schema_versions({
  semantic_version: "34.56", 
  type: "capability", 
})

resp.to_h outputs the following:
{
  items: [
    {
      description: "The Color Control cluster defined as Harmony Capability.", 
      namespace: "matter", 
      schema_id: "example.ColorControl", 
      semantic_version: "1.4", 
      type: "capability", 
    }, 
  ], 
}

Example: ListSchemaVersions error for invalid input.


resp = client.list_schema_versions({
  namespace: "matter", 
  schema_id: "example.ColorControl", 
  type: "capability", 
})

Request syntax with placeholder values


resp = client.list_schema_versions({
  type: "capability", # required, accepts capability, definition
  max_results: 1,
  next_token: "NextToken",
  schema_id: "SchemaId",
  namespace: "SchemaVersionNamespaceName",
  visibility: "PUBLIC", # accepts PUBLIC, PRIVATE
  semantic_version: "SchemaVersionVersion",
})

Response structure


resp.items #=> Array
resp.items[0].schema_id #=> String
resp.items[0].type #=> String, one of "capability", "definition"
resp.items[0].description #=> String
resp.items[0].namespace #=> String
resp.items[0].semantic_version #=> String
resp.items[0].visibility #=> String, one of "PUBLIC", "PRIVATE"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :type (required, String) —

    Filter on the type of schema version.

  • :max_results (Integer) —

    The maximum number of results to return at one time.

  • :next_token (String) —

    A token that can be used to retrieve the next set of results.

  • :schema_id (String) —

    Filter on the id of the schema version.

  • :namespace (String) —

    Filter on the name of the schema version.

  • :visibility (String) —

    The visibility of the schema version.

  • :semantic_version (String) —

    The schema version. If this is left blank, it defaults to the latest version.

Returns:



3437
3438
3439
3440
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 3437

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

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

Lists the tags for a specified resource.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource for which to list tags.

Returns:



3464
3465
3466
3467
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 3464

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

#put_default_encryption_configuration(params = {}) ⇒ Types::PutDefaultEncryptionConfigurationResponse

Sets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the AWS IoT SiteWise User Guide.

Examples:

Request syntax with placeholder values


resp = client.put_default_encryption_configuration({
  encryption_type: "MANAGED_INTEGRATIONS_DEFAULT_ENCRYPTION", # required, accepts MANAGED_INTEGRATIONS_DEFAULT_ENCRYPTION, CUSTOMER_KEY_ENCRYPTION
  kms_key_arn: "KmsKeyArn",
})

Response structure


resp.configuration_status.error.code #=> String
resp.configuration_status.error.message #=> String
resp.configuration_status.state #=> String, one of "ENABLED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
resp.encryption_type #=> String, one of "MANAGED_INTEGRATIONS_DEFAULT_ENCRYPTION", "CUSTOMER_KEY_ENCRYPTION"
resp.kms_key_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :encryption_type (required, String) —

    The type of encryption used for the encryption configuration.

  • :kms_key_arn (String) —

    The Key Amazon Resource Name (ARN) of the AWS KMS key used for KMS encryption if you use KMS_BASED_ENCRYPTION.

Returns:



3507
3508
3509
3510
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 3507

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

#put_hub_configuration(params = {}) ⇒ Types::PutHubConfigurationResponse

Update a hub configuration.

Examples:

Request syntax with placeholder values


resp = client.put_hub_configuration({
  hub_token_timer_expiry_setting_in_seconds: 1, # required
})

Response structure


resp.hub_token_timer_expiry_setting_in_seconds #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :hub_token_timer_expiry_setting_in_seconds (required, Integer) —

    A user-defined integer value that represents the hub token timer expiry setting in seconds.

Returns:



3534
3535
3536
3537
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 3534

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

#put_runtime_log_configuration(params = {}) ⇒ Struct

Set the runtime log configuration for a specific managed thing.

Examples:

Request syntax with placeholder values


resp = client.put_runtime_log_configuration({
  managed_thing_id: "ManagedThingId", # required
  runtime_log_configurations: { # required
    log_level: "DEBUG", # accepts DEBUG, ERROR, INFO, WARN
    log_flush_level: "DEBUG", # accepts DEBUG, ERROR, INFO, WARN
    local_store_location: "LocalStoreLocation",
    local_store_file_rotation_max_files: 1,
    local_store_file_rotation_max_bytes: 1,
    upload_log: false,
    upload_period_minutes: 1,
    delete_local_store_after_upload: false,
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :managed_thing_id (required, String) —

    The id for a managed thing.

  • :runtime_log_configurations (required, Types::RuntimeLogConfigurations) —

    The runtime log configuration for a managed thing.

Returns:

  • (Struct) —

    Returns an empty response.



3567
3568
3569
3570
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 3567

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

#register_account_association(params = {}) ⇒ Types::RegisterAccountAssociationResponse

Registers an account association with a managed thing, establishing a connection between a device and a third-party account.

Examples:

Request syntax with placeholder values


resp = client.({
  managed_thing_id: "ManagedThingId", # required
  account_association_id: "AccountAssociationId", # required
  device_discovery_id: "DeviceDiscoveryId", # required
})

Response structure


resp. #=> String
resp.device_discovery_id #=> String
resp.managed_thing_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :managed_thing_id (required, String) —

    The identifier of the managed thing to register with the account association.

  • :account_association_id (required, String) —

    The identifier of the account association to register with the managed thing.

  • :device_discovery_id (required, String) —

    The identifier of the device discovery job associated with this registration.

Returns:



3609
3610
3611
3612
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 3609

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

#register_custom_endpoint(params = {}) ⇒ Types::RegisterCustomEndpointResponse

Customers can request IoT managed integrations to manage the server trust for them or bring their own external server trusts for the custom domain. Returns an IoT managed integrations endpoint.

Examples:

Response structure


resp.endpoint_address #=> String

Parameters:

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

    ({})

Returns:



3628
3629
3630
3631
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 3628

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

#reset_runtime_log_configuration(params = {}) ⇒ Struct

Reset a runtime log configuration for a specific managed thing.

Examples:

Request syntax with placeholder values


resp = client.reset_runtime_log_configuration({
  managed_thing_id: "ManagedThingId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :managed_thing_id (required, String) —

    The id of a managed thing.

Returns:

  • (Struct) —

    Returns an empty response.



3648
3649
3650
3651
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 3648

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

#send_connector_event(params = {}) ⇒ Types::SendConnectorEventResponse

Relays third-party device events for a connector such as a new device or a device state change event.

Examples:

Request syntax with placeholder values


resp = client.send_connector_event({
  connector_id: "ConnectorId", # required
  user_id: "ThirdPartyUserId",
  operation: "DEVICE_COMMAND_RESPONSE", # required, accepts DEVICE_COMMAND_RESPONSE, DEVICE_DISCOVERY, DEVICE_EVENT, DEVICE_COMMAND_REQUEST
  operation_version: "ConnectorEventOperationVersion",
  status_code: 1,
  message: "ConnectorEventMessage",
  device_discovery_id: "DeviceDiscoveryId",
  connector_device_id: "ConnectorDeviceId",
  trace_id: "TraceId",
  devices: [
    {
      connector_device_id: "ConnectorDeviceId", # required
      connector_device_name: "ConnectorDeviceName",
      capability_report: { # required
        version: "CapabilityReportVersion", # required
        node_id: "NodeId",
        endpoints: [ # required
          {
            id: "EndpointId", # required
            device_types: ["DeviceType"], # required
            clusters: [ # required
              {
                id: "ClusterId", # required
                revision: 1, # required
                public_id: "SchemaVersionedId",
                name: "CapabilityName",
                spec_version: "SpecVersion",
                attributes: [
                  {
                    id: "MatterAttributeId",
                    name: "ActionName",
                    value: {
                    },
                  },
                ],
                commands: ["MatterCommandId"],
                events: ["MatterEventId"],
                feature_map: 1,
                generated_commands: ["MatterCommandId"],
                fabric_index: 1,
              },
            ],
            parts: ["EndpointId"],
            semantic_tags: ["EndpointSemanticTag"],
            client_clusters: ["ClusterId"],
          },
        ],
      },
      capability_schemas: [
        {
          format: "AWS", # required, accepts AWS, ZCL, CONNECTOR
          capability_id: "SchemaVersionedId", # required
          extrinsic_id: "ExtrinsicSchemaId", # required
          extrinsic_version: 1, # required
          schema: { # required
          },
        },
      ],
      device_metadata: {
      },
    },
  ],
  matter_endpoint: {
    id: "EndpointId",
    clusters: [
      {
        id: "ClusterId",
        attributes: {
        },
        commands: {
          "MatterCommandId" => {
          },
        },
        events: {
          "MatterEventId" => {
          },
        },
      },
    ],
  },
})

Response structure


resp.connector_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :connector_id (required, String) —

    The id of the connector between the third-party cloud provider and IoT managed integrations.

  • :user_id (String) —

    The id of the third-party cloud provider.

  • :operation (required, String) —

    The Open Connectivity Foundation (OCF) operation requested to be performed on the managed thing.

    The field op can have a value of "I" or "U". The field "cn" will contain the capability types.

  • :operation_version (String) —

    The Open Connectivity Foundation (OCF) security specification version for the operation being requested on the managed thing. For more information, see OCF Security Specification.

  • :status_code (Integer) —

    The status code of the Open Connectivity Foundation (OCF) operation being performed on the managed thing.

  • :message (String) —

    The device state change event payload.

    This parameter will include the following three fields:

    • uri: schema auc://<PARTNER-DEVICE-ID>/ResourcePath (The Resourcepath corresponds to an OCF resource.)

    • op: For device state changes, this field must populate as n+d.

    • cn: The content depends on the OCF resource referenced in ResourcePath.

  • :device_discovery_id (String) —

    The id for the device discovery job.

  • :connector_device_id (String) —

    The third-party device id as defined by the connector. This device id must not contain personal identifiable information (PII).

    This parameter is used for cloud-to-cloud devices only.

  • :trace_id (String) —

    The trace request identifier. This is generated by IoT managed integrations and can be used to trace this command and its related operations in CloudWatch.

  • :devices (Array<Types::Device>) —

    The list of devices.

  • :matter_endpoint (Types::MatterEndpoint) —

    The device endpoint.

Returns:



3815
3816
3817
3818
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 3815

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

#send_managed_thing_command(params = {}) ⇒ Types::SendManagedThingCommandResponse

Send the command to the device represented by the managed thing.

Examples:

Request syntax with placeholder values


resp = client.send_managed_thing_command({
  managed_thing_id: "ManagedThingId", # required
  endpoints: [ # required
    {
      endpoint_id: "EndpointId", # required
      capabilities: [ # required
        {
          id: "SchemaVersionedId", # required
          name: "CapabilityName", # required
          version: "CapabilityVersion", # required
          actions: [ # required
            {
              name: "CapabilityActionName", # required
              ref: "ActionReference",
              action_trace_id: "ActionTraceId",
              parameters: {
              },
            },
          ],
        },
      ],
    },
  ],
  connector_association_id: "ConnectorAssociationId",
  account_association_id: "AccountAssociationId",
})

Response structure


resp.trace_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :managed_thing_id (required, String) —

    The id of the device.

  • :endpoints (required, Array<Types::CommandEndpoint>) —

    The device endpoint.

  • :connector_association_id (String) —

    The ID tracking the current discovery process for one connector association.

  • :account_association_id (String) —

    The identifier of the account association to use when sending a command to a managed thing.

Returns:



3875
3876
3877
3878
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 3875

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

#start_account_association_refresh(params = {}) ⇒ Types::StartAccountAssociationRefreshResponse

Initiates a refresh of an existing account association to update its authorization and connection status.

Examples:

Request syntax with placeholder values


resp = client.({
  account_association_id: "AccountAssociationId", # required
})

Response structure


resp.o_auth_authorization_url #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_association_id (required, String) —

    The unique identifier of the account association to refresh.

Returns:



3902
3903
3904
3905
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 3902

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

#start_device_discovery(params = {}) ⇒ Types::StartDeviceDiscoveryResponse

This API is used to start device discovery for hub-connected and third-party-connected devices. The authentication material (install code) is delivered as a message to the controller instructing it to start the discovery.

Examples:

Request syntax with placeholder values


resp = client.start_device_discovery({
  discovery_type: "ZWAVE", # required, accepts ZWAVE, ZIGBEE, CLOUD, CUSTOM, CONTROLLER_CAPABILITY_REDISCOVERY
  custom_protocol_detail: {
    "CustomProtocolDetailKey" => "CustomProtocolDetailValue",
  },
  controller_identifier: "ManagedThingId",
  connector_association_identifier: "ConnectorAssociationId",
  account_association_id: "AccountAssociationId",
  authentication_material: "DiscoveryAuthMaterialString",
  authentication_material_type: "ZWAVE_INSTALL_CODE", # accepts ZWAVE_INSTALL_CODE
  client_token: "ClientToken",
  tags: {
    "TagKey" => "TagValue",
  },
  connector_device_id_list: ["ConnectorDeviceId"],
  protocol: "ZWAVE", # accepts ZWAVE, ZIGBEE, CUSTOM
  end_device_identifier: "ManagedThingId",
})

Response structure


resp.id #=> String
resp.started_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :discovery_type (required, String) —

    The discovery type supporting the type of device to be discovered in the device discovery task request.

  • :custom_protocol_detail (Hash<String,String>) —

    Additional protocol-specific details required for device discovery, which vary based on the discovery type.

    For a DiscoveryType of CUSTOM, the string-to-string map must have a key value of Name set to a non-empty-string.

  • :controller_identifier (String) —

    The id of the end-user's IoT hub.

  • :connector_association_identifier (String) —

    The id of the connector association.

  • :account_association_id (String) —

    The identifier of the cloud-to-cloud account association to use for discovery of third-party devices.

  • :authentication_material (String) —

    The authentication material required to start the local device discovery job request.

  • :authentication_material_type (String) —

    The type of authentication material used for device discovery jobs.

  • :client_token (String) —

    An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

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

    A set of key/value pairs that are used to manage the device discovery request.

  • :connector_device_id_list (Array<String>) —

    Used as a filter for PLA discoveries.

  • :protocol (String) —

    The protocol type for capability rediscovery (ZWAVE, ZIGBEE, or CUSTOM).

    This parameter is only available when the discovery type is CONTROLLER_CAPABILITY_REDISCOVERY.

  • :end_device_identifier (String) —

    The unique id of the end device for capability rediscovery.

    This parameter is only available when the discovery type is CONTROLLER_CAPABILITY_REDISCOVERY.

Returns:



4005
4006
4007
4008
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 4005

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

#tag_resource(params = {}) ⇒ Struct

Adds tags to a specified resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource to which to add tags.

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

    A set of key/value pairs that are used to manage the resource.

Returns:

  • (Struct) —

    Returns an empty response.



4031
4032
4033
4034
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 4031

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

#untag_resource(params = {}) ⇒ Struct

Removes tags from a specified resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource from which to remove tags.

  • :tag_keys (required, Array<String>) —

    A list of tag keys to remove from the resource.

Returns:

  • (Struct) —

    Returns an empty response.



4056
4057
4058
4059
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 4056

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

#update_account_association(params = {}) ⇒ Struct

Updates the properties of an existing account association.

Examples:

Request syntax with placeholder values


resp = client.({
  account_association_id: "AccountAssociationId", # required
  name: "AccountAssociationName",
  description: "AccountAssociationDescription",
})

Parameters:

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

    ({})

Options Hash (params):

  • :account_association_id (required, String) —

    The unique identifier of the account association to update.

  • :name (String) —

    The new name to assign to the account association.

  • :description (String) —

    The new description to assign to the account association.

Returns:

  • (Struct) —

    Returns an empty response.



4084
4085
4086
4087
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 4084

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

#update_cloud_connector(params = {}) ⇒ Struct

Update an existing cloud connector.

Examples:

Example: UpdateCloudConnector happy path for TP Link to update display name


resp = client.update_cloud_connector({
  identifier: "123456789012", 
  name: "Connector for TP Link Cloud V2", 
})

Example: UpdateCloudConnector error Id for Ring connector which does not exist


resp = client.update_cloud_connector({
  identifier: "123456789012", 
  name: "Connector for Ring Cloud", 
})

Request syntax with placeholder values


resp = client.update_cloud_connector({
  identifier: "CloudConnectorId", # required
  name: "DisplayName",
  description: "CloudConnectorDescription",
})

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The unique identifier of the cloud connector to update.

  • :name (String) —

    The new display name to assign to the cloud connector.

  • :description (String) —

    The new description to assign to the cloud connector.

Returns:

  • (Struct) —

    Returns an empty response.



4127
4128
4129
4130
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 4127

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

#update_connector_destination(params = {}) ⇒ Struct

Updates the properties of an existing connector destination.

Examples:

Request syntax with placeholder values


resp = client.update_connector_destination({
  identifier: "ConnectorDestinationId", # required
  description: "ConnectorDestinationDescription",
  name: "ConnectorDestinationName",
  auth_type: "OAUTH", # accepts OAUTH
  auth_config: {
    o_auth_update: {
      o_auth_complete_redirect_url: "String",
      proactive_refresh_token_renewal: {
        enabled: false,
        days_before_renewal: 1,
      },
    },
    general_authorization_update: {
      auth_materials_to_add: [
        {
          secrets_manager: { # required
            arn: "SecretsManagerArn", # required
            version_id: "SecretsManagerVersionId", # required
          },
          auth_material_name: "AuthMaterialName", # required
        },
      ],
      auth_materials_to_update: [
        {
          secrets_manager: { # required
            arn: "SecretsManagerArn", # required
            version_id: "SecretsManagerVersionId", # required
          },
          auth_material_name: "AuthMaterialName", # required
        },
      ],
    },
  },
  secrets_manager: {
    arn: "SecretsManagerArn", # required
    version_id: "SecretsManagerVersionId", # required
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The unique identifier of the connector destination to update.

  • :description (String) —

    The new description to assign to the connector destination.

  • :name (String) —

    The new display name to assign to the connector destination.

  • :auth_type (String) —

    The new authentication type to use for the connector destination.

  • :auth_config (Types::AuthConfigUpdate) —

    The updated authentication configuration details for the connector destination.

  • :secrets_manager (Types::SecretsManager) —

    The updated AWS Secrets Manager configuration for the connector destination.

Returns:

  • (Struct) —

    Returns an empty response.



4200
4201
4202
4203
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 4200

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

#update_destination(params = {}) ⇒ Struct

Update a destination specified by name.

Examples:

Request syntax with placeholder values


resp = client.update_destination({
  name: "DestinationName", # required
  delivery_destination_arn: "DeliveryDestinationArn",
  delivery_destination_type: "KINESIS", # accepts KINESIS
  role_arn: "DeliveryDestinationRoleArn",
  description: "DestinationDescription",
})

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the customer-managed destination.

  • :delivery_destination_arn (String) —

    The Amazon Resource Name (ARN) of the customer-managed destination.

  • :delivery_destination_type (String) —

    The destination type for the customer-managed destination.

  • :role_arn (String) —

    The Amazon Resource Name (ARN) of the delivery destination role.

  • :description (String) —

    The description of the customer-managed destination.

Returns:

  • (Struct) —

    Returns an empty response.



4236
4237
4238
4239
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 4236

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

#update_event_log_configuration(params = {}) ⇒ Struct

Update an event log configuration by log configuration ID.

Examples:

Request syntax with placeholder values


resp = client.update_event_log_configuration({
  id: "LogConfigurationId", # required
  event_log_level: "DEBUG", # required, accepts DEBUG, ERROR, INFO, WARN
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The log configuration id.

  • :event_log_level (required, String) —

    The log level for the event in terms of severity.

Returns:

  • (Struct) —

    Returns an empty response.



4260
4261
4262
4263
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 4260

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

#update_managed_thing(params = {}) ⇒ Struct

Update the attributes and capabilities associated with a managed thing.

Examples:

Request syntax with placeholder values


resp = client.update_managed_thing({
  identifier: "ManagedThingId", # required
  owner: "Owner",
  credential_locker_id: "CredentialLockerId",
  serial_number: "SerialNumber",
  wi_fi_simple_setup_configuration: {
    enable_as_provisioner: false,
    enable_as_provisionee: false,
    timeout_in_minutes: 1,
  },
  brand: "Brand",
  model: "Model",
  name: "Name",
  capability_report: {
    version: "CapabilityReportVersion", # required
    node_id: "NodeId",
    endpoints: [ # required
      {
        id: "EndpointId", # required
        device_types: ["DeviceType"], # required
        capabilities: [ # required
          {
            id: "SchemaVersionedId", # required
            name: "CapabilityName", # required
            version: "CapabilityVersion", # required
            properties: ["PropertyName"], # required
            actions: ["ActionName"], # required
            events: ["EventName"], # required
          },
        ],
      },
    ],
  },
  capability_schemas: [
    {
      format: "AWS", # required, accepts AWS, ZCL, CONNECTOR
      capability_id: "SchemaVersionedId", # required
      extrinsic_id: "ExtrinsicSchemaId", # required
      extrinsic_version: 1, # required
      schema: { # required
      },
    },
  ],
  capabilities: "Capabilities",
  classification: "Classification",
  hub_network_mode: "STANDARD", # accepts STANDARD, NETWORK_WIDE_EXCLUSION
  meta_data: {
    "AttributeName" => "AttributeValue",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The id of the managed thing.

  • :owner (String) —

    Owner of the device, usually an indication of whom the device belongs to. This value should not contain personal identifiable information.

  • :credential_locker_id (String) —

    The identifier of the credential for the managed thing.

  • :serial_number (String) —

    The serial number of the device.

  • :wi_fi_simple_setup_configuration (Types::WiFiSimpleSetupConfiguration) —

    The Wi-Fi Simple Setup configuration for the managed thing, which defines provisioning capabilities and timeout settings.

  • :brand (String) —

    The brand of the device.

  • :model (String) —

    The model of the device.

  • :name (String) —

    The name of the managed thing representing the physical device.

  • :capability_report (Types::CapabilityReport) —

    A report of the capabilities for the managed thing.

  • :capability_schemas (Array<Types::CapabilitySchemaItem>) —

    The updated capability schemas that define the functionality and features supported by the managed thing.

  • :capabilities (String) —

    The capabilities of the device such as light bulb.

  • :classification (String) —

    The classification of the managed thing such as light bulb or thermostat.

  • :hub_network_mode (String) —

    The network mode for the hub-connected device.

  • :meta_data (Hash<String,String>) —

    The metadata for the managed thing.

Returns:

  • (Struct) —

    Returns an empty response.



4371
4372
4373
4374
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 4371

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

#update_notification_configuration(params = {}) ⇒ Struct

Update a notification configuration.

Examples:

Request syntax with placeholder values


resp = client.update_notification_configuration({
  event_type: "DEVICE_COMMAND", # required, accepts DEVICE_COMMAND, DEVICE_COMMAND_REQUEST, DEVICE_DISCOVERY_STATUS, DEVICE_EVENT, DEVICE_LIFE_CYCLE, DEVICE_STATE, DEVICE_OTA, DEVICE_WSS, CONNECTOR_ASSOCIATION, ACCOUNT_ASSOCIATION, CONNECTOR_ERROR_REPORT
  destination_name: "DestinationName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :event_type (required, String) —

    The type of event triggering a device notification to the customer-managed destination.

  • :destination_name (required, String) —

    The name of the destination for the notification configuration.

Returns:

  • (Struct) —

    Returns an empty response.



4396
4397
4398
4399
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 4396

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

#update_ota_task(params = {}) ⇒ Struct

Update an over-the-air (OTA) task.

Examples:

Request syntax with placeholder values


resp = client.update_ota_task({
  identifier: "OtaTaskId", # required
  description: "OtaDescription",
  task_configuration_id: "OtaTaskConfigurationId",
})

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The over-the-air (OTA) task id.

  • :description (String) —

    The description of the over-the-air (OTA) task.

  • :task_configuration_id (String) —

    The identifier for the over-the-air (OTA) task configuration.

Returns:

  • (Struct) —

    Returns an empty response.



4424
4425
4426
4427
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/client.rb', line 4424

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