Amazon Web Services, Inc.

Managed integrations for AWS IoT Device Management

Managed integrations is a feature of AWS IoT Device Management that enables developers to quickly build innovative IoT solutions. Customers can use managed…

IoT & devices#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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.

Endpoints 83

Account association

  • GETList account associations/account-associations?ConnectorDestinationId=string&MaxResults=0&NextToken=stringLists all account associations, with optional filtering by connector destination ID.
  • POSTCreate account association/account-associationsCreates a new account association via the destination id.
  • GETGet account association/account-associations/:AccountAssociationIdGet an account association for an Amazon Web Services account linked to a customer-managed destination.
  • PUTUpdate account association/account-associations/:AccountAssociationIdUpdates the properties of an existing account association.
  • DELETEDelete account association/account-associations/:AccountAssociationIdRemove a third-party account association for an end user. You must first call the DeregisterAccountAssociation to remove the connection between the managed…
  • POSTStart account association refresh/account-associations/:AccountAssociationId/refreshInitiates a refresh of an existing account association to update its authorization and connection status.

Cloud connector

  • GETList cloud connectors/cloud-connectors?Type=string&LambdaArn=string&MaxResults=0&NextToken=stringReturns a list of connectors filtered by its Lambda Amazon Resource Name (ARN) and type .
  • POSTCreate cloud connector/cloud-connectorsCreates a C2C (cloud-to-cloud) connector.
  • GETGet cloud connector/cloud-connectors/:IdentifierGet configuration details for a cloud connector.
  • PUTUpdate cloud connector/cloud-connectors/:IdentifierUpdate an existing cloud connector.
  • DELETEDelete cloud connector/cloud-connectors/:IdentifierDelete a cloud connector.

Connector destination

  • GETList connector destinations/connector-destinations?CloudConnectorId=string&NextToken=string&MaxResults=0Lists all connector destinations, with optional filtering by cloud connector ID.
  • POSTCreate connector destination/connector-destinationsCreate a connector destination for connecting a cloud-to-cloud (C2C) connector to the customer's Amazon Web Services account.
  • GETGet connector destination/connector-destinations/:IdentifierGet connector destination details linked to a cloud-to-cloud (C2C) connector.
  • PUTUpdate connector destination/connector-destinations/:IdentifierUpdates the properties of an existing connector destination.
  • DELETEDelete connector destination/connector-destinations/:IdentifierDelete a connector destination linked to a cloud-to-cloud (C2C) connector. Deletion can't be done if the account association has used this connector…

Credential locker

  • GETList credential lockers/credential-lockers?NextToken=string&MaxResults=0List information on an existing credential locker.
  • POSTCreate credential locker/credential-lockersCreate a credential locker. This operation will not trigger the creation of all the manufacturing resources.
  • GETGet credential locker/credential-lockers/:IdentifierGet information on an existing credential locker
  • DELETEDelete credential locker/credential-lockers/:IdentifierDelete a credential locker. This operation can't be undone and any existing device won't be able to use IoT managed integrations.

Destination

  • GETList destinations/destinations?NextToken=string&MaxResults=0List all notification destinations.
  • POSTCreate destination/destinationsCreate a notification destination such as Kinesis Data Streams that receive events and notifications from Managed integrations. Managed integrations uses the…
  • GETGet destination/destinations/:NameGets a destination by name.
  • PUTUpdate destination/destinations/:NameUpdate a destination specified by name.
  • DELETEDelete destination/destinations/:NameDeletes a notification destination specified by name.

Event log configuration

  • GETList event log configurations/event-log-configurations?NextToken=string&MaxResults=0List all event log configurations for an account.
  • POSTCreate event log configuration/event-log-configurationsSet the event log configuration for the account, resource type, or specific resource.
  • GETGet event log configuration/event-log-configurations/:IdGet an event log configuration.
  • DELETEDelete event log configuration/event-log-configurations/:IdDelete an event log configuration.
  • PATCHUpdate event log configuration/event-log-configurations/:IdUpdate an event log configuration by log configuration ID.

