View Source AWS.IoTManagedIntegrations (aws-elixir v1.0.10)
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
Creates a new account association via the destination id.
Creates a C2C (cloud-to-cloud) connector.
Create a connector destination for connecting a cloud-to-cloud (C2C) connector to the customer's Amazon Web Services account.
Create a credential locker.
Create a notification destination such as Kinesis Data Streams that receive events and notifications from Managed integrations.
Set the event log configuration for the account, resource type, or specific resource.
Creates a managed thing.
Creates a notification configuration.
Create an over-the-air (OTA) task to target 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.
Remove a third-party account association for an end user.
Delete a cloud connector.
Delete a connector destination linked to a cloud-to-cloud (C2C) connector.
Delete a credential locker.
Deletes a notification destination specified by name.
Delete an event log configuration.
Delete a managed thing.
Deletes a notification configuration.
Delete the over-the-air (OTA) task.
Delete the over-the-air (OTA) task configuration.
Delete a provisioning profile.
Deregister an account association from a managed thing.
Get an account association for an Amazon Web Services account linked to a customer-managed destination.
Get configuration details for a cloud connector.
Get connector destination details linked to a cloud-to-cloud (C2C) connector.
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.
Gets a destination by name.
Get the current state of a device discovery.
Get an event log configuration.
Get a hub configuration.
Get details of a managed thing including its attributes and capabilities.
Get the capabilities for a managed thing using the device ID.
Retrieves the certificate PEM for a managed IoT thing.
Get the connectivity status of a managed thing.
Get the metadata information for a managed thing.
Returns the managed thing state for the given device Id.
Get a notification configuration for a specified event type.
Get details of the over-the-air (OTA) task by its task id.
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.
Gets a schema version with the provided information.
Lists all account associations, with optional filtering by connector destination ID.
Returns a list of connectors filtered by its Lambda Amazon Resource Name (ARN)
and type.
Lists all connector destinations, with optional filtering by cloud connector ID.
List information on an existing credential locker.
List all notification destinations.
Lists all device discovery tasks, with optional filtering by type and status.
Lists all devices discovered during a specific device discovery task.
List all event log configurations for an account.
Lists all account associations for a specific managed thing.
List schemas associated with a managed thing.
Listing all managed things with provision for filters.
List all notification configurations.
List all of the over-the-air (OTA) task configurations.
List all of the over-the-air (OTA) task executions.
List all of the over-the-air (OTA) tasks.
List the provisioning profiles within the Amazon Web Services account.
Lists schema versions with the provided information.
List tags for the specified resource.
Sets the default encryption configuration for the Amazon Web Services account.
Update a hub configuration.
Set the runtime log configuration for a specific managed thing or for all managed things as a group.
Registers an account association with a managed thing, establishing a connection between a device and a third-party account.
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.
Relays third-party device events for a connector such as a new device or a device state change event.
Send the command to the device represented by the managed thing.
Initiates a refresh of an existing account association to update its authorization and connection status.
This API is used to start device discovery for hub-connected and third-party-connected devices.
Add tags for the specified resource.
Remove tags for the specified resource.
Updates the properties of an existing account association.
Update an existing cloud connector.
Updates the properties of an existing connector destination.
Update a destination specified by name.
Update an event log configuration by log configuration ID.
Update the attributes and capabilities associated with a managed thing.
Update a notification configuration.
Update an over-the-air (OTA) task.
Link to this section Functions
Creates a new account association via the destination id.
Creates a C2C (cloud-to-cloud) connector.
Create a connector destination for connecting a cloud-to-cloud (C2C) connector to the customer's Amazon Web Services account.
Create a credential locker.
This operation will not trigger the creation of all the manufacturing resources.
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.
Set the event log configuration for the account, resource type, or specific resource.
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.
Creates a notification configuration.
A configuration is a connection between an event type and a destination that you have already created.
Create an over-the-air (OTA) task to target 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.
The provisioning template is a document that defines the set of resources and policies applied to a device during the provisioning process.
delete_account_association(client, account_association_id, input, options \\ [])
View SourceRemove 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.
Delete a cloud connector.
delete_connector_destination(client, identifier, input, options \\ [])
View SourceDelete 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.
delete_credential_locker(client, identifier, input, options \\ [])
View SourceDelete a credential locker.
This operation can't be undone and any existing device won't be able to use IoT managed integrations.
Deletes a notification destination specified by name.
Delete an event log configuration.
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.
delete_notification_configuration(client, event_type, input, options \\ [])
View SourceDeletes a notification configuration.
Delete the over-the-air (OTA) task.
delete_ota_task_configuration(client, identifier, input, options \\ [])
View SourceDelete the over-the-air (OTA) task configuration.
delete_provisioning_profile(client, identifier, input, options \\ [])
View SourceDelete a provisioning profile.
Deregister an account association from a managed thing.
get_account_association(client, account_association_id, options \\ [])
View SourceGet an account association for an Amazon Web Services account linked to a customer-managed destination.
Get configuration details for a cloud connector.
Get connector destination details linked to a cloud-to-cloud (C2C) connector.
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.
For more information, see Key management in the AWS IoT SiteWise User Guide.
Gets a destination by name.
Get the current state of a device discovery.
Get an event log configuration.
Get a hub configuration.
Get details of a managed thing including its attributes and capabilities.
Get the capabilities for a managed thing using the device ID.
Retrieves the certificate PEM for a managed IoT thing.
get_managed_thing_connectivity_data(client, identifier, input, options \\ [])
View SourceGet the connectivity status of a managed thing.
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.
Returns the managed thing state for the given device Id.
Get a notification configuration for a specified event type.
Get details of the over-the-air (OTA) task by its task id.
Get a configuraiton for the over-the-air (OTA) task.
Get a provisioning profile by template name.
get_runtime_log_configuration(client, managed_thing_id, options \\ [])
View SourceGet the runtime log configuration for a specific managed thing.
get_schema_version(client, schema_versioned_id, type, format \\ nil, options \\ [])
View SourceGets a schema version with the provided information.
list_account_associations(client, connector_destination_id \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists all account associations, with optional filtering by connector destination ID.
list_cloud_connectors(client, lambda_arn \\ nil, max_results \\ nil, next_token \\ nil, type \\ nil, options \\ [])
View SourceReturns a list of connectors filtered by its Lambda Amazon Resource Name (ARN)
and type.
list_connector_destinations(client, cloud_connector_id \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists all connector destinations, with optional filtering by cloud connector ID.
list_credential_lockers(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceList information on an existing credential locker.
list_destinations(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceList all notification destinations.
list_device_discoveries(client, max_results \\ nil, next_token \\ nil, status_filter \\ nil, type_filter \\ nil, options \\ [])
View SourceLists all device discovery tasks, with optional filtering by type and status.
list_discovered_devices(client, identifier, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists all devices discovered during a specific device discovery task.
list_event_log_configurations(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceList all event log configurations for an account.
list_managed_thing_account_associations(client, account_association_id \\ nil, managed_thing_id \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists all account associations for a specific managed thing.
list_managed_thing_schemas(client, identifier, capability_id_filter \\ nil, endpoint_id_filter \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceList schemas associated with a managed thing.
list_managed_things(client, connector_destination_id_filter \\ nil, connector_device_id_filter \\ nil, 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 SourceListing all managed things with provision for filters.
list_notification_configurations(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceList all notification configurations.
list_ota_task_configurations(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceList all of the over-the-air (OTA) task configurations.
list_ota_task_executions(client, identifier, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceList all of the over-the-air (OTA) task executions.
list_ota_tasks(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceList all of the over-the-air (OTA) tasks.
list_provisioning_profiles(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceList the provisioning profiles within the Amazon Web Services account.
list_schema_versions(client, type, max_results \\ nil, namespace \\ nil, next_token \\ nil, schema_id \\ nil, semantic_version \\ nil, visibility \\ nil, options \\ [])
View SourceLists schema versions with the provided information.
List tags for the specified resource.
put_default_encryption_configuration(client, input, options \\ [])
View SourceSets the default encryption configuration for the Amazon Web Services account.
For more information, see Key management in the AWS IoT SiteWise User Guide.
Update a hub configuration.
put_runtime_log_configuration(client, managed_thing_id, input, options \\ [])
View SourceSet the runtime log configuration for a specific managed thing or for all managed things as a group.
Registers an account association with a managed thing, establishing a connection between a device and a third-party account.
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.
reset_runtime_log_configuration(client, managed_thing_id, input, options \\ [])
View SourceReset a runtime log configuration for a specific managed thing.
Relays third-party device events for a connector such as a new device or a device state change event.
send_managed_thing_command(client, managed_thing_id, input, options \\ [])
View SourceSend the command to the device represented by the managed thing.
start_account_association_refresh(client, account_association_id, input, options \\ [])
View SourceInitiates a refresh of an existing account association to update its authorization and connection status.
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.
Add tags for the specified resource.
Remove tags for the specified resource.
update_account_association(client, account_association_id, input, options \\ [])
View SourceUpdates the properties of an existing account association.
Update an existing cloud connector.
update_connector_destination(client, identifier, input, options \\ [])
View SourceUpdates the properties of an existing connector destination.
Update a destination specified by name.
Update an event log configuration by log configuration ID.
Update the attributes and capabilities associated with a managed thing.
update_notification_configuration(client, event_type, input, options \\ [])
View SourceUpdate a notification configuration.
Update an over-the-air (OTA) task.