View Source AWS.IoTManagedIntegrations (aws-elixir v1.0.6)

Managed integrations is a feature of AWS IoT Device Management that enables developers to quickly build innovative IoT solutions.

Customers can use managed integrations to automate device setup workflows and support interoperability across many devices, regardless of device vendor or connectivity protocol. This allows developers to use a single user-interface to control, manage, and operate a range of devices.

Link to this section Summary

Functions

Create a product credential locker.

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

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

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

Create a provisioning profile for a device to execute the provisioning flows using a provisioning template.

Deletes a customer-managed destination specified by id.

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

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

Get information on an existing credential locker

Returns the IoT managed integrations custom endpoint.

Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified region.

Get the current state of a device discovery.

Get the attributes and capabilities associated with a managed thing.

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

Get the metadata information for a managed thing.

Returns the managed thing state for the given device Id.

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

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

Get a provisioning profile by template name.

Get the runtime log configuration for a specific managed thing or for all managed things as a group.

List all destination names under one Amazon Web Services account.

List the provisioning profiles within the Amazon Web Services account.

Sets the default encryption configuration for the Amazon Web Services account.

Set the runtime log configuration for a specific managed thing or for all managed things as a group.

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

Reset a runtime log configuration for a specific managed thing or for all managed things as a group.

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

During user-guided setup, this is used to start device discovery.

Update a destination specified by id.

Update an event log configuration by log configuration ID.

Update the attributes and capabilities associated with a managed thing.

Link to this section Functions

Link to this function

create_credential_locker(client, input, options \\ [])

View Source

Create a product credential locker.

This operation will trigger the creation of all the manufacturing resources including the Wi-Fi setup key pair and device certificate.

Link to this function

create_destination(client, input, options \\ [])

View Source

Create a destination.

IoT managed integrations uses the destination to determine where to deliver notifications for a device.

Link to this function

create_event_log_configuration(client, input, options \\ [])

View Source

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

Link to this function

create_managed_thing(client, input, options \\ [])

View Source

Creates a managed thing.

A managed thing contains the device identifier, protocol supported, and capabilities of the device in a protocol-specific format.

Link to this function

create_notification_configuration(client, input, options \\ [])

View Source

Creates a notification configuration.

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

Link to this function

create_ota_task(client, input, options \\ [])

View Source

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

Link to this function

create_ota_task_configuration(client, input, options \\ [])

View Source

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

Link to this function

create_provisioning_profile(client, input, options \\ [])

View Source

Create a provisioning profile for a device to execute the provisioning flows using a provisioning template.

The provisioning template is a document that defines the set of resources and policies applied to a device during the provisioning process.

Link to this function

delete_credential_locker(client, identifier, input, options \\ [])

View Source

Delete a credential locker.

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

Link to this function

delete_destination(client, name, input, options \\ [])

View Source

Deletes a customer-managed destination specified by id.

Link to this function

delete_event_log_configuration(client, id, input, options \\ [])

View Source

Delete an event log configuration.

Link to this function

delete_managed_thing(client, identifier, input, options \\ [])

View Source

Delete a managed thing.

If a controller is deleted, all of the devices connected to it will have their status changed to PENDING. It is not possible to remove a cloud device.

Link to this function

delete_notification_configuration(client, event_type, input, options \\ [])

View Source

Deletes a notification configuration.

Link to this function

delete_ota_task(client, identifier, input, options \\ [])

View Source

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

Link to this function

delete_ota_task_configuration(client, identifier, input, options \\ [])

View Source

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

Link to this function

delete_provisioning_profile(client, identifier, input, options \\ [])

View Source

Delete a provisioning profile.

Link to this function

get_credential_locker(client, identifier, options \\ [])

View Source

Get information on an existing credential locker

Link to this function

get_custom_endpoint(client, options \\ [])

View Source

Returns the IoT managed integrations custom endpoint.

Link to this function

get_default_encryption_configuration(client, options \\ [])

View Source

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.

Link to this function

get_destination(client, name, options \\ [])

View Source

Gets a destination by ID.

Link to this function

get_device_discovery(client, identifier, options \\ [])

View Source

Get the current state of a device discovery.

Link to this function

get_event_log_configuration(client, id, options \\ [])

View Source

Get an event log configuration.

Link to this function

get_hub_configuration(client, options \\ [])