Managed thing

  • GETList managed things/managed-things?OwnerFilter=string&CredentialLockerFilter=string&RoleFilter=string&ParentControllerIdentifierFilter=string&ConnectorPolicyIdFilter=string&ConnectorDestinationIdFilter=string&ConnectorDeviceIdFilter=string&SerialNumberFilter=string&ProvisioningStatusFilter=string&NextToken=string&MaxResults=0Listing all managed things with provision for filters.
  • POSTCreate managed thing/managed-thingsCreates a managed thing. A managed thing contains the device identifier, protocol supported, and capabilities of the device in a data model format defined by…
  • GETGet managed thing/managed-things/:IdentifierGet details of a managed thing including its attributes and capabilities.
  • PUTUpdate managed thing/managed-things/:IdentifierUpdate the attributes and capabilities associated with a managed thing.
  • DELETEDelete managed thing/managed-things/:Identifier?Force=trueDelete a managed thing. For direct-connected and hub-connected devices connecting with Managed integrations via a controller, all of the devices connected to…
  • GETGet managed thing capabilities/managed-things-capabilities/:IdentifierGet the capabilities for a managed thing using the device ID.
  • GETGet managed thing certificate/managed-things-certificate/:IdentifierRetrieves the certificate PEM for a managed IoT thing.
  • POSTGet managed thing connectivity data/managed-things-connectivity-data/:IdentifierGet the connectivity status of a managed thing.
  • GETGet managed thing meta data/managed-things-metadata/:IdentifierGet the metadata information for a managed thing. The managedThing metadata parameter is used for associating attributes with a managedThing that can be used…
  • GETList managed thing schemas/managed-thing-schemas/:Identifier?EndpointIdFilter=string&CapabilityIdFilter=string&NextToken=string&MaxResults=0List schemas associated with a managed thing.

Notification configuration

  • GETList notification configurations/notification-configurations?MaxResults=0&NextToken=stringList all notification configurations.
  • POSTCreate notification configuration/notification-configurationsCreates a notification configuration. A configuration is a connection between an event type and a destination that you have already created.
  • GETGet notification configuration/notification-configurations/:EventTypeGet a notification configuration for a specified event type.
  • PUTUpdate notification configuration/notification-configurations/:EventTypeUpdate a notification configuration.
  • DELETEDelete notification configuration/notification-configurations/:EventTypeDeletes a notification configuration.

Ota task

  • GETList ota tasks/ota-tasks?NextToken=string&MaxResults=0List all of the over-the-air (OTA) tasks.
  • POSTCreate ota task/ota-tasksCreate an over-the-air (OTA) task to target a device.
  • GETGet ota task/ota-tasks/:IdentifierGet details of the over-the-air (OTA) task by its task id.
  • PUTUpdate ota task/ota-tasks/:IdentifierUpdate an over-the-air (OTA) task.
  • DELETEDelete ota task/ota-tasks/:IdentifierDelete the over-the-air (OTA) task.
  • GETList ota task executions/ota-tasks/:Identifier/devices?NextToken=string&MaxResults=0List all of the over-the-air (OTA) task executions.

Ota task configuration

  • GETList ota task configurations/ota-task-configurations?NextToken=string&MaxResults=0List all of the over-the-air (OTA) task configurations.
  • POSTCreate ota task configuration/ota-task-configurationsCreate a configuraiton for the over-the-air (OTA) task.
  • GETGet ota task configuration/ota-task-configurations/:IdentifierGet a configuraiton for the over-the-air (OTA) task.
  • DELETEDelete ota task configuration/ota-task-configurations/:IdentifierDelete the over-the-air (OTA) task configuration.

Provisioning profile

  • GETList provisioning profiles/provisioning-profiles?NextToken=string&MaxResults=0List the provisioning profiles within the Amazon Web Services account.
  • POSTCreate provisioning profile/provisioning-profilesCreate a provisioning profile for executing device provisioning flows. The provisioning profile is a document that defines the set of resources and policies…
  • GETGet provisioning profile/provisioning-profiles/:IdentifierGet details of a provisioning profile.
  • DELETEDelete provisioning profile/provisioning-profiles/:IdentifierDelete a provisioning profile.

