IotManagedIntegrationsClient

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.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion
Link copied to clipboard
class Config

Properties

Link copied to clipboard

IotManagedIntegrationsClient's configuration

Functions

Link copied to clipboard

Creates a new account association via the destination id.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun createCredentialLocker(input: CreateCredentialLockerRequest = CreateCredentialLockerRequest { }): CreateCredentialLockerResponse

Create a credential locker.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun createOtaTaskConfiguration(input: CreateOtaTaskConfigurationRequest = CreateOtaTaskConfigurationRequest { }): CreateOtaTaskConfigurationResponse

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

Link copied to clipboard

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 copied to clipboard

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

Link copied to clipboard

Delete a cloud connector.

Link copied to clipboard

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

Link copied to clipboard

Delete a credential locker.

Link copied to clipboard

Deletes a notification destination specified by name.

Link copied to clipboard

Delete an event log configuration.

Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Delete a provisioning profile.

Link copied to clipboard

Deregister an account association from a managed thing.

Link copied to clipboard

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

Link copied to clipboard

Get configuration details for a cloud connector.

Link copied to clipboard

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

Link copied to clipboard

Get information on an existing credential locker

Link copied to clipboard
abstract suspend fun getCustomEndpoint(input: GetCustomEndpointRequest = GetCustomEndpointRequest { }): GetCustomEndpointResponse

Returns the IoT managed integrations custom endpoint.

Link copied to clipboard
abstract suspend fun getDefaultEncryptionConfiguration(input: GetDefaultEncryptionConfigurationRequest = GetDefaultEncryptionConfigurationRequest { }): 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.

Link copied to clipboard

Gets a destination by name.

Link copied to clipboard

Get the current state of a device discovery.

Link copied to clipboard

Get an event log configuration.

Link copied to clipboard
abstract suspend fun getHubConfiguration(input: GetHubConfigurationRequest = GetHubConfigurationRequest { }): GetHubConfigurationResponse

Get a hub configuration.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Retrieves the certificate PEM for a managed IoT thing.

Link copied to clipboard

Get the connectivity status of a managed thing.

Link copied to clipboard

Get the metadata information for a managed thing.

Link copied to clipboard

Returns the managed thing state for the given device Id.

Link copied to clipboard

Get a notification configuration for a specified event type.

Link copied to clipboard
abstract suspend fun getOtaTask(input: GetOtaTaskRequest): GetOtaTaskResponse

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

Link copied to clipboard

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

Link copied to clipboard

Get a provisioning profile by template name.

Link copied to clipboard

Get the runtime log configuration for a specific managed thing.

Link copied to clipboard

Gets a schema version with the provided information.

Link copied to clipboard
abstract suspend fun listAccountAssociations(input: ListAccountAssociationsRequest = ListAccountAssociationsRequest { }): ListAccountAssociationsResponse

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

Link copied to clipboard
abstract suspend fun listCloudConnectors(input: ListCloudConnectorsRequest = ListCloudConnectorsRequest { }): ListCloudConnectorsResponse

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

Link copied to clipboard
abstract suspend fun listConnectorDestinations(input: ListConnectorDestinationsRequest = ListConnectorDestinationsRequest { }): ListConnectorDestinationsResponse

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

Link copied to clipboard
abstract suspend fun listCredentialLockers(input: ListCredentialLockersRequest = ListCredentialLockersRequest { }): ListCredentialLockersResponse

List information on an existing credential locker.

Link copied to clipboard
abstract suspend fun listDestinations(input: ListDestinationsRequest = ListDestinationsRequest { }): ListDestinationsResponse

List all notification destinations.

Link copied to clipboard
abstract suspend fun listDeviceDiscoveries(input: ListDeviceDiscoveriesRequest = ListDeviceDiscoveriesRequest { }): ListDeviceDiscoveriesResponse

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

Link copied to clipboard

Lists all devices discovered during a specific device discovery task.

Link copied to clipboard
abstract suspend fun listEventLogConfigurations(input: ListEventLogConfigurationsRequest = ListEventLogConfigurationsRequest { }): ListEventLogConfigurationsResponse

List all event log configurations for an account.

Link copied to clipboard
abstract suspend fun listManagedThingAccountAssociations(input: ListManagedThingAccountAssociationsRequest = ListManagedThingAccountAssociationsRequest { }): ListManagedThingAccountAssociationsResponse

Lists all account associations for a specific managed thing.

