ManagedintegrationsforIoTDeviceManagement ***************************************** Client ====== class ManagedintegrationsforIoTDeviceManagement.Client A low-level client representing 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 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. import boto3 client = boto3.client('iot-managed-integrations') These are the available methods: * can_paginate * close * create_account_association * create_cloud_connector * create_connector_destination * create_credential_locker * create_destination * create_event_log_configuration * create_managed_thing * create_notification_configuration * create_ota_task * create_ota_task_configuration * create_provisioning_profile * delete_account_association * delete_cloud_connector * delete_connector_destination * delete_credential_locker * delete_destination * delete_event_log_configuration * delete_managed_thing * delete_notification_configuration * delete_ota_task * delete_ota_task_configuration * delete_provisioning_profile * deregister_account_association * get_account_association * get_cloud_connector * get_connector_destination * get_credential_locker * get_custom_endpoint * get_default_encryption_configuration * get_destination * get_device_discovery * get_event_log_configuration * get_hub_configuration * get_managed_thing * get_managed_thing_capabilities * get_managed_thing_connectivity_data * get_managed_thing_meta_data * get_managed_thing_state * get_notification_configuration * get_ota_task * get_ota_task_configuration * get_paginator * get_provisioning_profile * get_runtime_log_configuration * get_schema_version * get_waiter * list_account_associations * list_cloud_connectors * list_connector_destinations * list_credential_lockers * list_destinations * list_device_discoveries * list_discovered_devices * list_event_log_configurations * list_managed_thing_account_associations * list_managed_thing_schemas * list_managed_things * list_notification_configurations * list_ota_task_configurations * list_ota_task_executions * list_ota_tasks * list_provisioning_profiles * list_schema_versions * list_tags_for_resource * put_default_encryption_configuration * put_hub_configuration * put_runtime_log_configuration * register_account_association * register_custom_endpoint * reset_runtime_log_configuration * send_connector_event * send_managed_thing_command * start_account_association_refresh * start_device_discovery * tag_resource * untag_resource * update_account_association * update_cloud_connector * update_connector_destination * update_destination * update_event_log_configuration * update_managed_thing * update_notification_configuration * update_ota_task Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListAccountAssociations * ListCloudConnectors * ListConnectorDestinations * ListCredentialLockers * ListDestinations * ListDeviceDiscoveries * ListDiscoveredDevices * ListEventLogConfigurations * ListManagedThingAccountAssociations * ListManagedThingSchemas * ListManagedThings * ListNotificationConfigurations * ListOtaTaskConfigurations * ListOtaTaskExecutions * ListOtaTasks * ListProvisioningProfiles * ListSchemaVersions ManagedintegrationsforIoTDeviceManagement / Paginator / ListOtaTaskExecutions ListOtaTaskExecutions ********************* class ManagedintegrationsforIoTDeviceManagement.Paginator.ListOtaTaskExecutions paginator = client.get_paginator('list_ota_task_executions') paginate(**kwargs) Creates an iterator that will paginate through responses from " ManagedintegrationsforIoTDeviceManagement.Client.list_ota_task_ executions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( Identifier='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Identifier** (*string*) -- **[REQUIRED]** The over-the-air (OTA) task id. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ExecutionSummaries': [ { 'TaskExecutionSummary': { 'ExecutionNumber': 123, 'LastUpdatedAt': datetime(2015, 1, 1), 'QueuedAt': datetime(2015, 1, 1), 'RetryAttempt': 123, 'StartedAt': datetime(2015, 1, 1), 'Status': 'QUEUED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'REJECTED'|'REMOVED'|'CANCELED' }, 'ManagedThingId': 'string' }, ], } **Response Structure** * *(dict) --* * **ExecutionSummaries** *(list) --* A list of all of the over-the-air (OTA) task executions. * *(dict) --* Structure representing one execution summary. * **TaskExecutionSummary** *(dict) --* Structure representing one over-the-air (OTA) task execution summary * **ExecutionNumber** *(integer) --* The execution number of the over-the-air (OTA) task execution summary. * **LastUpdatedAt** *(datetime) --* The timestamp value of when the over-the-air (OTA) task execution summary was last updated. * **QueuedAt** *(datetime) --* The timestamp value of when the over-the-air (OTA) task execution summary is targeted to start. * **RetryAttempt** *(integer) --* The number of retry attempts for starting the over- the-air (OTA) task execution summary after a failed attempt. * **StartedAt** *(datetime) --* The timestamp value of when the over-the-air (OTA) task execution summary started. * **Status** *(string) --* The status of the over-the-air (OTA) task execution summary. * **ManagedThingId** *(string) --* The id of a managed thing. ManagedintegrationsforIoTDeviceManagement / Paginator / ListSchemaVersions ListSchemaVersions ****************** class ManagedintegrationsforIoTDeviceManagement.Paginator.ListSchemaVersions paginator = client.get_paginator('list_schema_versions') paginate(**kwargs) Creates an iterator that will paginate through responses from " ManagedintegrationsforIoTDeviceManagement.Client.list_schema_ve rsions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( Type='capability'|'definition', SchemaId='string', Namespace='string', Visibility='PUBLIC'|'PRIVATE', SemanticVersion='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Type** (*string*) -- **[REQUIRED]** Filter on the type of schema version. * **SchemaId** (*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. * **SemanticVersion** (*string*) -- The schema version. If this is left blank, it defaults to the latest version. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'SchemaId': 'string', 'Type': 'capability'|'definition', 'Description': 'string', 'Namespace': 'string', 'SemanticVersion': 'string', 'Visibility': 'PUBLIC'|'PRIVATE' }, ], } **Response Structure** * *(dict) --* * **Items** *(list) --* The list of schema versions. * *(dict) --* List item describing a schema version. * **SchemaId** *(string) --* The identifier of the schema version. * **Type** *(string) --* The type of schema version. * **Description** *(string) --* A description of the schema version. * **Namespace** *(string) --* The name of the schema version. * **SemanticVersion** *(string) --* The schema version. If this is left blank, it defaults to the latest version. * **Visibility** *(string) --* The visibility of the schema version. ManagedintegrationsforIoTDeviceManagement / Paginator / ListDiscoveredDevices ListDiscoveredDevices ********************* class ManagedintegrationsforIoTDeviceManagement.Paginator.ListDiscoveredDevices paginator = client.get_paginator('list_discovered_devices') paginate(**kwargs) Creates an iterator that will paginate through responses from " ManagedintegrationsforIoTDeviceManagement.Client.list_discovere d_devices()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( Identifier='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Identifier** (*string*) -- **[REQUIRED]** The identifier of the device discovery job to list discovered devices for. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'ConnectorDeviceId': 'string', 'ConnectorDeviceName': 'string', 'DeviceTypes': [ 'string', ], 'ManagedThingId': 'string', 'Modification': 'DISCOVERED'|'UPDATED'|'NO_CHANGE', 'DiscoveredAt': datetime(2015, 1, 1), 'Brand': 'string', 'Model': 'string', 'AuthenticationMaterial': 'string' }, ], } **Response Structure** * *(dict) --* * **Items** *(list) --* The list of discovered devices that match the specified criteria. * *(dict) --* Structure containing summary information about a device discovered during a device discovery job. * **ConnectorDeviceId** *(string) --* The third-party device identifier as defined by the connector. This identifier must not contain personal identifiable information (PII). * **ConnectorDeviceName** *(string) --* The name of the device as defined by the connector or third-party system. * **DeviceTypes** *(list) --* The list of device types or categories that the discovered device belongs to. * *(string) --* * **ManagedThingId** *(string) --* The identifier of the managed thing created for this discovered device, if one exists. * **Modification** *(string) --* The status of the discovered device, indicating whether it has been added, removed, or modified since the last discovery. * **DiscoveredAt** *(datetime) --* The timestamp indicating when the device was discovered. * **Brand** *(string) --* The brand of the discovered device. * **Model** *(string) --* The model of the discovered device. * **AuthenticationMaterial** *(string) --* The authentication material required for connecting to the discovered device, such as credentials or tokens. ManagedintegrationsforIoTDeviceManagement / Paginator / ListDeviceDiscoveries ListDeviceDiscoveries ********************* class ManagedintegrationsforIoTDeviceManagement.Paginator.ListDeviceDiscoveries paginator = client.get_paginator('list_device_discoveries') paginate(**kwargs) Creates an iterator that will paginate through responses from " ManagedintegrationsforIoTDeviceManagement.Client.list_device_di scoveries()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( TypeFilter='ZWAVE'|'ZIGBEE'|'CLOUD'|'CUSTOM', StatusFilter='RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **TypeFilter** (*string*) -- The discovery type to filter device discovery jobs by. * **StatusFilter** (*string*) -- The status to filter device discovery jobs by. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'Id': 'string', 'DiscoveryType': 'ZWAVE'|'ZIGBEE'|'CLOUD'|'CUSTOM', 'Status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT' }, ], } **Response Structure** * *(dict) --* * **Items** *(list) --* The list of device discovery jobs that match the specified criteria. * *(dict) --* Structure containing summary information about a device discovery job, including its identifier, type, and status. * **Id** *(string) --* The unique identifier of the device discovery job. * **DiscoveryType** *(string) --* The type of discovery process used to find devices. * **Status** *(string) --* The current status of the device discovery job. ManagedintegrationsforIoTDeviceManagement / Paginator / ListCloudConnectors ListCloudConnectors ******************* class ManagedintegrationsforIoTDeviceManagement.Paginator.ListCloudConnectors paginator = client.get_paginator('list_cloud_connectors') paginate(**kwargs) Creates an iterator that will paginate through responses from " ManagedintegrationsforIoTDeviceManagement.Client.list_cloud_con nectors()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( Type='LISTED'|'UNLISTED', LambdaArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Type** (*string*) -- The type of cloud connectors to filter by when listing available connectors. * **LambdaArn** (*string*) -- The Amazon Resource Name (ARN) of the Lambda function to filter cloud connectors by. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'Name': 'string', 'EndpointConfig': { 'lambda': { 'arn': 'string' } }, 'Description': 'string', 'EndpointType': 'LAMBDA', 'Id': 'string', 'Type': 'LISTED'|'UNLISTED' }, ], } **Response Structure** * *(dict) --* * **Items** *(list) --* The list of connectors. * *(dict) --* Structure describing a connector. * **Name** *(string) --* The display name of the C2C connector. * **EndpointConfig** *(dict) --* The configuration details for the cloud connector endpoint, including connection parameters and authentication requirements. * **lambda** *(dict) --* The Lambda function configuration for the endpoint, used when the endpoint communicates through an AWS Lambda function. * **arn** *(string) --* The Amazon Resource Name (ARN) of the Lambda function used as an endpoint. * **Description** *(string) --* A description of the C2C connector. * **EndpointType** *(string) --* The type of endpoint used for the C2C connector. * **Id** *(string) --* The identifier of the C2C connector. * **Type** *(string) --* The type of cloud connector created. ManagedintegrationsforIoTDeviceManagement / Paginator / ListManagedThingAccountAssociations ListManagedThingAccountAssociations *********************************** class ManagedintegrationsforIoTDeviceManagement.Paginator.ListManagedThingAccountAssociations paginator = client.get_paginator('list_managed_thing_account_associations') paginate(**kwargs) Creates an iterator that will paginate through responses from " ManagedintegrationsforIoTDeviceManagement.Client.list_managed_t hing_account_associations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ManagedThingId='string', AccountAssociationId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ManagedThingId** (*string*) -- The identifier of the managed thing to list account associations for. * **AccountAssociationId** (*string*) -- The identifier of the account association to filter results by. When specified, only associations with this account association ID will be returned. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'ManagedThingId': 'string', 'AccountAssociationId': 'string' }, ], } **Response Structure** * *(dict) --* * **Items** *(list) --* The list of managed thing associations that match the specified criteria, including the managed thing ID and account association ID for each association. * *(dict) --* Structure representing an association between a managed thing and an account association, which connects a device to a third-party account. * **ManagedThingId** *(string) --* The identifier of the managed thing in the association. * **AccountAssociationId** *(string) --* The identifier of the account association in the association. ManagedintegrationsforIoTDeviceManagement / Paginator / ListOtaTaskConfigurations ListOtaTaskConfigurations ************************* class ManagedintegrationsforIoTDeviceManagement.Paginator.ListOtaTaskConfigurations paginator = client.get_paginator('list_ota_task_configurations') paginate(**kwargs) Creates an iterator that will paginate through responses from " ManagedintegrationsforIoTDeviceManagement.Client.list_ota_task_ configurations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'TaskConfigurationId': 'string', 'Name': 'string', 'CreatedAt': datetime(2015, 1, 1) }, ], } **Response Structure** * *(dict) --* * **Items** *(list) --* The list of the over-the-air (OTA) task configurations. * *(dict) --* Structure representing one over-the-air (OTA) task configuration. * **TaskConfigurationId** *(string) --* The id of the over-the-air (OTA) task configuration * **Name** *(string) --* The name of the over-the-air (OTA) task configuration. * **CreatedAt** *(datetime) --* The timestamp value of when the over-the-air (OTA) task configuration was created at. ManagedintegrationsforIoTDeviceManagement / Paginator / ListConnectorDestinations ListConnectorDestinations ************************* class ManagedintegrationsforIoTDeviceManagement.Paginator.ListConnectorDestinations paginator = client.get_paginator('list_connector_destinations') paginate(**kwargs) Creates an iterator that will paginate through responses from " ManagedintegrationsforIoTDeviceManagement.Client.list_connector _destinations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( CloudConnectorId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **CloudConnectorId** (*string*) -- The identifier of the cloud connector to filter connector destinations by. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ConnectorDestinationList': [ { 'Name': 'string', 'Description': 'string', 'CloudConnectorId': 'string', 'Id': 'string' }, ], } **Response Structure** * *(dict) --* * **ConnectorDestinationList** *(list) --* The list of connector destinations that match the specified criteria. * *(dict) --* Structure containing summary information about a connector destination, which defines how a cloud-to- cloud connector connects to a customer's AWS account. * **Name** *(string) --* The display name of the connector destination. * **Description** *(string) --* A description of the connector destination. * **CloudConnectorId** *(string) --* The identifier of the cloud connector associated with this connector destination. * **Id** *(string) --* The unique identifier of the connector destination. ManagedintegrationsforIoTDeviceManagement / Paginator / ListOtaTasks ListOtaTasks ************ class ManagedintegrationsforIoTDeviceManagement.Paginator.ListOtaTasks paginator = client.get_paginator('list_ota_tasks') paginate(**kwargs) Creates an iterator that will paginate through responses from " ManagedintegrationsforIoTDeviceManagement.Client.list_ota_tasks ()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Tasks': [ { 'TaskId': 'string', 'TaskArn': 'string', 'CreatedAt': datetime(2015, 1, 1), 'LastUpdatedAt': datetime(2015, 1, 1), 'TaskConfigurationId': 'string', 'Status': 'IN_PROGRESS'|'CANCELED'|'COMPLETED'|'DELETION_IN_PROGRESS'|'SCHEDULED' }, ], } **Response Structure** * *(dict) --* * **Tasks** *(list) --* A list of all of the over-the-air (OTA) tasks. * *(dict) --* Structure representing one over-the-air (OTA) task. * **TaskId** *(string) --* The id of the over-the-air (OTA) task. * **TaskArn** *(string) --* The Amazon Resource Name (ARN) of the over-the-air (OTA) task. * **CreatedAt** *(datetime) --* The timestamp value of when the over-the-air (OTA) task was created at. * **LastUpdatedAt** *(datetime) --* The timestamp value of when the over-the-air (OTA) task was last updated at. * **TaskConfigurationId** *(string) --* The identifier for the over-the-air (OTA) task configuration. * **Status** *(string) --* The status of the over-the-air (OTA) task summary. ManagedintegrationsforIoTDeviceManagement / Paginator / ListManagedThings ListManagedThings ***************** class ManagedintegrationsforIoTDeviceManagement.Paginator.ListManagedThings paginator = client.get_paginator('list_managed_things') paginate(**kwargs) Creates an iterator that will paginate through responses from " ManagedintegrationsforIoTDeviceManagement.Client.list_managed_t hings()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( OwnerFilter='string', CredentialLockerFilter='string', RoleFilter='CONTROLLER'|'DEVICE', ParentControllerIdentifierFilter='string', ConnectorPolicyIdFilter='string', ConnectorDestinationIdFilter='string', ConnectorDeviceIdFilter='string', SerialNumberFilter='string', ProvisioningStatusFilter='UNASSOCIATED'|'PRE_ASSOCIATED'|'DISCOVERED'|'ACTIVATED'|'DELETION_FAILED'|'DELETE_IN_PROGRESS'|'ISOLATED'|'DELETED', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **OwnerFilter** (*string*) -- Filter on device owners when listing managed things. * **CredentialLockerFilter** (*string*) -- Filter on a credential locker for a managed thing. * **RoleFilter** (*string*) -- Filter on the type of device used. This will be the Amazon Web Services hub controller, cloud device, or IoT device. * **ParentControllerIdentifierFilter** (*string*) -- Filter on a parent controller id for a managed thing. * **ConnectorPolicyIdFilter** (*string*) -- Filter on a connector policy id for a managed thing. * **ConnectorDestinationIdFilter** (*string*) -- Filter managed things by the connector destination ID they are associated with. * **ConnectorDeviceIdFilter** (*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. * **SerialNumberFilter** (*string*) -- Filter on the serial number of the device. * **ProvisioningStatusFilter** (*string*) -- Filter on the status of the device. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'Id': 'string', 'Arn': 'string', 'AdvertisedProductId': 'string', 'Brand': 'string', 'Classification': 'string', 'ConnectorDeviceId': 'string', 'ConnectorPolicyId': 'string', 'ConnectorDestinationId': 'string', 'Model': 'string', 'Name': 'string', 'Owner': 'string', 'CredentialLockerId': 'string', 'ParentControllerId': 'string', 'ProvisioningStatus': 'UNASSOCIATED'|'PRE_ASSOCIATED'|'DISCOVERED'|'ACTIVATED'|'DELETION_FAILED'|'DELETE_IN_PROGRESS'|'ISOLATED'|'DELETED', 'Role': 'CONTROLLER'|'DEVICE', 'SerialNumber': 'string', 'CreatedAt': datetime(2015, 1, 1), 'UpdatedAt': datetime(2015, 1, 1), 'ActivatedAt': datetime(2015, 1, 1) }, ], } **Response Structure** * *(dict) --* * **Items** *(list) --* The list of managed things. * *(dict) --* Structure representing one managed thing. * **Id** *(string) --* The id of the device. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the managed thing. * **AdvertisedProductId** *(string) --* The id of the advertised product. * **Brand** *(string) --* The brand of the device. * **Classification** *(string) --* The classification of the managed thing such as light bulb or thermostat. * **ConnectorDeviceId** *(string) --* The third-party device id as defined by the connector. This device id must not contain personal identifiable information (PII). Note: This parameter is used for cloud-to-cloud devices only. * **ConnectorPolicyId** *(string) --* The id of the connector policy. Note: This parameter is used for cloud-to-cloud devices only. * **ConnectorDestinationId** *(string) --* The identifier of the connector destination associated with this managed thing, if applicable. * **Model** *(string) --* The model of the device. * **Name** *(string) --* The name of the managed thing representing the physical device. * **Owner** *(string) --* Owner of the device, usually an indication of whom the device belongs to. This value should not contain personal identifiable information. * **CredentialLockerId** *(string) --* The identifier of the credential locker for the managed thing. * **ParentControllerId** *(string) --* Id of the controller device used for the discovery job. * **ProvisioningStatus** *(string) --* The provisioning status of the device in the provisioning workflow for onboarding to IoT managed integrations. * **Role** *(string) --* The type of device used. This will be the Amazon Web Services hub controller, cloud device, or IoT device. * **SerialNumber** *(string) --* The serial number of the device. * **CreatedAt** *(datetime) --* The timestamp value of when the device creation request occurred. * **UpdatedAt** *(datetime) --* The timestamp value of when the managed thing was last updated at. * **ActivatedAt** *(datetime) --* The timestampe value of when the managed thing was activated at. ManagedintegrationsforIoTDeviceManagement / Paginator / ListDestinations ListDestinations **************** class ManagedintegrationsforIoTDeviceManagement.Paginator.ListDestinations paginator = client.get_paginator('list_destinations') paginate(**kwargs) Creates an iterator that will paginate through responses from " ManagedintegrationsforIoTDeviceManagement.Client.list_destinati ons()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'DestinationList': [ { 'Description': 'string', 'DeliveryDestinationArn': 'string', 'DeliveryDestinationType': 'KINESIS', 'Name': 'string', 'RoleArn': 'string' }, ], } **Response Structure** * *(dict) --* * **DestinationList** *(list) --* The list of destinations. * *(dict) --* Structure describing a destination for IoT managed integrations to deliver notifications for a device. * **Description** *(string) --* The description of the customer-managed destination. * **DeliveryDestinationArn** *(string) --* The Amazon Resource Name (ARN) of the customer- managed destination. * **DeliveryDestinationType** *(string) --* The destination type for the customer-managed destination. * **Name** *(string) --* The name of the customer-managed destination. * **RoleArn** *(string) --* The Amazon Resource Name (ARN) of the delivery destination. ManagedintegrationsforIoTDeviceManagement / Paginator / ListNotificationConfigurations ListNotificationConfigurations ****************************** class ManagedintegrationsforIoTDeviceManagement.Paginator.ListNotificationConfigurations paginator = client.get_paginator('list_notification_configurations') paginate(**kwargs) Creates an iterator that will paginate through responses from " ManagedintegrationsforIoTDeviceManagement.Client.list_notificat ion_configurations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'NotificationConfigurationList': [ { 'EventType': 'DEVICE_COMMAND'|'DEVICE_COMMAND_REQUEST'|'DEVICE_DISCOVERY_STATUS'|'DEVICE_EVENT'|'DEVICE_LIFE_CYCLE'|'DEVICE_STATE'|'DEVICE_OTA'|'CONNECTOR_ASSOCIATION'|'ACCOUNT_ASSOCIATION'|'CONNECTOR_ERROR_REPORT', 'DestinationName': 'string' }, ], } **Response Structure** * *(dict) --* * **NotificationConfigurationList** *(list) --* The list of notification configurations. * *(dict) --* Structure describing a notification configuration. * **EventType** *(string) --* The type of event triggering a device notification to the customer-managed destination. * **DestinationName** *(string) --* The name of the destination for the notification configuration. ManagedintegrationsforIoTDeviceManagement / Paginator / ListProvisioningProfiles ListProvisioningProfiles ************************ class ManagedintegrationsforIoTDeviceManagement.Paginator.ListProvisioningProfiles paginator = client.get_paginator('list_provisioning_profiles') paginate(**kwargs) Creates an iterator that will paginate through responses from " ManagedintegrationsforIoTDeviceManagement.Client.list_provision ing_profiles()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'Name': 'string', 'Id': 'string', 'Arn': 'string', 'ProvisioningType': 'FLEET_PROVISIONING'|'JITR' }, ], } **Response Structure** * *(dict) --* * **Items** *(list) --* The list of provisioning profiles. * *(dict) --* Structure describing a provisioning profile. * **Name** *(string) --* The name of the provisioning template. * **Id** *(string) --* The identifier of the provisioning profile. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the provisioning template used in the provisioning profile. * **ProvisioningType** *(string) --* The type of provisioning workflow the device uses for onboarding to IoT managed integrations. ManagedintegrationsforIoTDeviceManagement / Paginator / ListAccountAssociations ListAccountAssociations *********************** class ManagedintegrationsforIoTDeviceManagement.Paginator.ListAccountAssociations paginator = client.get_paginator('list_account_associations') paginate(**kwargs) Creates an iterator that will paginate through responses from " ManagedintegrationsforIoTDeviceManagement.Client.list_account_a ssociations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ConnectorDestinationId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ConnectorDestinationId** (*string*) -- The identifier of the connector destination to filter account associations by. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'AccountAssociationId': 'string', 'AssociationState': 'ASSOCIATION_IN_PROGRESS'|'ASSOCIATION_FAILED'|'ASSOCIATION_SUCCEEDED'|'ASSOCIATION_DELETING'|'REFRESH_TOKEN_EXPIRED', 'ErrorMessage': 'string', 'ConnectorDestinationId': 'string', 'Name': 'string', 'Description': 'string', 'Arn': 'string' }, ], } **Response Structure** * *(dict) --* * **Items** *(list) --* The list of account associations that match the specified criteria. * *(dict) --* Structure containing information about an account association, including its identifier, state, and related metadata. * **AccountAssociationId** *(string) --* The unique identifier of the account association. * **AssociationState** *(string) --* The current state of the account association, indicating its status in the association lifecycle. * **ErrorMessage** *(string) --* The error message explaining any issues with the account association, if applicable. * **ConnectorDestinationId** *(string) --* The identifier of the connector destination associated with this account association. * **Name** *(string) --* The name of the account association. * **Description** *(string) --* A description of the account association. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the account association. ManagedintegrationsforIoTDeviceManagement / Paginator / ListCredentialLockers ListCredentialLockers ********************* class ManagedintegrationsforIoTDeviceManagement.Paginator.ListCredentialLockers paginator = client.get_paginator('list_credential_lockers') paginate(**kwargs) Creates an iterator that will paginate through responses from " ManagedintegrationsforIoTDeviceManagement.Client.list_credentia l_lockers()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'CreatedAt': datetime(2015, 1, 1) }, ], } **Response Structure** * *(dict) --* * **Items** *(list) --* The list of credential lockers. * *(dict) --* Structure describing one Credential Locker. * **Id** *(string) --* The id of the credential locker. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the credential locker. * **Name** *(string) --* The name of the credential locker. * **CreatedAt** *(datetime) --* The timestampe value of when the credential locker was created at. ManagedintegrationsforIoTDeviceManagement / Paginator / ListEventLogConfigurations ListEventLogConfigurations ************************** class ManagedintegrationsforIoTDeviceManagement.Paginator.ListEventLogConfigurations paginator = client.get_paginator('list_event_log_configurations') paginate(**kwargs) Creates an iterator that will paginate through responses from " ManagedintegrationsforIoTDeviceManagement.Client.list_event_log _configurations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'EventLogConfigurationList': [ { 'Id': 'string', 'ResourceType': 'string', 'ResourceId': 'string', 'EventLogLevel': 'DEBUG'|'ERROR'|'INFO'|'WARN' }, ], } **Response Structure** * *(dict) --* * **EventLogConfigurationList** *(list) --* A list of each event log configuration and pertinent information. * *(dict) --* List of event log configurations. * **Id** *(string) --* The identifier of the event log configuration. * **ResourceType** *(string) --* The type of resource for the event log configuration. * **ResourceId** *(string) --* The identifier of the resource for the event log configuration. * **EventLogLevel** *(string) --* The logging level for the event log configuration. ManagedintegrationsforIoTDeviceManagement / Paginator / ListManagedThingSchemas ListManagedThingSchemas *********************** class ManagedintegrationsforIoTDeviceManagement.Paginator.ListManagedThingSchemas paginator = client.get_paginator('list_managed_thing_schemas') paginate(**kwargs) Creates an iterator that will paginate through responses from " ManagedintegrationsforIoTDeviceManagement.Client.list_managed_t hing_schemas()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( Identifier='string', EndpointIdFilter='string', CapabilityIdFilter='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Identifier** (*string*) -- **[REQUIRED]** The managed thing id. * **EndpointIdFilter** (*string*) -- Filter on an endpoint id. * **CapabilityIdFilter** (*string*) -- Filter on a capability id. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'EndpointId': 'string', 'CapabilityId': 'string', 'Schema': {...}|[...]|123|123.4|'string'|True|None }, ], } **Response Structure** * *(dict) --* * **Items** *(list) --* The list of managed thing schemas. * *(dict) --* Structure representing one schema item associated with a managed thing. * **EndpointId** *(string) --* The id of the endpoint for a managed thing. * **CapabilityId** *(string) --* The id of the capability for a managed thing. * **Schema** (*document*) -- The validation schema for one schema item associated with a managed thing. ManagedintegrationsforIoTDeviceManagement / Client / get_credential_locker get_credential_locker ********************* ManagedintegrationsforIoTDeviceManagement.Client.get_credential_locker(**kwargs) Get information on an existing credential locker See also: AWS API Documentation **Request Syntax** response = client.get_credential_locker( Identifier='string' ) Parameters: **Identifier** (*string*) -- **[REQUIRED]** The identifier of the credential locker. Return type: dict Returns: **Response Syntax** { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'CreatedAt': datetime(2015, 1, 1), 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **Id** *(string) --* The identifier of the credential locker. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the credential locker. * **Name** *(string) --* The name of the credential locker. * **CreatedAt** *(datetime) --* The timestamp value of when the credential locker requset occurred. * **Tags** *(dict) --* A set of key/value pairs that are used to manage the credential locker. * *(string) --* * *(string) --* **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / get_device_discovery get_device_discovery ******************** ManagedintegrationsforIoTDeviceManagement.Client.get_device_discovery(**kwargs) Get the current state of a device discovery. See also: AWS API Documentation **Request Syntax** response = client.get_device_discovery( Identifier='string' ) Parameters: **Identifier** (*string*) -- **[REQUIRED]** The id of the device discovery job request. Return type: dict Returns: **Response Syntax** { 'Id': 'string', 'Arn': 'string', 'DiscoveryType': 'ZWAVE'|'ZIGBEE'|'CLOUD'|'CUSTOM', 'Status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT', 'StartedAt': datetime(2015, 1, 1), 'ControllerId': 'string', 'ConnectorAssociationId': 'string', 'AccountAssociationId': 'string', 'FinishedAt': datetime(2015, 1, 1), 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **Id** *(string) --* The id of the device discovery job request. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the device discovery job request. * **DiscoveryType** *(string) --* The discovery type supporting the type of device to be discovered in the device discovery job request. * **Status** *(string) --* The status of the device discovery job request. * **StartedAt** *(datetime) --* The timestamp value for the start time of the device discovery. * **ControllerId** *(string) --* The id of the end-user's IoT hub. * **ConnectorAssociationId** *(string) --* The ID tracking the current discovery process for one connector association. * **AccountAssociationId** *(string) --* The identifier of the account association used for the device discovery. * **FinishedAt** *(datetime) --* The timestamp value for the completion time of the device discovery. * **Tags** *(dict) --* A set of key/value pairs that are used to manage the device discovery request. * *(string) --* * *(string) --* **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Una uthorizedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / delete_notification_configuration delete_notification_configuration ********************************* ManagedintegrationsforIoTDeviceManagement.Client.delete_notification_configuration(**kwargs) Deletes a notification configuration. See also: AWS API Documentation **Request Syntax** response = client.delete_notification_configuration( EventType='DEVICE_COMMAND'|'DEVICE_COMMAND_REQUEST'|'DEVICE_DISCOVERY_STATUS'|'DEVICE_EVENT'|'DEVICE_LIFE_CYCLE'|'DEVICE_STATE'|'DEVICE_OTA'|'CONNECTOR_ASSOCIATION'|'ACCOUNT_ASSOCIATION'|'CONNECTOR_ERROR_REPORT' ) Parameters: **EventType** (*string*) -- **[REQUIRED]** The type of event triggering a device notification to the customer-managed destination. Returns: None **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / get_paginator get_paginator ************* ManagedintegrationsforIoTDeviceManagement.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. ManagedintegrationsforIoTDeviceManagement / Client / list_cloud_connectors list_cloud_connectors ********************* ManagedintegrationsforIoTDeviceManagement.Client.list_cloud_connectors(**kwargs) Returns a list of connectors based on permissions. See also: AWS API Documentation **Request Syntax** response = client.list_cloud_connectors( Type='LISTED'|'UNLISTED', LambdaArn='string', MaxResults=123, NextToken='string' ) Parameters: * **Type** (*string*) -- The type of cloud connectors to filter by when listing available connectors. * **LambdaArn** (*string*) -- The Amazon Resource Name (ARN) of the Lambda function to filter cloud connectors by. * **MaxResults** (*integer*) -- The maximum number of results to return at one time. * **NextToken** (*string*) -- A token that can be used to retrieve the next set of results. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'Name': 'string', 'EndpointConfig': { 'lambda': { 'arn': 'string' } }, 'Description': 'string', 'EndpointType': 'LAMBDA', 'Id': 'string', 'Type': 'LISTED'|'UNLISTED' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Items** *(list) --* The list of connectors. * *(dict) --* Structure describing a connector. * **Name** *(string) --* The display name of the C2C connector. * **EndpointConfig** *(dict) --* The configuration details for the cloud connector endpoint, including connection parameters and authentication requirements. * **lambda** *(dict) --* The Lambda function configuration for the endpoint, used when the endpoint communicates through an AWS Lambda function. * **arn** *(string) --* The Amazon Resource Name (ARN) of the Lambda function used as an endpoint. * **Description** *(string) --* A description of the C2C connector. * **EndpointType** *(string) --* The type of endpoint used for the C2C connector. * **Id** *(string) --* The identifier of the C2C connector. * **Type** *(string) --* The type of cloud connector created. * **NextToken** *(string) --* A token that can be used to retrieve the next set of results. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / list_notification_configurations list_notification_configurations ******************************** ManagedintegrationsforIoTDeviceManagement.Client.list_notification_configurations(**kwargs) List all notification configurations. See also: AWS API Documentation **Request Syntax** response = client.list_notification_configurations( MaxResults=123, NextToken='string' ) Parameters: * **MaxResults** (*integer*) -- The maximum number of results to return at one time. * **NextToken** (*string*) -- A token that can be used to retrieve the next set of results. Return type: dict Returns: **Response Syntax** { 'NotificationConfigurationList': [ { 'EventType': 'DEVICE_COMMAND'|'DEVICE_COMMAND_REQUEST'|'DEVICE_DISCOVERY_STATUS'|'DEVICE_EVENT'|'DEVICE_LIFE_CYCLE'|'DEVICE_STATE'|'DEVICE_OTA'|'CONNECTOR_ASSOCIATION'|'ACCOUNT_ASSOCIATION'|'CONNECTOR_ERROR_REPORT', 'DestinationName': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **NotificationConfigurationList** *(list) --* The list of notification configurations. * *(dict) --* Structure describing a notification configuration. * **EventType** *(string) --* The type of event triggering a device notification to the customer-managed destination. * **DestinationName** *(string) --* The name of the destination for the notification configuration. * **NextToken** *(string) --* A token that can be used to retrieve the next set of results. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / create_ota_task_configuration create_ota_task_configuration ***************************** ManagedintegrationsforIoTDeviceManagement.Client.create_ota_task_configuration(**kwargs) Create a configuraiton for the over-the-air (OTA) task. See also: AWS API Documentation **Request Syntax** response = client.create_ota_task_configuration( Description='string', Name='string', PushConfig={ 'AbortConfig': { 'AbortConfigCriteriaList': [ { 'Action': 'CANCEL', 'FailureType': 'FAILED'|'REJECTED'|'TIMED_OUT'|'ALL', 'MinNumberOfExecutedThings': 123, 'ThresholdPercentage': 123.0 }, ] }, 'RolloutConfig': { 'ExponentialRolloutRate': { 'BaseRatePerMinute': 123, 'IncrementFactor': 123.0, 'RateIncreaseCriteria': { 'numberOfNotifiedThings': 123, 'numberOfSucceededThings': 123 } }, 'MaximumPerMinute': 123 }, 'TimeoutConfig': { 'InProgressTimeoutInMinutes': 123 } }, ClientToken='string' ) Parameters: * **Description** (*string*) -- A description of the over-the- air (OTA) task configuration. * **Name** (*string*) -- The name of the over-the-air (OTA) task. * **PushConfig** (*dict*) -- Describes the type of configuration used for the over-the-air (OTA) task. * **AbortConfig** *(dict) --* Structure representing one abort config. * **AbortConfigCriteriaList** *(list) --* The list of criteria for the abort config. * *(dict) --* Structure representing one abort config criteria. * **Action** *(string) --* The action taken by the abort configuration. * **FailureType** *(string) --* Over-the-air (OTA) task abort criteria failure type. * **MinNumberOfExecutedThings** *(integer) --* The minimum number of things that must receive task execution notifications before the task can be aborted. * **ThresholdPercentage** *(float) --* The minimum percentage of over-the-air (OTA) task execution failures that must occur to initiate the last abort. * **RolloutConfig** *(dict) --* Structure representing one rollout config. * **ExponentialRolloutRate** *(dict) --* Structure representing exponential rate of rollout for an over-the-air (OTA) task. * **BaseRatePerMinute** *(integer) --* The base rate per minute for the rollout of an over-the- air (OTA) task. * **IncrementFactor** *(float) --* The incremental factor for increasing the rollout rate of an over-the-air (OTA) task. * **RateIncreaseCriteria** *(dict) --* The criteria for increasing the rollout rate of an over- the-air (OTA) task. * **numberOfNotifiedThings** *(integer) --* The threshold for number of notified things that will initiate the increase in rate of rollout. * **numberOfSucceededThings** *(integer) --* The threshold for number of succeeded things that will initiate the increase in rate of rollout. * **MaximumPerMinute** *(integer) --* The maximum number of things that will be notified of a pending task, per minute. * **TimeoutConfig** *(dict) --* Structure representing one timeout config. * **InProgressTimeoutInMinutes** *(integer) --* Specifies the amount of time the device has to finish execution of this task. The timeout interval can be anywhere between 1 minute and 7 days. * **ClientToken** (*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. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'TaskConfigurationId': 'string' } **Response Structure** * *(dict) --* * **TaskConfigurationId** *(string) --* The identifier of the over-the-air (OTA) task configuration. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Con flictException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / delete_credential_locker delete_credential_locker ************************ ManagedintegrationsforIoTDeviceManagement.Client.delete_credential_locker(**kwargs) Delete a credential locker. Note: This operation can't be undone and any existing device won't be able to use IoT managed integrations. See also: AWS API Documentation **Request Syntax** response = client.delete_credential_locker( Identifier='string' ) Parameters: **Identifier** (*string*) -- **[REQUIRED]** The identifier of the credential locker. Returns: None **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / list_discovered_devices list_discovered_devices *********************** ManagedintegrationsforIoTDeviceManagement.Client.list_discovered_devices(**kwargs) Lists all devices discovered during a specific device discovery task. See also: AWS API Documentation **Request Syntax** response = client.list_discovered_devices( Identifier='string', NextToken='string', MaxResults=123 ) Parameters: * **Identifier** (*string*) -- **[REQUIRED]** The identifier of the device discovery job to list discovered devices for. * **NextToken** (*string*) -- A token used for pagination of results. * **MaxResults** (*integer*) -- The maximum number of discovered devices to return in a single response. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'ConnectorDeviceId': 'string', 'ConnectorDeviceName': 'string', 'DeviceTypes': [ 'string', ], 'ManagedThingId': 'string', 'Modification': 'DISCOVERED'|'UPDATED'|'NO_CHANGE', 'DiscoveredAt': datetime(2015, 1, 1), 'Brand': 'string', 'Model': 'string', 'AuthenticationMaterial': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Items** *(list) --* The list of discovered devices that match the specified criteria. * *(dict) --* Structure containing summary information about a device discovered during a device discovery job. * **ConnectorDeviceId** *(string) --* The third-party device identifier as defined by the connector. This identifier must not contain personal identifiable information (PII). * **ConnectorDeviceName** *(string) --* The name of the device as defined by the connector or third-party system. * **DeviceTypes** *(list) --* The list of device types or categories that the discovered device belongs to. * *(string) --* * **ManagedThingId** *(string) --* The identifier of the managed thing created for this discovered device, if one exists. * **Modification** *(string) --* The status of the discovered device, indicating whether it has been added, removed, or modified since the last discovery. * **DiscoveredAt** *(datetime) --* The timestamp indicating when the device was discovered. * **Brand** *(string) --* The brand of the discovered device. * **Model** *(string) --* The model of the discovered device. * **AuthenticationMaterial** *(string) --* The authentication material required for connecting to the discovered device, such as credentials or tokens. * **NextToken** *(string) --* A token used for pagination of results when there are more discovered devices than can be returned in a single response. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Una uthorizedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / list_managed_thing_account_associations list_managed_thing_account_associations *************************************** ManagedintegrationsforIoTDeviceManagement.Client.list_managed_thing_account_associations(**kwargs) Lists all account associations for a specific managed thing. See also: AWS API Documentation **Request Syntax** response = client.list_managed_thing_account_associations( ManagedThingId='string', AccountAssociationId='string', MaxResults=123, NextToken='string' ) Parameters: * **ManagedThingId** (*string*) -- The identifier of the managed thing to list account associations for. * **AccountAssociationId** (*string*) -- The identifier of the account association to filter results by. When specified, only associations with this account association ID will be returned. * **MaxResults** (*integer*) -- The maximum number of account associations to return in a single response. * **NextToken** (*string*) -- A token used for pagination of results. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'ManagedThingId': 'string', 'AccountAssociationId': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Items** *(list) --* The list of managed thing associations that match the specified criteria, including the managed thing ID and account association ID for each association. * *(dict) --* Structure representing an association between a managed thing and an account association, which connects a device to a third-party account. * **ManagedThingId** *(string) --* The identifier of the managed thing in the association. * **AccountAssociationId** *(string) --* The identifier of the account association in the association. * **NextToken** *(string) --* A token used for pagination of results when there are more account associations than can be returned in a single response. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / delete_connector_destination delete_connector_destination **************************** ManagedintegrationsforIoTDeviceManagement.Client.delete_connector_destination(**kwargs) Delete a connector destination for connecting a cloud-to-cloud (C2C) connector to the customer's Amazon Web Services account. See also: AWS API Documentation **Request Syntax** response = client.delete_connector_destination( Identifier='string' ) Parameters: **Identifier** (*string*) -- **[REQUIRED]** The identifier of the connector destination. Returns: None **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / update_event_log_configuration update_event_log_configuration ****************************** ManagedintegrationsforIoTDeviceManagement.Client.update_event_log_configuration(**kwargs) Update an event log configuration by log configuration ID. See also: AWS API Documentation **Request Syntax** response = client.update_event_log_configuration( Id='string', EventLogLevel='DEBUG'|'ERROR'|'INFO'|'WARN' ) Parameters: * **Id** (*string*) -- **[REQUIRED]** The log configuration id. * **EventLogLevel** (*string*) -- **[REQUIRED]** The log level for the event in terms of severity. Returns: None **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / update_connector_destination update_connector_destination **************************** ManagedintegrationsforIoTDeviceManagement.Client.update_connector_destination(**kwargs) Updates the properties of an existing connector destination. See also: AWS API Documentation **Request Syntax** response = client.update_connector_destination( Identifier='string', Description='string', Name='string', AuthType='OAUTH', AuthConfig={ 'oAuthUpdate': { 'oAuthCompleteRedirectUrl': 'string', 'proactiveRefreshTokenRenewal': { 'enabled': True|False, 'DaysBeforeRenewal': 123 } } }, SecretsManager={ 'arn': 'string', 'versionId': 'string' } ) Parameters: * **Identifier** (*string*) -- **[REQUIRED]** 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. * **AuthType** (*string*) -- The new authentication type to use for the connector destination. * **AuthConfig** (*dict*) -- The updated authentication configuration details for the connector destination. * **oAuthUpdate** *(dict) --* The updated OAuth configuration settings for the authentication configuration. * **oAuthCompleteRedirectUrl** *(string) --* The updated URL where users are redirected after completing the OAuth authorization process. * **proactiveRefreshTokenRenewal** *(dict) --* Updated configuration for proactively refreshing OAuth tokens before they expire. * **enabled** *(boolean) --* Indicates whether proactive refresh token renewal is enabled. * **DaysBeforeRenewal** *(integer) --* The days before token expiration when the system should attempt to renew the token, specified in days. * **SecretsManager** (*dict*) -- The updated AWS Secrets Manager configuration for the connector destination. * **arn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the AWS Secrets Manager secret. * **versionId** *(string) --* **[REQUIRED]** The version ID of the AWS Secrets Manager secret. Returns: None **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / register_account_association register_account_association **************************** ManagedintegrationsforIoTDeviceManagement.Client.register_account_association(**kwargs) Registers an account association with a managed thing, establishing a connection between a device and a third-party account. See also: AWS API Documentation **Request Syntax** response = client.register_account_association( ManagedThingId='string', AccountAssociationId='string', DeviceDiscoveryId='string' ) Parameters: * **ManagedThingId** (*string*) -- **[REQUIRED]** The identifier of the managed thing to register with the account association. * **AccountAssociationId** (*string*) -- **[REQUIRED]** The identifier of the account association to register with the managed thing. * **DeviceDiscoveryId** (*string*) -- **[REQUIRED]** The identifier of the device discovery job associated with this registration. Return type: dict Returns: **Response Syntax** { 'AccountAssociationId': 'string', 'DeviceDiscoveryId': 'string', 'ManagedThingId': 'string' } **Response Structure** * *(dict) --* * **AccountAssociationId** *(string) --* The identifier of the account association that was registered. * **DeviceDiscoveryId** *(string) --* The identifier of the device discovery job associated with this registration. * **ManagedThingId** *(string) --* The identifier of the managed thing that was registered with the account association. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Con flictException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" ManagedintegrationsforIoTDeviceManagement / Client / can_paginate can_paginate ************ ManagedintegrationsforIoTDeviceManagement.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. ManagedintegrationsforIoTDeviceManagement / Client / start_device_discovery start_device_discovery ********************** ManagedintegrationsforIoTDeviceManagement.Client.start_device_discovery(**kwargs) This API is used to start device discovery for hub-connected and third-party-connected devices. The authentication material (install code) is passed as a message to the controller telling it to start the discovery. See also: AWS API Documentation **Request Syntax** response = client.start_device_discovery( DiscoveryType='ZWAVE'|'ZIGBEE'|'CLOUD'|'CUSTOM', CustomProtocolDetail={ 'string': 'string' }, ControllerIdentifier='string', ConnectorAssociationIdentifier='string', AccountAssociationId='string', AuthenticationMaterial='string', AuthenticationMaterialType='ZWAVE_INSTALL_CODE', ClientToken='string', Tags={ 'string': 'string' } ) Parameters: * **DiscoveryType** (*string*) -- **[REQUIRED]** The discovery type supporting the type of device to be discovered in the device discovery task request. * **CustomProtocolDetail** (*dict*) -- Additional protocol-specific details required for device discovery, which vary based on the discovery type. Note: For a "DiscoveryType" of "CUSTOM", the string-to-string map must have a key value of "Name" set to a non-empty-string. * *(string) --* * *(string) --* * **ControllerIdentifier** (*string*) -- The id of the end- user's IoT hub. * **ConnectorAssociationIdentifier** (*string*) -- The id of the connector association. * **AccountAssociationId** (*string*) -- The identifier of the cloud-to-cloud account association to use for discovery of third-party devices. * **AuthenticationMaterial** (*string*) -- The authentication material required to start the local device discovery job request. * **AuthenticationMaterialType** (*string*) -- The type of authentication material used for device discovery jobs. * **ClientToken** (*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** (*dict*) -- A set of key/value pairs that are used to manage the device discovery request. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'Id': 'string', 'StartedAt': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **Id** *(string) --* The id of the device discovery job request. * **StartedAt** *(datetime) --* The timestamp value for the start time of the device discovery. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Una uthorizedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Con flictException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / delete_ota_task delete_ota_task *************** ManagedintegrationsforIoTDeviceManagement.Client.delete_ota_task(**kwargs) Delete the over-the-air (OTA) task. See also: AWS API Documentation **Request Syntax** response = client.delete_ota_task( Identifier='string' ) Parameters: **Identifier** (*string*) -- **[REQUIRED]** The identifier of the over-the-air (OTA) task. Returns: None **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Lim itExceededException" ManagedintegrationsforIoTDeviceManagement / Client / list_managed_things list_managed_things ******************* ManagedintegrationsforIoTDeviceManagement.Client.list_managed_things(**kwargs) Listing all managed things with provision for filters. See also: AWS API Documentation **Request Syntax** response = client.list_managed_things( OwnerFilter='string', CredentialLockerFilter='string', RoleFilter='CONTROLLER'|'DEVICE', ParentControllerIdentifierFilter='string', ConnectorPolicyIdFilter='string', ConnectorDestinationIdFilter='string', ConnectorDeviceIdFilter='string', SerialNumberFilter='string', ProvisioningStatusFilter='UNASSOCIATED'|'PRE_ASSOCIATED'|'DISCOVERED'|'ACTIVATED'|'DELETION_FAILED'|'DELETE_IN_PROGRESS'|'ISOLATED'|'DELETED', NextToken='string', MaxResults=123 ) Parameters: * **OwnerFilter** (*string*) -- Filter on device owners when listing managed things. * **CredentialLockerFilter** (*string*) -- Filter on a credential locker for a managed thing. * **RoleFilter** (*string*) -- Filter on the type of device used. This will be the Amazon Web Services hub controller, cloud device, or IoT device. * **ParentControllerIdentifierFilter** (*string*) -- Filter on a parent controller id for a managed thing. * **ConnectorPolicyIdFilter** (*string*) -- Filter on a connector policy id for a managed thing. * **ConnectorDestinationIdFilter** (*string*) -- Filter managed things by the connector destination ID they are associated with. * **ConnectorDeviceIdFilter** (*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. * **SerialNumberFilter** (*string*) -- Filter on the serial number of the device. * **ProvisioningStatusFilter** (*string*) -- Filter on the status of the device. * **NextToken** (*string*) -- A token that can be used to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return at one time. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'Id': 'string', 'Arn': 'string', 'AdvertisedProductId': 'string', 'Brand': 'string', 'Classification': 'string', 'ConnectorDeviceId': 'string', 'ConnectorPolicyId': 'string', 'ConnectorDestinationId': 'string', 'Model': 'string', 'Name': 'string', 'Owner': 'string', 'CredentialLockerId': 'string', 'ParentControllerId': 'string', 'ProvisioningStatus': 'UNASSOCIATED'|'PRE_ASSOCIATED'|'DISCOVERED'|'ACTIVATED'|'DELETION_FAILED'|'DELETE_IN_PROGRESS'|'ISOLATED'|'DELETED', 'Role': 'CONTROLLER'|'DEVICE', 'SerialNumber': 'string', 'CreatedAt': datetime(2015, 1, 1), 'UpdatedAt': datetime(2015, 1, 1), 'ActivatedAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Items** *(list) --* The list of managed things. * *(dict) --* Structure representing one managed thing. * **Id** *(string) --* The id of the device. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the managed thing. * **AdvertisedProductId** *(string) --* The id of the advertised product. * **Brand** *(string) --* The brand of the device. * **Classification** *(string) --* The classification of the managed thing such as light bulb or thermostat. * **ConnectorDeviceId** *(string) --* The third-party device id as defined by the connector. This device id must not contain personal identifiable information (PII). Note: This parameter is used for cloud-to-cloud devices only. * **ConnectorPolicyId** *(string) --* The id of the connector policy. Note: This parameter is used for cloud-to-cloud devices only. * **ConnectorDestinationId** *(string) --* The identifier of the connector destination associated with this managed thing, if applicable. * **Model** *(string) --* The model of the device. * **Name** *(string) --* The name of the managed thing representing the physical device. * **Owner** *(string) --* Owner of the device, usually an indication of whom the device belongs to. This value should not contain personal identifiable information. * **CredentialLockerId** *(string) --* The identifier of the credential locker for the managed thing. * **ParentControllerId** *(string) --* Id of the controller device used for the discovery job. * **ProvisioningStatus** *(string) --* The provisioning status of the device in the provisioning workflow for onboarding to IoT managed integrations. * **Role** *(string) --* The type of device used. This will be the Amazon Web Services hub controller, cloud device, or IoT device. * **SerialNumber** *(string) --* The serial number of the device. * **CreatedAt** *(datetime) --* The timestamp value of when the device creation request occurred. * **UpdatedAt** *(datetime) --* The timestamp value of when the managed thing was last updated at. * **ActivatedAt** *(datetime) --* The timestampe value of when the managed thing was activated at. * **NextToken** *(string) --* A token that can be used to retrieve the next set of results. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Una uthorizedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / put_hub_configuration put_hub_configuration ********************* ManagedintegrationsforIoTDeviceManagement.Client.put_hub_configuration(**kwargs) Update a hub configuration. See also: AWS API Documentation **Request Syntax** response = client.put_hub_configuration( HubTokenTimerExpirySettingInSeconds=123 ) Parameters: **HubTokenTimerExpirySettingInSeconds** (*integer*) -- **[REQUIRED]** A user-defined integer value that represents the hub token timer expiry setting in seconds. Return type: dict Returns: **Response Syntax** { 'HubTokenTimerExpirySettingInSeconds': 123 } **Response Structure** * *(dict) --* * **HubTokenTimerExpirySettingInSeconds** *(integer) --* A user-defined integer value that represents the hub token timer expiry setting in seconds. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / start_account_association_refresh start_account_association_refresh ********************************* ManagedintegrationsforIoTDeviceManagement.Client.start_account_association_refresh(**kwargs) Initiates a refresh of an existing account association to update its authorization and connection status. See also: AWS API Documentation **Request Syntax** response = client.start_account_association_refresh( AccountAssociationId='string' ) Parameters: **AccountAssociationId** (*string*) -- **[REQUIRED]** The unique identifier of the account association to refresh. Return type: dict Returns: **Response Syntax** { 'OAuthAuthorizationUrl': 'string' } **Response Structure** * *(dict) --* * **OAuthAuthorizationUrl** *(string) --* Third-party IoT platform OAuth authorization server URL with all required parameters to perform end-user authentication during the refresh process. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / delete_ota_task_configuration delete_ota_task_configuration ***************************** ManagedintegrationsforIoTDeviceManagement.Client.delete_ota_task_configuration(**kwargs) Delete the over-the-air (OTA) task configuration. See also: AWS API Documentation **Request Syntax** response = client.delete_ota_task_configuration( Identifier='string' ) Parameters: **Identifier** (*string*) -- **[REQUIRED]** The identifier of the over-the-air (OTA) task configuration. Returns: None **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / list_schema_versions list_schema_versions ******************** ManagedintegrationsforIoTDeviceManagement.Client.list_schema_versions(**kwargs) Lists schema versions with the provided information. See also: AWS API Documentation **Request Syntax** response = client.list_schema_versions( Type='capability'|'definition', MaxResults=123, NextToken='string', SchemaId='string', Namespace='string', Visibility='PUBLIC'|'PRIVATE', SemanticVersion='string' ) Parameters: * **Type** (*string*) -- **[REQUIRED]** Filter on the type of schema version. * **MaxResults** (*integer*) -- The maximum number of results to return at one time. * **NextToken** (*string*) -- A token that can be used to retrieve the next set of results. * **SchemaId** (*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. * **SemanticVersion** (*string*) -- The schema version. If this is left blank, it defaults to the latest version. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'SchemaId': 'string', 'Type': 'capability'|'definition', 'Description': 'string', 'Namespace': 'string', 'SemanticVersion': 'string', 'Visibility': 'PUBLIC'|'PRIVATE' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Items** *(list) --* The list of schema versions. * *(dict) --* List item describing a schema version. * **SchemaId** *(string) --* The identifier of the schema version. * **Type** *(string) --* The type of schema version. * **Description** *(string) --* A description of the schema version. * **Namespace** *(string) --* The name of the schema version. * **SemanticVersion** *(string) --* The schema version. If this is left blank, it defaults to the latest version. * **Visibility** *(string) --* The visibility of the schema version. * **NextToken** *(string) --* A token that can be used to retrieve the next set of results. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Con flictException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / register_custom_endpoint register_custom_endpoint ************************ ManagedintegrationsforIoTDeviceManagement.Client.register_custom_endpoint() 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. See also: AWS API Documentation **Request Syntax** response = client.register_custom_endpoint() Return type: dict Returns: **Response Syntax** { 'EndpointAddress': 'string' } **Response Structure** * *(dict) --* * **EndpointAddress** *(string) --* The IoT managed integrations dedicated, custom endpoint for the device to route traffic through. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Una uthorizedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Con flictException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / update_account_association update_account_association ************************** ManagedintegrationsforIoTDeviceManagement.Client.update_account_association(**kwargs) Updates the properties of an existing account association. See also: AWS API Documentation **Request Syntax** response = client.update_account_association( AccountAssociationId='string', Name='string', Description='string' ) Parameters: * **AccountAssociationId** (*string*) -- **[REQUIRED]** 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: None **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Con flictException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / get_hub_configuration get_hub_configuration ********************* ManagedintegrationsforIoTDeviceManagement.Client.get_hub_configuration() Get a hub configuration. See also: AWS API Documentation **Request Syntax** response = client.get_hub_configuration() Return type: dict Returns: **Response Syntax** { 'HubTokenTimerExpirySettingInSeconds': 123, 'UpdatedAt': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **HubTokenTimerExpirySettingInSeconds** *(integer) --* A user-defined integer value that represents the hub token timer expiry setting in seconds. * **UpdatedAt** *(datetime) --* The timestamp value of when the hub configuration was updated. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / create_account_association create_account_association ************************** ManagedintegrationsforIoTDeviceManagement.Client.create_account_association(**kwargs) Creates a new account association via the destination id. See also: AWS API Documentation **Request Syntax** response = client.create_account_association( ClientToken='string', ConnectorDestinationId='string', Name='string', Description='string', Tags={ 'string': 'string' } ) Parameters: * **ClientToken** (*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. This field is autopopulated if not provided. * **ConnectorDestinationId** (*string*) -- **[REQUIRED]** 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** (*dict*) -- A set of key/value pairs that are used to manage the account association. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'OAuthAuthorizationUrl': 'string', 'AccountAssociationId': 'string', 'AssociationState': 'ASSOCIATION_IN_PROGRESS'|'ASSOCIATION_FAILED'|'ASSOCIATION_SUCCEEDED'|'ASSOCIATION_DELETING'|'REFRESH_TOKEN_EXPIRED', 'Arn': 'string' } **Response Structure** * *(dict) --* * **OAuthAuthorizationUrl** *(string) --* Third-party IoT platform OAuth authorization server URL backed with all the required parameters to perform end-user authentication. * **AccountAssociationId** *(string) --* The identifier for the account association request. * **AssociationState** *(string) --* The current state of the account association request. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the account association. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Con flictException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" ManagedintegrationsforIoTDeviceManagement / Client / list_event_log_configurations list_event_log_configurations ***************************** ManagedintegrationsforIoTDeviceManagement.Client.list_event_log_configurations(**kwargs) List all event log configurations for an account. See also: AWS API Documentation **Request Syntax** response = client.list_event_log_configurations( NextToken='string', MaxResults=123 ) Parameters: * **NextToken** (*string*) -- A token that can be used to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return at one time. Return type: dict Returns: **Response Syntax** { 'EventLogConfigurationList': [ { 'Id': 'string', 'ResourceType': 'string', 'ResourceId': 'string', 'EventLogLevel': 'DEBUG'|'ERROR'|'INFO'|'WARN' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **EventLogConfigurationList** *(list) --* A list of each event log configuration and pertinent information. * *(dict) --* List of event log configurations. * **Id** *(string) --* The identifier of the event log configuration. * **ResourceType** *(string) --* The type of resource for the event log configuration. * **ResourceId** *(string) --* The identifier of the resource for the event log configuration. * **EventLogLevel** *(string) --* The logging level for the event log configuration. * **NextToken** *(string) --* A token that can be used to retrieve the next set of results. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / create_notification_configuration create_notification_configuration ********************************* ManagedintegrationsforIoTDeviceManagement.Client.create_notification_configuration(**kwargs) Creates a notification configuration. A configuration is a connection between an event type and a destination that you have already created. See also: AWS API Documentation **Request Syntax** response = client.create_notification_configuration( EventType='DEVICE_COMMAND'|'DEVICE_COMMAND_REQUEST'|'DEVICE_DISCOVERY_STATUS'|'DEVICE_EVENT'|'DEVICE_LIFE_CYCLE'|'DEVICE_STATE'|'DEVICE_OTA'|'CONNECTOR_ASSOCIATION'|'ACCOUNT_ASSOCIATION'|'CONNECTOR_ERROR_REPORT', DestinationName='string', ClientToken='string', Tags={ 'string': 'string' } ) Parameters: * **EventType** (*string*) -- **[REQUIRED]** The type of event triggering a device notification to the customer-managed destination. * **DestinationName** (*string*) -- **[REQUIRED]** The name of the destination for the notification configuration. * **ClientToken** (*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. This field is autopopulated if not provided. * **Tags** (*dict*) -- A set of key/value pairs that are used to manage the notification configuration. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'EventType': 'DEVICE_COMMAND'|'DEVICE_COMMAND_REQUEST'|'DEVICE_DISCOVERY_STATUS'|'DEVICE_EVENT'|'DEVICE_LIFE_CYCLE'|'DEVICE_STATE'|'DEVICE_OTA'|'CONNECTOR_ASSOCIATION'|'ACCOUNT_ASSOCIATION'|'CONNECTOR_ERROR_REPORT' } **Response Structure** * *(dict) --* * **EventType** *(string) --* The type of event triggering a device notification to the customer-managed destination. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Con flictException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / get_provisioning_profile get_provisioning_profile ************************ ManagedintegrationsforIoTDeviceManagement.Client.get_provisioning_profile(**kwargs) Get a provisioning profile by template name. See also: AWS API Documentation **Request Syntax** response = client.get_provisioning_profile( Identifier='string' ) Parameters: **Identifier** (*string*) -- **[REQUIRED]** The provisioning template the device uses for the provisioning process. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'Name': 'string', 'ProvisioningType': 'FLEET_PROVISIONING'|'JITR', 'Id': 'string', 'ClaimCertificate': 'string', 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the provisioning template used in the provisioning profile. * **Name** *(string) --* The name of the provisioning template. * **ProvisioningType** *(string) --* The type of provisioning workflow the device uses for onboarding to IoT managed integrations. * **Id** *(string) --* The provisioning profile id.. * **ClaimCertificate** *(string) --* The id of the claim certificate. * **Tags** *(dict) --* A set of key/value pairs that are used to manage the provisioning profile. * *(string) --* * *(string) --* **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Una uthorizedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / create_managed_thing create_managed_thing ******************** ManagedintegrationsforIoTDeviceManagement.Client.create_managed_thing(**kwargs) Creates a managed thing. A managed thing contains the device identifier, protocol supported, and capabilities of the device in a protocol-specific format. See also: AWS API Documentation **Request Syntax** response = client.create_managed_thing( Role='CONTROLLER'|'DEVICE', Owner='string', CredentialLockerId='string', AuthenticationMaterial='string', AuthenticationMaterialType='CUSTOM_PROTOCOL_QR_BAR_CODE'|'WIFI_SETUP_QR_BAR_CODE'|'ZWAVE_QR_BAR_CODE'|'ZIGBEE_QR_BAR_CODE'|'DISCOVERED_DEVICE', SerialNumber='string', Brand='string', Model='string', Name='string', CapabilityReport={ 'version': 'string', 'nodeId': 'string', 'endpoints': [ { 'id': 'string', 'deviceTypes': [ 'string', ], 'capabilities': [ { 'id': 'string', 'name': 'string', 'version': 'string', 'properties': [ 'string', ], 'actions': [ 'string', ], 'events': [ 'string', ] }, ] }, ] }, CapabilitySchemas=[ { 'Format': 'AWS'|'ZCL'|'CONNECTOR', 'CapabilityId': 'string', 'ExtrinsicId': 'string', 'ExtrinsicVersion': 123, 'Schema': {...}|[...]|123|123.4|'string'|True|None }, ], Capabilities='string', ClientToken='string', Classification='string', Tags={ 'string': 'string' }, MetaData={ 'string': 'string' } ) Parameters: * **Role** (*string*) -- **[REQUIRED]** 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. * **CredentialLockerId** (*string*) -- The identifier of the credential for the managed thing. * **AuthenticationMaterial** (*string*) -- **[REQUIRED]** The authentication material defining the device connectivity setup requests. The authentication materials used are the device bar code. * **AuthenticationMaterialType** (*string*) -- **[REQUIRED]** The type of authentication material used for device connectivity setup requests. * **SerialNumber** (*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. * **CapabilityReport** (*dict*) -- A report of the capabilities for the managed thing. * **version** *(string) --* **[REQUIRED]** The version of the capability report. * **nodeId** *(string) --* The numeric identifier of the node. * **endpoints** *(list) --* **[REQUIRED]** The endpoints used in the capability report. * *(dict) --* The endpoint used in the capability report. * **id** *(string) --* **[REQUIRED]** The id of the endpoint used in the capability report. * **deviceTypes** *(list) --* **[REQUIRED]** The type of device. * *(string) --* * **capabilities** *(list) --* **[REQUIRED]** The capabilities used in the capability report. * *(dict) --* The capability used in capability report. * **id** *(string) --* **[REQUIRED]** The id of the schema version. * **name** *(string) --* **[REQUIRED]** The name of the capability. * **version** *(string) --* **[REQUIRED]** The version of the capability. * **properties** *(list) --* **[REQUIRED]** The capability properties used in the capability report. * *(string) --* * **actions** *(list) --* **[REQUIRED]** The capability actions used in the capability report. * *(string) --* * **events** *(list) --* **[REQUIRED]** The capability events used in the capability report. * *(string) --* * **CapabilitySchemas** (*list*) -- The capability schemas that define the functionality and features supported by the managed thing, including device capabilities and their associated properties. * *(dict) --* Structure representing a capability schema item that defines the functionality and features supported by a managed thing. * **Format** *(string) --* **[REQUIRED]** The format of the capability schema, which defines how the schema is structured and interpreted. * **CapabilityId** *(string) --* **[REQUIRED]** The unique identifier of the capability defined in the schema. * **ExtrinsicId** *(string) --* **[REQUIRED]** The external identifier for the capability, used when referencing the capability outside of the AWS ecosystem. * **ExtrinsicVersion** *(integer) --* **[REQUIRED]** The version of the external capability definition, used to track compatibility with external systems. * **Schema** (*document*) -- **[REQUIRED]** The actual schema definition that describes the capability's properties, actions, and events. * **Capabilities** (*string*) -- The capabilities of the device such as light bulb. * **ClientToken** (*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. This field is autopopulated if not provided. * **Classification** (*string*) -- The classification of the managed thing such as light bulb or thermostat. * **Tags** (*dict*) -- A set of key/value pairs that are used to manage the managed thing. * *(string) --* * *(string) --* * **MetaData** (*dict*) -- The metadata for the managed thing. Note: 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. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'Id': 'string', 'Arn': 'string', 'CreatedAt': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **Id** *(string) --* The id of the managed thing. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the managed thing. * **CreatedAt** *(datetime) --* The timestamp value of when the device creation request occurred. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Una uthorizedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Con flictException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / list_destinations list_destinations ***************** ManagedintegrationsforIoTDeviceManagement.Client.list_destinations(**kwargs) List all destination names under one Amazon Web Services account. See also: AWS API Documentation **Request Syntax** response = client.list_destinations( NextToken='string', MaxResults=123 ) Parameters: * **NextToken** (*string*) -- A token that can be used to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return at one time. Return type: dict Returns: **Response Syntax** { 'DestinationList': [ { 'Description': 'string', 'DeliveryDestinationArn': 'string', 'DeliveryDestinationType': 'KINESIS', 'Name': 'string', 'RoleArn': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **DestinationList** *(list) --* The list of destinations. * *(dict) --* Structure describing a destination for IoT managed integrations to deliver notifications for a device. * **Description** *(string) --* The description of the customer-managed destination. * **DeliveryDestinationArn** *(string) --* The Amazon Resource Name (ARN) of the customer-managed destination. * **DeliveryDestinationType** *(string) --* The destination type for the customer-managed destination. * **Name** *(string) --* The name of the customer-managed destination. * **RoleArn** *(string) --* The Amazon Resource Name (ARN) of the delivery destination. * **NextToken** *(string) --* A token that can be used to retrieve the next set of results. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / get_managed_thing_state get_managed_thing_state *********************** ManagedintegrationsforIoTDeviceManagement.Client.get_managed_thing_state(**kwargs) Returns the managed thing state for the given device Id. See also: AWS API Documentation **Request Syntax** response = client.get_managed_thing_state( ManagedThingId='string' ) Parameters: **ManagedThingId** (*string*) -- **[REQUIRED]** The id of the device. Return type: dict Returns: **Response Syntax** { 'Endpoints': [ { 'endpointId': 'string', 'capabilities': [ { 'id': 'string', 'name': 'string', 'version': 'string', 'properties': {...}|[...]|123|123.4|'string'|True|None }, ] }, ] } **Response Structure** * *(dict) --* * **Endpoints** *(list) --* The device endpoint. * *(dict) --* Describe the endpoint with an Id, a name, and the relevant capabilities for reporting state * **endpointId** *(string) --* Numeric identifier of the endpoint * **capabilities** *(list) --* Describe the endpoint with an id, a name, and the relevant capabilities for the reporting state. * *(dict) --* State capabilities added for the managed thing. * **id** *(string) --* The id of the managed thing in the capability report. * **name** *(string) --* Name for the Amazon Web Services capability. * **version** *(string) --* Version for the Amazon Web Services capability. * **properties** (*document*) -- Describe the command capability with the properties it supports. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalFailureException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Una uthorizedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / get_event_log_configuration get_event_log_configuration *************************** ManagedintegrationsforIoTDeviceManagement.Client.get_event_log_configuration(**kwargs) Get an event log configuration. See also: AWS API Documentation **Request Syntax** response = client.get_event_log_configuration( Id='string' ) Parameters: **Id** (*string*) -- **[REQUIRED]** The identifier of the event log configuration. Return type: dict Returns: **Response Syntax** { 'Id': 'string', 'ResourceType': 'string', 'ResourceId': 'string', 'EventLogLevel': 'DEBUG'|'ERROR'|'INFO'|'WARN' } **Response Structure** * *(dict) --* * **Id** *(string) --* The identifier of the event log configuration. * **ResourceType** *(string) --* The type of resource for the event log configuration. * **ResourceId** *(string) --* The identifier of the resource for the event log configuration. * **EventLogLevel** *(string) --* The logging level for the event log configuration. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / create_event_log_configuration create_event_log_configuration ****************************** ManagedintegrationsforIoTDeviceManagement.Client.create_event_log_configuration(**kwargs) Set the event log configuration for the account, resource type, or specific resource. See also: AWS API Documentation **Request Syntax** response = client.create_event_log_configuration( ResourceType='string', ResourceId='string', EventLogLevel='DEBUG'|'ERROR'|'INFO'|'WARN', ClientToken='string' ) Parameters: * **ResourceType** (*string*) -- **[REQUIRED]** The type of resource for the event log configuration. * **ResourceId** (*string*) -- The identifier of the resource for the event log configuration. * **EventLogLevel** (*string*) -- **[REQUIRED]** The logging level for the event log configuration. * **ClientToken** (*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. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'Id': 'string' } **Response Structure** * *(dict) --* * **Id** *(string) --* The identifier of the event log configuration request. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceQuotaExceededException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Con flictException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / get_schema_version get_schema_version ****************** ManagedintegrationsforIoTDeviceManagement.Client.get_schema_version(**kwargs) Gets a schema version with the provided information. See also: AWS API Documentation **Request Syntax** response = client.get_schema_version( Type='capability'|'definition', SchemaVersionedId='string', Format='AWS'|'ZCL'|'CONNECTOR' ) Parameters: * **Type** (*string*) -- **[REQUIRED]** The type of schema version. * **SchemaVersionedId** (*string*) -- **[REQUIRED]** Schema id with a version specified. If the version is missing, it defaults to latest version. * **Format** (*string*) -- The format of the schema version. Return type: dict Returns: **Response Syntax** { 'SchemaId': 'string', 'Type': 'capability'|'definition', 'Description': 'string', 'Namespace': 'string', 'SemanticVersion': 'string', 'Visibility': 'PUBLIC'|'PRIVATE', 'Schema': {...}|[...]|123|123.4|'string'|True|None } **Response Structure** * *(dict) --* * **SchemaId** *(string) --* The id of the schema version. * **Type** *(string) --* The type of schema version. * **Description** *(string) --* The description of the schema version. * **Namespace** *(string) --* The name of the schema version. * **SemanticVersion** *(string) --* The schema version. If this is left blank, it defaults to the latest version. * **Visibility** *(string) --* The visibility of the schema version. * **Schema** (*document*) -- The schema of the schema version. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Con flictException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / get_ota_task get_ota_task ************ ManagedintegrationsforIoTDeviceManagement.Client.get_ota_task(**kwargs) Get the over-the-air (OTA) task. See also: AWS API Documentation **Request Syntax** response = client.get_ota_task( Identifier='string' ) Parameters: **Identifier** (*string*) -- **[REQUIRED]** The over-the-air (OTA) task id. Return type: dict Returns: **Response Syntax** { 'TaskId': 'string', 'TaskArn': 'string', 'Description': 'string', 'S3Url': 'string', 'Protocol': 'HTTP', 'OtaType': 'ONE_TIME'|'CONTINUOUS', 'OtaTargetQueryString': 'string', 'OtaMechanism': 'PUSH', 'Target': [ 'string', ], 'CreatedAt': datetime(2015, 1, 1), 'LastUpdatedAt': datetime(2015, 1, 1), 'TaskConfigurationId': 'string', 'TaskProcessingDetails': { 'NumberOfCanceledThings': 123, 'NumberOfFailedThings': 123, 'NumberOfInProgressThings': 123, 'numberOfQueuedThings': 123, 'numberOfRejectedThings': 123, 'numberOfRemovedThings': 123, 'numberOfSucceededThings': 123, 'numberOfTimedOutThings': 123, 'processingTargets': [ 'string', ] }, 'OtaSchedulingConfig': { 'EndBehavior': 'STOP_ROLLOUT'|'CANCEL'|'FORCE_CANCEL', 'EndTime': 'string', 'MaintenanceWindows': [ { 'DurationInMinutes': 123, 'StartTime': 'string' }, ], 'StartTime': 'string' }, 'OtaTaskExecutionRetryConfig': { 'RetryConfigCriteria': [ { 'FailureType': 'FAILED'|'TIMED_OUT'|'ALL', 'MinNumberOfRetries': 123 }, ] }, 'Status': 'IN_PROGRESS'|'CANCELED'|'COMPLETED'|'DELETION_IN_PROGRESS'|'SCHEDULED', 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **TaskId** *(string) --* The id of the over-the-air (OTA) task. * **TaskArn** *(string) --* The Amazon Resource Name (ARN) of the over-the-air (OTA) task * **Description** *(string) --* The description of the over-the-air (OTA) task. * **S3Url** *(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. * **OtaType** *(string) --* The frequency type for the over-the-air (OTA) task. * **OtaTargetQueryString** *(string) --* The query string to add things to the thing group. * **OtaMechanism** *(string) --* The deployment mechanism for the over-the-air (OTA) task. * **Target** *(list) --* The device targeted for the over-the-air (OTA) task. * *(string) --* * **CreatedAt** *(datetime) --* The timestamp value of when the over-the-air (OTA) task was created. * **LastUpdatedAt** *(datetime) --* The timestamp value of when the over-the-air (OTA) task was last updated at. * **TaskConfigurationId** *(string) --* The identifier for the over-the-air (OTA) task configuration. * **TaskProcessingDetails** *(dict) --* The processing details of all over-the-air (OTA) tasks. * **NumberOfCanceledThings** *(integer) --* The number of canceled things in an over-the-air (OTA) task. * **NumberOfFailedThings** *(integer) --* The number of failed things in an over-the-air (OTA) task. * **NumberOfInProgressThings** *(integer) --* The number of in progress things in an over-the-air (OTA) task. * **numberOfQueuedThings** *(integer) --* The number of queued things in an over-the-air (OTA) task. * **numberOfRejectedThings** *(integer) --* The number of rejected things in an over-the-air (OTA) task. * **numberOfRemovedThings** *(integer) --* The number of removed things in an over-the-air (OTA) task. * **numberOfSucceededThings** *(integer) --* The number of succeeded things in an over-the-air (OTA) task. * **numberOfTimedOutThings** *(integer) --* The number of timed out things in an over-the-air (OTA) task. * **processingTargets** *(list) --* The targets of the over-the-air (OTA) task. * *(string) --* * **OtaSchedulingConfig** *(dict) --* Over-the-air (OTA) task scheduling config. * **EndBehavior** *(string) --* Specifies the end behavior for all task executions after a task reaches the selected "endTime". If "endTime" is not selected when creating the task, then "endBehavior" does not apply. * **EndTime** *(string) --* The time an over-the-air (OTA) task will stop. * **MaintenanceWindows** *(list) --* Maintenance window list for over-the-air (OTA) task scheduling config. * *(dict) --* Structure representing scheduling maintenance window. * **DurationInMinutes** *(integer) --* Displays the duration of the next maintenance window. * **StartTime** *(string) --* Displays the start time of the next maintenance window. * **StartTime** *(string) --* The time an over-the-air (OTA) task will start. * **OtaTaskExecutionRetryConfig** *(dict) --* Over-the-air (OTA) task retry config. * **RetryConfigCriteria** *(list) --* The list of retry config criteria. * *(dict) --* Structure representing one retry config criteria. * **FailureType** *(string) --* Over-the-air (OTA) retry criteria failure type. * **MinNumberOfRetries** *(integer) --* The number of retries allowed for a failure type for the over-the-air (OTA) task. * **Status** *(string) --* The status of the over-the-air (OTA) task. * **Tags** *(dict) --* A set of key/value pairs that are used to manage the over- the-air (OTA) task. * *(string) --* * *(string) --* **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / list_tags_for_resource list_tags_for_resource ********************** ManagedintegrationsforIoTDeviceManagement.Client.list_tags_for_resource(**kwargs) List tags for the specified resource. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( ResourceArn='string' ) Parameters: **ResourceArn** (*string*) -- **[REQUIRED]** The ARN of the resource for which to list tags. Return type: dict Returns: **Response Syntax** { 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **tags** *(dict) --* A set of key/value pairs that are used to manage the resource. * *(string) --* * *(string) --* **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Una uthorizedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Inv alidRequestException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / get_managed_thing_meta_data get_managed_thing_meta_data *************************** ManagedintegrationsforIoTDeviceManagement.Client.get_managed_thing_meta_data(**kwargs) Get the metadata information for a managed thing. Note: 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. See also: AWS API Documentation **Request Syntax** response = client.get_managed_thing_meta_data( Identifier='string' ) Parameters: **Identifier** (*string*) -- **[REQUIRED]** The managed thing id. Return type: dict Returns: **Response Syntax** { 'ManagedThingId': 'string', 'MetaData': { 'string': 'string' } } **Response Structure** * *(dict) --* * **ManagedThingId** *(string) --* The managed thing id. * **MetaData** *(dict) --* The metadata for the managed thing. * *(string) --* * *(string) --* **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Una uthorizedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / get_runtime_log_configuration get_runtime_log_configuration ***************************** ManagedintegrationsforIoTDeviceManagement.Client.get_runtime_log_configuration(**kwargs) Get the runtime log configuration for a specific managed thing or for all managed things as a group. See also: AWS API Documentation **Request Syntax** response = client.get_runtime_log_configuration( ManagedThingId='string' ) Parameters: **ManagedThingId** (*string*) -- **[REQUIRED]** The id for a managed thing. Return type: dict Returns: **Response Syntax** { 'ManagedThingId': 'string', 'RuntimeLogConfigurations': { 'LogLevel': 'DEBUG'|'ERROR'|'INFO'|'WARN', 'LogFlushLevel': 'DEBUG'|'ERROR'|'INFO'|'WARN', 'LocalStoreLocation': 'string', 'LocalStoreFileRotationMaxFiles': 123, 'LocalStoreFileRotationMaxBytes': 123, 'UploadLog': True|False, 'UploadPeriodMinutes': 123, 'DeleteLocalStoreAfterUpload': True|False } } **Response Structure** * *(dict) --* * **ManagedThingId** *(string) --* The id for a managed thing. * **RuntimeLogConfigurations** *(dict) --* The runtime log configuration for a managed thing. * **LogLevel** *(string) --* The different log levels available for configuration. * **LogFlushLevel** *(string) --* The different log levels available for configuration. * **LocalStoreLocation** *(string) --* Configuration of where to store runtime logs in the device. * **LocalStoreFileRotationMaxFiles** *(integer) --* Configuration to set the maximum number of runtime log files that can be stored on the device before the oldest files are deleted or overwritten. * **LocalStoreFileRotationMaxBytes** *(integer) --* Configuration to set the maximum bytes of runtime logs that can be stored on the device before the oldest logs are deleted or overwritten. * **UploadLog** *(boolean) --* Configuration to enable or disable uploading of runtime logs to the cloud. * **UploadPeriodMinutes** *(integer) --* Configuration to set the time interval in minutes between each batch of runtime logs that the device uploads to the cloud. * **DeleteLocalStoreAfterUpload** *(boolean) --* Configuration to enable or disable deleting of runtime logs in the device once uploaded to the cloud. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / untag_resource untag_resource ************** ManagedintegrationsforIoTDeviceManagement.Client.untag_resource(**kwargs) Remove tags for the specified resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( ResourceArn='string', TagKeys=[ 'string', ] ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The ARN of the resource to which to add tags. * **TagKeys** (*list*) -- **[REQUIRED]** A list of tag keys to remove from the resource. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Una uthorizedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Con flictException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Inv alidRequestException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / list_credential_lockers list_credential_lockers *********************** ManagedintegrationsforIoTDeviceManagement.Client.list_credential_lockers(**kwargs) List information on an existing credential locker. See also: AWS API Documentation **Request Syntax** response = client.list_credential_lockers( NextToken='string', MaxResults=123 ) Parameters: * **NextToken** (*string*) -- A token that can be used to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return at one time. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'CreatedAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Items** *(list) --* The list of credential lockers. * *(dict) --* Structure describing one Credential Locker. * **Id** *(string) --* The id of the credential locker. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the credential locker. * **Name** *(string) --* The name of the credential locker. * **CreatedAt** *(datetime) --* The timestampe value of when the credential locker was created at. * **NextToken** *(string) --* A token that can be used to retrieve the next set of results. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / list_provisioning_profiles list_provisioning_profiles ************************** ManagedintegrationsforIoTDeviceManagement.Client.list_provisioning_profiles(**kwargs) List the provisioning profiles within the Amazon Web Services account. See also: AWS API Documentation **Request Syntax** response = client.list_provisioning_profiles( NextToken='string', MaxResults=123 ) Parameters: * **NextToken** (*string*) -- A token that can be used to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return at one time. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'Name': 'string', 'Id': 'string', 'Arn': 'string', 'ProvisioningType': 'FLEET_PROVISIONING'|'JITR' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Items** *(list) --* The list of provisioning profiles. * *(dict) --* Structure describing a provisioning profile. * **Name** *(string) --* The name of the provisioning template. * **Id** *(string) --* The identifier of the provisioning profile. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the provisioning template used in the provisioning profile. * **ProvisioningType** *(string) --* The type of provisioning workflow the device uses for onboarding to IoT managed integrations. * **NextToken** *(string) --* A token that can be used to retrieve the next set of results. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Una uthorizedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / create_connector_destination create_connector_destination **************************** ManagedintegrationsforIoTDeviceManagement.Client.create_connector_destination(**kwargs) Create a connector destination for connecting a cloud-to-cloud (C2C) connector to the customer's Amazon Web Services account. See also: AWS API Documentation **Request Syntax** response = client.create_connector_destination( Name='string', Description='string', CloudConnectorId='string', AuthType='OAUTH', AuthConfig={ 'oAuth': { 'authUrl': 'string', 'tokenUrl': 'string', 'scope': 'string', 'tokenEndpointAuthenticationScheme': 'HTTP_BASIC'|'REQUEST_BODY_CREDENTIALS', 'oAuthCompleteRedirectUrl': 'string', 'proactiveRefreshTokenRenewal': { 'enabled': True|False, 'DaysBeforeRenewal': 123 } } }, SecretsManager={ 'arn': 'string', 'versionId': 'string' }, ClientToken='string' ) Parameters: * **Name** (*string*) -- The display name of the connector destination. * **Description** (*string*) -- A description of the connector destination. * **CloudConnectorId** (*string*) -- **[REQUIRED]** The identifier of the C2C connector. * **AuthType** (*string*) -- **[REQUIRED]** The authentication type used for the connector destination, which determines how credentials and access are managed. * **AuthConfig** (*dict*) -- **[REQUIRED]** The authentication configuration details for the connector destination, including OAuth settings and other authentication parameters. * **oAuth** *(dict) --* The OAuth configuration settings used for authentication with the third-party service. * **authUrl** *(string) --* **[REQUIRED]** The authorization URL for the OAuth service, where users are directed to authenticate and authorize access. * **tokenUrl** *(string) --* **[REQUIRED]** The token URL for the OAuth service, where authorization codes are exchanged for access tokens. * **scope** *(string) --* The OAuth scopes requested during authorization, which define the permissions granted to the application. * **tokenEndpointAuthenticationScheme** *(string) --* **[REQUIRED]** The authentication scheme used when requesting tokens from the token endpoint. * **oAuthCompleteRedirectUrl** *(string) --* The URL where users are redirected after completing the OAuth authorization process. * **proactiveRefreshTokenRenewal** *(dict) --* Configuration for proactively refreshing OAuth tokens before they expire. * **enabled** *(boolean) --* Indicates whether proactive refresh token renewal is enabled. * **DaysBeforeRenewal** *(integer) --* The days before token expiration when the system should attempt to renew the token, specified in days. * **SecretsManager** (*dict*) -- **[REQUIRED]** The AWS Secrets Manager configuration used to securely store and manage sensitive information for the connector destination. * **arn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the AWS Secrets Manager secret. * **versionId** *(string) --* **[REQUIRED]** The version ID of the AWS Secrets Manager secret. * **ClientToken** (*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. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'Id': 'string' } **Response Structure** * *(dict) --* * **Id** *(string) --* The identifier of the C2C connector destination creation request. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Con flictException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / get_waiter get_waiter ********** ManagedintegrationsforIoTDeviceManagement.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" ManagedintegrationsforIoTDeviceManagement / Client / update_notification_configuration update_notification_configuration ********************************* ManagedintegrationsforIoTDeviceManagement.Client.update_notification_configuration(**kwargs) Update a notification configuration. See also: AWS API Documentation **Request Syntax** response = client.update_notification_configuration( EventType='DEVICE_COMMAND'|'DEVICE_COMMAND_REQUEST'|'DEVICE_DISCOVERY_STATUS'|'DEVICE_EVENT'|'DEVICE_LIFE_CYCLE'|'DEVICE_STATE'|'DEVICE_OTA'|'CONNECTOR_ASSOCIATION'|'ACCOUNT_ASSOCIATION'|'CONNECTOR_ERROR_REPORT', DestinationName='string' ) Parameters: * **EventType** (*string*) -- **[REQUIRED]** The type of event triggering a device notification to the customer-managed destination. * **DestinationName** (*string*) -- **[REQUIRED]** The name of the destination for the notification configuration. Returns: None **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / list_connector_destinations list_connector_destinations *************************** ManagedintegrationsforIoTDeviceManagement.Client.list_connector_destinations(**kwargs) Lists all connector destinations, with optional filtering by cloud connector ID. See also: AWS API Documentation **Request Syntax** response = client.list_connector_destinations( CloudConnectorId='string', NextToken='string', MaxResults=123 ) Parameters: * **CloudConnectorId** (*string*) -- The identifier of the cloud connector to filter connector destinations by. * **NextToken** (*string*) -- A token used for pagination of results. * **MaxResults** (*integer*) -- The maximum number of connector destinations to return in a single response. Return type: dict Returns: **Response Syntax** { 'ConnectorDestinationList': [ { 'Name': 'string', 'Description': 'string', 'CloudConnectorId': 'string', 'Id': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ConnectorDestinationList** *(list) --* The list of connector destinations that match the specified criteria. * *(dict) --* Structure containing summary information about a connector destination, which defines how a cloud-to-cloud connector connects to a customer's AWS account. * **Name** *(string) --* The display name of the connector destination. * **Description** *(string) --* A description of the connector destination. * **CloudConnectorId** *(string) --* The identifier of the cloud connector associated with this connector destination. * **Id** *(string) --* The unique identifier of the connector destination. * **NextToken** *(string) --* A token used for pagination of results when there are more connector destinations than can be returned in a single response. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / get_default_encryption_configuration get_default_encryption_configuration ************************************ ManagedintegrationsforIoTDeviceManagement.Client.get_default_encryption_configuration() 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*. See also: AWS API Documentation **Request Syntax** response = client.get_default_encryption_configuration() Return type: dict Returns: **Response Syntax** { 'configurationStatus': { 'error': { 'code': 'string', 'message': 'string' }, 'state': 'ENABLED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED' }, 'encryptionType': 'MANAGED_INTEGRATIONS_DEFAULT_ENCRYPTION'|'CUSTOMER_KEY_ENCRYPTION', 'kmsKeyArn': 'string' } **Response Structure** * *(dict) --* * **configurationStatus** *(dict) --* Provides the status of the default encryption configuration for an Amazon Web Services account. * **error** *(dict) --* The error details describing a failed default encryption configuration update. * **code** *(string) --* The error code returned when the default encryption configuration update fails. * **message** *(string) --* The error message returned when the default encryption configuration update fails. * **state** *(string) --* The status state describing the default encryption configuration update. * **encryptionType** *(string) --* The type of encryption used for the encryption configuration. * **kmsKeyArn** *(string) --* The Key Amazon Resource Name (ARN) of the AWS KMS key used for KMS encryption if you use "KMS_BASED_ENCRYPTION". **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalFailureException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Una uthorizedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / get_managed_thing_connectivity_data get_managed_thing_connectivity_data *********************************** ManagedintegrationsforIoTDeviceManagement.Client.get_managed_thing_connectivity_data(**kwargs) Get the connectivity status of a managed thing. See also: AWS API Documentation **Request Syntax** response = client.get_managed_thing_connectivity_data( Identifier='string' ) Parameters: **Identifier** (*string*) -- **[REQUIRED]** The identifier of a managed thing. Return type: dict Returns: **Response Syntax** { 'ManagedThingId': 'string', 'Connected': True|False, 'Timestamp': datetime(2015, 1, 1), 'DisconnectReason': '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' } **Response Structure** * *(dict) --* * **ManagedThingId** *(string) --* The id of a managed thing. * **Connected** *(boolean) --* The connectivity status for a managed thing. * **Timestamp** *(datetime) --* The timestamp value of when the connectivity status for a managed thing was last taken. * **DisconnectReason** *(string) --* The reason for the connectivity disconnect with the managed thing. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Una uthorizedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / delete_cloud_connector delete_cloud_connector ********************** ManagedintegrationsforIoTDeviceManagement.Client.delete_cloud_connector(**kwargs) Delete a cloud connector. See also: AWS API Documentation **Request Syntax** response = client.delete_cloud_connector( Identifier='string' ) Parameters: **Identifier** (*string*) -- **[REQUIRED]** The identifier of the cloud connector. Returns: None **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / get_account_association get_account_association *********************** ManagedintegrationsforIoTDeviceManagement.Client.get_account_association(**kwargs) Get an account association for an Amazon Web Services account linked to a customer-managed destination. See also: AWS API Documentation **Request Syntax** response = client.get_account_association( AccountAssociationId='string' ) Parameters: **AccountAssociationId** (*string*) -- **[REQUIRED]** The unique identifier of the account association to retrieve. Return type: dict Returns: **Response Syntax** { 'AccountAssociationId': 'string', 'AssociationState': 'ASSOCIATION_IN_PROGRESS'|'ASSOCIATION_FAILED'|'ASSOCIATION_SUCCEEDED'|'ASSOCIATION_DELETING'|'REFRESH_TOKEN_EXPIRED', 'ErrorMessage': 'string', 'ConnectorDestinationId': 'string', 'Name': 'string', 'Description': 'string', 'Arn': 'string', 'OAuthAuthorizationUrl': 'string', 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **AccountAssociationId** *(string) --* The unique identifier of the retrieved account association. * **AssociationState** *(string) --* The current status state for the account association. * **ErrorMessage** *(string) --* The error message explaining the current account association error. * **ConnectorDestinationId** *(string) --* The identifier of the connector destination associated with this account association. * **Name** *(string) --* The name of the account association. * **Description** *(string) --* The description of the account association. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the account association. * **OAuthAuthorizationUrl** *(string) --* Third party IoT platform OAuth authorization server URL backed with all the required parameters to perform end-user authentication. * **Tags** *(dict) --* A set of key/value pairs that are used to manage the account association. * *(string) --* * *(string) --* **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / deregister_account_association deregister_account_association ****************************** ManagedintegrationsforIoTDeviceManagement.Client.deregister_account_association(**kwargs) Deregisters an account association, removing the connection between a managed thing and a third-party account. See also: AWS API Documentation **Request Syntax** response = client.deregister_account_association( ManagedThingId='string', AccountAssociationId='string' ) Parameters: * **ManagedThingId** (*string*) -- **[REQUIRED]** The identifier of the managed thing to be deregistered from the account association. * **AccountAssociationId** (*string*) -- **[REQUIRED]** The unique identifier of the account association to be deregistered. Returns: None **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" ManagedintegrationsforIoTDeviceManagement / Client / create_destination create_destination ****************** ManagedintegrationsforIoTDeviceManagement.Client.create_destination(**kwargs) Create a destination. IoT managed integrations uses the destination to determine where to deliver notifications for a device. See also: AWS API Documentation **Request Syntax** response = client.create_destination( DeliveryDestinationArn='string', DeliveryDestinationType='KINESIS', Name='string', RoleArn='string', ClientToken='string', Description='string', Tags={ 'string': 'string' } ) Parameters: * **DeliveryDestinationArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the customer-managed destination. * **DeliveryDestinationType** (*string*) -- **[REQUIRED]** The destination type for the customer-managed destination. * **Name** (*string*) -- **[REQUIRED]** The name of the customer-managed destination. * **RoleArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the delivery destination role. * **ClientToken** (*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. This field is autopopulated if not provided. * **Description** (*string*) -- The description of the customer- managed destination. * **Tags** (*dict*) -- A set of key/value pairs that are used to manage the destination. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'Name': 'string' } **Response Structure** * *(dict) --* * **Name** *(string) --* The name of the customer-managed destination. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Con flictException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / list_ota_tasks list_ota_tasks ************** ManagedintegrationsforIoTDeviceManagement.Client.list_ota_tasks(**kwargs) List all of the over-the-air (OTA) tasks. See also: AWS API Documentation **Request Syntax** response = client.list_ota_tasks( NextToken='string', MaxResults=123 ) Parameters: * **NextToken** (*string*) -- A token that can be used to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return at one time. Return type: dict Returns: **Response Syntax** { 'Tasks': [ { 'TaskId': 'string', 'TaskArn': 'string', 'CreatedAt': datetime(2015, 1, 1), 'LastUpdatedAt': datetime(2015, 1, 1), 'TaskConfigurationId': 'string', 'Status': 'IN_PROGRESS'|'CANCELED'|'COMPLETED'|'DELETION_IN_PROGRESS'|'SCHEDULED' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Tasks** *(list) --* A list of all of the over-the-air (OTA) tasks. * *(dict) --* Structure representing one over-the-air (OTA) task. * **TaskId** *(string) --* The id of the over-the-air (OTA) task. * **TaskArn** *(string) --* The Amazon Resource Name (ARN) of the over-the-air (OTA) task. * **CreatedAt** *(datetime) --* The timestamp value of when the over-the-air (OTA) task was created at. * **LastUpdatedAt** *(datetime) --* The timestamp value of when the over-the-air (OTA) task was last updated at. * **TaskConfigurationId** *(string) --* The identifier for the over-the-air (OTA) task configuration. * **Status** *(string) --* The status of the over-the-air (OTA) task summary. * **NextToken** *(string) --* A token that can be used to retrieve the next set of results. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" ManagedintegrationsforIoTDeviceManagement / Client / delete_destination delete_destination ****************** ManagedintegrationsforIoTDeviceManagement.Client.delete_destination(**kwargs) Deletes a customer-managed destination specified by id. See also: AWS API Documentation **Request Syntax** response = client.delete_destination( Name='string' ) Parameters: **Name** (*string*) -- **[REQUIRED]** The id of the customer-managed destination. Returns: None **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / update_ota_task update_ota_task *************** ManagedintegrationsforIoTDeviceManagement.Client.update_ota_task(**kwargs) Update an over-the-air (OTA) task. See also: AWS API Documentation **Request Syntax** response = client.update_ota_task( Identifier='string', Description='string', TaskConfigurationId='string' ) Parameters: * **Identifier** (*string*) -- **[REQUIRED]** The over-the-air (OTA) task id. * **Description** (*string*) -- The description of the over-the- air (OTA) task. * **TaskConfigurationId** (*string*) -- The identifier for the over-the-air (OTA) task configuration. Returns: None **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / get_managed_thing get_managed_thing ***************** ManagedintegrationsforIoTDeviceManagement.Client.get_managed_thing(**kwargs) Get the attributes and capabilities associated with a managed thing. See also: AWS API Documentation **Request Syntax** response = client.get_managed_thing( Identifier='string' ) Parameters: **Identifier** (*string*) -- **[REQUIRED]** The id of the managed thing. Return type: dict Returns: **Response Syntax** { 'Id': 'string', 'Arn': 'string', 'Owner': 'string', 'CredentialLockerId': 'string', 'AdvertisedProductId': 'string', 'Role': 'CONTROLLER'|'DEVICE', 'ProvisioningStatus': 'UNASSOCIATED'|'PRE_ASSOCIATED'|'DISCOVERED'|'ACTIVATED'|'DELETION_FAILED'|'DELETE_IN_PROGRESS'|'ISOLATED'|'DELETED', 'Name': 'string', 'Model': 'string', 'Brand': 'string', 'SerialNumber': 'string', 'UniversalProductCode': 'string', 'InternationalArticleNumber': 'string', 'ConnectorPolicyId': 'string', 'ConnectorDestinationId': 'string', 'ConnectorDeviceId': 'string', 'DeviceSpecificKey': 'string', 'MacAddress': 'string', 'ParentControllerId': 'string', 'Classification': 'string', 'CreatedAt': datetime(2015, 1, 1), 'UpdatedAt': datetime(2015, 1, 1), 'ActivatedAt': datetime(2015, 1, 1), 'HubNetworkMode': 'STANDARD'|'NETWORK_WIDE_EXCLUSION', 'MetaData': { 'string': 'string' }, 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **Id** *(string) --* The id of the managed thing. * **Arn** *(string) --* The Amazon Resource Name (ARN) 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. * **CredentialLockerId** *(string) --* The identifier of the credential locker for the managed thing. * **AdvertisedProductId** *(string) --* The id of the advertised product. * **Role** *(string) --* The type of device used. This will be the Amazon Web Services hub controller, cloud device, or IoT device. * **ProvisioningStatus** *(string) --* The provisioning status of the device in the provisioning workflow for onboarding to IoT managed integrations. * **Name** *(string) --* The name of the managed thing representing the physical device. * **Model** *(string) --* The model of the device. * **Brand** *(string) --* The brand of the device. * **SerialNumber** *(string) --* The serial number of the device. * **UniversalProductCode** *(string) --* The universal product code (UPC) of the device model. The UPC is typically used in the United States of America and Canada. * **InternationalArticleNumber** *(string) --* The unique 13 digit number that identifies the managed thing. * **ConnectorPolicyId** *(string) --* The id of the connector policy. Note: This parameter is used for cloud-to-cloud devices only. * **ConnectorDestinationId** *(string) --* The identifier of the connector destination associated with this managed thing. * **ConnectorDeviceId** *(string) --* The third-party device id as defined by the connector. This device id must not contain personal identifiable information (PII). Note: This parameter is used for cloud-to-cloud devices only. * **DeviceSpecificKey** *(string) --* A Zwave device-specific key used during device activation. Note: This parameter is used for Zwave devices only. * **MacAddress** *(string) --* The media access control (MAC) address for the device represented by the managed thing. Note: This parameter is used for Zigbee devices only. * **ParentControllerId** *(string) --* Id of the controller device used for the discovery job. * **Classification** *(string) --* The classification of the managed thing such as light bulb or thermostat. * **CreatedAt** *(datetime) --* The timestamp value of when the device creation request occurred. * **UpdatedAt** *(datetime) --* The timestamp value of when the managed thing was last updated at. * **ActivatedAt** *(datetime) --* The timestampe value of when the device was activated. * **HubNetworkMode** *(string) --* The network mode for the hub-connected device. * **MetaData** *(dict) --* The metadata for the managed thing. * *(string) --* * *(string) --* * **Tags** *(dict) --* A set of key/value pairs that are used to manage the managed thing. * *(string) --* * *(string) --* **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Una uthorizedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / get_notification_configuration get_notification_configuration ****************************** ManagedintegrationsforIoTDeviceManagement.Client.get_notification_configuration(**kwargs) Get a notification configuration. See also: AWS API Documentation **Request Syntax** response = client.get_notification_configuration( EventType='DEVICE_COMMAND'|'DEVICE_COMMAND_REQUEST'|'DEVICE_DISCOVERY_STATUS'|'DEVICE_EVENT'|'DEVICE_LIFE_CYCLE'|'DEVICE_STATE'|'DEVICE_OTA'|'CONNECTOR_ASSOCIATION'|'ACCOUNT_ASSOCIATION'|'CONNECTOR_ERROR_REPORT' ) Parameters: **EventType** (*string*) -- **[REQUIRED]** The type of event triggering a device notification to the customer-managed destination. Return type: dict Returns: **Response Syntax** { 'EventType': 'DEVICE_COMMAND'|'DEVICE_COMMAND_REQUEST'|'DEVICE_DISCOVERY_STATUS'|'DEVICE_EVENT'|'DEVICE_LIFE_CYCLE'|'DEVICE_STATE'|'DEVICE_OTA'|'CONNECTOR_ASSOCIATION'|'ACCOUNT_ASSOCIATION'|'CONNECTOR_ERROR_REPORT', 'DestinationName': 'string', 'CreatedAt': datetime(2015, 1, 1), 'UpdatedAt': datetime(2015, 1, 1), 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **EventType** *(string) --* The type of event triggering a device notification to the customer-managed destination. * **DestinationName** *(string) --* The name of the destination for the notification configuration. * **CreatedAt** *(datetime) --* The timestamp value of when the notification configuration was created. * **UpdatedAt** *(datetime) --* The timestamp value of when the notification configuration was last updated. * **Tags** *(dict) --* A set of key/value pairs that are used to manage the notification configuration. * *(string) --* * *(string) --* **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / put_runtime_log_configuration put_runtime_log_configuration ***************************** ManagedintegrationsforIoTDeviceManagement.Client.put_runtime_log_configuration(**kwargs) Set the runtime log configuration for a specific managed thing or for all managed things as a group. See also: AWS API Documentation **Request Syntax** response = client.put_runtime_log_configuration( ManagedThingId='string', RuntimeLogConfigurations={ 'LogLevel': 'DEBUG'|'ERROR'|'INFO'|'WARN', 'LogFlushLevel': 'DEBUG'|'ERROR'|'INFO'|'WARN', 'LocalStoreLocation': 'string', 'LocalStoreFileRotationMaxFiles': 123, 'LocalStoreFileRotationMaxBytes': 123, 'UploadLog': True|False, 'UploadPeriodMinutes': 123, 'DeleteLocalStoreAfterUpload': True|False } ) Parameters: * **ManagedThingId** (*string*) -- **[REQUIRED]** The id for a managed thing. * **RuntimeLogConfigurations** (*dict*) -- **[REQUIRED]** The runtime log configuration for a managed thing. * **LogLevel** *(string) --* The different log levels available for configuration. * **LogFlushLevel** *(string) --* The different log levels available for configuration. * **LocalStoreLocation** *(string) --* Configuration of where to store runtime logs in the device. * **LocalStoreFileRotationMaxFiles** *(integer) --* Configuration to set the maximum number of runtime log files that can be stored on the device before the oldest files are deleted or overwritten. * **LocalStoreFileRotationMaxBytes** *(integer) --* Configuration to set the maximum bytes of runtime logs that can be stored on the device before the oldest logs are deleted or overwritten. * **UploadLog** *(boolean) --* Configuration to enable or disable uploading of runtime logs to the cloud. * **UploadPeriodMinutes** *(integer) --* Configuration to set the time interval in minutes between each batch of runtime logs that the device uploads to the cloud. * **DeleteLocalStoreAfterUpload** *(boolean) --* Configuration to enable or disable deleting of runtime logs in the device once uploaded to the cloud. Returns: None **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / send_connector_event send_connector_event ******************** ManagedintegrationsforIoTDeviceManagement.Client.send_connector_event(**kwargs) Relays third-party device events for a connector such as a new device or a device state change event. See also: AWS API Documentation **Request Syntax** response = client.send_connector_event( ConnectorId='string', UserId='string', Operation='DEVICE_COMMAND_RESPONSE'|'DEVICE_DISCOVERY'|'DEVICE_EVENT'|'DEVICE_COMMAND_REQUEST', OperationVersion='string', StatusCode=123, Message='string', DeviceDiscoveryId='string', ConnectorDeviceId='string', TraceId='string', Devices=[ { 'ConnectorDeviceId': 'string', 'ConnectorDeviceName': 'string', 'CapabilityReport': { 'version': 'string', 'nodeId': 'string', 'endpoints': [ { 'id': 'string', 'deviceTypes': [ 'string', ], 'clusters': [ { 'id': 'string', 'revision': 123, 'publicId': 'string', 'name': 'string', 'specVersion': 'string', 'attributes': [ { 'id': 'string', 'name': 'string', 'value': {...}|[...]|123|123.4|'string'|True|None }, ], 'commands': [ 'string', ], 'events': [ 'string', ], 'featureMap': 123, 'generatedCommands': [ 'string', ], 'fabricIndex': 123 }, ], 'parts': [ 'string', ], 'semanticTags': [ 'string', ], 'clientClusters': [ 'string', ] }, ] }, 'CapabilitySchemas': [ { 'Format': 'AWS'|'ZCL'|'CONNECTOR', 'CapabilityId': 'string', 'ExtrinsicId': 'string', 'ExtrinsicVersion': 123, 'Schema': {...}|[...]|123|123.4|'string'|True|None }, ], 'DeviceMetadata': {...}|[...]|123|123.4|'string'|True|None }, ], MatterEndpoint={ 'id': 'string', 'clusters': [ { 'id': 'string', 'attributes': {...}|[...]|123|123.4|'string'|True|None, 'commands': { 'string': {...}|[...]|123|123.4|'string'|True|None }, 'events': { 'string': {...}|[...]|123|123.4|'string'|True|None } }, ] } ) Parameters: * **ConnectorId** (*string*) -- **[REQUIRED]** The id of the connector between the third-party cloud provider and IoT managed integrations. * **UserId** (*string*) -- The id of the third-party cloud provider. * **Operation** (*string*) -- **[REQUIRED]** The Open Connectivity Foundation (OCF) operation requested to be performed on the managed thing. Note: The field op can have a value of "I" or "U". The field "cn" will contain the capability types. * **OperationVersion** (*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. * **StatusCode** (*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:///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". * **DeviceDiscoveryId** (*string*) -- The id for the device discovery job. * **ConnectorDeviceId** (*string*) -- The third-party device id as defined by the connector. This device id must not contain personal identifiable information (PII). Note: This parameter is used for cloud-to-cloud devices only. * **TraceId** (*string*) -- The trace request identifier used to correlate a command request and response. This is specified by the device owner, but will be generated by IoT managed integrations if not provided by the device owner. * **Devices** (*list*) -- The list of devices. * *(dict) --* Describe the device using the relevant metadata and supported clusters for device discovery. * **ConnectorDeviceId** *(string) --* **[REQUIRED]** The device id as defined by the connector. Note: This parameter is used for cloud-to-cloud devices only. * **ConnectorDeviceName** *(string) --* The name of the device as defined by the connector. * **CapabilityReport** *(dict) --* **[REQUIRED]** The capability report for the device. * **version** *(string) --* **[REQUIRED]** The version of the capability report. * **nodeId** *(string) --* The numeric identifier of the node. * **endpoints** *(list) --* **[REQUIRED]** The endpoints used in the capability report. * *(dict) --* Matter endpoint used in capability report. * **id** *(string) --* **[REQUIRED]** The id of the Amazon Web Services Matter capability report endpoint. * **deviceTypes** *(list) --* **[REQUIRED]** The type of device. * *(string) --* * **clusters** *(list) --* **[REQUIRED]** Matter clusters used in capability report. * *(dict) --* Capability used in Matter capability report. * **id** *(string) --* **[REQUIRED]** The id of the Amazon Web Services Matter capability report cluster. * **revision** *(integer) --* **[REQUIRED]** The id of the revision for the Amazon Web Services Matter capability report. * **publicId** *(string) --* The id of the schema version. * **name** *(string) --* The capability name used in the Amazon Web Services Matter capability report. * **specVersion** *(string) --* The spec version used in the Amazon Web Services Matter capability report. * **attributes** *(list) --* The attributes of the Amazon Web Services Matter capability report. * *(dict) --* Matter attribute used in capability report. * **id** *(string) --* The id of the Matter attribute. * **name** *(string) --* Name for the Amazon Web Services Matter capability report attribute. * **value** (*document*) -- Value for the Amazon Web Services Matter capability report attribute. * **commands** *(list) --* The commands used with the Amazon Web Services Matter capability report. * *(string) --* * **events** *(list) --* The events used with the Amazon Web Services Matter capability report. * *(string) --* * **featureMap** *(integer) --* 32 bit-map used to indicate which features a cluster supports. * **generatedCommands** *(list) --* Matter clusters used in capability report. * *(string) --* * **fabricIndex** *(integer) --* The fabric index for the Amazon Web Services Matter capability report. * **parts** *(list) --* Heirachy of child endpoints contained in the given endpoint. * *(string) --* * **semanticTags** *(list) --* Semantic information related to endpoint. * *(string) --* * **clientClusters** *(list) --* Semantic information related to endpoint. * *(string) --* * **CapabilitySchemas** *(list) --* Report of all capabilities supported by the device. * *(dict) --* Structure representing a capability schema item that defines the functionality and features supported by a managed thing. * **Format** *(string) --* **[REQUIRED]** The format of the capability schema, which defines how the schema is structured and interpreted. * **CapabilityId** *(string) --* **[REQUIRED]** The unique identifier of the capability defined in the schema. * **ExtrinsicId** *(string) --* **[REQUIRED]** The external identifier for the capability, used when referencing the capability outside of the AWS ecosystem. * **ExtrinsicVersion** *(integer) --* **[REQUIRED]** The version of the external capability definition, used to track compatibility with external systems. * **Schema** (*document*) -- **[REQUIRED]** The actual schema definition that describes the capability's properties, actions, and events. * **DeviceMetadata** (*document*) -- The metadata attributes for a device. * **MatterEndpoint** (*dict*) -- The device endpoint. * **id** *(string) --* The Matter endpoint id. * **clusters** *(list) --* A list of Matter clusters for a managed thing. * *(dict) --* Describe a Matter cluster with an id, and the relevant attributes, commands, and events. * **id** *(string) --* The cluster id. * **attributes** (*document*) -- The Matter attributes. * **commands** *(dict) --* Describe the Matter commands with the Matter command identifier mapped to the command fields. * *(string) --* * (*document*) -- * **events** *(dict) --* Describe the Matter events with the Matter event identifier mapped to the event fields. * *(string) --* * (*document*) -- Return type: dict Returns: **Response Syntax** { 'ConnectorId': 'string' } **Response Structure** * *(dict) --* * **ConnectorId** *(string) --* The id of the connector between the third-party cloud provider and IoT managed integrations. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / get_ota_task_configuration get_ota_task_configuration ************************** ManagedintegrationsforIoTDeviceManagement.Client.get_ota_task_configuration(**kwargs) Get a configuraiton for the over-the-air (OTA) task. See also: AWS API Documentation **Request Syntax** response = client.get_ota_task_configuration( Identifier='string' ) Parameters: **Identifier** (*string*) -- **[REQUIRED]** The over-the-air (OTA) task configuration id. Return type: dict Returns: **Response Syntax** { 'TaskConfigurationId': 'string', 'Name': 'string', 'PushConfig': { 'AbortConfig': { 'AbortConfigCriteriaList': [ { 'Action': 'CANCEL', 'FailureType': 'FAILED'|'REJECTED'|'TIMED_OUT'|'ALL', 'MinNumberOfExecutedThings': 123, 'ThresholdPercentage': 123.0 }, ] }, 'RolloutConfig': { 'ExponentialRolloutRate': { 'BaseRatePerMinute': 123, 'IncrementFactor': 123.0, 'RateIncreaseCriteria': { 'numberOfNotifiedThings': 123, 'numberOfSucceededThings': 123 } }, 'MaximumPerMinute': 123 }, 'TimeoutConfig': { 'InProgressTimeoutInMinutes': 123 } }, 'Description': 'string', 'CreatedAt': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **TaskConfigurationId** *(string) --* The over-the-air (OTA) task configuration id. * **Name** *(string) --* The name of the over-the-air (OTA) task configuration. * **PushConfig** *(dict) --* Describes the type of configuration used for the over-the- air (OTA) task. * **AbortConfig** *(dict) --* Structure representing one abort config. * **AbortConfigCriteriaList** *(list) --* The list of criteria for the abort config. * *(dict) --* Structure representing one abort config criteria. * **Action** *(string) --* The action taken by the abort configuration. * **FailureType** *(string) --* Over-the-air (OTA) task abort criteria failure type. * **MinNumberOfExecutedThings** *(integer) --* The minimum number of things that must receive task execution notifications before the task can be aborted. * **ThresholdPercentage** *(float) --* The minimum percentage of over-the-air (OTA) task execution failures that must occur to initiate the last abort. * **RolloutConfig** *(dict) --* Structure representing one rollout config. * **ExponentialRolloutRate** *(dict) --* Structure representing exponential rate of rollout for an over-the-air (OTA) task. * **BaseRatePerMinute** *(integer) --* The base rate per minute for the rollout of an over- the-air (OTA) task. * **IncrementFactor** *(float) --* The incremental factor for increasing the rollout rate of an over-the-air (OTA) task. * **RateIncreaseCriteria** *(dict) --* The criteria for increasing the rollout rate of an over-the-air (OTA) task. * **numberOfNotifiedThings** *(integer) --* The threshold for number of notified things that will initiate the increase in rate of rollout. * **numberOfSucceededThings** *(integer) --* The threshold for number of succeeded things that will initiate the increase in rate of rollout. * **MaximumPerMinute** *(integer) --* The maximum number of things that will be notified of a pending task, per minute. * **TimeoutConfig** *(dict) --* Structure representing one timeout config. * **InProgressTimeoutInMinutes** *(integer) --* Specifies the amount of time the device has to finish execution of this task. The timeout interval can be anywhere between 1 minute and 7 days. * **Description** *(string) --* A description of the over-the-air (OTA) task configuration. * **CreatedAt** *(datetime) --* The timestamp value of when the over-the-air (OTA) task configuration was created at. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / create_cloud_connector create_cloud_connector ********************** ManagedintegrationsforIoTDeviceManagement.Client.create_cloud_connector(**kwargs) Creates a C2C (cloud-to-cloud) connector. See also: AWS API Documentation **Request Syntax** response = client.create_cloud_connector( Name='string', EndpointConfig={ 'lambda': { 'arn': 'string' } }, Description='string', EndpointType='LAMBDA', ClientToken='string' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The display name of the C2C connector. * **EndpointConfig** (*dict*) -- **[REQUIRED]** The configuration details for the cloud connector endpoint, including connection parameters and authentication requirements. * **lambda** *(dict) --* The Lambda function configuration for the endpoint, used when the endpoint communicates through an AWS Lambda function. * **arn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the Lambda function used as an endpoint. * **Description** (*string*) -- A description of the C2C connector. * **EndpointType** (*string*) -- The type of endpoint used for the cloud connector, which defines how the connector communicates with external services. * **ClientToken** (*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. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'Id': 'string' } **Response Structure** * *(dict) --* * **Id** *(string) --* The unique identifier assigned to the newly created cloud connector. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Con flictException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / get_destination get_destination *************** ManagedintegrationsforIoTDeviceManagement.Client.get_destination(**kwargs) Gets a destination by ID. See also: AWS API Documentation **Request Syntax** response = client.get_destination( Name='string' ) Parameters: **Name** (*string*) -- **[REQUIRED]** The name of the customer-managed destination. Return type: dict Returns: **Response Syntax** { 'Description': 'string', 'DeliveryDestinationArn': 'string', 'DeliveryDestinationType': 'KINESIS', 'Name': 'string', 'RoleArn': 'string', 'CreatedAt': datetime(2015, 1, 1), 'UpdatedAt': datetime(2015, 1, 1), 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **Description** *(string) --* The description of the customer-managed destination. * **DeliveryDestinationArn** *(string) --* The Amazon Resource Name (ARN) of the customer-managed destination. * **DeliveryDestinationType** *(string) --* The destination type for the customer-managed destination. * **Name** *(string) --* The name of the customer-managed destination. * **RoleArn** *(string) --* The Amazon Resource Name (ARN) of the delivery destination role. * **CreatedAt** *(datetime) --* The timestamp value of when the destination creation requset occurred. * **UpdatedAt** *(datetime) --* The timestamp value of when the destination update requset occurred. * **Tags** *(dict) --* A set of key/value pairs that are used to manage the customer-managed destination. * *(string) --* * *(string) --* **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / delete_account_association delete_account_association ************************** ManagedintegrationsforIoTDeviceManagement.Client.delete_account_association(**kwargs) Remove a third party account and related devices from an end user. See also: AWS API Documentation **Request Syntax** response = client.delete_account_association( AccountAssociationId='string' ) Parameters: **AccountAssociationId** (*string*) -- **[REQUIRED]** The unique identifier of the account association to be deleted. Returns: None **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / list_ota_task_executions list_ota_task_executions ************************ ManagedintegrationsforIoTDeviceManagement.Client.list_ota_task_executions(**kwargs) List all of the over-the-air (OTA) task executions. See also: AWS API Documentation **Request Syntax** response = client.list_ota_task_executions( Identifier='string', NextToken='string', MaxResults=123 ) Parameters: * **Identifier** (*string*) -- **[REQUIRED]** The over-the-air (OTA) task id. * **NextToken** (*string*) -- A token that can be used to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return at one time. Return type: dict Returns: **Response Syntax** { 'ExecutionSummaries': [ { 'TaskExecutionSummary': { 'ExecutionNumber': 123, 'LastUpdatedAt': datetime(2015, 1, 1), 'QueuedAt': datetime(2015, 1, 1), 'RetryAttempt': 123, 'StartedAt': datetime(2015, 1, 1), 'Status': 'QUEUED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'REJECTED'|'REMOVED'|'CANCELED' }, 'ManagedThingId': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ExecutionSummaries** *(list) --* A list of all of the over-the-air (OTA) task executions. * *(dict) --* Structure representing one execution summary. * **TaskExecutionSummary** *(dict) --* Structure representing one over-the-air (OTA) task execution summary * **ExecutionNumber** *(integer) --* The execution number of the over-the-air (OTA) task execution summary. * **LastUpdatedAt** *(datetime) --* The timestamp value of when the over-the-air (OTA) task execution summary was last updated. * **QueuedAt** *(datetime) --* The timestamp value of when the over-the-air (OTA) task execution summary is targeted to start. * **RetryAttempt** *(integer) --* The number of retry attempts for starting the over- the-air (OTA) task execution summary after a failed attempt. * **StartedAt** *(datetime) --* The timestamp value of when the over-the-air (OTA) task execution summary started. * **Status** *(string) --* The status of the over-the-air (OTA) task execution summary. * **ManagedThingId** *(string) --* The id of a managed thing. * **NextToken** *(string) --* A token that can be used to retrieve the next set of results. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" ManagedintegrationsforIoTDeviceManagement / Client / get_connector_destination get_connector_destination ************************* ManagedintegrationsforIoTDeviceManagement.Client.get_connector_destination(**kwargs) Get a connector destination of a cloud-to-cloud (C2C) connector connecting to a customer's Amazon Web Services account. See also: AWS API Documentation **Request Syntax** response = client.get_connector_destination( Identifier='string' ) Parameters: **Identifier** (*string*) -- **[REQUIRED]** The identifier of the C2C connector destination. Return type: dict Returns: **Response Syntax** { 'Name': 'string', 'Description': 'string', 'CloudConnectorId': 'string', 'Id': 'string', 'AuthType': 'OAUTH', 'AuthConfig': { 'oAuth': { 'authUrl': 'string', 'tokenUrl': 'string', 'scope': 'string', 'tokenEndpointAuthenticationScheme': 'HTTP_BASIC'|'REQUEST_BODY_CREDENTIALS', 'oAuthCompleteRedirectUrl': 'string', 'proactiveRefreshTokenRenewal': { 'enabled': True|False, 'DaysBeforeRenewal': 123 } } }, 'SecretsManager': { 'arn': 'string', 'versionId': 'string' }, 'OAuthCompleteRedirectUrl': 'string' } **Response Structure** * *(dict) --* * **Name** *(string) --* The display name of the connector destination. * **Description** *(string) --* A description of the connector destination. * **CloudConnectorId** *(string) --* The identifier of the C2C connector. * **Id** *(string) --* The unique identifier of the connector destination. * **AuthType** *(string) --* The authentication type used for the connector destination, which determines how credentials and access are managed. * **AuthConfig** *(dict) --* The authentication configuration details for the connector destination, including OAuth settings and other authentication parameters. * **oAuth** *(dict) --* The OAuth configuration settings used for authentication with the third-party service. * **authUrl** *(string) --* The authorization URL for the OAuth service, where users are directed to authenticate and authorize access. * **tokenUrl** *(string) --* The token URL for the OAuth service, where authorization codes are exchanged for access tokens. * **scope** *(string) --* The OAuth scopes requested during authorization, which define the permissions granted to the application. * **tokenEndpointAuthenticationScheme** *(string) --* The authentication scheme used when requesting tokens from the token endpoint. * **oAuthCompleteRedirectUrl** *(string) --* The URL where users are redirected after completing the OAuth authorization process. * **proactiveRefreshTokenRenewal** *(dict) --* Configuration for proactively refreshing OAuth tokens before they expire. * **enabled** *(boolean) --* Indicates whether proactive refresh token renewal is enabled. * **DaysBeforeRenewal** *(integer) --* The days before token expiration when the system should attempt to renew the token, specified in days. * **SecretsManager** *(dict) --* The AWS Secrets Manager configuration used to securely store and manage sensitive information for the connector destination. * **arn** *(string) --* The Amazon Resource Name (ARN) of the AWS Secrets Manager secret. * **versionId** *(string) --* The version ID of the AWS Secrets Manager secret. * **OAuthCompleteRedirectUrl** *(string) --* The URL where users are redirected after completing the OAuth authorization process for the connector destination. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / close close ***** ManagedintegrationsforIoTDeviceManagement.Client.close() Closes underlying endpoint connections. ManagedintegrationsforIoTDeviceManagement / Client / create_ota_task create_ota_task *************** ManagedintegrationsforIoTDeviceManagement.Client.create_ota_task(**kwargs) Create an over-the-air (OTA) task to update a device. See also: AWS API Documentation **Request Syntax** response = client.create_ota_task( Description='string', S3Url='string', Protocol='HTTP', Target=[ 'string', ], TaskConfigurationId='string', OtaMechanism='PUSH', OtaType='ONE_TIME'|'CONTINUOUS', OtaTargetQueryString='string', ClientToken='string', OtaSchedulingConfig={ 'EndBehavior': 'STOP_ROLLOUT'|'CANCEL'|'FORCE_CANCEL', 'EndTime': 'string', 'MaintenanceWindows': [ { 'DurationInMinutes': 123, 'StartTime': 'string' }, ], 'StartTime': 'string' }, OtaTaskExecutionRetryConfig={ 'RetryConfigCriteria': [ { 'FailureType': 'FAILED'|'TIMED_OUT'|'ALL', 'MinNumberOfRetries': 123 }, ] }, Tags={ 'string': 'string' } ) Parameters: * **Description** (*string*) -- The description of the over-the- air (OTA) task. * **S3Url** (*string*) -- **[REQUIRED]** 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** (*list*) -- The device targeted for the over-the-air (OTA) task. * *(string) --* * **TaskConfigurationId** (*string*) -- The identifier for the over-the-air (OTA) task configuration. * **OtaMechanism** (*string*) -- The deployment mechanism for the over-the-air (OTA) task. * **OtaType** (*string*) -- **[REQUIRED]** The frequency type for the over-the-air (OTA) task. * **OtaTargetQueryString** (*string*) -- The query string to add things to the thing group. * **ClientToken** (*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. This field is autopopulated if not provided. * **OtaSchedulingConfig** (*dict*) -- Over-the-air (OTA) task scheduling config. * **EndBehavior** *(string) --* Specifies the end behavior for all task executions after a task reaches the selected "endTime". If "endTime" is not selected when creating the task, then "endBehavior" does not apply. * **EndTime** *(string) --* The time an over-the-air (OTA) task will stop. * **MaintenanceWindows** *(list) --* Maintenance window list for over-the-air (OTA) task scheduling config. * *(dict) --* Structure representing scheduling maintenance window. * **DurationInMinutes** *(integer) --* Displays the duration of the next maintenance window. * **StartTime** *(string) --* Displays the start time of the next maintenance window. * **StartTime** *(string) --* The time an over-the-air (OTA) task will start. * **OtaTaskExecutionRetryConfig** (*dict*) -- Over-the-air (OTA) task retry config. * **RetryConfigCriteria** *(list) --* The list of retry config criteria. * *(dict) --* Structure representing one retry config criteria. * **FailureType** *(string) --* Over-the-air (OTA) retry criteria failure type. * **MinNumberOfRetries** *(integer) --* The number of retries allowed for a failure type for the over-the-air (OTA) task. * **Tags** (*dict*) -- A set of key/value pairs that are used to manage the over-the- air (OTA) task. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'TaskId': 'string', 'TaskArn': 'string', 'Description': 'string' } **Response Structure** * *(dict) --* * **TaskId** *(string) --* The identifier of the over-the-air (OTA) task. * **TaskArn** *(string) --* The Amazon Resource Name (ARN) of the over-the-air (OTA) task. * **Description** *(string) --* A description of the over-the-air (OTA) task. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Una uthorizedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Con flictException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" ManagedintegrationsforIoTDeviceManagement / Client / reset_runtime_log_configuration reset_runtime_log_configuration ******************************* ManagedintegrationsforIoTDeviceManagement.Client.reset_runtime_log_configuration(**kwargs) Reset a runtime log configuration for a specific managed thing or for all managed things as a group. See also: AWS API Documentation **Request Syntax** response = client.reset_runtime_log_configuration( ManagedThingId='string' ) Parameters: **ManagedThingId** (*string*) -- **[REQUIRED]** The id of a managed thing. Returns: None **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / get_managed_thing_capabilities get_managed_thing_capabilities ****************************** ManagedintegrationsforIoTDeviceManagement.Client.get_managed_thing_capabilities(**kwargs) Get the capabilities for a managed thing using the device ID. See also: AWS API Documentation **Request Syntax** response = client.get_managed_thing_capabilities( Identifier='string' ) Parameters: **Identifier** (*string*) -- **[REQUIRED]** The id of the device. Return type: dict Returns: **Response Syntax** { 'ManagedThingId': 'string', 'Capabilities': 'string', 'CapabilityReport': { 'version': 'string', 'nodeId': 'string', 'endpoints': [ { 'id': 'string', 'deviceTypes': [ 'string', ], 'capabilities': [ { 'id': 'string', 'name': 'string', 'version': 'string', 'properties': [ 'string', ], 'actions': [ 'string', ], 'events': [ 'string', ] }, ] }, ] } } **Response Structure** * *(dict) --* * **ManagedThingId** *(string) --* The id of the device. * **Capabilities** *(string) --* The capabilities of the device such as light bulb. * **CapabilityReport** *(dict) --* A report of the capabilities for the managed thing. * **version** *(string) --* The version of the capability report. * **nodeId** *(string) --* The numeric identifier of the node. * **endpoints** *(list) --* The endpoints used in the capability report. * *(dict) --* The endpoint used in the capability report. * **id** *(string) --* The id of the endpoint used in the capability report. * **deviceTypes** *(list) --* The type of device. * *(string) --* * **capabilities** *(list) --* The capabilities used in the capability report. * *(dict) --* The capability used in capability report. * **id** *(string) --* The id of the schema version. * **name** *(string) --* The name of the capability. * **version** *(string) --* The version of the capability. * **properties** *(list) --* The capability properties used in the capability report. * *(string) --* * **actions** *(list) --* The capability actions used in the capability report. * *(string) --* * **events** *(list) --* The capability events used in the capability report. * *(string) --* **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Una uthorizedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / get_cloud_connector get_cloud_connector ******************* ManagedintegrationsforIoTDeviceManagement.Client.get_cloud_connector(**kwargs) Gets all the information about a connector for a connector developer. See also: AWS API Documentation **Request Syntax** response = client.get_cloud_connector( Identifier='string' ) Parameters: **Identifier** (*string*) -- **[REQUIRED]** The identifier of the C2C connector. Return type: dict Returns: **Response Syntax** { 'Name': 'string', 'EndpointConfig': { 'lambda': { 'arn': 'string' } }, 'Description': 'string', 'EndpointType': 'LAMBDA', 'Id': 'string', 'Type': 'LISTED'|'UNLISTED' } **Response Structure** * *(dict) --* * **Name** *(string) --* The display name of the C2C connector. * **EndpointConfig** *(dict) --* The configuration details for the cloud connector endpoint, including connection parameters and authentication requirements. * **lambda** *(dict) --* The Lambda function configuration for the endpoint, used when the endpoint communicates through an AWS Lambda function. * **arn** *(string) --* The Amazon Resource Name (ARN) of the Lambda function used as an endpoint. * **Description** *(string) --* A description of the C2C connector. * **EndpointType** *(string) --* The type of endpoint used for the cloud connector, which defines how the connector communicates with external services. * **Id** *(string) --* The unique identifier of the cloud connector. * **Type** *(string) --* The type of cloud connector created. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / create_provisioning_profile create_provisioning_profile *************************** ManagedintegrationsforIoTDeviceManagement.Client.create_provisioning_profile(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.create_provisioning_profile( ProvisioningType='FLEET_PROVISIONING'|'JITR', CaCertificate='string', Name='string', ClientToken='string', Tags={ 'string': 'string' } ) Parameters: * **ProvisioningType** (*string*) -- **[REQUIRED]** The type of provisioning workflow the device uses for onboarding to IoT managed integrations. * **CaCertificate** (*string*) -- The id of the certificate authority (CA) certificate. * **Name** (*string*) -- The name of the provisioning template. * **ClientToken** (*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. This field is autopopulated if not provided. * **Tags** (*dict*) -- A set of key/value pairs that are used to manage the provisioning profile. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'Name': 'string', 'ProvisioningType': 'FLEET_PROVISIONING'|'JITR', 'Id': 'string', 'ClaimCertificate': 'string', 'ClaimCertificatePrivateKey': 'string' } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the provisioning template used in the provisioning profile. * **Name** *(string) --* The name of the provisioning template. * **ProvisioningType** *(string) --* The type of provisioning workflow the device uses for onboarding to IoT managed integrations. * **Id** *(string) --* The identifier of the provisioning profile. * **ClaimCertificate** *(string) --* The id of the claim certificate. * **ClaimCertificatePrivateKey** *(string) --* The private key of the claim certificate. This is stored securely on the device for validating the connection endpoint with IoT managed integrations using the public key. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Una uthorizedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Con flictException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" ManagedintegrationsforIoTDeviceManagement / Client / update_managed_thing update_managed_thing ******************** ManagedintegrationsforIoTDeviceManagement.Client.update_managed_thing(**kwargs) Update the attributes and capabilities associated with a managed thing. See also: AWS API Documentation **Request Syntax** response = client.update_managed_thing( Identifier='string', Owner='string', CredentialLockerId='string', SerialNumber='string', Brand='string', Model='string', Name='string', CapabilityReport={ 'version': 'string', 'nodeId': 'string', 'endpoints': [ { 'id': 'string', 'deviceTypes': [ 'string', ], 'capabilities': [ { 'id': 'string', 'name': 'string', 'version': 'string', 'properties': [ 'string', ], 'actions': [ 'string', ], 'events': [ 'string', ] }, ] }, ] }, CapabilitySchemas=[ { 'Format': 'AWS'|'ZCL'|'CONNECTOR', 'CapabilityId': 'string', 'ExtrinsicId': 'string', 'ExtrinsicVersion': 123, 'Schema': {...}|[...]|123|123.4|'string'|True|None }, ], Capabilities='string', Classification='string', HubNetworkMode='STANDARD'|'NETWORK_WIDE_EXCLUSION', MetaData={ 'string': 'string' } ) Parameters: * **Identifier** (*string*) -- **[REQUIRED]** 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. * **CredentialLockerId** (*string*) -- The identifier of the credential for the managed thing. * **SerialNumber** (*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. * **CapabilityReport** (*dict*) -- A report of the capabilities for the managed thing. * **version** *(string) --* **[REQUIRED]** The version of the capability report. * **nodeId** *(string) --* The numeric identifier of the node. * **endpoints** *(list) --* **[REQUIRED]** The endpoints used in the capability report. * *(dict) --* The endpoint used in the capability report. * **id** *(string) --* **[REQUIRED]** The id of the endpoint used in the capability report. * **deviceTypes** *(list) --* **[REQUIRED]** The type of device. * *(string) --* * **capabilities** *(list) --* **[REQUIRED]** The capabilities used in the capability report. * *(dict) --* The capability used in capability report. * **id** *(string) --* **[REQUIRED]** The id of the schema version. * **name** *(string) --* **[REQUIRED]** The name of the capability. * **version** *(string) --* **[REQUIRED]** The version of the capability. * **properties** *(list) --* **[REQUIRED]** The capability properties used in the capability report. * *(string) --* * **actions** *(list) --* **[REQUIRED]** The capability actions used in the capability report. * *(string) --* * **events** *(list) --* **[REQUIRED]** The capability events used in the capability report. * *(string) --* * **CapabilitySchemas** (*list*) -- The updated capability schemas that define the functionality and features supported by the managed thing. * *(dict) --* Structure representing a capability schema item that defines the functionality and features supported by a managed thing. * **Format** *(string) --* **[REQUIRED]** The format of the capability schema, which defines how the schema is structured and interpreted. * **CapabilityId** *(string) --* **[REQUIRED]** The unique identifier of the capability defined in the schema. * **ExtrinsicId** *(string) --* **[REQUIRED]** The external identifier for the capability, used when referencing the capability outside of the AWS ecosystem. * **ExtrinsicVersion** *(integer) --* **[REQUIRED]** The version of the external capability definition, used to track compatibility with external systems. * **Schema** (*document*) -- **[REQUIRED]** The actual schema definition that describes the capability's properties, actions, and events. * **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. * **HubNetworkMode** (*string*) -- The network mode for the hub- connected device. * **MetaData** (*dict*) -- The metadata for the managed thing. * *(string) --* * *(string) --* Returns: None **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Una uthorizedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Con flictException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / get_custom_endpoint get_custom_endpoint ******************* ManagedintegrationsforIoTDeviceManagement.Client.get_custom_endpoint() Returns the IoT managed integrations custom endpoint. See also: AWS API Documentation **Request Syntax** response = client.get_custom_endpoint() Return type: dict Returns: **Response Syntax** { 'EndpointAddress': 'string' } **Response Structure** * *(dict) --* * **EndpointAddress** *(string) --* The IoT managed integrations dedicated, custom endpoint for the device to route traffic through. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Una uthorizedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / delete_event_log_configuration delete_event_log_configuration ****************************** ManagedintegrationsforIoTDeviceManagement.Client.delete_event_log_configuration(**kwargs) Delete an event log configuration. See also: AWS API Documentation **Request Syntax** response = client.delete_event_log_configuration( Id='string' ) Parameters: **Id** (*string*) -- **[REQUIRED]** The identifier of the event log configuration. Returns: None **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / send_managed_thing_command send_managed_thing_command ************************** ManagedintegrationsforIoTDeviceManagement.Client.send_managed_thing_command(**kwargs) Send the command to the device represented by the managed thing. See also: AWS API Documentation **Request Syntax** response = client.send_managed_thing_command( ManagedThingId='string', Endpoints=[ { 'endpointId': 'string', 'capabilities': [ { 'id': 'string', 'name': 'string', 'version': 'string', 'actions': [ { 'name': 'string', 'ref': 'string', 'actionTraceId': 'string', 'parameters': {...}|[...]|123|123.4|'string'|True|None }, ] }, ] }, ], ConnectorAssociationId='string', AccountAssociationId='string' ) Parameters: * **ManagedThingId** (*string*) -- **[REQUIRED]** The id of the device. * **Endpoints** (*list*) -- **[REQUIRED]** The device endpoint. * *(dict) --* The endpoint for a managed thing when sending a command. * **endpointId** *(string) --* **[REQUIRED]** The id of the endpoint for a managed thing. * **capabilities** *(list) --* **[REQUIRED]** Describe the endpoint with an id, a name, and the relevant capabilities for sending commands. * *(dict) --* The command capabilities added for the managed thing * **id** *(string) --* **[REQUIRED]** Describe the capability with an id. * **name** *(string) --* **[REQUIRED]** Describe the capability with an name. * **version** *(string) --* **[REQUIRED]** Describe the capability with a version. * **actions** *(list) --* **[REQUIRED]** Describe the command capability with the actions it supports. * *(dict) --* Action for an Amazon Web Services capability, containing the action parameters for control. * **name** *(string) --* **[REQUIRED]** Describe a capability action with a name. * **ref** *(string) --* Describe a capability action with an reference. * **actionTraceId** *(string) --* Describe a capability action with an "actionTraceId" for a response command. * **parameters** (*document*) -- Describe a capability action with a capability property. * **ConnectorAssociationId** (*string*) -- The ID tracking the current discovery process for one connector association. * **AccountAssociationId** (*string*) -- The identifier of the account association to use when sending a command to a managed thing. Return type: dict Returns: **Response Syntax** { 'TraceId': 'string' } **Response Structure** * *(dict) --* * **TraceId** *(string) --* The trace request identifier. This is specified by the device owner, but will be generated by IoT managed integrations if not provided by the device owner. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Una uthorizedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / list_managed_thing_schemas list_managed_thing_schemas ************************** ManagedintegrationsforIoTDeviceManagement.Client.list_managed_thing_schemas(**kwargs) List schemas associated with a managed thing. See also: AWS API Documentation **Request Syntax** response = client.list_managed_thing_schemas( Identifier='string', EndpointIdFilter='string', CapabilityIdFilter='string', NextToken='string', MaxResults=123 ) Parameters: * **Identifier** (*string*) -- **[REQUIRED]** The managed thing id. * **EndpointIdFilter** (*string*) -- Filter on an endpoint id. * **CapabilityIdFilter** (*string*) -- Filter on a capability id. * **NextToken** (*string*) -- A token that can be used to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return at one time. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'EndpointId': 'string', 'CapabilityId': 'string', 'Schema': {...}|[...]|123|123.4|'string'|True|None }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Items** *(list) --* The list of managed thing schemas. * *(dict) --* Structure representing one schema item associated with a managed thing. * **EndpointId** *(string) --* The id of the endpoint for a managed thing. * **CapabilityId** *(string) --* The id of the capability for a managed thing. * **Schema** (*document*) -- The validation schema for one schema item associated with a managed thing. * **NextToken** *(string) --* A token that can be used to retrieve the next set of results. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Una uthorizedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / tag_resource tag_resource ************ ManagedintegrationsforIoTDeviceManagement.Client.tag_resource(**kwargs) Add tags for the specified resource. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( ResourceArn='string', Tags={ 'string': 'string' } ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The ARN of the resource to which to add tags. * **Tags** (*dict*) -- **[REQUIRED]** A set of key/value pairs that are used to manage the resource * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Una uthorizedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Con flictException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Inv alidRequestException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / put_default_encryption_configuration put_default_encryption_configuration ************************************ ManagedintegrationsforIoTDeviceManagement.Client.put_default_encryption_configuration(**kwargs) Sets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the AWS IoT SiteWise User Guide. See also: AWS API Documentation **Request Syntax** response = client.put_default_encryption_configuration( encryptionType='MANAGED_INTEGRATIONS_DEFAULT_ENCRYPTION'|'CUSTOMER_KEY_ENCRYPTION', kmsKeyArn='string' ) Parameters: * **encryptionType** (*string*) -- **[REQUIRED]** The type of encryption used for the encryption configuration. * **kmsKeyArn** (*string*) -- The Key Amazon Resource Name (ARN) of the AWS KMS key used for KMS encryption if you use "KMS_BASED_ENCRYPTION". Return type: dict Returns: **Response Syntax** { 'configurationStatus': { 'error': { 'code': 'string', 'message': 'string' }, 'state': 'ENABLED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED' }, 'encryptionType': 'MANAGED_INTEGRATIONS_DEFAULT_ENCRYPTION'|'CUSTOMER_KEY_ENCRYPTION', 'kmsKeyArn': 'string' } **Response Structure** * *(dict) --* * **configurationStatus** *(dict) --* Provides the status of the default encryption configuration for an Amazon Web Services account. * **error** *(dict) --* The error details describing a failed default encryption configuration update. * **code** *(string) --* The error code returned when the default encryption configuration update fails. * **message** *(string) --* The error message returned when the default encryption configuration update fails. * **state** *(string) --* The status state describing the default encryption configuration update. * **encryptionType** *(string) --* The type of encryption used for the encryption configuration. * **kmsKeyArn** *(string) --* The Key Amazon Resource Name (ARN) of the AWS KMS key used for KMS encryption if you use "KMS_BASED_ENCRYPTION". **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalFailureException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Una uthorizedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" ManagedintegrationsforIoTDeviceManagement / Client / create_credential_locker create_credential_locker ************************ ManagedintegrationsforIoTDeviceManagement.Client.create_credential_locker(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.create_credential_locker( Name='string', ClientToken='string', Tags={ 'string': 'string' } ) Parameters: * **Name** (*string*) -- The name of the credential locker. * **ClientToken** (*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. This field is autopopulated if not provided. * **Tags** (*dict*) -- A set of key/value pairs that are used to manage the credential locker. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'Id': 'string', 'Arn': 'string', 'CreatedAt': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **Id** *(string) --* The identifier of the credential locker creation request. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the credential locker. * **CreatedAt** *(datetime) --* The timestamp value of when the credential locker request occurred. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceQuotaExceededException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Con flictException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / delete_managed_thing delete_managed_thing ******************** ManagedintegrationsforIoTDeviceManagement.Client.delete_managed_thing(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.delete_managed_thing( Identifier='string', Force=True|False ) Parameters: * **Identifier** (*string*) -- **[REQUIRED]** 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: None **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Una uthorizedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Con flictException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / update_cloud_connector update_cloud_connector ********************** ManagedintegrationsforIoTDeviceManagement.Client.update_cloud_connector(**kwargs) Update an existing cloud connector. See also: AWS API Documentation **Request Syntax** response = client.update_cloud_connector( Identifier='string', Name='string', Description='string' ) Parameters: * **Identifier** (*string*) -- **[REQUIRED]** 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: None **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / update_destination update_destination ****************** ManagedintegrationsforIoTDeviceManagement.Client.update_destination(**kwargs) Update a destination specified by id. See also: AWS API Documentation **Request Syntax** response = client.update_destination( Name='string', DeliveryDestinationArn='string', DeliveryDestinationType='KINESIS', RoleArn='string', Description='string' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the customer-managed destination. * **DeliveryDestinationArn** (*string*) -- The Amazon Resource Name (ARN) of the customer-managed destination. * **DeliveryDestinationType** (*string*) -- The destination type for the customer-managed destination. * **RoleArn** (*string*) -- The Amazon Resource Name (ARN) of the delivery destination role. * **Description** (*string*) -- The description of the customer- managed destination. Returns: None **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / delete_provisioning_profile delete_provisioning_profile *************************** ManagedintegrationsforIoTDeviceManagement.Client.delete_provisioning_profile(**kwargs) Delete a provisioning profile. See also: AWS API Documentation **Request Syntax** response = client.delete_provisioning_profile( Identifier='string' ) Parameters: **Identifier** (*string*) -- **[REQUIRED]** The name of the provisioning template. Returns: None **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Una uthorizedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Res ourceNotFoundException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / list_account_associations list_account_associations ************************* ManagedintegrationsforIoTDeviceManagement.Client.list_account_associations(**kwargs) Lists all account associations, with optional filtering by connector destination ID. See also: AWS API Documentation **Request Syntax** response = client.list_account_associations( ConnectorDestinationId='string', MaxResults=123, NextToken='string' ) Parameters: * **ConnectorDestinationId** (*string*) -- The identifier of the connector destination to filter account associations by. * **MaxResults** (*integer*) -- The maximum number of account associations to return in a single response. * **NextToken** (*string*) -- A token used for pagination of results. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'AccountAssociationId': 'string', 'AssociationState': 'ASSOCIATION_IN_PROGRESS'|'ASSOCIATION_FAILED'|'ASSOCIATION_SUCCEEDED'|'ASSOCIATION_DELETING'|'REFRESH_TOKEN_EXPIRED', 'ErrorMessage': 'string', 'ConnectorDestinationId': 'string', 'Name': 'string', 'Description': 'string', 'Arn': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Items** *(list) --* The list of account associations that match the specified criteria. * *(dict) --* Structure containing information about an account association, including its identifier, state, and related metadata. * **AccountAssociationId** *(string) --* The unique identifier of the account association. * **AssociationState** *(string) --* The current state of the account association, indicating its status in the association lifecycle. * **ErrorMessage** *(string) --* The error message explaining any issues with the account association, if applicable. * **ConnectorDestinationId** *(string) --* The identifier of the connector destination associated with this account association. * **Name** *(string) --* The name of the account association. * **Description** *(string) --* A description of the account association. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the account association. * **NextToken** *(string) --* A token used for pagination of results when there are more account associations than can be returned in a single response. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / list_ota_task_configurations list_ota_task_configurations **************************** ManagedintegrationsforIoTDeviceManagement.Client.list_ota_task_configurations(**kwargs) List all of the over-the-air (OTA) task configurations. See also: AWS API Documentation **Request Syntax** response = client.list_ota_task_configurations( NextToken='string', MaxResults=123 ) Parameters: * **NextToken** (*string*) -- A token that can be used to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return at one time. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'TaskConfigurationId': 'string', 'Name': 'string', 'CreatedAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Items** *(list) --* The list of the over-the-air (OTA) task configurations. * *(dict) --* Structure representing one over-the-air (OTA) task configuration. * **TaskConfigurationId** *(string) --* The id of the over-the-air (OTA) task configuration * **Name** *(string) --* The name of the over-the-air (OTA) task configuration. * **CreatedAt** *(datetime) --* The timestamp value of when the over-the-air (OTA) task configuration was created at. * **NextToken** *(string) --* A token that can be used to retrieve the next set of results. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException" ManagedintegrationsforIoTDeviceManagement / Client / list_device_discoveries list_device_discoveries *********************** ManagedintegrationsforIoTDeviceManagement.Client.list_device_discoveries(**kwargs) Lists all device discovery tasks, with optional filtering by type and status. See also: AWS API Documentation **Request Syntax** response = client.list_device_discoveries( NextToken='string', MaxResults=123, TypeFilter='ZWAVE'|'ZIGBEE'|'CLOUD'|'CUSTOM', StatusFilter='RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT' ) Parameters: * **NextToken** (*string*) -- A token used for pagination of results. * **MaxResults** (*integer*) -- The maximum number of device discovery jobs to return in a single response. * **TypeFilter** (*string*) -- The discovery type to filter device discovery jobs by. * **StatusFilter** (*string*) -- The status to filter device discovery jobs by. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'Id': 'string', 'DiscoveryType': 'ZWAVE'|'ZIGBEE'|'CLOUD'|'CUSTOM', 'Status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Items** *(list) --* The list of device discovery jobs that match the specified criteria. * *(dict) --* Structure containing summary information about a device discovery job, including its identifier, type, and status. * **Id** *(string) --* The unique identifier of the device discovery job. * **DiscoveryType** *(string) --* The type of discovery process used to find devices. * **Status** *(string) --* The current status of the device discovery job. * **NextToken** *(string) --* A token used for pagination of results when there are more device discovery jobs than can be returned in a single response. **Exceptions** * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Val idationException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Acc essDeniedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Int ernalServerException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Una uthorizedException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Ser viceUnavailableException" * "ManagedintegrationsforIoTDeviceManagement.Client.exceptions.Thr ottlingException"