Managed thing association

  • PUTDeregister account association/managed-thing-associations/deregisterDeregister an account association from a managed thing.
  • GETList managed thing account associations/managed-thing-associations?ManagedThingId=string&AccountAssociationId=string&MaxResults=0&NextToken=stringLists all account associations for a specific managed thing.
  • PUTRegister account association/managed-thing-associations/registerRegisters an account association with a managed thing, establishing a connection between a device and a third-party account.

Kms key association

  • GETGet default encryption configuration/configuration/account/encryptionRetrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified region. For more information,…
  • POSTPut default encryption configuration/configuration/account/encryptionSets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the AWS IoT SiteWise User Guide.

Device discovery

  • GETGet device discovery/device-discoveries/:IdentifierGet the current state of a device discovery.
  • GETList device discoveries/device-discoveries?NextToken=string&MaxResults=0&TypeFilter=string&StatusFilter=stringLists all device discovery tasks, with optional filtering by type and status.
  • POSTStart device discovery/device-discoveriesThis API is used to start device discovery for hub-connected and third-party-connected devices. The authentication material (install code) is delivered as a…
  • GETList discovered devices/device-discoveries/:Identifier/devices?NextToken=string&MaxResults=0Lists all devices discovered during a specific device discovery task.

Hub configuration

  • GETGet hub configuration/hub-configurationGet a hub configuration.
  • PUTPut hub configuration/hub-configurationUpdate a hub configuration.

Managed thing state

  • GETGet managed thing state/managed-thing-states/:ManagedThingIdReturns the managed thing state for the given device Id.

Runtime log configuration

  • GETGet runtime log configuration/runtime-log-configurations/:ManagedThingIdGet the runtime log configuration for a specific managed thing.
  • PUTPut runtime log configuration/runtime-log-configurations/:ManagedThingIdSet the runtime log configuration for a specific managed thing.
  • DELETEReset runtime log configuration/runtime-log-configurations/:ManagedThingIdReset a runtime log configuration for a specific managed thing.

Schema version

  • GETGet schema version/schema-versions/:Type/:SchemaVersionedId?Format=stringGets a schema version with the provided information.
  • GETList schema versions/schema-versions/:Type?MaxResults=0&NextToken=string&SchemaIdFilter=string&NamespaceFilter=string&VisibilityFilter=string&SemanticVersionFilter=stringLists schema versions with the provided information.

Managed thing command

  • POSTSend managed thing command/managed-things-command/:ManagedThingIdSend the command to the device represented by the managed thing.
  • GETGet custom endpoint/custom-endpointReturns the IoT managed integrations custom endpoint.
  • POSTRegister custom endpoint/custom-endpointCustomers 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…
  • GETList tags for resource/tags/:ResourceArnLists the tags for a specified resource.
  • POSTTag resource/tags/:ResourceArnAdds tags to a specified resource.
  • DELETEUntag resource/tags/:ResourceArn?tagKeys=Removes tags from a specified resource.
  • POSTSend connector event/connector-event/:ConnectorIdRelays third-party device events for a connector such as a new device or a device state change event.

API details

Base URL
https://api.iotmanagedintegrations.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
83 operations on 45 pathsGET 39POST 19DELETE 13PUT 11PATCH 1
Main resources
Managed thing 10Account association 6Ota task 6Cloud connector 5Connector destination 5Destination 5Event log configuration 5Notification configuration 5Credential locker 4Device discovery 4
Description format
AWS Smithy model, API version 2025-03-03

How to test the Managed integrations for AWS IoT Device Management in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Managed integrations for AWS IoT Device Management collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List account associations” (GET /account-associations?ConnectorDestinationId=string&MaxResults=0&NextToken=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Managed integrations for AWS IoT Device Management?

Managed integrations is a feature of AWS IoT Device Management that enables developers to quickly build innovative IoT solutions. Customers can use managed… It is listed under IoT & devices and has 83 endpoints.

Who publishes the Managed integrations for AWS IoT Device Management?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Managed integrations for AWS IoT Device Management?

Requests go to https://api.iotmanagedintegrations.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Managed integrations for AWS IoT Device Management?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Managed integrations for AWS IoT Device Management have?

83 operations on 45 paths (39 GET, 19 POST, 13 DELETE, 11 PUT, 1 PATCH). The largest groups are Managed thing, Account association, Ota task, Cloud connector.

Is forking the Managed integrations for AWS IoT Device Management free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.