Link copied to clipboard
abstract suspend fun listManagedThings(input: ListManagedThingsRequest = ListManagedThingsRequest { }): ListManagedThingsResponse

Listing all managed things with provision for filters.

Link copied to clipboard

List schemas associated with a managed thing.

Link copied to clipboard
abstract suspend fun listNotificationConfigurations(input: ListNotificationConfigurationsRequest = ListNotificationConfigurationsRequest { }): ListNotificationConfigurationsResponse

List all notification configurations.

Link copied to clipboard
abstract suspend fun listOtaTaskConfigurations(input: ListOtaTaskConfigurationsRequest = ListOtaTaskConfigurationsRequest { }): ListOtaTaskConfigurationsResponse

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

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun listOtaTasks(input: ListOtaTasksRequest = ListOtaTasksRequest { }): ListOtaTasksResponse

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

Link copied to clipboard
abstract suspend fun listProvisioningProfiles(input: ListProvisioningProfilesRequest = ListProvisioningProfilesRequest { }): ListProvisioningProfilesResponse

List the provisioning profiles within the Amazon Web Services account.

Link copied to clipboard

Lists schema versions with the provided information.

Link copied to clipboard

Lists the tags for a specified resource.

Link copied to clipboard

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 copied to clipboard

Update a hub configuration.

Link copied to clipboard

Set the runtime log configuration for a specific managed thing.

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun registerCustomEndpoint(input: RegisterCustomEndpointRequest = RegisterCustomEndpointRequest { }): 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.

Link copied to clipboard

Reset a runtime log configuration for a specific managed thing.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds tags to a specified resource.

Link copied to clipboard

Removes tags from a specified resource.

Link copied to clipboard

Updates the properties of an existing account association.

Link copied to clipboard

Update an existing cloud connector.

Link copied to clipboard

Updates the properties of an existing connector destination.

Link copied to clipboard

Update a destination specified by name.

Link copied to clipboard

Update an event log configuration by log configuration ID.

Link copied to clipboard

Update the attributes and capabilities associated with a managed thing.

Link copied to clipboard
Link copied to clipboard

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

Inherited functions

Link copied to clipboard

Creates a new account association via the destination id.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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 copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

Deletes a notification destination specified by name.

Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

Deregister an account association from a managed thing.

Link copied to clipboard

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

Link copied to clipboard

Get configuration details for a cloud connector.

Link copied to clipboard

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

Link copied to clipboard

Get information on an existing credential locker

Link copied to clipboard

Returns the IoT managed integrations custom endpoint.

Link copied to clipboard

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 copied to clipboard

Gets a destination by name.

Link copied to clipboard

Get the current state of a device discovery.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Retrieves the certificate PEM for a managed IoT thing.

Link copied to clipboard
Link copied to clipboard

Get the metadata information for a managed thing.

Link copied to clipboard

Returns the managed thing state for the given device Id.

Link copied to clipboard

Get a notification configuration for a specified event type.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Get a provisioning profile by template name.

Link copied to clipboard

Get the runtime log configuration for a specific managed thing.

Link copied to clipboard

Gets a schema version with the provided information.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

List information on an existing credential locker.

Link copied to clipboard

List all notification destinations.

Link copied to clipboard

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

Link copied to clipboard

Lists all devices discovered during a specific device discovery task.

Link copied to clipboard

List all event log configurations for an account.

Link copied to clipboard

Lists all account associations for a specific managed thing.

Link copied to clipboard

Listing all managed things with provision for filters.

Link copied to clipboard

List schemas associated with a managed thing.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

List the provisioning profiles within the Amazon Web Services account.

Link copied to clipboard

Lists schema versions with the provided information.

Link copied to clipboard

Lists the tags for a specified resource.

Link copied to clipboard

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 copied to clipboard

Update a hub configuration.

Link copied to clipboard

Set the runtime log configuration for a specific managed thing.

Link copied to clipboard

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

Link copied to clipboard

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 copied to clipboard

Reset a runtime log configuration for a specific managed thing.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Adds tags to a specified resource.

Link copied to clipboard

Removes tags from a specified resource.

Link copied to clipboard

Updates the properties of an existing account association.

Link copied to clipboard

Update an existing cloud connector.

Link copied to clipboard

Updates the properties of an existing connector destination.

Link copied to clipboard

Update a destination specified by name.

Link copied to clipboard

Update an event log configuration by log configuration ID.

Link copied to clipboard

Update the attributes and capabilities associated with a managed thing.

Link copied to clipboard

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

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.