View Source

Get a hub configuration.

Link to this function

get_managed_thing(client, identifier, options \\ [])

View Source

Get the attributes and capabilities associated with a managed thing.

Link to this function

get_managed_thing_capabilities(client, identifier, options \\ [])

View Source

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

Link to this function

get_managed_thing_connectivity_data(client, identifier, input, options \\ [])

View Source

Get the connectivity status of a managed thing.

Link to this function

get_managed_thing_meta_data(client, identifier, options \\ [])

View Source

Get the metadata information for a managed thing.

Link to this function

get_managed_thing_state(client, managed_thing_id, options \\ [])

View Source

Returns the managed thing state for the given device Id.

Link to this function

get_notification_configuration(client, event_type, options \\ [])

View Source

Get a notification configuration.

Link to this function

get_ota_task(client, identifier, options \\ [])

View Source

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

Link to this function

get_ota_task_configuration(client, identifier, options \\ [])

View Source

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

Link to this function

get_provisioning_profile(client, identifier, options \\ [])

View Source

Get a provisioning profile by template name.

Link to this function

get_runtime_log_configuration(client, managed_thing_id, options \\ [])

View Source

Get the runtime log configuration for a specific managed thing or for all managed things as a group.

Link to this function

get_schema_version(client, schema_versioned_id, type, format \\ nil, options \\ [])

View Source

Gets a schema version with the provided information.

Link to this function

list_credential_lockers(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

List information on an existing credential locker.

Link to this function

list_destinations(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

List all destination names under one Amazon Web Services account.

Link to this function

list_event_log_configurations(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

List all event log configurations for an account.

Link to this function

list_managed_thing_schemas(client, identifier, capability_id_filter \\ nil, endpoint_id_filter \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

List schemas associated with a managed thing.

Link to this function

list_managed_things(client, connector_policy_id_filter \\ nil, credential_locker_filter \\ nil, max_results \\ nil, next_token \\ nil, owner_filter \\ nil, parent_controller_identifier_filter \\ nil, provisioning_status_filter \\ nil, role_filter \\ nil, serial_number_filter \\ nil, options \\ [])

View Source

List all of the associations and statuses for a managed thing by its owner.

Link to this function

list_notification_configurations(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

List all notification configurations.

Link to this function

list_ota_task_configurations(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_ota_task_executions(client, identifier, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_ota_tasks(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_provisioning_profiles(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

List the provisioning profiles within the Amazon Web Services account.

Link to this function

list_schema_versions(client, type, max_results \\ nil, namespace \\ nil, next_token \\ nil, schema_id \\ nil, semantic_version \\ nil, visibility \\ nil, options \\ [])

View Source

Lists schema versions with the provided information.

Link to this function

put_default_encryption_configuration(client, input, options \\ [])

View Source

Sets the default encryption configuration for the Amazon Web Services account.

For more information, see Key management in the AWS IoT SiteWise User Guide.

Link to this function

put_hub_configuration(client, input, options \\ [])

View Source

Update a hub configuration.

Link to this function

put_runtime_log_configuration(client, managed_thing_id, input, options \\ [])

View Source

Set the runtime log configuration for a specific managed thing or for all managed things as a group.

Link to this function

register_custom_endpoint(client, input, options \\ [])

View Source

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.

Link to this function

reset_runtime_log_configuration(client, managed_thing_id, input, options \\ [])

View Source

Reset a runtime log configuration for a specific managed thing or for all managed things as a group.

Link to this function

send_managed_thing_command(client, managed_thing_id, input, options \\ [])

View Source

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

Link to this function

start_device_discovery(client, input, options \\ [])

View Source

During user-guided setup, this is used to start device discovery.

The authentication material (install code) is passed as a message to the controller telling it to start the discovery.

Link to this function

update_destination(client, name, input, options \\ [])

View Source

Update a destination specified by id.

Link to this function

update_event_log_configuration(client, id, input, options \\ [])

View Source

Update an event log configuration by log configuration ID.

Link to this function

update_managed_thing(client, identifier, input, options \\ [])

View Source

Update the attributes and capabilities associated with a managed thing.

Link to this function

update_notification_configuration(client, event_type, input, options \\ [])

View Source

Update a notification configuration.

Link to this function

update_ota_task(client, identifier, input, options \\ [])

View Source

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