@aws-sdk/client-iot-managed-integrations 3.761.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +661 -0
- package/dist-cjs/IoTManagedIntegrations.js +125 -0
- package/dist-cjs/IoTManagedIntegrationsClient.js +51 -0
- package/dist-cjs/auth/httpAuthExtensionConfiguration.js +43 -0
- package/dist-cjs/auth/httpAuthSchemeProvider.js +47 -0
- package/dist-cjs/commands/CreateCredentialLockerCommand.js +27 -0
- package/dist-cjs/commands/CreateDestinationCommand.js +27 -0
- package/dist-cjs/commands/CreateEventLogConfigurationCommand.js +26 -0
- package/dist-cjs/commands/CreateManagedThingCommand.js +27 -0
- package/dist-cjs/commands/CreateNotificationConfigurationCommand.js +27 -0
- package/dist-cjs/commands/CreateOtaTaskCommand.js +27 -0
- package/dist-cjs/commands/CreateOtaTaskConfigurationCommand.js +27 -0
- package/dist-cjs/commands/CreateProvisioningProfileCommand.js +27 -0
- package/dist-cjs/commands/DeleteCredentialLockerCommand.js +26 -0
- package/dist-cjs/commands/DeleteDestinationCommand.js +26 -0
- package/dist-cjs/commands/DeleteEventLogConfigurationCommand.js +26 -0
- package/dist-cjs/commands/DeleteManagedThingCommand.js +26 -0
- package/dist-cjs/commands/DeleteNotificationConfigurationCommand.js +26 -0
- package/dist-cjs/commands/DeleteOtaTaskCommand.js +26 -0
- package/dist-cjs/commands/DeleteOtaTaskConfigurationCommand.js +26 -0
- package/dist-cjs/commands/DeleteProvisioningProfileCommand.js +26 -0
- package/dist-cjs/commands/GetCredentialLockerCommand.js +27 -0
- package/dist-cjs/commands/GetCustomEndpointCommand.js +26 -0
- package/dist-cjs/commands/GetDefaultEncryptionConfigurationCommand.js +26 -0
- package/dist-cjs/commands/GetDestinationCommand.js +27 -0
- package/dist-cjs/commands/GetDeviceDiscoveryCommand.js +27 -0
- package/dist-cjs/commands/GetEventLogConfigurationCommand.js +26 -0
- package/dist-cjs/commands/GetHubConfigurationCommand.js +26 -0
- package/dist-cjs/commands/GetManagedThingCapabilitiesCommand.js +26 -0
- package/dist-cjs/commands/GetManagedThingCommand.js +27 -0
- package/dist-cjs/commands/GetManagedThingConnectivityDataCommand.js +26 -0
- package/dist-cjs/commands/GetManagedThingMetaDataCommand.js +26 -0
- package/dist-cjs/commands/GetManagedThingStateCommand.js +27 -0
- package/dist-cjs/commands/GetNotificationConfigurationCommand.js +27 -0
- package/dist-cjs/commands/GetOtaTaskCommand.js +26 -0
- package/dist-cjs/commands/GetOtaTaskConfigurationCommand.js +27 -0
- package/dist-cjs/commands/GetProvisioningProfileCommand.js +27 -0
- package/dist-cjs/commands/GetRuntimeLogConfigurationCommand.js +26 -0
- package/dist-cjs/commands/GetSchemaVersionCommand.js +26 -0
- package/dist-cjs/commands/ListCredentialLockersCommand.js +27 -0
- package/dist-cjs/commands/ListDestinationsCommand.js +26 -0
- package/dist-cjs/commands/ListEventLogConfigurationsCommand.js +26 -0
- package/dist-cjs/commands/ListManagedThingSchemasCommand.js +26 -0
- package/dist-cjs/commands/ListManagedThingsCommand.js +27 -0
- package/dist-cjs/commands/ListNotificationConfigurationsCommand.js +26 -0
- package/dist-cjs/commands/ListOtaTaskConfigurationsCommand.js +27 -0
- package/dist-cjs/commands/ListOtaTaskExecutionsCommand.js +26 -0
- package/dist-cjs/commands/ListOtaTasksCommand.js +26 -0
- package/dist-cjs/commands/ListProvisioningProfilesCommand.js +26 -0
- package/dist-cjs/commands/ListSchemaVersionsCommand.js +26 -0
- package/dist-cjs/commands/PutDefaultEncryptionConfigurationCommand.js +26 -0
- package/dist-cjs/commands/PutHubConfigurationCommand.js +26 -0
- package/dist-cjs/commands/PutRuntimeLogConfigurationCommand.js +26 -0
- package/dist-cjs/commands/RegisterCustomEndpointCommand.js +26 -0
- package/dist-cjs/commands/ResetRuntimeLogConfigurationCommand.js +26 -0
- package/dist-cjs/commands/SendManagedThingCommandCommand.js +27 -0
- package/dist-cjs/commands/StartDeviceDiscoveryCommand.js +27 -0
- package/dist-cjs/commands/UpdateDestinationCommand.js +26 -0
- package/dist-cjs/commands/UpdateEventLogConfigurationCommand.js +26 -0
- package/dist-cjs/commands/UpdateManagedThingCommand.js +27 -0
- package/dist-cjs/commands/UpdateNotificationConfigurationCommand.js +26 -0
- package/dist-cjs/commands/UpdateOtaTaskCommand.js +26 -0
- package/dist-cjs/commands/index.js +60 -0
- package/dist-cjs/endpoint/EndpointParameters.js +16 -0
- package/dist-cjs/endpoint/endpointResolver.js +18 -0
- package/dist-cjs/endpoint/ruleset.js +7 -0
- package/dist-cjs/extensionConfiguration.js +2 -0
- package/dist-cjs/index.js +11 -0
- package/dist-cjs/models/IoTManagedIntegrationsServiceException.js +12 -0
- package/dist-cjs/models/index.js +4 -0
- package/dist-cjs/models/models_0.js +484 -0
- package/dist-cjs/pagination/Interfaces.js +2 -0
- package/dist-cjs/pagination/ListCredentialLockersPaginator.js +7 -0
- package/dist-cjs/pagination/ListDestinationsPaginator.js +7 -0
- package/dist-cjs/pagination/ListEventLogConfigurationsPaginator.js +7 -0
- package/dist-cjs/pagination/ListManagedThingSchemasPaginator.js +7 -0
- package/dist-cjs/pagination/ListManagedThingsPaginator.js +7 -0
- package/dist-cjs/pagination/ListNotificationConfigurationsPaginator.js +7 -0
- package/dist-cjs/pagination/ListOtaTaskConfigurationsPaginator.js +7 -0
- package/dist-cjs/pagination/ListOtaTaskExecutionsPaginator.js +7 -0
- package/dist-cjs/pagination/ListOtaTasksPaginator.js +7 -0
- package/dist-cjs/pagination/ListProvisioningProfilesPaginator.js +7 -0
- package/dist-cjs/pagination/ListSchemaVersionsPaginator.js +7 -0
- package/dist-cjs/pagination/index.js +15 -0
- package/dist-cjs/protocols/Aws_restJson1.js +2179 -0
- package/dist-cjs/runtimeConfig.browser.js +39 -0
- package/dist-cjs/runtimeConfig.js +52 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +34 -0
- package/dist-cjs/runtimeExtensions.js +25 -0
- package/dist-es/IoTManagedIntegrations.js +121 -0
- package/dist-es/IoTManagedIntegrationsClient.js +47 -0
- package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +41 -0
- package/dist-es/commands/CreateCredentialLockerCommand.js +23 -0
- package/dist-es/commands/CreateDestinationCommand.js +23 -0
- package/dist-es/commands/CreateEventLogConfigurationCommand.js +22 -0
- package/dist-es/commands/CreateManagedThingCommand.js +23 -0
- package/dist-es/commands/CreateNotificationConfigurationCommand.js +23 -0
- package/dist-es/commands/CreateOtaTaskCommand.js +23 -0
- package/dist-es/commands/CreateOtaTaskConfigurationCommand.js +23 -0
- package/dist-es/commands/CreateProvisioningProfileCommand.js +23 -0
- package/dist-es/commands/DeleteCredentialLockerCommand.js +22 -0
- package/dist-es/commands/DeleteDestinationCommand.js +22 -0
- package/dist-es/commands/DeleteEventLogConfigurationCommand.js +22 -0
- package/dist-es/commands/DeleteManagedThingCommand.js +22 -0
- package/dist-es/commands/DeleteNotificationConfigurationCommand.js +22 -0
- package/dist-es/commands/DeleteOtaTaskCommand.js +22 -0
- package/dist-es/commands/DeleteOtaTaskConfigurationCommand.js +22 -0
- package/dist-es/commands/DeleteProvisioningProfileCommand.js +22 -0
- package/dist-es/commands/GetCredentialLockerCommand.js +23 -0
- package/dist-es/commands/GetCustomEndpointCommand.js +22 -0
- package/dist-es/commands/GetDefaultEncryptionConfigurationCommand.js +22 -0
- package/dist-es/commands/GetDestinationCommand.js +23 -0
- package/dist-es/commands/GetDeviceDiscoveryCommand.js +23 -0
- package/dist-es/commands/GetEventLogConfigurationCommand.js +22 -0
- package/dist-es/commands/GetHubConfigurationCommand.js +22 -0
- package/dist-es/commands/GetManagedThingCapabilitiesCommand.js +22 -0
- package/dist-es/commands/GetManagedThingCommand.js +23 -0
- package/dist-es/commands/GetManagedThingConnectivityDataCommand.js +22 -0
- package/dist-es/commands/GetManagedThingMetaDataCommand.js +22 -0
- package/dist-es/commands/GetManagedThingStateCommand.js +23 -0
- package/dist-es/commands/GetNotificationConfigurationCommand.js +23 -0
- package/dist-es/commands/GetOtaTaskCommand.js +22 -0
- package/dist-es/commands/GetOtaTaskConfigurationCommand.js +23 -0
- package/dist-es/commands/GetProvisioningProfileCommand.js +23 -0
- package/dist-es/commands/GetRuntimeLogConfigurationCommand.js +22 -0
- package/dist-es/commands/GetSchemaVersionCommand.js +22 -0
- package/dist-es/commands/ListCredentialLockersCommand.js +23 -0
- package/dist-es/commands/ListDestinationsCommand.js +22 -0
- package/dist-es/commands/ListEventLogConfigurationsCommand.js +22 -0
- package/dist-es/commands/ListManagedThingSchemasCommand.js +22 -0
- package/dist-es/commands/ListManagedThingsCommand.js +23 -0
- package/dist-es/commands/ListNotificationConfigurationsCommand.js +22 -0
- package/dist-es/commands/ListOtaTaskConfigurationsCommand.js +23 -0
- package/dist-es/commands/ListOtaTaskExecutionsCommand.js +22 -0
- package/dist-es/commands/ListOtaTasksCommand.js +22 -0
- package/dist-es/commands/ListProvisioningProfilesCommand.js +22 -0
- package/dist-es/commands/ListSchemaVersionsCommand.js +22 -0
- package/dist-es/commands/PutDefaultEncryptionConfigurationCommand.js +22 -0
- package/dist-es/commands/PutHubConfigurationCommand.js +22 -0
- package/dist-es/commands/PutRuntimeLogConfigurationCommand.js +22 -0
- package/dist-es/commands/RegisterCustomEndpointCommand.js +22 -0
- package/dist-es/commands/ResetRuntimeLogConfigurationCommand.js +22 -0
- package/dist-es/commands/SendManagedThingCommandCommand.js +23 -0
- package/dist-es/commands/StartDeviceDiscoveryCommand.js +23 -0
- package/dist-es/commands/UpdateDestinationCommand.js +22 -0
- package/dist-es/commands/UpdateEventLogConfigurationCommand.js +22 -0
- package/dist-es/commands/UpdateManagedThingCommand.js +23 -0
- package/dist-es/commands/UpdateNotificationConfigurationCommand.js +22 -0
- package/dist-es/commands/UpdateOtaTaskCommand.js +22 -0
- package/dist-es/commands/index.js +57 -0
- package/dist-es/endpoint/EndpointParameters.js +12 -0
- package/dist-es/endpoint/endpointResolver.js +14 -0
- package/dist-es/endpoint/ruleset.js +4 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +6 -0
- package/dist-es/models/IoTManagedIntegrationsServiceException.js +8 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +439 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListCredentialLockersPaginator.js +4 -0
- package/dist-es/pagination/ListDestinationsPaginator.js +4 -0
- package/dist-es/pagination/ListEventLogConfigurationsPaginator.js +4 -0
- package/dist-es/pagination/ListManagedThingSchemasPaginator.js +4 -0
- package/dist-es/pagination/ListManagedThingsPaginator.js +4 -0
- package/dist-es/pagination/ListNotificationConfigurationsPaginator.js +4 -0
- package/dist-es/pagination/ListOtaTaskConfigurationsPaginator.js +4 -0
- package/dist-es/pagination/ListOtaTaskExecutionsPaginator.js +4 -0
- package/dist-es/pagination/ListOtaTasksPaginator.js +4 -0
- package/dist-es/pagination/ListProvisioningProfilesPaginator.js +4 -0
- package/dist-es/pagination/ListSchemaVersionsPaginator.js +4 -0
- package/dist-es/pagination/index.js +12 -0
- package/dist-es/protocols/Aws_restJson1.js +2060 -0
- package/dist-es/runtimeConfig.browser.js +34 -0
- package/dist-es/runtimeConfig.js +47 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +30 -0
- package/dist-es/runtimeExtensions.js +21 -0
- package/dist-types/IoTManagedIntegrations.d.ts +423 -0
- package/dist-types/IoTManagedIntegrationsClient.d.ts +244 -0
- package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +61 -0
- package/dist-types/commands/CreateCredentialLockerCommand.d.ts +100 -0
- package/dist-types/commands/CreateDestinationCommand.d.ts +96 -0
- package/dist-types/commands/CreateEventLogConfigurationCommand.d.ts +94 -0
- package/dist-types/commands/CreateManagedThingCommand.d.ts +144 -0
- package/dist-types/commands/CreateNotificationConfigurationCommand.d.ts +93 -0
- package/dist-types/commands/CreateOtaTaskCommand.d.ts +121 -0
- package/dist-types/commands/CreateOtaTaskConfigurationCommand.d.ts +115 -0
- package/dist-types/commands/CreateProvisioningProfileCommand.d.ts +106 -0
- package/dist-types/commands/DeleteCredentialLockerCommand.d.ts +92 -0
- package/dist-types/commands/DeleteDestinationCommand.d.ts +85 -0
- package/dist-types/commands/DeleteEventLogConfigurationCommand.d.ts +85 -0
- package/dist-types/commands/DeleteManagedThingCommand.d.ts +97 -0
- package/dist-types/commands/DeleteNotificationConfigurationCommand.d.ts +85 -0
- package/dist-types/commands/DeleteOtaTaskCommand.d.ts +85 -0
- package/dist-types/commands/DeleteOtaTaskConfigurationCommand.d.ts +85 -0
- package/dist-types/commands/DeleteProvisioningProfileCommand.d.ts +91 -0
- package/dist-types/commands/GetCredentialLockerCommand.d.ts +96 -0
- package/dist-types/commands/GetCustomEndpointCommand.d.ts +91 -0
- package/dist-types/commands/GetDefaultEncryptionConfigurationCommand.d.ts +100 -0
- package/dist-types/commands/GetDestinationCommand.d.ts +96 -0
- package/dist-types/commands/GetDeviceDiscoveryCommand.d.ts +103 -0
- package/dist-types/commands/GetEventLogConfigurationCommand.d.ts +90 -0
- package/dist-types/commands/GetHubConfigurationCommand.d.ts +89 -0
- package/dist-types/commands/GetManagedThingCapabilitiesCommand.d.ts +122 -0
- package/dist-types/commands/GetManagedThingCommand.d.ts +121 -0
- package/dist-types/commands/GetManagedThingConnectivityDataCommand.d.ts +96 -0
- package/dist-types/commands/GetManagedThingMetaDataCommand.d.ts +96 -0
- package/dist-types/commands/GetManagedThingStateCommand.d.ts +104 -0
- package/dist-types/commands/GetNotificationConfigurationCommand.d.ts +93 -0
- package/dist-types/commands/GetOtaTaskCommand.d.ts +133 -0
- package/dist-types/commands/GetOtaTaskConfigurationCommand.d.ts +116 -0
- package/dist-types/commands/GetProvisioningProfileCommand.d.ts +100 -0
- package/dist-types/commands/GetRuntimeLogConfigurationCommand.d.ts +98 -0
- package/dist-types/commands/GetSchemaVersionCommand.d.ts +101 -0
- package/dist-types/commands/ListCredentialLockersCommand.d.ts +96 -0
- package/dist-types/commands/ListDestinationsCommand.d.ts +94 -0
- package/dist-types/commands/ListEventLogConfigurationsCommand.d.ts +93 -0
- package/dist-types/commands/ListManagedThingSchemasCommand.d.ts +104 -0
- package/dist-types/commands/ListManagedThingsCommand.d.ts +120 -0
- package/dist-types/commands/ListNotificationConfigurationsCommand.d.ts +91 -0
- package/dist-types/commands/ListOtaTaskConfigurationsCommand.d.ts +92 -0
- package/dist-types/commands/ListOtaTaskExecutionsCommand.d.ts +99 -0
- package/dist-types/commands/ListOtaTasksCommand.d.ts +95 -0
- package/dist-types/commands/ListProvisioningProfilesCommand.d.ts +99 -0
- package/dist-types/commands/ListSchemaVersionsCommand.d.ts +106 -0
- package/dist-types/commands/PutDefaultEncryptionConfigurationCommand.d.ts +103 -0
- package/dist-types/commands/PutHubConfigurationCommand.d.ts +90 -0
- package/dist-types/commands/PutRuntimeLogConfigurationCommand.d.ts +96 -0
- package/dist-types/commands/RegisterCustomEndpointCommand.d.ts +92 -0
- package/dist-types/commands/ResetRuntimeLogConfigurationCommand.d.ts +86 -0
- package/dist-types/commands/SendManagedThingCommandCommand.d.ts +111 -0
- package/dist-types/commands/StartDeviceDiscoveryCommand.d.ts +107 -0
- package/dist-types/commands/UpdateDestinationCommand.d.ts +89 -0
- package/dist-types/commands/UpdateEventLogConfigurationCommand.d.ts +86 -0
- package/dist-types/commands/UpdateManagedThingCommand.d.ts +134 -0
- package/dist-types/commands/UpdateNotificationConfigurationCommand.d.ts +86 -0
- package/dist-types/commands/UpdateOtaTaskCommand.d.ts +87 -0
- package/dist-types/commands/index.d.ts +57 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +34 -0
- package/dist-types/endpoint/endpointResolver.d.ts +5 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/extensionConfiguration.d.ts +9 -0
- package/dist-types/index.d.ts +14 -0
- package/dist-types/models/IoTManagedIntegrationsServiceException.d.ts +14 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +3678 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListCredentialLockersPaginator.d.ts +7 -0
- package/dist-types/pagination/ListDestinationsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListEventLogConfigurationsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListManagedThingSchemasPaginator.d.ts +7 -0
- package/dist-types/pagination/ListManagedThingsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListNotificationConfigurationsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListOtaTaskConfigurationsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListOtaTaskExecutionsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListOtaTasksPaginator.d.ts +7 -0
- package/dist-types/pagination/ListProvisioningProfilesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListSchemaVersionsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +12 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +515 -0
- package/dist-types/runtimeConfig.browser.d.ts +49 -0
- package/dist-types/runtimeConfig.d.ts +49 -0
- package/dist-types/runtimeConfig.native.d.ts +48 -0
- package/dist-types/runtimeConfig.shared.d.ts +21 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/ts3.4/IoTManagedIntegrations.d.ts +1002 -0
- package/dist-types/ts3.4/IoTManagedIntegrationsClient.d.ts +464 -0
- package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
- package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +44 -0
- package/dist-types/ts3.4/commands/CreateCredentialLockerCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateDestinationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateEventLogConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateManagedThingCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateNotificationConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateOtaTaskCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/CreateOtaTaskConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateProvisioningProfileCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteCredentialLockerCommand.d.ts +46 -0
- package/dist-types/ts3.4/commands/DeleteDestinationCommand.d.ts +46 -0
- package/dist-types/ts3.4/commands/DeleteEventLogConfigurationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteManagedThingCommand.d.ts +46 -0
- package/dist-types/ts3.4/commands/DeleteNotificationConfigurationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteOtaTaskCommand.d.ts +45 -0
- package/dist-types/ts3.4/commands/DeleteOtaTaskConfigurationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteProvisioningProfileCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetCredentialLockerCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetCustomEndpointCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetDefaultEncryptionConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetDestinationCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetDeviceDiscoveryCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetEventLogConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetHubConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetManagedThingCapabilitiesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetManagedThingCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetManagedThingConnectivityDataCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetManagedThingMetaDataCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetManagedThingStateCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetNotificationConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetOtaTaskCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetOtaTaskConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetProvisioningProfileCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetRuntimeLogConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetSchemaVersionCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListCredentialLockersCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListDestinationsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListEventLogConfigurationsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListManagedThingSchemasCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListManagedThingsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListNotificationConfigurationsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListOtaTaskConfigurationsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListOtaTaskExecutionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListOtaTasksCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListProvisioningProfilesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListSchemaVersionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/PutDefaultEncryptionConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/PutHubConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/PutRuntimeLogConfigurationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/RegisterCustomEndpointCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ResetRuntimeLogConfigurationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/SendManagedThingCommandCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/StartDeviceDiscoveryCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateDestinationCommand.d.ts +46 -0
- package/dist-types/ts3.4/commands/UpdateEventLogConfigurationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UpdateManagedThingCommand.d.ts +46 -0
- package/dist-types/ts3.4/commands/UpdateNotificationConfigurationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UpdateOtaTaskCommand.d.ts +45 -0
- package/dist-types/ts3.4/commands/index.d.ts +57 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +45 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +9 -0
- package/dist-types/ts3.4/models/IoTManagedIntegrationsServiceException.d.ts +9 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +1080 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/ListCredentialLockersPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListDestinationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListEventLogConfigurationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListManagedThingSchemasPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListManagedThingsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListNotificationConfigurationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListOtaTaskConfigurationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListOtaTaskExecutionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListOtaTasksPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListProvisioningProfilesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListSchemaVersionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +12 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +689 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +98 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +99 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +102 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +23 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +13 -0
- package/package.json +101 -0
|
@@ -0,0 +1,3678 @@
|
|
|
1
|
+
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
|
+
import { DocumentType as __DocumentType } from "@smithy/types";
|
|
3
|
+
import { IoTManagedIntegrationsServiceException as __BaseException } from "./IoTManagedIntegrationsServiceException";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
* @enum
|
|
7
|
+
*/
|
|
8
|
+
export declare const AbortCriteriaAction: {
|
|
9
|
+
readonly CANCEL: "CANCEL";
|
|
10
|
+
};
|
|
11
|
+
/**
|
|
12
|
+
* @public
|
|
13
|
+
*/
|
|
14
|
+
export type AbortCriteriaAction = (typeof AbortCriteriaAction)[keyof typeof AbortCriteriaAction];
|
|
15
|
+
/**
|
|
16
|
+
* @public
|
|
17
|
+
* @enum
|
|
18
|
+
*/
|
|
19
|
+
export declare const AbortCriteriaFailureType: {
|
|
20
|
+
readonly ALL: "ALL";
|
|
21
|
+
readonly FAILED: "FAILED";
|
|
22
|
+
readonly REJECTED: "REJECTED";
|
|
23
|
+
readonly TIMED_OUT: "TIMED_OUT";
|
|
24
|
+
};
|
|
25
|
+
/**
|
|
26
|
+
* @public
|
|
27
|
+
*/
|
|
28
|
+
export type AbortCriteriaFailureType = (typeof AbortCriteriaFailureType)[keyof typeof AbortCriteriaFailureType];
|
|
29
|
+
/**
|
|
30
|
+
* <p>Structure representing one abort config criteria.</p>
|
|
31
|
+
* @public
|
|
32
|
+
*/
|
|
33
|
+
export interface AbortConfigCriteria {
|
|
34
|
+
/**
|
|
35
|
+
* <p>The action taken by the abort configuration.</p>
|
|
36
|
+
* @public
|
|
37
|
+
*/
|
|
38
|
+
Action?: AbortCriteriaAction | undefined;
|
|
39
|
+
/**
|
|
40
|
+
* <p>Over-the-air (OTA) task abort criteria failure type.</p>
|
|
41
|
+
* @public
|
|
42
|
+
*/
|
|
43
|
+
FailureType?: AbortCriteriaFailureType | undefined;
|
|
44
|
+
/**
|
|
45
|
+
* <p>The minimum number of things that must receive task execution notifications before the
|
|
46
|
+
* task can be aborted.</p>
|
|
47
|
+
* @public
|
|
48
|
+
*/
|
|
49
|
+
MinNumberOfExecutedThings?: number | undefined;
|
|
50
|
+
/**
|
|
51
|
+
* <p>The minimum percentage of over-the-air (OTA) task execution failures that must occur to
|
|
52
|
+
* initiate the last abort.</p>
|
|
53
|
+
* @public
|
|
54
|
+
*/
|
|
55
|
+
ThresholdPercentage?: number | undefined;
|
|
56
|
+
}
|
|
57
|
+
/**
|
|
58
|
+
* <p>User is not authorized.</p>
|
|
59
|
+
* @public
|
|
60
|
+
*/
|
|
61
|
+
export declare class AccessDeniedException extends __BaseException {
|
|
62
|
+
readonly name: "AccessDeniedException";
|
|
63
|
+
readonly $fault: "client";
|
|
64
|
+
Message?: string | undefined;
|
|
65
|
+
/**
|
|
66
|
+
* @internal
|
|
67
|
+
*/
|
|
68
|
+
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* @public
|
|
72
|
+
* @enum
|
|
73
|
+
*/
|
|
74
|
+
export declare const AuthMaterialType: {
|
|
75
|
+
readonly WIFI_SETUP_QR_BAR_CODE: "WIFI_SETUP_QR_BAR_CODE";
|
|
76
|
+
readonly ZIGBEE_QR_BAR_CODE: "ZIGBEE_QR_BAR_CODE";
|
|
77
|
+
readonly ZWAVE_QR_BAR_CODE: "ZWAVE_QR_BAR_CODE";
|
|
78
|
+
};
|
|
79
|
+
/**
|
|
80
|
+
* @public
|
|
81
|
+
*/
|
|
82
|
+
export type AuthMaterialType = (typeof AuthMaterialType)[keyof typeof AuthMaterialType];
|
|
83
|
+
/**
|
|
84
|
+
* <p>Action for an Amazon Web Services capability, containing the action parameters for control.</p>
|
|
85
|
+
* @public
|
|
86
|
+
*/
|
|
87
|
+
export interface CapabilityAction {
|
|
88
|
+
/**
|
|
89
|
+
* <p>Describe a capability action with a name.</p>
|
|
90
|
+
* @public
|
|
91
|
+
*/
|
|
92
|
+
name: string | undefined;
|
|
93
|
+
/**
|
|
94
|
+
* <p>Describe a capability action with an reference.</p>
|
|
95
|
+
* @public
|
|
96
|
+
*/
|
|
97
|
+
ref?: string | undefined;
|
|
98
|
+
/**
|
|
99
|
+
* <p>Describe a capability action with an <code>actionTraceId</code> for a response
|
|
100
|
+
* command.</p>
|
|
101
|
+
* @public
|
|
102
|
+
*/
|
|
103
|
+
actionTraceId?: string | undefined;
|
|
104
|
+
/**
|
|
105
|
+
* <p>Describe a capability action with a capability property.</p>
|
|
106
|
+
* @public
|
|
107
|
+
*/
|
|
108
|
+
parameters?: __DocumentType | undefined;
|
|
109
|
+
}
|
|
110
|
+
/**
|
|
111
|
+
* <p>The capability used in capability report.</p>
|
|
112
|
+
* @public
|
|
113
|
+
*/
|
|
114
|
+
export interface CapabilityReportCapability {
|
|
115
|
+
/**
|
|
116
|
+
* <p>The id of the schema version.</p>
|
|
117
|
+
* @public
|
|
118
|
+
*/
|
|
119
|
+
id: string | undefined;
|
|
120
|
+
/**
|
|
121
|
+
* <p>The name of the capability.</p>
|
|
122
|
+
* @public
|
|
123
|
+
*/
|
|
124
|
+
name: string | undefined;
|
|
125
|
+
/**
|
|
126
|
+
* <p>The version of the capability.</p>
|
|
127
|
+
* @public
|
|
128
|
+
*/
|
|
129
|
+
version: string | undefined;
|
|
130
|
+
/**
|
|
131
|
+
* <p>The capability properties used in the capability report.</p>
|
|
132
|
+
* @public
|
|
133
|
+
*/
|
|
134
|
+
properties: string[] | undefined;
|
|
135
|
+
/**
|
|
136
|
+
* <p>The capability actions used in the capability report.</p>
|
|
137
|
+
* @public
|
|
138
|
+
*/
|
|
139
|
+
actions: string[] | undefined;
|
|
140
|
+
/**
|
|
141
|
+
* <p>The capability events used in the capability report.</p>
|
|
142
|
+
* @public
|
|
143
|
+
*/
|
|
144
|
+
events: string[] | undefined;
|
|
145
|
+
}
|
|
146
|
+
/**
|
|
147
|
+
* <p>The endpoint used in the capability report.</p>
|
|
148
|
+
* @public
|
|
149
|
+
*/
|
|
150
|
+
export interface CapabilityReportEndpoint {
|
|
151
|
+
/**
|
|
152
|
+
* <p>The id of the endpoint used in the capability report.</p>
|
|
153
|
+
* @public
|
|
154
|
+
*/
|
|
155
|
+
id: string | undefined;
|
|
156
|
+
/**
|
|
157
|
+
* <p>The type of device.</p>
|
|
158
|
+
* @public
|
|
159
|
+
*/
|
|
160
|
+
deviceTypes: string[] | undefined;
|
|
161
|
+
/**
|
|
162
|
+
* <p>The capabilities used in the capability report.</p>
|
|
163
|
+
* @public
|
|
164
|
+
*/
|
|
165
|
+
capabilities: CapabilityReportCapability[] | undefined;
|
|
166
|
+
}
|
|
167
|
+
/**
|
|
168
|
+
* <p>Report of all capabilities supported by the device.</p>
|
|
169
|
+
* @public
|
|
170
|
+
*/
|
|
171
|
+
export interface CapabilityReport {
|
|
172
|
+
/**
|
|
173
|
+
* <p>The version of the capability report.</p>
|
|
174
|
+
* @public
|
|
175
|
+
*/
|
|
176
|
+
version: string | undefined;
|
|
177
|
+
/**
|
|
178
|
+
* <p>The numeric identifier of the node.</p>
|
|
179
|
+
* @public
|
|
180
|
+
*/
|
|
181
|
+
nodeId?: string | undefined;
|
|
182
|
+
/**
|
|
183
|
+
* <p>The endpoints used in the capability report.</p>
|
|
184
|
+
* @public
|
|
185
|
+
*/
|
|
186
|
+
endpoints: CapabilityReportEndpoint[] | undefined;
|
|
187
|
+
}
|
|
188
|
+
/**
|
|
189
|
+
* <p>The command capabilities added for the managed thing</p>
|
|
190
|
+
* @public
|
|
191
|
+
*/
|
|
192
|
+
export interface CommandCapability {
|
|
193
|
+
/**
|
|
194
|
+
* <p>Describe the capability with an id.</p>
|
|
195
|
+
* @public
|
|
196
|
+
*/
|
|
197
|
+
id: string | undefined;
|
|
198
|
+
/**
|
|
199
|
+
* <p>Describe the capability with an name.</p>
|
|
200
|
+
* @public
|
|
201
|
+
*/
|
|
202
|
+
name: string | undefined;
|
|
203
|
+
/**
|
|
204
|
+
* <p>Describe the capability with a version.</p>
|
|
205
|
+
* @public
|
|
206
|
+
*/
|
|
207
|
+
version: string | undefined;
|
|
208
|
+
/**
|
|
209
|
+
* <p>Describe the command capability with the actions it supports.</p>
|
|
210
|
+
* @public
|
|
211
|
+
*/
|
|
212
|
+
actions: CapabilityAction[] | undefined;
|
|
213
|
+
}
|
|
214
|
+
/**
|
|
215
|
+
* <p>The endpoint for a managed thing when sending a command.</p>
|
|
216
|
+
* @public
|
|
217
|
+
*/
|
|
218
|
+
export interface CommandEndpoint {
|
|
219
|
+
/**
|
|
220
|
+
* <p>The id of the endpoint for a managed thing.</p>
|
|
221
|
+
* @public
|
|
222
|
+
*/
|
|
223
|
+
endpointId: string | undefined;
|
|
224
|
+
/**
|
|
225
|
+
* <p>Describe the endpoint with an id, a name, and the relevant capabilities for sending
|
|
226
|
+
* commands.</p>
|
|
227
|
+
* @public
|
|
228
|
+
*/
|
|
229
|
+
capabilities: CommandCapability[] | undefined;
|
|
230
|
+
}
|
|
231
|
+
/**
|
|
232
|
+
* <p>Provides the default encryption configuration error update details.</p>
|
|
233
|
+
* @public
|
|
234
|
+
*/
|
|
235
|
+
export interface ConfigurationError {
|
|
236
|
+
/**
|
|
237
|
+
* <p>The error code returned when the default encryption configuration update fails.</p>
|
|
238
|
+
* @public
|
|
239
|
+
*/
|
|
240
|
+
code?: string | undefined;
|
|
241
|
+
/**
|
|
242
|
+
* <p>The error message returned when the default encryption configuration update
|
|
243
|
+
* fails.</p>
|
|
244
|
+
* @public
|
|
245
|
+
*/
|
|
246
|
+
message?: string | undefined;
|
|
247
|
+
}
|
|
248
|
+
/**
|
|
249
|
+
* @public
|
|
250
|
+
* @enum
|
|
251
|
+
*/
|
|
252
|
+
export declare const ConfigurationState: {
|
|
253
|
+
readonly ENABLED: "ENABLED";
|
|
254
|
+
readonly UPDATE_FAILED: "UPDATE_FAILED";
|
|
255
|
+
readonly UPDATE_IN_PROGRESS: "UPDATE_IN_PROGRESS";
|
|
256
|
+
};
|
|
257
|
+
/**
|
|
258
|
+
* @public
|
|
259
|
+
*/
|
|
260
|
+
export type ConfigurationState = (typeof ConfigurationState)[keyof typeof ConfigurationState];
|
|
261
|
+
/**
|
|
262
|
+
* <p>Provides the status of the default encryption configuration for an Amazon Web Services account.</p>
|
|
263
|
+
* @public
|
|
264
|
+
*/
|
|
265
|
+
export interface ConfigurationStatus {
|
|
266
|
+
/**
|
|
267
|
+
* <p>The error details describing a failed default encryption configuration update.</p>
|
|
268
|
+
* @public
|
|
269
|
+
*/
|
|
270
|
+
error?: ConfigurationError | undefined;
|
|
271
|
+
/**
|
|
272
|
+
* <p>The status state describing the default encryption configuration update.</p>
|
|
273
|
+
* @public
|
|
274
|
+
*/
|
|
275
|
+
state: ConfigurationState | undefined;
|
|
276
|
+
}
|
|
277
|
+
/**
|
|
278
|
+
* <p>There is a conflict with the request.</p>
|
|
279
|
+
* @public
|
|
280
|
+
*/
|
|
281
|
+
export declare class ConflictException extends __BaseException {
|
|
282
|
+
readonly name: "ConflictException";
|
|
283
|
+
readonly $fault: "client";
|
|
284
|
+
Message?: string | undefined;
|
|
285
|
+
/**
|
|
286
|
+
* @internal
|
|
287
|
+
*/
|
|
288
|
+
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
289
|
+
}
|
|
290
|
+
/**
|
|
291
|
+
* @public
|
|
292
|
+
*/
|
|
293
|
+
export interface CreateCredentialLockerRequest {
|
|
294
|
+
/**
|
|
295
|
+
* <p>The name of the credential locker.</p>
|
|
296
|
+
* @public
|
|
297
|
+
*/
|
|
298
|
+
Name?: string | undefined;
|
|
299
|
+
/**
|
|
300
|
+
* <p>An idempotency token. If you retry a request that completed successfully initially using
|
|
301
|
+
* the same client token and parameters, then the retry attempt will succeed without
|
|
302
|
+
* performing any further actions.</p>
|
|
303
|
+
* @public
|
|
304
|
+
*/
|
|
305
|
+
ClientToken?: string | undefined;
|
|
306
|
+
/**
|
|
307
|
+
* <p>A set of key/value pairs that are used to manage the credential locker.</p>
|
|
308
|
+
* @public
|
|
309
|
+
*/
|
|
310
|
+
Tags?: Record<string, string> | undefined;
|
|
311
|
+
}
|
|
312
|
+
/**
|
|
313
|
+
* @public
|
|
314
|
+
*/
|
|
315
|
+
export interface CreateCredentialLockerResponse {
|
|
316
|
+
/**
|
|
317
|
+
* <p>The identifier of the credential locker creation request.</p>
|
|
318
|
+
* @public
|
|
319
|
+
*/
|
|
320
|
+
Id?: string | undefined;
|
|
321
|
+
/**
|
|
322
|
+
* <p>The Amazon Resource Name (ARN) of the credential locker.</p>
|
|
323
|
+
* @public
|
|
324
|
+
*/
|
|
325
|
+
Arn?: string | undefined;
|
|
326
|
+
/**
|
|
327
|
+
* <p>The timestamp value of when the credential locker request occurred.</p>
|
|
328
|
+
* @public
|
|
329
|
+
*/
|
|
330
|
+
CreatedAt?: Date | undefined;
|
|
331
|
+
}
|
|
332
|
+
/**
|
|
333
|
+
* <p>Internal error from the service that indicates an unexpected error or that the service
|
|
334
|
+
* is unavailable.</p>
|
|
335
|
+
* @public
|
|
336
|
+
*/
|
|
337
|
+
export declare class InternalServerException extends __BaseException {
|
|
338
|
+
readonly name: "InternalServerException";
|
|
339
|
+
readonly $fault: "server";
|
|
340
|
+
Message?: string | undefined;
|
|
341
|
+
/**
|
|
342
|
+
* @internal
|
|
343
|
+
*/
|
|
344
|
+
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
345
|
+
}
|
|
346
|
+
/**
|
|
347
|
+
* <p>The service quota has been exceeded for this request.</p>
|
|
348
|
+
* @public
|
|
349
|
+
*/
|
|
350
|
+
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
351
|
+
readonly name: "ServiceQuotaExceededException";
|
|
352
|
+
readonly $fault: "client";
|
|
353
|
+
Message?: string | undefined;
|
|
354
|
+
/**
|
|
355
|
+
* @internal
|
|
356
|
+
*/
|
|
357
|
+
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
358
|
+
}
|
|
359
|
+
/**
|
|
360
|
+
* <p>The service is temporarily unavailable.</p>
|
|
361
|
+
* @public
|
|
362
|
+
*/
|
|
363
|
+
export declare class ServiceUnavailableException extends __BaseException {
|
|
364
|
+
readonly name: "ServiceUnavailableException";
|
|
365
|
+
readonly $fault: "server";
|
|
366
|
+
Message?: string | undefined;
|
|
367
|
+
/**
|
|
368
|
+
* @internal
|
|
369
|
+
*/
|
|
370
|
+
constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
|
|
371
|
+
}
|
|
372
|
+
/**
|
|
373
|
+
* <p>The rate exceeds the limit.</p>
|
|
374
|
+
* @public
|
|
375
|
+
*/
|
|
376
|
+
export declare class ThrottlingException extends __BaseException {
|
|
377
|
+
readonly name: "ThrottlingException";
|
|
378
|
+
readonly $fault: "client";
|
|
379
|
+
Message?: string | undefined;
|
|
380
|
+
/**
|
|
381
|
+
* @internal
|
|
382
|
+
*/
|
|
383
|
+
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
384
|
+
}
|
|
385
|
+
/**
|
|
386
|
+
* <p>A validation error occurred when performing the API request.</p>
|
|
387
|
+
* @public
|
|
388
|
+
*/
|
|
389
|
+
export declare class ValidationException extends __BaseException {
|
|
390
|
+
readonly name: "ValidationException";
|
|
391
|
+
readonly $fault: "client";
|
|
392
|
+
Message?: string | undefined;
|
|
393
|
+
/**
|
|
394
|
+
* @internal
|
|
395
|
+
*/
|
|
396
|
+
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
397
|
+
}
|
|
398
|
+
/**
|
|
399
|
+
* @public
|
|
400
|
+
* @enum
|
|
401
|
+
*/
|
|
402
|
+
export declare const DeliveryDestinationType: {
|
|
403
|
+
readonly KINESIS: "KINESIS";
|
|
404
|
+
};
|
|
405
|
+
/**
|
|
406
|
+
* @public
|
|
407
|
+
*/
|
|
408
|
+
export type DeliveryDestinationType = (typeof DeliveryDestinationType)[keyof typeof DeliveryDestinationType];
|
|
409
|
+
/**
|
|
410
|
+
* @public
|
|
411
|
+
*/
|
|
412
|
+
export interface CreateDestinationRequest {
|
|
413
|
+
/**
|
|
414
|
+
* <p>The Amazon Resource Name (ARN) of the customer-managed destination.</p>
|
|
415
|
+
* @public
|
|
416
|
+
*/
|
|
417
|
+
DeliveryDestinationArn: string | undefined;
|
|
418
|
+
/**
|
|
419
|
+
* <p>The destination type for the customer-managed destination.</p>
|
|
420
|
+
* @public
|
|
421
|
+
*/
|
|
422
|
+
DeliveryDestinationType: DeliveryDestinationType | undefined;
|
|
423
|
+
/**
|
|
424
|
+
* <p>The name of the customer-managed destination.</p>
|
|
425
|
+
* @public
|
|
426
|
+
*/
|
|
427
|
+
Name: string | undefined;
|
|
428
|
+
/**
|
|
429
|
+
* <p>The Amazon Resource Name (ARN) of the delivery destination role.</p>
|
|
430
|
+
* @public
|
|
431
|
+
*/
|
|
432
|
+
RoleArn: string | undefined;
|
|
433
|
+
/**
|
|
434
|
+
* <p>An idempotency token. If you retry a request that completed successfully initially using
|
|
435
|
+
* the same client token and parameters, then the retry attempt will succeed without
|
|
436
|
+
* performing any further actions.</p>
|
|
437
|
+
* @public
|
|
438
|
+
*/
|
|
439
|
+
ClientToken?: string | undefined;
|
|
440
|
+
/**
|
|
441
|
+
* <p>The description of the customer-managed destination.</p>
|
|
442
|
+
* @public
|
|
443
|
+
*/
|
|
444
|
+
Description?: string | undefined;
|
|
445
|
+
/**
|
|
446
|
+
* <p>A set of key/value pairs that are used to manage the destination.</p>
|
|
447
|
+
* @public
|
|
448
|
+
*/
|
|
449
|
+
Tags?: Record<string, string> | undefined;
|
|
450
|
+
}
|
|
451
|
+
/**
|
|
452
|
+
* @public
|
|
453
|
+
*/
|
|
454
|
+
export interface CreateDestinationResponse {
|
|
455
|
+
/**
|
|
456
|
+
* <p>The name of the customer-managed destination.</p>
|
|
457
|
+
* @public
|
|
458
|
+
*/
|
|
459
|
+
Name?: string | undefined;
|
|
460
|
+
}
|
|
461
|
+
/**
|
|
462
|
+
* @public
|
|
463
|
+
* @enum
|
|
464
|
+
*/
|
|
465
|
+
export declare const LogLevel: {
|
|
466
|
+
readonly DEBUG: "DEBUG";
|
|
467
|
+
readonly ERROR: "ERROR";
|
|
468
|
+
readonly INFO: "INFO";
|
|
469
|
+
readonly WARN: "WARN";
|
|
470
|
+
};
|
|
471
|
+
/**
|
|
472
|
+
* @public
|
|
473
|
+
*/
|
|
474
|
+
export type LogLevel = (typeof LogLevel)[keyof typeof LogLevel];
|
|
475
|
+
/**
|
|
476
|
+
* @public
|
|
477
|
+
*/
|
|
478
|
+
export interface CreateEventLogConfigurationRequest {
|
|
479
|
+
/**
|
|
480
|
+
* <p>The type of resource for the event log configuration.</p>
|
|
481
|
+
* @public
|
|
482
|
+
*/
|
|
483
|
+
ResourceType: string | undefined;
|
|
484
|
+
/**
|
|
485
|
+
* <p>The identifier of the resource for the event log configuration.</p>
|
|
486
|
+
* @public
|
|
487
|
+
*/
|
|
488
|
+
ResourceId?: string | undefined;
|
|
489
|
+
/**
|
|
490
|
+
* <p>The logging level for the event log configuration.</p>
|
|
491
|
+
* @public
|
|
492
|
+
*/
|
|
493
|
+
EventLogLevel: LogLevel | undefined;
|
|
494
|
+
/**
|
|
495
|
+
* <p>An idempotency token. If you retry a request that completed successfully initially using
|
|
496
|
+
* the same client token and parameters, then the retry attempt will succeed without
|
|
497
|
+
* performing any further actions.</p>
|
|
498
|
+
* @public
|
|
499
|
+
*/
|
|
500
|
+
ClientToken?: string | undefined;
|
|
501
|
+
}
|
|
502
|
+
/**
|
|
503
|
+
* @public
|
|
504
|
+
*/
|
|
505
|
+
export interface CreateEventLogConfigurationResponse {
|
|
506
|
+
/**
|
|
507
|
+
* <p>The identifier of the event log configuration request.</p>
|
|
508
|
+
* @public
|
|
509
|
+
*/
|
|
510
|
+
Id?: string | undefined;
|
|
511
|
+
}
|
|
512
|
+
/**
|
|
513
|
+
* @public
|
|
514
|
+
* @enum
|
|
515
|
+
*/
|
|
516
|
+
export declare const Role: {
|
|
517
|
+
readonly CONTROLLER: "CONTROLLER";
|
|
518
|
+
readonly DEVICE: "DEVICE";
|
|
519
|
+
};
|
|
520
|
+
/**
|
|
521
|
+
* @public
|
|
522
|
+
*/
|
|
523
|
+
export type Role = (typeof Role)[keyof typeof Role];
|
|
524
|
+
/**
|
|
525
|
+
* @public
|
|
526
|
+
*/
|
|
527
|
+
export interface CreateManagedThingRequest {
|
|
528
|
+
/**
|
|
529
|
+
* <p>The type of device used. This will be the hub controller, cloud device, or AWS IoT
|
|
530
|
+
* device.</p>
|
|
531
|
+
* @public
|
|
532
|
+
*/
|
|
533
|
+
Role: Role | undefined;
|
|
534
|
+
/**
|
|
535
|
+
* <p>Owner of the device, usually an indication of whom the device belongs to. This value
|
|
536
|
+
* should not contain personal identifiable information.</p>
|
|
537
|
+
* @public
|
|
538
|
+
*/
|
|
539
|
+
Owner?: string | undefined;
|
|
540
|
+
/**
|
|
541
|
+
* <p>The identifier of the credential for the managed thing.</p>
|
|
542
|
+
* @public
|
|
543
|
+
*/
|
|
544
|
+
CredentialLockerId?: string | undefined;
|
|
545
|
+
/**
|
|
546
|
+
* <p>The authentication material defining the device connectivity setup requests. The
|
|
547
|
+
* authentication materials used are the device bar code.</p>
|
|
548
|
+
* @public
|
|
549
|
+
*/
|
|
550
|
+
AuthenticationMaterial: string | undefined;
|
|
551
|
+
/**
|
|
552
|
+
* <p>The type of authentication material used for device connectivity setup requests.</p>
|
|
553
|
+
* @public
|
|
554
|
+
*/
|
|
555
|
+
AuthenticationMaterialType: AuthMaterialType | undefined;
|
|
556
|
+
/**
|
|
557
|
+
* <p>The serial number of the device.</p>
|
|
558
|
+
* @public
|
|
559
|
+
*/
|
|
560
|
+
SerialNumber?: string | undefined;
|
|
561
|
+
/**
|
|
562
|
+
* <p>The brand of the device.</p>
|
|
563
|
+
* @public
|
|
564
|
+
*/
|
|
565
|
+
Brand?: string | undefined;
|
|
566
|
+
/**
|
|
567
|
+
* <p>The model of the device.</p>
|
|
568
|
+
* @public
|
|
569
|
+
*/
|
|
570
|
+
Model?: string | undefined;
|
|
571
|
+
/**
|
|
572
|
+
* <p>The name of the managed thing representing the physical device.</p>
|
|
573
|
+
* @public
|
|
574
|
+
*/
|
|
575
|
+
Name?: string | undefined;
|
|
576
|
+
/**
|
|
577
|
+
* <p>A report of the capabilities for the managed thing.</p>
|
|
578
|
+
* @public
|
|
579
|
+
*/
|
|
580
|
+
CapabilityReport?: CapabilityReport | undefined;
|
|
581
|
+
/**
|
|
582
|
+
* <p>The capabilities of the device such as light bulb.</p>
|
|
583
|
+
* @public
|
|
584
|
+
*/
|
|
585
|
+
Capabilities?: string | undefined;
|
|
586
|
+
/**
|
|
587
|
+
* <p>An idempotency token. If you retry a request that completed successfully initially using
|
|
588
|
+
* the same client token and parameters, then the retry attempt will succeed without
|
|
589
|
+
* performing any further actions.</p>
|
|
590
|
+
* @public
|
|
591
|
+
*/
|
|
592
|
+
ClientToken?: string | undefined;
|
|
593
|
+
/**
|
|
594
|
+
* <p>The classification of the managed thing such as light bulb or thermostat.</p>
|
|
595
|
+
* @public
|
|
596
|
+
*/
|
|
597
|
+
Classification?: string | undefined;
|
|
598
|
+
/**
|
|
599
|
+
* <p>A set of key/value pairs that are used to manage the managed thing.</p>
|
|
600
|
+
* @public
|
|
601
|
+
*/
|
|
602
|
+
Tags?: Record<string, string> | undefined;
|
|
603
|
+
/**
|
|
604
|
+
* <p>The metadata for the managed thing.</p>
|
|
605
|
+
* @public
|
|
606
|
+
*/
|
|
607
|
+
MetaData?: Record<string, string> | undefined;
|
|
608
|
+
}
|
|
609
|
+
/**
|
|
610
|
+
* @public
|
|
611
|
+
*/
|
|
612
|
+
export interface CreateManagedThingResponse {
|
|
613
|
+
/**
|
|
614
|
+
* <p>The id of the managed thing.</p>
|
|
615
|
+
* @public
|
|
616
|
+
*/
|
|
617
|
+
Id?: string | undefined;
|
|
618
|
+
/**
|
|
619
|
+
* <p>The Amazon Resource Name (ARN) of the managed thing.</p>
|
|
620
|
+
* @public
|
|
621
|
+
*/
|
|
622
|
+
Arn?: string | undefined;
|
|
623
|
+
/**
|
|
624
|
+
* <p>The timestamp value of when the device creation request occurred.</p>
|
|
625
|
+
* @public
|
|
626
|
+
*/
|
|
627
|
+
CreatedAt?: Date | undefined;
|
|
628
|
+
}
|
|
629
|
+
/**
|
|
630
|
+
* <p>The specified resource does not exist.</p>
|
|
631
|
+
* @public
|
|
632
|
+
*/
|
|
633
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
634
|
+
readonly name: "ResourceNotFoundException";
|
|
635
|
+
readonly $fault: "client";
|
|
636
|
+
Message?: string | undefined;
|
|
637
|
+
/**
|
|
638
|
+
* @internal
|
|
639
|
+
*/
|
|
640
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
641
|
+
}
|
|
642
|
+
/**
|
|
643
|
+
* <p>You are not authorized to perform this operation.</p>
|
|
644
|
+
* @public
|
|
645
|
+
*/
|
|
646
|
+
export declare class UnauthorizedException extends __BaseException {
|
|
647
|
+
readonly name: "UnauthorizedException";
|
|
648
|
+
readonly $fault: "client";
|
|
649
|
+
Message?: string | undefined;
|
|
650
|
+
/**
|
|
651
|
+
* @internal
|
|
652
|
+
*/
|
|
653
|
+
constructor(opts: __ExceptionOptionType<UnauthorizedException, __BaseException>);
|
|
654
|
+
}
|
|
655
|
+
/**
|
|
656
|
+
* @public
|
|
657
|
+
* @enum
|
|
658
|
+
*/
|
|
659
|
+
export declare const EventType: {
|
|
660
|
+
readonly CONNECTOR_ASSOCIATION: "CONNECTOR_ASSOCIATION";
|
|
661
|
+
readonly CONNECTOR_ERROR_REPORT: "CONNECTOR_ERROR_REPORT";
|
|
662
|
+
readonly DEVICE_COMMAND: "DEVICE_COMMAND";
|
|
663
|
+
readonly DEVICE_COMMAND_REQUEST: "DEVICE_COMMAND_REQUEST";
|
|
664
|
+
readonly DEVICE_EVENT: "DEVICE_EVENT";
|
|
665
|
+
readonly DEVICE_LIFE_CYCLE: "DEVICE_LIFE_CYCLE";
|
|
666
|
+
readonly DEVICE_OTA: "DEVICE_OTA";
|
|
667
|
+
readonly DEVICE_STATE: "DEVICE_STATE";
|
|
668
|
+
};
|
|
669
|
+
/**
|
|
670
|
+
* @public
|
|
671
|
+
*/
|
|
672
|
+
export type EventType = (typeof EventType)[keyof typeof EventType];
|
|
673
|
+
/**
|
|
674
|
+
* @public
|
|
675
|
+
*/
|
|
676
|
+
export interface CreateNotificationConfigurationRequest {
|
|
677
|
+
/**
|
|
678
|
+
* <p>The type of event triggering a device notification to the customer-managed
|
|
679
|
+
* destination.</p>
|
|
680
|
+
* @public
|
|
681
|
+
*/
|
|
682
|
+
EventType: EventType | undefined;
|
|
683
|
+
/**
|
|
684
|
+
* <p>The name of the destination for the notification configuration.</p>
|
|
685
|
+
* @public
|
|
686
|
+
*/
|
|
687
|
+
DestinationName: string | undefined;
|
|
688
|
+
/**
|
|
689
|
+
* <p>An idempotency token. If you retry a request that completed successfully initially using
|
|
690
|
+
* the same client token and parameters, then the retry attempt will succeed without
|
|
691
|
+
* performing any further actions.</p>
|
|
692
|
+
* @public
|
|
693
|
+
*/
|
|
694
|
+
ClientToken?: string | undefined;
|
|
695
|
+
/**
|
|
696
|
+
* <p>A set of key/value pairs that are used to manage the notification configuration.</p>
|
|
697
|
+
* @public
|
|
698
|
+
*/
|
|
699
|
+
Tags?: Record<string, string> | undefined;
|
|
700
|
+
}
|
|
701
|
+
/**
|
|
702
|
+
* @public
|
|
703
|
+
*/
|
|
704
|
+
export interface CreateNotificationConfigurationResponse {
|
|
705
|
+
/**
|
|
706
|
+
* <p>The type of event triggering a device notification to the customer-managed
|
|
707
|
+
* destination.</p>
|
|
708
|
+
* @public
|
|
709
|
+
*/
|
|
710
|
+
EventType?: EventType | undefined;
|
|
711
|
+
}
|
|
712
|
+
/**
|
|
713
|
+
* @public
|
|
714
|
+
* @enum
|
|
715
|
+
*/
|
|
716
|
+
export declare const OtaMechanism: {
|
|
717
|
+
readonly PUSH: "PUSH";
|
|
718
|
+
};
|
|
719
|
+
/**
|
|
720
|
+
* @public
|
|
721
|
+
*/
|
|
722
|
+
export type OtaMechanism = (typeof OtaMechanism)[keyof typeof OtaMechanism];
|
|
723
|
+
/**
|
|
724
|
+
* @public
|
|
725
|
+
* @enum
|
|
726
|
+
*/
|
|
727
|
+
export declare const SchedulingConfigEndBehavior: {
|
|
728
|
+
readonly CANCEL: "CANCEL";
|
|
729
|
+
readonly FORCE_CANCEL: "FORCE_CANCEL";
|
|
730
|
+
readonly STOP_ROLLOUT: "STOP_ROLLOUT";
|
|
731
|
+
};
|
|
732
|
+
/**
|
|
733
|
+
* @public
|
|
734
|
+
*/
|
|
735
|
+
export type SchedulingConfigEndBehavior = (typeof SchedulingConfigEndBehavior)[keyof typeof SchedulingConfigEndBehavior];
|
|
736
|
+
/**
|
|
737
|
+
* <p>Structure representing scheduling maintenance window.</p>
|
|
738
|
+
* @public
|
|
739
|
+
*/
|
|
740
|
+
export interface ScheduleMaintenanceWindow {
|
|
741
|
+
/**
|
|
742
|
+
* <p>Displays the duration of the next maintenance window.</p>
|
|
743
|
+
* @public
|
|
744
|
+
*/
|
|
745
|
+
DurationInMinutes?: number | undefined;
|
|
746
|
+
/**
|
|
747
|
+
* <p>Displays the start time of the next maintenance window.</p>
|
|
748
|
+
* @public
|
|
749
|
+
*/
|
|
750
|
+
StartTime?: string | undefined;
|
|
751
|
+
}
|
|
752
|
+
/**
|
|
753
|
+
* <p>Over-the-air (OTA) task scheduling config.</p>
|
|
754
|
+
* @public
|
|
755
|
+
*/
|
|
756
|
+
export interface OtaTaskSchedulingConfig {
|
|
757
|
+
/**
|
|
758
|
+
* <p>Specifies the end behavior for all task executions after a task reaches the selected
|
|
759
|
+
* <code>endTime</code>. If <code>endTime</code> is not selected when creating the task,
|
|
760
|
+
* then <code>endBehavior</code> does not apply.</p>
|
|
761
|
+
* @public
|
|
762
|
+
*/
|
|
763
|
+
EndBehavior?: SchedulingConfigEndBehavior | undefined;
|
|
764
|
+
/**
|
|
765
|
+
* <p>The time an over-the-air (OTA) task will stop.</p>
|
|
766
|
+
* @public
|
|
767
|
+
*/
|
|
768
|
+
EndTime?: string | undefined;
|
|
769
|
+
/**
|
|
770
|
+
* <p>Maintenance window list for over-the-air (OTA) task scheduling config.</p>
|
|
771
|
+
* @public
|
|
772
|
+
*/
|
|
773
|
+
MaintenanceWindows?: ScheduleMaintenanceWindow[] | undefined;
|
|
774
|
+
/**
|
|
775
|
+
* <p>The time an over-the-air (OTA) task will start.</p>
|
|
776
|
+
* @public
|
|
777
|
+
*/
|
|
778
|
+
StartTime?: string | undefined;
|
|
779
|
+
}
|
|
780
|
+
/**
|
|
781
|
+
* @public
|
|
782
|
+
* @enum
|
|
783
|
+
*/
|
|
784
|
+
export declare const RetryCriteriaFailureType: {
|
|
785
|
+
readonly ALL: "ALL";
|
|
786
|
+
readonly FAILED: "FAILED";
|
|
787
|
+
readonly TIMED_OUT: "TIMED_OUT";
|
|
788
|
+
};
|
|
789
|
+
/**
|
|
790
|
+
* @public
|
|
791
|
+
*/
|
|
792
|
+
export type RetryCriteriaFailureType = (typeof RetryCriteriaFailureType)[keyof typeof RetryCriteriaFailureType];
|
|
793
|
+
/**
|
|
794
|
+
* <p>Structure representing one retry config criteria.</p>
|
|
795
|
+
* @public
|
|
796
|
+
*/
|
|
797
|
+
export interface RetryConfigCriteria {
|
|
798
|
+
/**
|
|
799
|
+
* <p>Over-the-air (OTA) retry criteria failure type.</p>
|
|
800
|
+
* @public
|
|
801
|
+
*/
|
|
802
|
+
FailureType?: RetryCriteriaFailureType | undefined;
|
|
803
|
+
/**
|
|
804
|
+
* <p>The number of retries allowed for a failure type for the over-the-air (OTA) task.</p>
|
|
805
|
+
* @public
|
|
806
|
+
*/
|
|
807
|
+
MinNumberOfRetries?: number | undefined;
|
|
808
|
+
}
|
|
809
|
+
/**
|
|
810
|
+
* <p>Over-the-air (OTA) task retry config.</p>
|
|
811
|
+
* @public
|
|
812
|
+
*/
|
|
813
|
+
export interface OtaTaskExecutionRetryConfig {
|
|
814
|
+
/**
|
|
815
|
+
* <p>The list of retry config criteria.</p>
|
|
816
|
+
* @public
|
|
817
|
+
*/
|
|
818
|
+
RetryConfigCriteria?: RetryConfigCriteria[] | undefined;
|
|
819
|
+
}
|
|
820
|
+
/**
|
|
821
|
+
* @public
|
|
822
|
+
* @enum
|
|
823
|
+
*/
|
|
824
|
+
export declare const OtaType: {
|
|
825
|
+
readonly CONTINUOUS: "CONTINUOUS";
|
|
826
|
+
readonly ONE_TIME: "ONE_TIME";
|
|
827
|
+
};
|
|
828
|
+
/**
|
|
829
|
+
* @public
|
|
830
|
+
*/
|
|
831
|
+
export type OtaType = (typeof OtaType)[keyof typeof OtaType];
|
|
832
|
+
/**
|
|
833
|
+
* @public
|
|
834
|
+
* @enum
|
|
835
|
+
*/
|
|
836
|
+
export declare const OtaProtocol: {
|
|
837
|
+
readonly HTTP: "HTTP";
|
|
838
|
+
};
|
|
839
|
+
/**
|
|
840
|
+
* @public
|
|
841
|
+
*/
|
|
842
|
+
export type OtaProtocol = (typeof OtaProtocol)[keyof typeof OtaProtocol];
|
|
843
|
+
/**
|
|
844
|
+
* @public
|
|
845
|
+
*/
|
|
846
|
+
export interface CreateOtaTaskRequest {
|
|
847
|
+
/**
|
|
848
|
+
* <p>The description of the over-the-air (OTA) task.</p>
|
|
849
|
+
* @public
|
|
850
|
+
*/
|
|
851
|
+
Description?: string | undefined;
|
|
852
|
+
/**
|
|
853
|
+
* <p>The URL to the Amazon S3 bucket where the over-the-air (OTA) task is stored.</p>
|
|
854
|
+
* @public
|
|
855
|
+
*/
|
|
856
|
+
S3Url: string | undefined;
|
|
857
|
+
/**
|
|
858
|
+
* <p>The connection protocol the over-the-air (OTA) task uses to update the device.</p>
|
|
859
|
+
* @public
|
|
860
|
+
*/
|
|
861
|
+
Protocol?: OtaProtocol | undefined;
|
|
862
|
+
/**
|
|
863
|
+
* <p>The device targeted for the over-the-air (OTA) task.</p>
|
|
864
|
+
* @public
|
|
865
|
+
*/
|
|
866
|
+
Target?: string[] | undefined;
|
|
867
|
+
/**
|
|
868
|
+
* <p>The identifier for the over-the-air (OTA) task configuration.</p>
|
|
869
|
+
* @public
|
|
870
|
+
*/
|
|
871
|
+
TaskConfigurationId?: string | undefined;
|
|
872
|
+
/**
|
|
873
|
+
* <p>The deployment mechanism for the over-the-air (OTA) task.</p>
|
|
874
|
+
* @public
|
|
875
|
+
*/
|
|
876
|
+
OtaMechanism?: OtaMechanism | undefined;
|
|
877
|
+
/**
|
|
878
|
+
* <p>The frequency type for the over-the-air (OTA) task.</p>
|
|
879
|
+
* @public
|
|
880
|
+
*/
|
|
881
|
+
OtaType: OtaType | undefined;
|
|
882
|
+
/**
|
|
883
|
+
* <p>The query string to add things to the thing group.</p>
|
|
884
|
+
* @public
|
|
885
|
+
*/
|
|
886
|
+
OtaTargetQueryString?: string | undefined;
|
|
887
|
+
/**
|
|
888
|
+
* <p>An idempotency token. If you retry a request that completed successfully initially using
|
|
889
|
+
* the same client token and parameters, then the retry attempt will succeed without
|
|
890
|
+
* performing any further actions.</p>
|
|
891
|
+
* @public
|
|
892
|
+
*/
|
|
893
|
+
ClientToken?: string | undefined;
|
|
894
|
+
/**
|
|
895
|
+
* <p>Over-the-air (OTA) task scheduling config.</p>
|
|
896
|
+
* @public
|
|
897
|
+
*/
|
|
898
|
+
OtaSchedulingConfig?: OtaTaskSchedulingConfig | undefined;
|
|
899
|
+
/**
|
|
900
|
+
* <p>Over-the-air (OTA) task retry config.</p>
|
|
901
|
+
* @public
|
|
902
|
+
*/
|
|
903
|
+
OtaTaskExecutionRetryConfig?: OtaTaskExecutionRetryConfig | undefined;
|
|
904
|
+
/**
|
|
905
|
+
* <p>A set of key/value pairs that are used to manage the over-the-air (OTA) task.</p>
|
|
906
|
+
* @public
|
|
907
|
+
*/
|
|
908
|
+
Tags?: Record<string, string> | undefined;
|
|
909
|
+
}
|
|
910
|
+
/**
|
|
911
|
+
* @public
|
|
912
|
+
*/
|
|
913
|
+
export interface CreateOtaTaskResponse {
|
|
914
|
+
/**
|
|
915
|
+
* <p>The identifier of the over-the-air (OTA) task.</p>
|
|
916
|
+
* @public
|
|
917
|
+
*/
|
|
918
|
+
TaskId?: string | undefined;
|
|
919
|
+
/**
|
|
920
|
+
* <p>The Amazon Resource Name (ARN) of the over-the-air (OTA) task.</p>
|
|
921
|
+
* @public
|
|
922
|
+
*/
|
|
923
|
+
TaskArn?: string | undefined;
|
|
924
|
+
/**
|
|
925
|
+
* <p>A description of the over-the-air (OTA) task.</p>
|
|
926
|
+
* @public
|
|
927
|
+
*/
|
|
928
|
+
Description?: string | undefined;
|
|
929
|
+
}
|
|
930
|
+
/**
|
|
931
|
+
* <p>Over-the-air (OTA) task abort config.</p>
|
|
932
|
+
* @public
|
|
933
|
+
*/
|
|
934
|
+
export interface OtaTaskAbortConfig {
|
|
935
|
+
/**
|
|
936
|
+
* <p>The list of criteria for the abort config.</p>
|
|
937
|
+
* @public
|
|
938
|
+
*/
|
|
939
|
+
AbortConfigCriteriaList?: AbortConfigCriteria[] | undefined;
|
|
940
|
+
}
|
|
941
|
+
/**
|
|
942
|
+
* <p>Structure representing rollout config criteria.</p>
|
|
943
|
+
* @public
|
|
944
|
+
*/
|
|
945
|
+
export interface RolloutRateIncreaseCriteria {
|
|
946
|
+
/**
|
|
947
|
+
* <p>The threshold for number of notified things that will initiate the increase in rate of
|
|
948
|
+
* rollout.</p>
|
|
949
|
+
* @public
|
|
950
|
+
*/
|
|
951
|
+
numberOfNotifiedThings?: number | undefined;
|
|
952
|
+
/**
|
|
953
|
+
* <p>The threshold for number of succeeded things that will initiate the increase in rate of
|
|
954
|
+
* rollout.</p>
|
|
955
|
+
* @public
|
|
956
|
+
*/
|
|
957
|
+
numberOfSucceededThings?: number | undefined;
|
|
958
|
+
}
|
|
959
|
+
/**
|
|
960
|
+
* <p>Structure representing exponential rate of rollout for an over-the-air (OTA)
|
|
961
|
+
* task.</p>
|
|
962
|
+
* @public
|
|
963
|
+
*/
|
|
964
|
+
export interface ExponentialRolloutRate {
|
|
965
|
+
/**
|
|
966
|
+
* <p>The base rate per minute for the rollout of an over-the-air (OTA) task.</p>
|
|
967
|
+
* @public
|
|
968
|
+
*/
|
|
969
|
+
BaseRatePerMinute?: number | undefined;
|
|
970
|
+
/**
|
|
971
|
+
* <p>The incremental factor for increasing the rollout rate of an over-the-air (OTA)
|
|
972
|
+
* task.</p>
|
|
973
|
+
* @public
|
|
974
|
+
*/
|
|
975
|
+
IncrementFactor?: number | undefined;
|
|
976
|
+
/**
|
|
977
|
+
* <p>The criteria for increasing the rollout rate of an over-the-air (OTA) task.</p>
|
|
978
|
+
* @public
|
|
979
|
+
*/
|
|
980
|
+
RateIncreaseCriteria?: RolloutRateIncreaseCriteria | undefined;
|
|
981
|
+
}
|
|
982
|
+
/**
|
|
983
|
+
* <p>Over-the-air (OTA) task rollout config.</p>
|
|
984
|
+
* @public
|
|
985
|
+
*/
|
|
986
|
+
export interface OtaTaskExecutionRolloutConfig {
|
|
987
|
+
/**
|
|
988
|
+
* <p>Structure representing exponential rate of rollout for an over-the-air (OTA)
|
|
989
|
+
* task.</p>
|
|
990
|
+
* @public
|
|
991
|
+
*/
|
|
992
|
+
ExponentialRolloutRate?: ExponentialRolloutRate | undefined;
|
|
993
|
+
/**
|
|
994
|
+
* <p>The maximum number of things that will be notified of a pending task, per minute.</p>
|
|
995
|
+
* @public
|
|
996
|
+
*/
|
|
997
|
+
MaximumPerMinute?: number | undefined;
|
|
998
|
+
}
|
|
999
|
+
/**
|
|
1000
|
+
* <p>Over-the-air (OTA) task timeout config.</p>
|
|
1001
|
+
* @public
|
|
1002
|
+
*/
|
|
1003
|
+
export interface OtaTaskTimeoutConfig {
|
|
1004
|
+
/**
|
|
1005
|
+
* <p>Specifies the amount of time the device has to finish execution of this task. The
|
|
1006
|
+
* timeout interval can be anywhere between 1 minute and 7 days.</p>
|
|
1007
|
+
* @public
|
|
1008
|
+
*/
|
|
1009
|
+
InProgressTimeoutInMinutes?: number | undefined;
|
|
1010
|
+
}
|
|
1011
|
+
/**
|
|
1012
|
+
* <p>Structure representing a push config.</p>
|
|
1013
|
+
* @public
|
|
1014
|
+
*/
|
|
1015
|
+
export interface PushConfig {
|
|
1016
|
+
/**
|
|
1017
|
+
* <p>Structure representing one abort config.</p>
|
|
1018
|
+
* @public
|
|
1019
|
+
*/
|
|
1020
|
+
AbortConfig?: OtaTaskAbortConfig | undefined;
|
|
1021
|
+
/**
|
|
1022
|
+
* <p>Structure representing one rollout config.</p>
|
|
1023
|
+
* @public
|
|
1024
|
+
*/
|
|
1025
|
+
RolloutConfig?: OtaTaskExecutionRolloutConfig | undefined;
|
|
1026
|
+
/**
|
|
1027
|
+
* <p>Structure representing one timeout config.</p>
|
|
1028
|
+
* @public
|
|
1029
|
+
*/
|
|
1030
|
+
TimeoutConfig?: OtaTaskTimeoutConfig | undefined;
|
|
1031
|
+
}
|
|
1032
|
+
/**
|
|
1033
|
+
* @public
|
|
1034
|
+
*/
|
|
1035
|
+
export interface CreateOtaTaskConfigurationRequest {
|
|
1036
|
+
/**
|
|
1037
|
+
* <p>A description of the over-the-air (OTA) task configuration.</p>
|
|
1038
|
+
* @public
|
|
1039
|
+
*/
|
|
1040
|
+
Description?: string | undefined;
|
|
1041
|
+
/**
|
|
1042
|
+
* <p>The name of the over-the-air (OTA) task.</p>
|
|
1043
|
+
* @public
|
|
1044
|
+
*/
|
|
1045
|
+
Name?: string | undefined;
|
|
1046
|
+
/**
|
|
1047
|
+
* <p>Describes the type of configuration used for the over-the-air (OTA) task.</p>
|
|
1048
|
+
* @public
|
|
1049
|
+
*/
|
|
1050
|
+
PushConfig?: PushConfig | undefined;
|
|
1051
|
+
/**
|
|
1052
|
+
* <p>An idempotency token. If you retry a request that completed successfully initially using
|
|
1053
|
+
* the same client token and parameters, then the retry attempt will succeed without
|
|
1054
|
+
* performing any further actions.</p>
|
|
1055
|
+
* @public
|
|
1056
|
+
*/
|
|
1057
|
+
ClientToken?: string | undefined;
|
|
1058
|
+
}
|
|
1059
|
+
/**
|
|
1060
|
+
* @public
|
|
1061
|
+
*/
|
|
1062
|
+
export interface CreateOtaTaskConfigurationResponse {
|
|
1063
|
+
/**
|
|
1064
|
+
* <p>The identifier of the over-the-air (OTA) task configuration.</p>
|
|
1065
|
+
* @public
|
|
1066
|
+
*/
|
|
1067
|
+
TaskConfigurationId?: string | undefined;
|
|
1068
|
+
}
|
|
1069
|
+
/**
|
|
1070
|
+
* @public
|
|
1071
|
+
* @enum
|
|
1072
|
+
*/
|
|
1073
|
+
export declare const ProvisioningType: {
|
|
1074
|
+
readonly FLEET_PROVISIONING: "FLEET_PROVISIONING";
|
|
1075
|
+
readonly JITR: "JITR";
|
|
1076
|
+
};
|
|
1077
|
+
/**
|
|
1078
|
+
* @public
|
|
1079
|
+
*/
|
|
1080
|
+
export type ProvisioningType = (typeof ProvisioningType)[keyof typeof ProvisioningType];
|
|
1081
|
+
/**
|
|
1082
|
+
* @public
|
|
1083
|
+
*/
|
|
1084
|
+
export interface CreateProvisioningProfileRequest {
|
|
1085
|
+
/**
|
|
1086
|
+
* <p>The type of provisioning workflow the device uses for onboarding to IoT managed integrations.</p>
|
|
1087
|
+
* @public
|
|
1088
|
+
*/
|
|
1089
|
+
ProvisioningType: ProvisioningType | undefined;
|
|
1090
|
+
/**
|
|
1091
|
+
* <p>The id of the certificate authority (CA) certificate.</p>
|
|
1092
|
+
* @public
|
|
1093
|
+
*/
|
|
1094
|
+
CaCertificate?: string | undefined;
|
|
1095
|
+
/**
|
|
1096
|
+
* <p>The name of the provisioning template.</p>
|
|
1097
|
+
* @public
|
|
1098
|
+
*/
|
|
1099
|
+
Name?: string | undefined;
|
|
1100
|
+
/**
|
|
1101
|
+
* <p>An idempotency token. If you retry a request that completed successfully initially using
|
|
1102
|
+
* the same client token and parameters, then the retry attempt will succeed without
|
|
1103
|
+
* performing any further actions.</p>
|
|
1104
|
+
* @public
|
|
1105
|
+
*/
|
|
1106
|
+
ClientToken?: string | undefined;
|
|
1107
|
+
/**
|
|
1108
|
+
* <p>A set of key/value pairs that are used to manage the provisioning profile.</p>
|
|
1109
|
+
* @public
|
|
1110
|
+
*/
|
|
1111
|
+
Tags?: Record<string, string> | undefined;
|
|
1112
|
+
}
|
|
1113
|
+
/**
|
|
1114
|
+
* @public
|
|
1115
|
+
*/
|
|
1116
|
+
export interface CreateProvisioningProfileResponse {
|
|
1117
|
+
/**
|
|
1118
|
+
* <p>The Amazon Resource Name (ARN) of the provisioning template used in the provisioning
|
|
1119
|
+
* profile.</p>
|
|
1120
|
+
* @public
|
|
1121
|
+
*/
|
|
1122
|
+
Arn?: string | undefined;
|
|
1123
|
+
/**
|
|
1124
|
+
* <p>The name of the provisioning template.</p>
|
|
1125
|
+
* @public
|
|
1126
|
+
*/
|
|
1127
|
+
Name?: string | undefined;
|
|
1128
|
+
/**
|
|
1129
|
+
* <p>The type of provisioning workflow the device uses for onboarding to IoT managed integrations.</p>
|
|
1130
|
+
* @public
|
|
1131
|
+
*/
|
|
1132
|
+
ProvisioningType?: ProvisioningType | undefined;
|
|
1133
|
+
/**
|
|
1134
|
+
* <p>The identifier of the provisioning profile.</p>
|
|
1135
|
+
* @public
|
|
1136
|
+
*/
|
|
1137
|
+
Id?: string | undefined;
|
|
1138
|
+
/**
|
|
1139
|
+
* <p>The id of the claim certificate.</p>
|
|
1140
|
+
* @public
|
|
1141
|
+
*/
|
|
1142
|
+
ClaimCertificate?: string | undefined;
|
|
1143
|
+
/**
|
|
1144
|
+
* <p>The private key of the claim certificate. This is stored securely on the device for
|
|
1145
|
+
* validating the connection endpoint with IoT managed integrations using the public key.</p>
|
|
1146
|
+
* @public
|
|
1147
|
+
*/
|
|
1148
|
+
ClaimCertificatePrivateKey?: string | undefined;
|
|
1149
|
+
}
|
|
1150
|
+
/**
|
|
1151
|
+
* <p>Structure describing one Credential Locker.</p>
|
|
1152
|
+
* @public
|
|
1153
|
+
*/
|
|
1154
|
+
export interface CredentialLockerSummary {
|
|
1155
|
+
/**
|
|
1156
|
+
* <p>The id of the credential locker.</p>
|
|
1157
|
+
* @public
|
|
1158
|
+
*/
|
|
1159
|
+
Id?: string | undefined;
|
|
1160
|
+
/**
|
|
1161
|
+
* <p>The Amazon Resource Name (ARN) of the credential locker.</p>
|
|
1162
|
+
* @public
|
|
1163
|
+
*/
|
|
1164
|
+
Arn?: string | undefined;
|
|
1165
|
+
/**
|
|
1166
|
+
* <p>The name of the credential locker.</p>
|
|
1167
|
+
* @public
|
|
1168
|
+
*/
|
|
1169
|
+
Name?: string | undefined;
|
|
1170
|
+
/**
|
|
1171
|
+
* <p>The timestampe value of when the credential locker was created at.</p>
|
|
1172
|
+
* @public
|
|
1173
|
+
*/
|
|
1174
|
+
CreatedAt?: Date | undefined;
|
|
1175
|
+
}
|
|
1176
|
+
/**
|
|
1177
|
+
* @public
|
|
1178
|
+
*/
|
|
1179
|
+
export interface DeleteCredentialLockerRequest {
|
|
1180
|
+
/**
|
|
1181
|
+
* <p>The identifier of the credential locker.</p>
|
|
1182
|
+
* @public
|
|
1183
|
+
*/
|
|
1184
|
+
Identifier: string | undefined;
|
|
1185
|
+
}
|
|
1186
|
+
/**
|
|
1187
|
+
* @public
|
|
1188
|
+
*/
|
|
1189
|
+
export interface GetCredentialLockerRequest {
|
|
1190
|
+
/**
|
|
1191
|
+
* <p>The identifier of the credential locker.</p>
|
|
1192
|
+
* @public
|
|
1193
|
+
*/
|
|
1194
|
+
Identifier: string | undefined;
|
|
1195
|
+
}
|
|
1196
|
+
/**
|
|
1197
|
+
* @public
|
|
1198
|
+
*/
|
|
1199
|
+
export interface GetCredentialLockerResponse {
|
|
1200
|
+
/**
|
|
1201
|
+
* <p>The identifier of the credential locker.</p>
|
|
1202
|
+
* @public
|
|
1203
|
+
*/
|
|
1204
|
+
Id?: string | undefined;
|
|
1205
|
+
/**
|
|
1206
|
+
* <p>The Amazon Resource Name (ARN) of the credential locker.</p>
|
|
1207
|
+
* @public
|
|
1208
|
+
*/
|
|
1209
|
+
Arn?: string | undefined;
|
|
1210
|
+
/**
|
|
1211
|
+
* <p>The name of the credential locker.</p>
|
|
1212
|
+
* @public
|
|
1213
|
+
*/
|
|
1214
|
+
Name?: string | undefined;
|
|
1215
|
+
/**
|
|
1216
|
+
* <p>The timestamp value of when the credential locker requset occurred.</p>
|
|
1217
|
+
* @public
|
|
1218
|
+
*/
|
|
1219
|
+
CreatedAt?: Date | undefined;
|
|
1220
|
+
/**
|
|
1221
|
+
* <p>A set of key/value pairs that are used to manage the credential locker.</p>
|
|
1222
|
+
* @public
|
|
1223
|
+
*/
|
|
1224
|
+
Tags?: Record<string, string> | undefined;
|
|
1225
|
+
}
|
|
1226
|
+
/**
|
|
1227
|
+
* @public
|
|
1228
|
+
*/
|
|
1229
|
+
export interface ListCredentialLockersRequest {
|
|
1230
|
+
/**
|
|
1231
|
+
* <p>A token that can be used to retrieve the next set of results.</p>
|
|
1232
|
+
* @public
|
|
1233
|
+
*/
|
|
1234
|
+
NextToken?: string | undefined;
|
|
1235
|
+
/**
|
|
1236
|
+
* <p>The maximum number of results to return at one time.</p>
|
|
1237
|
+
* @public
|
|
1238
|
+
*/
|
|
1239
|
+
MaxResults?: number | undefined;
|
|
1240
|
+
}
|
|
1241
|
+
/**
|
|
1242
|
+
* @public
|
|
1243
|
+
*/
|
|
1244
|
+
export interface ListCredentialLockersResponse {
|
|
1245
|
+
/**
|
|
1246
|
+
* <p>The list of credential lockers.</p>
|
|
1247
|
+
* @public
|
|
1248
|
+
*/
|
|
1249
|
+
Items?: CredentialLockerSummary[] | undefined;
|
|
1250
|
+
/**
|
|
1251
|
+
* <p>A token that can be used to retrieve the next set of results.</p>
|
|
1252
|
+
* @public
|
|
1253
|
+
*/
|
|
1254
|
+
NextToken?: string | undefined;
|
|
1255
|
+
}
|
|
1256
|
+
/**
|
|
1257
|
+
* @public
|
|
1258
|
+
*/
|
|
1259
|
+
export interface DeleteDestinationRequest {
|
|
1260
|
+
/**
|
|
1261
|
+
* <p>The id of the customer-managed destination.</p>
|
|
1262
|
+
* @public
|
|
1263
|
+
*/
|
|
1264
|
+
Name: string | undefined;
|
|
1265
|
+
}
|
|
1266
|
+
/**
|
|
1267
|
+
* @public
|
|
1268
|
+
*/
|
|
1269
|
+
export interface DeleteEventLogConfigurationRequest {
|
|
1270
|
+
/**
|
|
1271
|
+
* <p>The identifier of the event log configuration.</p>
|
|
1272
|
+
* @public
|
|
1273
|
+
*/
|
|
1274
|
+
Id: string | undefined;
|
|
1275
|
+
}
|
|
1276
|
+
/**
|
|
1277
|
+
* @public
|
|
1278
|
+
*/
|
|
1279
|
+
export interface DeleteManagedThingRequest {
|
|
1280
|
+
/**
|
|
1281
|
+
* <p>The id of the managed thing.</p>
|
|
1282
|
+
* @public
|
|
1283
|
+
*/
|
|
1284
|
+
Identifier: string | undefined;
|
|
1285
|
+
/**
|
|
1286
|
+
* <p>When set to <code>TRUE</code>, a forceful deteletion of the managed thing will occur.
|
|
1287
|
+
* When set to <code>FALSE</code>, a non-forceful deletion of the managed thing will
|
|
1288
|
+
* occur.</p>
|
|
1289
|
+
* @public
|
|
1290
|
+
*/
|
|
1291
|
+
Force?: boolean | undefined;
|
|
1292
|
+
}
|
|
1293
|
+
/**
|
|
1294
|
+
* @public
|
|
1295
|
+
*/
|
|
1296
|
+
export interface DeleteNotificationConfigurationRequest {
|
|
1297
|
+
/**
|
|
1298
|
+
* <p>The type of event triggering a device notification to the customer-managed
|
|
1299
|
+
* destination.</p>
|
|
1300
|
+
* @public
|
|
1301
|
+
*/
|
|
1302
|
+
EventType: EventType | undefined;
|
|
1303
|
+
}
|
|
1304
|
+
/**
|
|
1305
|
+
* @public
|
|
1306
|
+
*/
|
|
1307
|
+
export interface DeleteOtaTaskRequest {
|
|
1308
|
+
/**
|
|
1309
|
+
* <p>The identifier of the over-the-air (OTA) task.</p>
|
|
1310
|
+
* @public
|
|
1311
|
+
*/
|
|
1312
|
+
Identifier: string | undefined;
|
|
1313
|
+
}
|
|
1314
|
+
/**
|
|
1315
|
+
* @public
|
|
1316
|
+
*/
|
|
1317
|
+
export interface DeleteOtaTaskConfigurationRequest {
|
|
1318
|
+
/**
|
|
1319
|
+
* <p>The identifier of the over-the-air (OTA) task configuration.</p>
|
|
1320
|
+
* @public
|
|
1321
|
+
*/
|
|
1322
|
+
Identifier: string | undefined;
|
|
1323
|
+
}
|
|
1324
|
+
/**
|
|
1325
|
+
* @public
|
|
1326
|
+
*/
|
|
1327
|
+
export interface DeleteProvisioningProfileRequest {
|
|
1328
|
+
/**
|
|
1329
|
+
* <p>The name of the provisioning template.</p>
|
|
1330
|
+
* @public
|
|
1331
|
+
*/
|
|
1332
|
+
Identifier: string | undefined;
|
|
1333
|
+
}
|
|
1334
|
+
/**
|
|
1335
|
+
* <p>Structure describing a destination for IoT managed integrations to deliver notifications for a
|
|
1336
|
+
* device.</p>
|
|
1337
|
+
* @public
|
|
1338
|
+
*/
|
|
1339
|
+
export interface DestinationSummary {
|
|
1340
|
+
/**
|
|
1341
|
+
* <p>The description of the customer-managed destination.</p>
|
|
1342
|
+
* @public
|
|
1343
|
+
*/
|
|
1344
|
+
Description?: string | undefined;
|
|
1345
|
+
/**
|
|
1346
|
+
* <p>The Amazon Resource Name (ARN) of the customer-managed destination.</p>
|
|
1347
|
+
* @public
|
|
1348
|
+
*/
|
|
1349
|
+
DeliveryDestinationArn?: string | undefined;
|
|
1350
|
+
/**
|
|
1351
|
+
* <p>The destination type for the customer-managed destination.</p>
|
|
1352
|
+
* @public
|
|
1353
|
+
*/
|
|
1354
|
+
DeliveryDestinationType?: DeliveryDestinationType | undefined;
|
|
1355
|
+
/**
|
|
1356
|
+
* <p>The name of the customer-managed destination.</p>
|
|
1357
|
+
* @public
|
|
1358
|
+
*/
|
|
1359
|
+
Name?: string | undefined;
|
|
1360
|
+
/**
|
|
1361
|
+
* <p>The Amazon Resource Name (ARN) of the delivery destination.</p>
|
|
1362
|
+
* @public
|
|
1363
|
+
*/
|
|
1364
|
+
RoleArn?: string | undefined;
|
|
1365
|
+
}
|
|
1366
|
+
/**
|
|
1367
|
+
* @public
|
|
1368
|
+
*/
|
|
1369
|
+
export interface GetDestinationRequest {
|
|
1370
|
+
/**
|
|
1371
|
+
* <p>The name of the customer-managed destination.</p>
|
|
1372
|
+
* @public
|
|
1373
|
+
*/
|
|
1374
|
+
Name: string | undefined;
|
|
1375
|
+
}
|
|
1376
|
+
/**
|
|
1377
|
+
* @public
|
|
1378
|
+
*/
|
|
1379
|
+
export interface GetDestinationResponse {
|
|
1380
|
+
/**
|
|
1381
|
+
* <p>The description of the customer-managed destination.</p>
|
|
1382
|
+
* @public
|
|
1383
|
+
*/
|
|
1384
|
+
Description?: string | undefined;
|
|
1385
|
+
/**
|
|
1386
|
+
* <p>The Amazon Resource Name (ARN) of the customer-managed destination.</p>
|
|
1387
|
+
* @public
|
|
1388
|
+
*/
|
|
1389
|
+
DeliveryDestinationArn?: string | undefined;
|
|
1390
|
+
/**
|
|
1391
|
+
* <p>The destination type for the customer-managed destination.</p>
|
|
1392
|
+
* @public
|
|
1393
|
+
*/
|
|
1394
|
+
DeliveryDestinationType?: DeliveryDestinationType | undefined;
|
|
1395
|
+
/**
|
|
1396
|
+
* <p>The name of the customer-managed destination.</p>
|
|
1397
|
+
* @public
|
|
1398
|
+
*/
|
|
1399
|
+
Name?: string | undefined;
|
|
1400
|
+
/**
|
|
1401
|
+
* <p>The Amazon Resource Name (ARN) of the delivery destination role.</p>
|
|
1402
|
+
* @public
|
|
1403
|
+
*/
|
|
1404
|
+
RoleArn?: string | undefined;
|
|
1405
|
+
/**
|
|
1406
|
+
* <p>The timestamp value of when the destination creation requset occurred.</p>
|
|
1407
|
+
* @public
|
|
1408
|
+
*/
|
|
1409
|
+
CreatedAt?: Date | undefined;
|
|
1410
|
+
/**
|
|
1411
|
+
* <p>The timestamp value of when the destination update requset occurred.</p>
|
|
1412
|
+
* @public
|
|
1413
|
+
*/
|
|
1414
|
+
UpdatedAt?: Date | undefined;
|
|
1415
|
+
/**
|
|
1416
|
+
* <p>A set of key/value pairs that are used to manage the customer-managed
|
|
1417
|
+
* destination.</p>
|
|
1418
|
+
* @public
|
|
1419
|
+
*/
|
|
1420
|
+
Tags?: Record<string, string> | undefined;
|
|
1421
|
+
}
|
|
1422
|
+
/**
|
|
1423
|
+
* @public
|
|
1424
|
+
*/
|
|
1425
|
+
export interface ListDestinationsRequest {
|
|
1426
|
+
/**
|
|
1427
|
+
* <p>A token that can be used to retrieve the next set of results.</p>
|
|
1428
|
+
* @public
|
|
1429
|
+
*/
|
|
1430
|
+
NextToken?: string | undefined;
|
|
1431
|
+
/**
|
|
1432
|
+
* <p>The maximum number of results to return at one time.</p>
|
|
1433
|
+
* @public
|
|
1434
|
+
*/
|
|
1435
|
+
MaxResults?: number | undefined;
|
|
1436
|
+
}
|
|
1437
|
+
/**
|
|
1438
|
+
* @public
|
|
1439
|
+
*/
|
|
1440
|
+
export interface ListDestinationsResponse {
|
|
1441
|
+
/**
|
|
1442
|
+
* <p>The list of destinations.</p>
|
|
1443
|
+
* @public
|
|
1444
|
+
*/
|
|
1445
|
+
DestinationList?: DestinationSummary[] | undefined;
|
|
1446
|
+
/**
|
|
1447
|
+
* <p>A token that can be used to retrieve the next set of results.</p>
|
|
1448
|
+
* @public
|
|
1449
|
+
*/
|
|
1450
|
+
NextToken?: string | undefined;
|
|
1451
|
+
}
|
|
1452
|
+
/**
|
|
1453
|
+
* @public
|
|
1454
|
+
*/
|
|
1455
|
+
export interface UpdateDestinationRequest {
|
|
1456
|
+
/**
|
|
1457
|
+
* <p>The name of the customer-managed destination.</p>
|
|
1458
|
+
* @public
|
|
1459
|
+
*/
|
|
1460
|
+
Name: string | undefined;
|
|
1461
|
+
/**
|
|
1462
|
+
* <p>The Amazon Resource Name (ARN) of the customer-managed destination.</p>
|
|
1463
|
+
* @public
|
|
1464
|
+
*/
|
|
1465
|
+
DeliveryDestinationArn?: string | undefined;
|
|
1466
|
+
/**
|
|
1467
|
+
* <p>The destination type for the customer-managed destination.</p>
|
|
1468
|
+
* @public
|
|
1469
|
+
*/
|
|
1470
|
+
DeliveryDestinationType?: DeliveryDestinationType | undefined;
|
|
1471
|
+
/**
|
|
1472
|
+
* <p>The Amazon Resource Name (ARN) of the delivery destination role.</p>
|
|
1473
|
+
* @public
|
|
1474
|
+
*/
|
|
1475
|
+
RoleArn?: string | undefined;
|
|
1476
|
+
/**
|
|
1477
|
+
* <p>The description of the customer-managed destination.</p>
|
|
1478
|
+
* @public
|
|
1479
|
+
*/
|
|
1480
|
+
Description?: string | undefined;
|
|
1481
|
+
}
|
|
1482
|
+
/**
|
|
1483
|
+
* @public
|
|
1484
|
+
*/
|
|
1485
|
+
export interface GetDeviceDiscoveryRequest {
|
|
1486
|
+
/**
|
|
1487
|
+
* <p>The id of the device discovery job request.</p>
|
|
1488
|
+
* @public
|
|
1489
|
+
*/
|
|
1490
|
+
Identifier: string | undefined;
|
|
1491
|
+
}
|
|
1492
|
+
/**
|
|
1493
|
+
* @public
|
|
1494
|
+
* @enum
|
|
1495
|
+
*/
|
|
1496
|
+
export declare const DiscoveryType: {
|
|
1497
|
+
readonly CLOUD: "CLOUD";
|
|
1498
|
+
readonly ZIGBEE: "ZIGBEE";
|
|
1499
|
+
readonly ZWAVE: "ZWAVE";
|
|
1500
|
+
};
|
|
1501
|
+
/**
|
|
1502
|
+
* @public
|
|
1503
|
+
*/
|
|
1504
|
+
export type DiscoveryType = (typeof DiscoveryType)[keyof typeof DiscoveryType];
|
|
1505
|
+
/**
|
|
1506
|
+
* @public
|
|
1507
|
+
* @enum
|
|
1508
|
+
*/
|
|
1509
|
+
export declare const DeviceDiscoveryStatus: {
|
|
1510
|
+
readonly FAILED: "FAILED";
|
|
1511
|
+
readonly RUNNING: "RUNNING";
|
|
1512
|
+
readonly SUCCEEDED: "SUCCEEDED";
|
|
1513
|
+
readonly TIMED_OUT: "TIMED_OUT";
|
|
1514
|
+
};
|
|
1515
|
+
/**
|
|
1516
|
+
* @public
|
|
1517
|
+
*/
|
|
1518
|
+
export type DeviceDiscoveryStatus = (typeof DeviceDiscoveryStatus)[keyof typeof DeviceDiscoveryStatus];
|
|
1519
|
+
/**
|
|
1520
|
+
* @public
|
|
1521
|
+
*/
|
|
1522
|
+
export interface GetDeviceDiscoveryResponse {
|
|
1523
|
+
/**
|
|
1524
|
+
* <p>The id of the device discovery job request.</p>
|
|
1525
|
+
* @public
|
|
1526
|
+
*/
|
|
1527
|
+
Id: string | undefined;
|
|
1528
|
+
/**
|
|
1529
|
+
* <p>The Amazon Resource Name (ARN) of the device discovery job request.</p>
|
|
1530
|
+
* @public
|
|
1531
|
+
*/
|
|
1532
|
+
Arn: string | undefined;
|
|
1533
|
+
/**
|
|
1534
|
+
* <p>The discovery type supporting the type of device to be discovered in the device
|
|
1535
|
+
* discovery job request.</p>
|
|
1536
|
+
* @public
|
|
1537
|
+
*/
|
|
1538
|
+
DiscoveryType: DiscoveryType | undefined;
|
|
1539
|
+
/**
|
|
1540
|
+
* <p>The status of the device discovery job request.</p>
|
|
1541
|
+
* @public
|
|
1542
|
+
*/
|
|
1543
|
+
Status: DeviceDiscoveryStatus | undefined;
|
|
1544
|
+
/**
|
|
1545
|
+
* <p>The timestamp value for the start time of the device discovery.</p>
|
|
1546
|
+
* @public
|
|
1547
|
+
*/
|
|
1548
|
+
StartedAt: Date | undefined;
|
|
1549
|
+
/**
|
|
1550
|
+
* <p>The id of the end-user's IoT hub.</p>
|
|
1551
|
+
* @public
|
|
1552
|
+
*/
|
|
1553
|
+
ControllerId?: string | undefined;
|
|
1554
|
+
/**
|
|
1555
|
+
* <p>The ID tracking the current discovery process for one connector association.</p>
|
|
1556
|
+
* @public
|
|
1557
|
+
*/
|
|
1558
|
+
ConnectorAssociationId?: string | undefined;
|
|
1559
|
+
/**
|
|
1560
|
+
* <p>The timestamp value for the completion time of the device discovery.</p>
|
|
1561
|
+
* @public
|
|
1562
|
+
*/
|
|
1563
|
+
FinishedAt?: Date | undefined;
|
|
1564
|
+
/**
|
|
1565
|
+
* <p>A set of key/value pairs that are used to manage the device discovery request.</p>
|
|
1566
|
+
* @public
|
|
1567
|
+
*/
|
|
1568
|
+
Tags?: Record<string, string> | undefined;
|
|
1569
|
+
}
|
|
1570
|
+
/**
|
|
1571
|
+
* @public
|
|
1572
|
+
* @enum
|
|
1573
|
+
*/
|
|
1574
|
+
export declare const DiscoveryAuthMaterialType: {
|
|
1575
|
+
readonly ZWAVE_INSTALL_CODE: "ZWAVE_INSTALL_CODE";
|
|
1576
|
+
};
|
|
1577
|
+
/**
|
|
1578
|
+
* @public
|
|
1579
|
+
*/
|
|
1580
|
+
export type DiscoveryAuthMaterialType = (typeof DiscoveryAuthMaterialType)[keyof typeof DiscoveryAuthMaterialType];
|
|
1581
|
+
/**
|
|
1582
|
+
* @public
|
|
1583
|
+
*/
|
|
1584
|
+
export interface StartDeviceDiscoveryRequest {
|
|
1585
|
+
/**
|
|
1586
|
+
* <p>The discovery type supporting the type of device to be discovered in the device
|
|
1587
|
+
* discovery job request.</p>
|
|
1588
|
+
* @public
|
|
1589
|
+
*/
|
|
1590
|
+
DiscoveryType: DiscoveryType | undefined;
|
|
1591
|
+
/**
|
|
1592
|
+
* <p>The id of the end-user's IoT hub.</p>
|
|
1593
|
+
* @public
|
|
1594
|
+
*/
|
|
1595
|
+
ControllerIdentifier?: string | undefined;
|
|
1596
|
+
/**
|
|
1597
|
+
* <p>The id of the connector association.</p>
|
|
1598
|
+
* @public
|
|
1599
|
+
*/
|
|
1600
|
+
ConnectorAssociationIdentifier?: string | undefined;
|
|
1601
|
+
/**
|
|
1602
|
+
* <p>The authentication material required to start the local device discovery job
|
|
1603
|
+
* request.</p>
|
|
1604
|
+
* @public
|
|
1605
|
+
*/
|
|
1606
|
+
AuthenticationMaterial?: string | undefined;
|
|
1607
|
+
/**
|
|
1608
|
+
* <p>The type of authentication material used for device discovery jobs.</p>
|
|
1609
|
+
* @public
|
|
1610
|
+
*/
|
|
1611
|
+
AuthenticationMaterialType?: DiscoveryAuthMaterialType | undefined;
|
|
1612
|
+
/**
|
|
1613
|
+
* <p>An idempotency token. If you retry a request that completed successfully initially using
|
|
1614
|
+
* the same client token and parameters, then the retry attempt will succeed without
|
|
1615
|
+
* performing any further actions.</p>
|
|
1616
|
+
* @public
|
|
1617
|
+
*/
|
|
1618
|
+
ClientToken?: string | undefined;
|
|
1619
|
+
/**
|
|
1620
|
+
* <p>A set of key/value pairs that are used to manage the device discovery request.</p>
|
|
1621
|
+
* @public
|
|
1622
|
+
*/
|
|
1623
|
+
Tags?: Record<string, string> | undefined;
|
|
1624
|
+
}
|
|
1625
|
+
/**
|
|
1626
|
+
* @public
|
|
1627
|
+
*/
|
|
1628
|
+
export interface StartDeviceDiscoveryResponse {
|
|
1629
|
+
/**
|
|
1630
|
+
* <p>The id of the device discovery job request.</p>
|
|
1631
|
+
* @public
|
|
1632
|
+
*/
|
|
1633
|
+
Id?: string | undefined;
|
|
1634
|
+
/**
|
|
1635
|
+
* <p>The timestamp value for the start time of the device discovery.</p>
|
|
1636
|
+
* @public
|
|
1637
|
+
*/
|
|
1638
|
+
StartedAt?: Date | undefined;
|
|
1639
|
+
}
|
|
1640
|
+
/**
|
|
1641
|
+
* @public
|
|
1642
|
+
* @enum
|
|
1643
|
+
*/
|
|
1644
|
+
export declare const DisconnectReasonValue: {
|
|
1645
|
+
readonly AUTH_ERROR: "AUTH_ERROR";
|
|
1646
|
+
readonly CLIENT_ERROR: "CLIENT_ERROR";
|
|
1647
|
+
readonly CLIENT_INITIATED_DISCONNECT: "CLIENT_INITIATED_DISCONNECT";
|
|
1648
|
+
readonly CONNECTION_LOST: "CONNECTION_LOST";
|
|
1649
|
+
readonly CUSTOMAUTH_TTL_EXPIRATION: "CUSTOMAUTH_TTL_EXPIRATION";
|
|
1650
|
+
readonly DUPLICATE_CLIENTID: "DUPLICATE_CLIENTID";
|
|
1651
|
+
readonly FORBIDDEN_ACCESS: "FORBIDDEN_ACCESS";
|
|
1652
|
+
readonly MQTT_KEEP_ALIVE_TIMEOUT: "MQTT_KEEP_ALIVE_TIMEOUT";
|
|
1653
|
+
readonly NONE: "NONE";
|
|
1654
|
+
readonly SERVER_ERROR: "SERVER_ERROR";
|
|
1655
|
+
readonly SERVER_INITIATED_DISCONNECT: "SERVER_INITIATED_DISCONNECT";
|
|
1656
|
+
readonly THROTTLED: "THROTTLED";
|
|
1657
|
+
readonly UNKNOWN: "UNKNOWN";
|
|
1658
|
+
readonly WEBSOCKET_TTL_EXPIRATION: "WEBSOCKET_TTL_EXPIRATION";
|
|
1659
|
+
};
|
|
1660
|
+
/**
|
|
1661
|
+
* @public
|
|
1662
|
+
*/
|
|
1663
|
+
export type DisconnectReasonValue = (typeof DisconnectReasonValue)[keyof typeof DisconnectReasonValue];
|
|
1664
|
+
/**
|
|
1665
|
+
* @public
|
|
1666
|
+
* @enum
|
|
1667
|
+
*/
|
|
1668
|
+
export declare const EncryptionType: {
|
|
1669
|
+
readonly CUSTOMER_KEY_ENCRYPTION: "CUSTOMER_KEY_ENCRYPTION";
|
|
1670
|
+
readonly MANAGED_INTEGRATIONS_DEFAULT_ENCRYPTION: "MANAGED_INTEGRATIONS_DEFAULT_ENCRYPTION";
|
|
1671
|
+
};
|
|
1672
|
+
/**
|
|
1673
|
+
* @public
|
|
1674
|
+
*/
|
|
1675
|
+
export type EncryptionType = (typeof EncryptionType)[keyof typeof EncryptionType];
|
|
1676
|
+
/**
|
|
1677
|
+
* <p>List of event log configurations.</p>
|
|
1678
|
+
* @public
|
|
1679
|
+
*/
|
|
1680
|
+
export interface EventLogConfigurationSummary {
|
|
1681
|
+
/**
|
|
1682
|
+
* <p>The identifier of the event log configuration.</p>
|
|
1683
|
+
* @public
|
|
1684
|
+
*/
|
|
1685
|
+
Id?: string | undefined;
|
|
1686
|
+
/**
|
|
1687
|
+
* <p>The type of resource for the event log configuration.</p>
|
|
1688
|
+
* @public
|
|
1689
|
+
*/
|
|
1690
|
+
ResourceType?: string | undefined;
|
|
1691
|
+
/**
|
|
1692
|
+
* <p>The identifier of the resource for the event log configuration.</p>
|
|
1693
|
+
* @public
|
|
1694
|
+
*/
|
|
1695
|
+
ResourceId?: string | undefined;
|
|
1696
|
+
/**
|
|
1697
|
+
* <p>The logging level for the event log configuration.</p>
|
|
1698
|
+
* @public
|
|
1699
|
+
*/
|
|
1700
|
+
EventLogLevel?: LogLevel | undefined;
|
|
1701
|
+
}
|
|
1702
|
+
/**
|
|
1703
|
+
* @public
|
|
1704
|
+
*/
|
|
1705
|
+
export interface GetEventLogConfigurationRequest {
|
|
1706
|
+
/**
|
|
1707
|
+
* <p>The identifier of the event log configuration.</p>
|
|
1708
|
+
* @public
|
|
1709
|
+
*/
|
|
1710
|
+
Id: string | undefined;
|
|
1711
|
+
}
|
|
1712
|
+
/**
|
|
1713
|
+
* @public
|
|
1714
|
+
*/
|
|
1715
|
+
export interface GetEventLogConfigurationResponse {
|
|
1716
|
+
/**
|
|
1717
|
+
* <p>The identifier of the event log configuration.</p>
|
|
1718
|
+
* @public
|
|
1719
|
+
*/
|
|
1720
|
+
Id?: string | undefined;
|
|
1721
|
+
/**
|
|
1722
|
+
* <p>The type of resource for the event log configuration.</p>
|
|
1723
|
+
* @public
|
|
1724
|
+
*/
|
|
1725
|
+
ResourceType?: string | undefined;
|
|
1726
|
+
/**
|
|
1727
|
+
* <p>The identifier of the resource for the event log configuration.</p>
|
|
1728
|
+
* @public
|
|
1729
|
+
*/
|
|
1730
|
+
ResourceId?: string | undefined;
|
|
1731
|
+
/**
|
|
1732
|
+
* <p>The logging level for the event log configuration.</p>
|
|
1733
|
+
* @public
|
|
1734
|
+
*/
|
|
1735
|
+
EventLogLevel?: LogLevel | undefined;
|
|
1736
|
+
}
|
|
1737
|
+
/**
|
|
1738
|
+
* @public
|
|
1739
|
+
*/
|
|
1740
|
+
export interface ListEventLogConfigurationsRequest {
|
|
1741
|
+
/**
|
|
1742
|
+
* <p>A token that can be used to retrieve the next set of results.</p>
|
|
1743
|
+
* @public
|
|
1744
|
+
*/
|
|
1745
|
+
NextToken?: string | undefined;
|
|
1746
|
+
/**
|
|
1747
|
+
* <p>The maximum number of results to return at one time.</p>
|
|
1748
|
+
* @public
|
|
1749
|
+
*/
|
|
1750
|
+
MaxResults?: number | undefined;
|
|
1751
|
+
}
|
|
1752
|
+
/**
|
|
1753
|
+
* @public
|
|
1754
|
+
*/
|
|
1755
|
+
export interface ListEventLogConfigurationsResponse {
|
|
1756
|
+
/**
|
|
1757
|
+
* <p>A list of each event log configuration and pertinent information.</p>
|
|
1758
|
+
* @public
|
|
1759
|
+
*/
|
|
1760
|
+
EventLogConfigurationList?: EventLogConfigurationSummary[] | undefined;
|
|
1761
|
+
/**
|
|
1762
|
+
* <p>A token that can be used to retrieve the next set of results.</p>
|
|
1763
|
+
* @public
|
|
1764
|
+
*/
|
|
1765
|
+
NextToken?: string | undefined;
|
|
1766
|
+
}
|
|
1767
|
+
/**
|
|
1768
|
+
* @public
|
|
1769
|
+
*/
|
|
1770
|
+
export interface UpdateEventLogConfigurationRequest {
|
|
1771
|
+
/**
|
|
1772
|
+
* <p>The log configuration id.</p>
|
|
1773
|
+
* @public
|
|
1774
|
+
*/
|
|
1775
|
+
Id: string | undefined;
|
|
1776
|
+
/**
|
|
1777
|
+
* <p>The log level for the event in terms of severity.</p>
|
|
1778
|
+
* @public
|
|
1779
|
+
*/
|
|
1780
|
+
EventLogLevel: LogLevel | undefined;
|
|
1781
|
+
}
|
|
1782
|
+
/**
|
|
1783
|
+
* @public
|
|
1784
|
+
*/
|
|
1785
|
+
export interface GetCustomEndpointRequest {
|
|
1786
|
+
}
|
|
1787
|
+
/**
|
|
1788
|
+
* @public
|
|
1789
|
+
*/
|
|
1790
|
+
export interface GetCustomEndpointResponse {
|
|
1791
|
+
/**
|
|
1792
|
+
* <p>The IoT managed integrations dedicated, custom endpoint for the device to route traffic through.</p>
|
|
1793
|
+
* @public
|
|
1794
|
+
*/
|
|
1795
|
+
EndpointAddress: string | undefined;
|
|
1796
|
+
}
|
|
1797
|
+
/**
|
|
1798
|
+
* @public
|
|
1799
|
+
*/
|
|
1800
|
+
export interface GetDefaultEncryptionConfigurationRequest {
|
|
1801
|
+
}
|
|
1802
|
+
/**
|
|
1803
|
+
* @public
|
|
1804
|
+
*/
|
|
1805
|
+
export interface GetDefaultEncryptionConfigurationResponse {
|
|
1806
|
+
/**
|
|
1807
|
+
* <p>Provides the status of the default encryption configuration for an Amazon Web Services account.</p>
|
|
1808
|
+
* @public
|
|
1809
|
+
*/
|
|
1810
|
+
configurationStatus: ConfigurationStatus | undefined;
|
|
1811
|
+
/**
|
|
1812
|
+
* <p>The type of encryption used for the encryption configuration.</p>
|
|
1813
|
+
* @public
|
|
1814
|
+
*/
|
|
1815
|
+
encryptionType: EncryptionType | undefined;
|
|
1816
|
+
/**
|
|
1817
|
+
* <p>The Key Amazon Resource Name (ARN) of the AWS KMS key used for KMS encryption if you use
|
|
1818
|
+
* <code>KMS_BASED_ENCRYPTION</code>.</p>
|
|
1819
|
+
* @public
|
|
1820
|
+
*/
|
|
1821
|
+
kmsKeyArn?: string | undefined;
|
|
1822
|
+
}
|
|
1823
|
+
/**
|
|
1824
|
+
* <p>An unexpected error has occurred.</p>
|
|
1825
|
+
* @public
|
|
1826
|
+
*/
|
|
1827
|
+
export declare class InternalFailureException extends __BaseException {
|
|
1828
|
+
readonly name: "InternalFailureException";
|
|
1829
|
+
readonly $fault: "server";
|
|
1830
|
+
Message?: string | undefined;
|
|
1831
|
+
/**
|
|
1832
|
+
* @internal
|
|
1833
|
+
*/
|
|
1834
|
+
constructor(opts: __ExceptionOptionType<InternalFailureException, __BaseException>);
|
|
1835
|
+
}
|
|
1836
|
+
/**
|
|
1837
|
+
* @public
|
|
1838
|
+
*/
|
|
1839
|
+
export interface GetHubConfigurationRequest {
|
|
1840
|
+
}
|
|
1841
|
+
/**
|
|
1842
|
+
* @public
|
|
1843
|
+
*/
|
|
1844
|
+
export interface GetHubConfigurationResponse {
|
|
1845
|
+
/**
|
|
1846
|
+
* <p>A user-defined integer value that represents the hub token timer expiry setting in
|
|
1847
|
+
* seconds.</p>
|
|
1848
|
+
* @public
|
|
1849
|
+
*/
|
|
1850
|
+
HubTokenTimerExpirySettingInSeconds?: number | undefined;
|
|
1851
|
+
/**
|
|
1852
|
+
* <p>The timestamp value of when the hub configuration was updated.</p>
|
|
1853
|
+
* @public
|
|
1854
|
+
*/
|
|
1855
|
+
UpdatedAt?: Date | undefined;
|
|
1856
|
+
}
|
|
1857
|
+
/**
|
|
1858
|
+
* @public
|
|
1859
|
+
*/
|
|
1860
|
+
export interface GetManagedThingRequest {
|
|
1861
|
+
/**
|
|
1862
|
+
* <p>The id of the managed thing.</p>
|
|
1863
|
+
* @public
|
|
1864
|
+
*/
|
|
1865
|
+
Identifier: string | undefined;
|
|
1866
|
+
}
|
|
1867
|
+
/**
|
|
1868
|
+
* @public
|
|
1869
|
+
* @enum
|
|
1870
|
+
*/
|
|
1871
|
+
export declare const HubNetworkMode: {
|
|
1872
|
+
readonly NETWORK_WIDE_EXCLUSION: "NETWORK_WIDE_EXCLUSION";
|
|
1873
|
+
readonly STANDARD: "STANDARD";
|
|
1874
|
+
};
|
|
1875
|
+
/**
|
|
1876
|
+
* @public
|
|
1877
|
+
*/
|
|
1878
|
+
export type HubNetworkMode = (typeof HubNetworkMode)[keyof typeof HubNetworkMode];
|
|
1879
|
+
/**
|
|
1880
|
+
* @public
|
|
1881
|
+
* @enum
|
|
1882
|
+
*/
|
|
1883
|
+
export declare const ProvisioningStatus: {
|
|
1884
|
+
readonly ACTIVATED: "ACTIVATED";
|
|
1885
|
+
readonly DELETED: "DELETED";
|
|
1886
|
+
readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
|
|
1887
|
+
readonly DELETION_FAILED: "DELETION_FAILED";
|
|
1888
|
+
readonly DISCOVERED: "DISCOVERED";
|
|
1889
|
+
readonly ISOLATED: "ISOLATED";
|
|
1890
|
+
readonly PRE_ASSOCIATED: "PRE_ASSOCIATED";
|
|
1891
|
+
readonly UNASSOCIATED: "UNASSOCIATED";
|
|
1892
|
+
};
|
|
1893
|
+
/**
|
|
1894
|
+
* @public
|
|
1895
|
+
*/
|
|
1896
|
+
export type ProvisioningStatus = (typeof ProvisioningStatus)[keyof typeof ProvisioningStatus];
|
|
1897
|
+
/**
|
|
1898
|
+
* @public
|
|
1899
|
+
*/
|
|
1900
|
+
export interface GetManagedThingResponse {
|
|
1901
|
+
/**
|
|
1902
|
+
* <p>The id of the managed thing.</p>
|
|
1903
|
+
* @public
|
|
1904
|
+
*/
|
|
1905
|
+
Id?: string | undefined;
|
|
1906
|
+
/**
|
|
1907
|
+
* <p>The Amazon Resource Name (ARN) of the managed thing.</p>
|
|
1908
|
+
* @public
|
|
1909
|
+
*/
|
|
1910
|
+
Arn?: string | undefined;
|
|
1911
|
+
/**
|
|
1912
|
+
* <p>Owner of the device, usually an indication of whom the device belongs to. This value
|
|
1913
|
+
* should not contain personal identifiable information.</p>
|
|
1914
|
+
* @public
|
|
1915
|
+
*/
|
|
1916
|
+
Owner?: string | undefined;
|
|
1917
|
+
/**
|
|
1918
|
+
* <p>The identifier of the credential locker for the managed thing.</p>
|
|
1919
|
+
* @public
|
|
1920
|
+
*/
|
|
1921
|
+
CredentialLockerId?: string | undefined;
|
|
1922
|
+
/**
|
|
1923
|
+
* <p>The id of the advertised product.</p>
|
|
1924
|
+
* @public
|
|
1925
|
+
*/
|
|
1926
|
+
AdvertisedProductId?: string | undefined;
|
|
1927
|
+
/**
|
|
1928
|
+
* <p>The type of device used. This will be the Amazon Web Services hub controller, cloud device, or IoT
|
|
1929
|
+
* device.</p>
|
|
1930
|
+
* @public
|
|
1931
|
+
*/
|
|
1932
|
+
Role?: Role | undefined;
|
|
1933
|
+
/**
|
|
1934
|
+
* <p>The provisioning status of the device in the provisioning workflow for onboarding to
|
|
1935
|
+
* IoT managed integrations.</p>
|
|
1936
|
+
* @public
|
|
1937
|
+
*/
|
|
1938
|
+
ProvisioningStatus?: ProvisioningStatus | undefined;
|
|
1939
|
+
/**
|
|
1940
|
+
* <p>The name of the managed thing representing the physical device.</p>
|
|
1941
|
+
* @public
|
|
1942
|
+
*/
|
|
1943
|
+
Name?: string | undefined;
|
|
1944
|
+
/**
|
|
1945
|
+
* <p>The model of the device.</p>
|
|
1946
|
+
* @public
|
|
1947
|
+
*/
|
|
1948
|
+
Model?: string | undefined;
|
|
1949
|
+
/**
|
|
1950
|
+
* <p>The brand of the device.</p>
|
|
1951
|
+
* @public
|
|
1952
|
+
*/
|
|
1953
|
+
Brand?: string | undefined;
|
|
1954
|
+
/**
|
|
1955
|
+
* <p>The serial number of the device.</p>
|
|
1956
|
+
* @public
|
|
1957
|
+
*/
|
|
1958
|
+
SerialNumber?: string | undefined;
|
|
1959
|
+
/**
|
|
1960
|
+
* <p>The universal product code (UPC) of the device model. The UPC is typically used in the
|
|
1961
|
+
* United States of America and Canada.</p>
|
|
1962
|
+
* @public
|
|
1963
|
+
*/
|
|
1964
|
+
UniversalProductCode?: string | undefined;
|
|
1965
|
+
/**
|
|
1966
|
+
* <p>The unique 13 digit number that identifies the managed thing.</p>
|
|
1967
|
+
* @public
|
|
1968
|
+
*/
|
|
1969
|
+
InternationalArticleNumber?: string | undefined;
|
|
1970
|
+
/**
|
|
1971
|
+
* <p>The id of the connector policy.</p>
|
|
1972
|
+
* <note>
|
|
1973
|
+
* <p>This parameter is used for cloud-to-cloud devices only.</p>
|
|
1974
|
+
* </note>
|
|
1975
|
+
* @public
|
|
1976
|
+
*/
|
|
1977
|
+
ConnectorPolicyId?: string | undefined;
|
|
1978
|
+
/**
|
|
1979
|
+
* <p>The third-party device id as defined by the connector. This device id must not contain
|
|
1980
|
+
* personal identifiable information (PII).</p>
|
|
1981
|
+
* <note>
|
|
1982
|
+
* <p>This parameter is used for cloud-to-cloud devices only.</p>
|
|
1983
|
+
* </note>
|
|
1984
|
+
* @public
|
|
1985
|
+
*/
|
|
1986
|
+
ConnectorDeviceId?: string | undefined;
|
|
1987
|
+
/**
|
|
1988
|
+
* <p>A Zwave device-specific key used during device activation.</p>
|
|
1989
|
+
* <note>
|
|
1990
|
+
* <p>This parameter is used for Zwave devices only.</p>
|
|
1991
|
+
* </note>
|
|
1992
|
+
* @public
|
|
1993
|
+
*/
|
|
1994
|
+
DeviceSpecificKey?: string | undefined;
|
|
1995
|
+
/**
|
|
1996
|
+
* <p>The media access control (MAC) address for the device represented by the managed
|
|
1997
|
+
* thing.</p>
|
|
1998
|
+
* <note>
|
|
1999
|
+
* <p>This parameter is used for Zigbee devices only.</p>
|
|
2000
|
+
* </note>
|
|
2001
|
+
* @public
|
|
2002
|
+
*/
|
|
2003
|
+
MacAddress?: string | undefined;
|
|
2004
|
+
/**
|
|
2005
|
+
* <p>Id of the controller device used for the discovery job.</p>
|
|
2006
|
+
* @public
|
|
2007
|
+
*/
|
|
2008
|
+
ParentControllerId?: string | undefined;
|
|
2009
|
+
/**
|
|
2010
|
+
* <p>The classification of the managed thing such as light bulb or thermostat.</p>
|
|
2011
|
+
* @public
|
|
2012
|
+
*/
|
|
2013
|
+
Classification?: string | undefined;
|
|
2014
|
+
/**
|
|
2015
|
+
* <p>The timestamp value of when the device creation request occurred.</p>
|
|
2016
|
+
* @public
|
|
2017
|
+
*/
|
|
2018
|
+
CreatedAt?: Date | undefined;
|
|
2019
|
+
/**
|
|
2020
|
+
* <p>The timestamp value of when the managed thing was last updated at.</p>
|
|
2021
|
+
* @public
|
|
2022
|
+
*/
|
|
2023
|
+
UpdatedAt?: Date | undefined;
|
|
2024
|
+
/**
|
|
2025
|
+
* <p>The timestampe value of when the device was activated.</p>
|
|
2026
|
+
* @public
|
|
2027
|
+
*/
|
|
2028
|
+
ActivatedAt?: Date | undefined;
|
|
2029
|
+
/**
|
|
2030
|
+
* <p>The network mode for the hub-connected device.</p>
|
|
2031
|
+
* @public
|
|
2032
|
+
*/
|
|
2033
|
+
HubNetworkMode?: HubNetworkMode | undefined;
|
|
2034
|
+
/**
|
|
2035
|
+
* <p>The metadata for the managed thing.</p>
|
|
2036
|
+
* @public
|
|
2037
|
+
*/
|
|
2038
|
+
MetaData?: Record<string, string> | undefined;
|
|
2039
|
+
/**
|
|
2040
|
+
* <p>A set of key/value pairs that are used to manage the managed thing.</p>
|
|
2041
|
+
* @public
|
|
2042
|
+
*/
|
|
2043
|
+
Tags?: Record<string, string> | undefined;
|
|
2044
|
+
}
|
|
2045
|
+
/**
|
|
2046
|
+
* @public
|
|
2047
|
+
*/
|
|
2048
|
+
export interface GetManagedThingCapabilitiesRequest {
|
|
2049
|
+
/**
|
|
2050
|
+
* <p>The id of the device.</p>
|
|
2051
|
+
* @public
|
|
2052
|
+
*/
|
|
2053
|
+
Identifier: string | undefined;
|
|
2054
|
+
}
|
|
2055
|
+
/**
|
|
2056
|
+
* @public
|
|
2057
|
+
*/
|
|
2058
|
+
export interface GetManagedThingCapabilitiesResponse {
|
|
2059
|
+
/**
|
|
2060
|
+
* <p>The id of the device.</p>
|
|
2061
|
+
* @public
|
|
2062
|
+
*/
|
|
2063
|
+
ManagedThingId?: string | undefined;
|
|
2064
|
+
/**
|
|
2065
|
+
* <p>The capabilities of the device such as light bulb.</p>
|
|
2066
|
+
* @public
|
|
2067
|
+
*/
|
|
2068
|
+
Capabilities?: string | undefined;
|
|
2069
|
+
/**
|
|
2070
|
+
* <p>A report of the capabilities for the managed thing.</p>
|
|
2071
|
+
* @public
|
|
2072
|
+
*/
|
|
2073
|
+
CapabilityReport?: CapabilityReport | undefined;
|
|
2074
|
+
}
|
|
2075
|
+
/**
|
|
2076
|
+
* @public
|
|
2077
|
+
*/
|
|
2078
|
+
export interface GetManagedThingConnectivityDataRequest {
|
|
2079
|
+
/**
|
|
2080
|
+
* <p>The identifier of a managed thing.</p>
|
|
2081
|
+
* @public
|
|
2082
|
+
*/
|
|
2083
|
+
Identifier: string | undefined;
|
|
2084
|
+
}
|
|
2085
|
+
/**
|
|
2086
|
+
* @public
|
|
2087
|
+
*/
|
|
2088
|
+
export interface GetManagedThingConnectivityDataResponse {
|
|
2089
|
+
/**
|
|
2090
|
+
* <p>The id of a managed thing.</p>
|
|
2091
|
+
* @public
|
|
2092
|
+
*/
|
|
2093
|
+
ManagedThingId?: string | undefined;
|
|
2094
|
+
/**
|
|
2095
|
+
* <p>The connectivity status for a managed thing.</p>
|
|
2096
|
+
* @public
|
|
2097
|
+
*/
|
|
2098
|
+
Connected?: boolean | undefined;
|
|
2099
|
+
/**
|
|
2100
|
+
* <p>The timestamp value of when the connectivity status for a managed thing was last
|
|
2101
|
+
* taken.</p>
|
|
2102
|
+
* @public
|
|
2103
|
+
*/
|
|
2104
|
+
Timestamp?: Date | undefined;
|
|
2105
|
+
/**
|
|
2106
|
+
* <p>The reason for the connectivity disconnect with the managed thing.</p>
|
|
2107
|
+
* @public
|
|
2108
|
+
*/
|
|
2109
|
+
DisconnectReason?: DisconnectReasonValue | undefined;
|
|
2110
|
+
}
|
|
2111
|
+
/**
|
|
2112
|
+
* @public
|
|
2113
|
+
*/
|
|
2114
|
+
export interface GetManagedThingMetaDataRequest {
|
|
2115
|
+
/**
|
|
2116
|
+
* <p>The managed thing id.</p>
|
|
2117
|
+
* @public
|
|
2118
|
+
*/
|
|
2119
|
+
Identifier: string | undefined;
|
|
2120
|
+
}
|
|
2121
|
+
/**
|
|
2122
|
+
* @public
|
|
2123
|
+
*/
|
|
2124
|
+
export interface GetManagedThingMetaDataResponse {
|
|
2125
|
+
/**
|
|
2126
|
+
* <p>The managed thing id.</p>
|
|
2127
|
+
* @public
|
|
2128
|
+
*/
|
|
2129
|
+
ManagedThingId?: string | undefined;
|
|
2130
|
+
/**
|
|
2131
|
+
* <p>The metadata for the managed thing.</p>
|
|
2132
|
+
* @public
|
|
2133
|
+
*/
|
|
2134
|
+
MetaData?: Record<string, string> | undefined;
|
|
2135
|
+
}
|
|
2136
|
+
/**
|
|
2137
|
+
* @public
|
|
2138
|
+
*/
|
|
2139
|
+
export interface GetManagedThingStateRequest {
|
|
2140
|
+
/**
|
|
2141
|
+
* <p>The id of the device.</p>
|
|
2142
|
+
* @public
|
|
2143
|
+
*/
|
|
2144
|
+
ManagedThingId: string | undefined;
|
|
2145
|
+
}
|
|
2146
|
+
/**
|
|
2147
|
+
* <p>State capabilities added for the managed thing.</p>
|
|
2148
|
+
* @public
|
|
2149
|
+
*/
|
|
2150
|
+
export interface StateCapability {
|
|
2151
|
+
/**
|
|
2152
|
+
* <p>The id of the managed thing in the capability report.</p>
|
|
2153
|
+
* @public
|
|
2154
|
+
*/
|
|
2155
|
+
id: string | undefined;
|
|
2156
|
+
/**
|
|
2157
|
+
* <p>Name for the Amazon Web Services capability.</p>
|
|
2158
|
+
* @public
|
|
2159
|
+
*/
|
|
2160
|
+
name: string | undefined;
|
|
2161
|
+
/**
|
|
2162
|
+
* <p>Version for the Amazon Web Services capability.</p>
|
|
2163
|
+
* @public
|
|
2164
|
+
*/
|
|
2165
|
+
version: string | undefined;
|
|
2166
|
+
/**
|
|
2167
|
+
* <p>Describe the command capability with the properties it supports.</p>
|
|
2168
|
+
* @public
|
|
2169
|
+
*/
|
|
2170
|
+
properties?: __DocumentType | undefined;
|
|
2171
|
+
}
|
|
2172
|
+
/**
|
|
2173
|
+
* <p>Describe the endpoint with an Id, a name, and the relevant capabilities for reporting
|
|
2174
|
+
* state</p>
|
|
2175
|
+
* @public
|
|
2176
|
+
*/
|
|
2177
|
+
export interface StateEndpoint {
|
|
2178
|
+
/**
|
|
2179
|
+
* <p>Numeric identifier of the endpoint</p>
|
|
2180
|
+
* @public
|
|
2181
|
+
*/
|
|
2182
|
+
endpointId: string | undefined;
|
|
2183
|
+
/**
|
|
2184
|
+
* <p>Describe the endpoint with an id, a name, and the relevant capabilities for the
|
|
2185
|
+
* reporting state.</p>
|
|
2186
|
+
* @public
|
|
2187
|
+
*/
|
|
2188
|
+
capabilities: StateCapability[] | undefined;
|
|
2189
|
+
}
|
|
2190
|
+
/**
|
|
2191
|
+
* @public
|
|
2192
|
+
*/
|
|
2193
|
+
export interface GetManagedThingStateResponse {
|
|
2194
|
+
/**
|
|
2195
|
+
* <p>The device endpoint.</p>
|
|
2196
|
+
* @public
|
|
2197
|
+
*/
|
|
2198
|
+
Endpoints: StateEndpoint[] | undefined;
|
|
2199
|
+
}
|
|
2200
|
+
/**
|
|
2201
|
+
* @public
|
|
2202
|
+
*/
|
|
2203
|
+
export interface GetNotificationConfigurationRequest {
|
|
2204
|
+
/**
|
|
2205
|
+
* <p>The type of event triggering a device notification to the customer-managed
|
|
2206
|
+
* destination.</p>
|
|
2207
|
+
* @public
|
|
2208
|
+
*/
|
|
2209
|
+
EventType: EventType | undefined;
|
|
2210
|
+
}
|
|
2211
|
+
/**
|
|
2212
|
+
* @public
|
|
2213
|
+
*/
|
|
2214
|
+
export interface GetNotificationConfigurationResponse {
|
|
2215
|
+
/**
|
|
2216
|
+
* <p>The type of event triggering a device notification to the customer-managed
|
|
2217
|
+
* destination.</p>
|
|
2218
|
+
* @public
|
|
2219
|
+
*/
|
|
2220
|
+
EventType?: EventType | undefined;
|
|
2221
|
+
/**
|
|
2222
|
+
* <p>The name of the destination for the notification configuration.</p>
|
|
2223
|
+
* @public
|
|
2224
|
+
*/
|
|
2225
|
+
DestinationName?: string | undefined;
|
|
2226
|
+
/**
|
|
2227
|
+
* <p>The timestamp value of when the notification configuration was created.</p>
|
|
2228
|
+
* @public
|
|
2229
|
+
*/
|
|
2230
|
+
CreatedAt?: Date | undefined;
|
|
2231
|
+
/**
|
|
2232
|
+
* <p>The timestamp value of when the notification configuration was last updated.</p>
|
|
2233
|
+
* @public
|
|
2234
|
+
*/
|
|
2235
|
+
UpdatedAt?: Date | undefined;
|
|
2236
|
+
/**
|
|
2237
|
+
* <p>A set of key/value pairs that are used to manage the notification configuration.</p>
|
|
2238
|
+
* @public
|
|
2239
|
+
*/
|
|
2240
|
+
Tags?: Record<string, string> | undefined;
|
|
2241
|
+
}
|
|
2242
|
+
/**
|
|
2243
|
+
* @public
|
|
2244
|
+
*/
|
|
2245
|
+
export interface GetOtaTaskRequest {
|
|
2246
|
+
/**
|
|
2247
|
+
* <p>The over-the-air (OTA) task id.</p>
|
|
2248
|
+
* @public
|
|
2249
|
+
*/
|
|
2250
|
+
Identifier: string | undefined;
|
|
2251
|
+
}
|
|
2252
|
+
/**
|
|
2253
|
+
* @public
|
|
2254
|
+
* @enum
|
|
2255
|
+
*/
|
|
2256
|
+
export declare const OtaStatus: {
|
|
2257
|
+
readonly CANCELED: "CANCELED";
|
|
2258
|
+
readonly COMPLETED: "COMPLETED";
|
|
2259
|
+
readonly DELETION_IN_PROGRESS: "DELETION_IN_PROGRESS";
|
|
2260
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
2261
|
+
readonly SCHEDULED: "SCHEDULED";
|
|
2262
|
+
};
|
|
2263
|
+
/**
|
|
2264
|
+
* @public
|
|
2265
|
+
*/
|
|
2266
|
+
export type OtaStatus = (typeof OtaStatus)[keyof typeof OtaStatus];
|
|
2267
|
+
/**
|
|
2268
|
+
* <p>Details about the over-the-air (OTA) task process.</p>
|
|
2269
|
+
* @public
|
|
2270
|
+
*/
|
|
2271
|
+
export interface TaskProcessingDetails {
|
|
2272
|
+
/**
|
|
2273
|
+
* <p>The number of canceled things in an over-the-air (OTA) task.</p>
|
|
2274
|
+
* @public
|
|
2275
|
+
*/
|
|
2276
|
+
NumberOfCanceledThings?: number | undefined;
|
|
2277
|
+
/**
|
|
2278
|
+
* <p>The number of failed things in an over-the-air (OTA) task.</p>
|
|
2279
|
+
* @public
|
|
2280
|
+
*/
|
|
2281
|
+
NumberOfFailedThings?: number | undefined;
|
|
2282
|
+
/**
|
|
2283
|
+
* <p>The number of in progress things in an over-the-air (OTA) task.</p>
|
|
2284
|
+
* @public
|
|
2285
|
+
*/
|
|
2286
|
+
NumberOfInProgressThings?: number | undefined;
|
|
2287
|
+
/**
|
|
2288
|
+
* <p>The number of queued things in an over-the-air (OTA) task.</p>
|
|
2289
|
+
* @public
|
|
2290
|
+
*/
|
|
2291
|
+
numberOfQueuedThings?: number | undefined;
|
|
2292
|
+
/**
|
|
2293
|
+
* <p>The number of rejected things in an over-the-air (OTA) task.</p>
|
|
2294
|
+
* @public
|
|
2295
|
+
*/
|
|
2296
|
+
numberOfRejectedThings?: number | undefined;
|
|
2297
|
+
/**
|
|
2298
|
+
* <p>The number of removed things in an over-the-air (OTA) task.</p>
|
|
2299
|
+
* @public
|
|
2300
|
+
*/
|
|
2301
|
+
numberOfRemovedThings?: number | undefined;
|
|
2302
|
+
/**
|
|
2303
|
+
* <p>The number of succeeded things in an over-the-air (OTA) task.</p>
|
|
2304
|
+
* @public
|
|
2305
|
+
*/
|
|
2306
|
+
numberOfSucceededThings?: number | undefined;
|
|
2307
|
+
/**
|
|
2308
|
+
* <p>The number of timed out things in an over-the-air (OTA) task.</p>
|
|
2309
|
+
* @public
|
|
2310
|
+
*/
|
|
2311
|
+
numberOfTimedOutThings?: number | undefined;
|
|
2312
|
+
/**
|
|
2313
|
+
* <p>The targets of the over-the-air (OTA) task.</p>
|
|
2314
|
+
* @public
|
|
2315
|
+
*/
|
|
2316
|
+
processingTargets?: string[] | undefined;
|
|
2317
|
+
}
|
|
2318
|
+
/**
|
|
2319
|
+
* @public
|
|
2320
|
+
*/
|
|
2321
|
+
export interface GetOtaTaskResponse {
|
|
2322
|
+
/**
|
|
2323
|
+
* <p>The id of the over-the-air (OTA) task.</p>
|
|
2324
|
+
* @public
|
|
2325
|
+
*/
|
|
2326
|
+
TaskId?: string | undefined;
|
|
2327
|
+
/**
|
|
2328
|
+
* <p>The Amazon Resource Name (ARN) of the over-the-air (OTA) task</p>
|
|
2329
|
+
* @public
|
|
2330
|
+
*/
|
|
2331
|
+
TaskArn?: string | undefined;
|
|
2332
|
+
/**
|
|
2333
|
+
* <p>The description of the over-the-air (OTA) task.</p>
|
|
2334
|
+
* @public
|
|
2335
|
+
*/
|
|
2336
|
+
Description?: string | undefined;
|
|
2337
|
+
/**
|
|
2338
|
+
* <p>The URL to the Amazon S3 bucket where the over-the-air (OTA) task is stored.</p>
|
|
2339
|
+
* @public
|
|
2340
|
+
*/
|
|
2341
|
+
S3Url?: string | undefined;
|
|
2342
|
+
/**
|
|
2343
|
+
* <p>The connection protocol the over-the-air (OTA) task uses to update the device.</p>
|
|
2344
|
+
* @public
|
|
2345
|
+
*/
|
|
2346
|
+
Protocol?: OtaProtocol | undefined;
|
|
2347
|
+
/**
|
|
2348
|
+
* <p>The frequency type for the over-the-air (OTA) task.</p>
|
|
2349
|
+
* @public
|
|
2350
|
+
*/
|
|
2351
|
+
OtaType?: OtaType | undefined;
|
|
2352
|
+
/**
|
|
2353
|
+
* <p>The query string to add things to the thing group.</p>
|
|
2354
|
+
* @public
|
|
2355
|
+
*/
|
|
2356
|
+
OtaTargetQueryString?: string | undefined;
|
|
2357
|
+
/**
|
|
2358
|
+
* <p>The deployment mechanism for the over-the-air (OTA) task.</p>
|
|
2359
|
+
* @public
|
|
2360
|
+
*/
|
|
2361
|
+
OtaMechanism?: OtaMechanism | undefined;
|
|
2362
|
+
/**
|
|
2363
|
+
* <p>The device targeted for the over-the-air (OTA) task.</p>
|
|
2364
|
+
* @public
|
|
2365
|
+
*/
|
|
2366
|
+
Target?: string[] | undefined;
|
|
2367
|
+
/**
|
|
2368
|
+
* <p>The timestamp value of when the over-the-air (OTA) task was created.</p>
|
|
2369
|
+
* @public
|
|
2370
|
+
*/
|
|
2371
|
+
CreatedAt?: Date | undefined;
|
|
2372
|
+
/**
|
|
2373
|
+
* <p>The timestamp value of when the over-the-air (OTA) task was last updated at.</p>
|
|
2374
|
+
* @public
|
|
2375
|
+
*/
|
|
2376
|
+
LastUpdatedAt?: Date | undefined;
|
|
2377
|
+
/**
|
|
2378
|
+
* <p>The identifier for the over-the-air (OTA) task configuration.</p>
|
|
2379
|
+
* @public
|
|
2380
|
+
*/
|
|
2381
|
+
TaskConfigurationId?: string | undefined;
|
|
2382
|
+
/**
|
|
2383
|
+
* <p>The processing details of all over-the-air (OTA) tasks.</p>
|
|
2384
|
+
* @public
|
|
2385
|
+
*/
|
|
2386
|
+
TaskProcessingDetails?: TaskProcessingDetails | undefined;
|
|
2387
|
+
/**
|
|
2388
|
+
* <p>Over-the-air (OTA) task scheduling config.</p>
|
|
2389
|
+
* @public
|
|
2390
|
+
*/
|
|
2391
|
+
OtaSchedulingConfig?: OtaTaskSchedulingConfig | undefined;
|
|
2392
|
+
/**
|
|
2393
|
+
* <p>Over-the-air (OTA) task retry config.</p>
|
|
2394
|
+
* @public
|
|
2395
|
+
*/
|
|
2396
|
+
OtaTaskExecutionRetryConfig?: OtaTaskExecutionRetryConfig | undefined;
|
|
2397
|
+
/**
|
|
2398
|
+
* <p>The status of the over-the-air (OTA) task.</p>
|
|
2399
|
+
* @public
|
|
2400
|
+
*/
|
|
2401
|
+
Status?: OtaStatus | undefined;
|
|
2402
|
+
}
|
|
2403
|
+
/**
|
|
2404
|
+
* @public
|
|
2405
|
+
*/
|
|
2406
|
+
export interface GetOtaTaskConfigurationRequest {
|
|
2407
|
+
/**
|
|
2408
|
+
* <p>The over-the-air (OTA) task configuration id.</p>
|
|
2409
|
+
* @public
|
|
2410
|
+
*/
|
|
2411
|
+
Identifier: string | undefined;
|
|
2412
|
+
}
|
|
2413
|
+
/**
|
|
2414
|
+
* @public
|
|
2415
|
+
*/
|
|
2416
|
+
export interface GetOtaTaskConfigurationResponse {
|
|
2417
|
+
/**
|
|
2418
|
+
* <p>The over-the-air (OTA) task configuration id.</p>
|
|
2419
|
+
* @public
|
|
2420
|
+
*/
|
|
2421
|
+
TaskConfigurationId?: string | undefined;
|
|
2422
|
+
/**
|
|
2423
|
+
* <p>The name of the over-the-air (OTA) task configuration.</p>
|
|
2424
|
+
* @public
|
|
2425
|
+
*/
|
|
2426
|
+
Name?: string | undefined;
|
|
2427
|
+
/**
|
|
2428
|
+
* <p>Describes the type of configuration used for the over-the-air (OTA) task.</p>
|
|
2429
|
+
* @public
|
|
2430
|
+
*/
|
|
2431
|
+
PushConfig?: PushConfig | undefined;
|
|
2432
|
+
/**
|
|
2433
|
+
* <p>A description of the over-the-air (OTA) task configuration.</p>
|
|
2434
|
+
* @public
|
|
2435
|
+
*/
|
|
2436
|
+
Description?: string | undefined;
|
|
2437
|
+
/**
|
|
2438
|
+
* <p>The timestamp value of when the over-the-air (OTA) task configuration was created
|
|
2439
|
+
* at.</p>
|
|
2440
|
+
* @public
|
|
2441
|
+
*/
|
|
2442
|
+
CreatedAt?: Date | undefined;
|
|
2443
|
+
}
|
|
2444
|
+
/**
|
|
2445
|
+
* @public
|
|
2446
|
+
*/
|
|
2447
|
+
export interface GetProvisioningProfileRequest {
|
|
2448
|
+
/**
|
|
2449
|
+
* <p>The provisioning template the device uses for the provisioning process.</p>
|
|
2450
|
+
* @public
|
|
2451
|
+
*/
|
|
2452
|
+
Identifier: string | undefined;
|
|
2453
|
+
}
|
|
2454
|
+
/**
|
|
2455
|
+
* @public
|
|
2456
|
+
*/
|
|
2457
|
+
export interface GetProvisioningProfileResponse {
|
|
2458
|
+
/**
|
|
2459
|
+
* <p>The Amazon Resource Name (ARN) of the provisioning template used in the provisioning
|
|
2460
|
+
* profile.</p>
|
|
2461
|
+
* @public
|
|
2462
|
+
*/
|
|
2463
|
+
Arn?: string | undefined;
|
|
2464
|
+
/**
|
|
2465
|
+
* <p>The name of the provisioning template.</p>
|
|
2466
|
+
* @public
|
|
2467
|
+
*/
|
|
2468
|
+
Name?: string | undefined;
|
|
2469
|
+
/**
|
|
2470
|
+
* <p>The type of provisioning workflow the device uses for onboarding to IoT managed integrations.</p>
|
|
2471
|
+
* @public
|
|
2472
|
+
*/
|
|
2473
|
+
ProvisioningType?: ProvisioningType | undefined;
|
|
2474
|
+
/**
|
|
2475
|
+
* <p>The provisioning profile id..</p>
|
|
2476
|
+
* @public
|
|
2477
|
+
*/
|
|
2478
|
+
Id?: string | undefined;
|
|
2479
|
+
/**
|
|
2480
|
+
* <p>The id of the claim certificate.</p>
|
|
2481
|
+
* @public
|
|
2482
|
+
*/
|
|
2483
|
+
ClaimCertificate?: string | undefined;
|
|
2484
|
+
/**
|
|
2485
|
+
* <p>A set of key/value pairs that are used to manage the provisioning profile.</p>
|
|
2486
|
+
* @public
|
|
2487
|
+
*/
|
|
2488
|
+
Tags?: Record<string, string> | undefined;
|
|
2489
|
+
}
|
|
2490
|
+
/**
|
|
2491
|
+
* @public
|
|
2492
|
+
*/
|
|
2493
|
+
export interface GetRuntimeLogConfigurationRequest {
|
|
2494
|
+
/**
|
|
2495
|
+
* <p>The id for a managed thing.</p>
|
|
2496
|
+
* @public
|
|
2497
|
+
*/
|
|
2498
|
+
ManagedThingId: string | undefined;
|
|
2499
|
+
}
|
|
2500
|
+
/**
|
|
2501
|
+
* <p>The different configurations for runtime logs.</p>
|
|
2502
|
+
* @public
|
|
2503
|
+
*/
|
|
2504
|
+
export interface RuntimeLogConfigurations {
|
|
2505
|
+
/**
|
|
2506
|
+
* <p>The different log levels available for configuration.</p>
|
|
2507
|
+
* @public
|
|
2508
|
+
*/
|
|
2509
|
+
LogLevel?: LogLevel | undefined;
|
|
2510
|
+
/**
|
|
2511
|
+
* <p>The different log levels available for configuration.</p>
|
|
2512
|
+
* @public
|
|
2513
|
+
*/
|
|
2514
|
+
LogFlushLevel?: LogLevel | undefined;
|
|
2515
|
+
/**
|
|
2516
|
+
* <p>Configuration of where to store runtime logs in the device.</p>
|
|
2517
|
+
* @public
|
|
2518
|
+
*/
|
|
2519
|
+
LocalStoreLocation?: string | undefined;
|
|
2520
|
+
/**
|
|
2521
|
+
* <p>Configuration to set the maximum number of runtime log files that can be stored on the
|
|
2522
|
+
* device before the oldest files are deleted or overwritten.</p>
|
|
2523
|
+
* @public
|
|
2524
|
+
*/
|
|
2525
|
+
LocalStoreFileRotationMaxFiles?: number | undefined;
|
|
2526
|
+
/**
|
|
2527
|
+
* <p>Configuration to set the maximum bytes of runtime logs that can be stored on the device
|
|
2528
|
+
* before the oldest logs are deleted or overwritten.</p>
|
|
2529
|
+
* @public
|
|
2530
|
+
*/
|
|
2531
|
+
LocalStoreFileRotationMaxBytes?: number | undefined;
|
|
2532
|
+
/**
|
|
2533
|
+
* <p>Configuration to enable or disable uploading of runtime logs to the cloud.</p>
|
|
2534
|
+
* @public
|
|
2535
|
+
*/
|
|
2536
|
+
UploadLog?: boolean | undefined;
|
|
2537
|
+
/**
|
|
2538
|
+
* <p>Configuration to set the time interval in minutes between each batch of runtime logs
|
|
2539
|
+
* that the device uploads to the cloud.</p>
|
|
2540
|
+
* @public
|
|
2541
|
+
*/
|
|
2542
|
+
UploadPeriodMinutes?: number | undefined;
|
|
2543
|
+
/**
|
|
2544
|
+
* <p>Configuration to enable or disable deleting of runtime logs in the device once uploaded
|
|
2545
|
+
* to the cloud.</p>
|
|
2546
|
+
* @public
|
|
2547
|
+
*/
|
|
2548
|
+
DeleteLocalStoreAfterUpload?: boolean | undefined;
|
|
2549
|
+
}
|
|
2550
|
+
/**
|
|
2551
|
+
* @public
|
|
2552
|
+
*/
|
|
2553
|
+
export interface GetRuntimeLogConfigurationResponse {
|
|
2554
|
+
/**
|
|
2555
|
+
* <p>The id for a managed thing.</p>
|
|
2556
|
+
* @public
|
|
2557
|
+
*/
|
|
2558
|
+
ManagedThingId?: string | undefined;
|
|
2559
|
+
/**
|
|
2560
|
+
* <p>The runtime log configuration for a managed thing.</p>
|
|
2561
|
+
* @public
|
|
2562
|
+
*/
|
|
2563
|
+
RuntimeLogConfigurations?: RuntimeLogConfigurations | undefined;
|
|
2564
|
+
}
|
|
2565
|
+
/**
|
|
2566
|
+
* @public
|
|
2567
|
+
* @enum
|
|
2568
|
+
*/
|
|
2569
|
+
export declare const SchemaVersionFormat: {
|
|
2570
|
+
readonly AWS: "AWS";
|
|
2571
|
+
readonly CONNECTOR: "CONNECTOR";
|
|
2572
|
+
readonly ZCL: "ZCL";
|
|
2573
|
+
};
|
|
2574
|
+
/**
|
|
2575
|
+
* @public
|
|
2576
|
+
*/
|
|
2577
|
+
export type SchemaVersionFormat = (typeof SchemaVersionFormat)[keyof typeof SchemaVersionFormat];
|
|
2578
|
+
/**
|
|
2579
|
+
* @public
|
|
2580
|
+
* @enum
|
|
2581
|
+
*/
|
|
2582
|
+
export declare const SchemaVersionType: {
|
|
2583
|
+
readonly CAPABILITY: "capability";
|
|
2584
|
+
readonly DEFINITION: "definition";
|
|
2585
|
+
};
|
|
2586
|
+
/**
|
|
2587
|
+
* @public
|
|
2588
|
+
*/
|
|
2589
|
+
export type SchemaVersionType = (typeof SchemaVersionType)[keyof typeof SchemaVersionType];
|
|
2590
|
+
/**
|
|
2591
|
+
* @public
|
|
2592
|
+
*/
|
|
2593
|
+
export interface GetSchemaVersionRequest {
|
|
2594
|
+
/**
|
|
2595
|
+
* <p>The type of schema version.</p>
|
|
2596
|
+
* @public
|
|
2597
|
+
*/
|
|
2598
|
+
Type: SchemaVersionType | undefined;
|
|
2599
|
+
/**
|
|
2600
|
+
* <p>Schema id with a version specified. If the version is missing, it defaults to latest
|
|
2601
|
+
* version.</p>
|
|
2602
|
+
* @public
|
|
2603
|
+
*/
|
|
2604
|
+
SchemaVersionedId: string | undefined;
|
|
2605
|
+
/**
|
|
2606
|
+
* <p>The format of the schema version.</p>
|
|
2607
|
+
* @public
|
|
2608
|
+
*/
|
|
2609
|
+
Format?: SchemaVersionFormat | undefined;
|
|
2610
|
+
}
|
|
2611
|
+
/**
|
|
2612
|
+
* @public
|
|
2613
|
+
* @enum
|
|
2614
|
+
*/
|
|
2615
|
+
export declare const SchemaVersionVisibility: {
|
|
2616
|
+
readonly PRIVATE: "PRIVATE";
|
|
2617
|
+
readonly PUBLIC: "PUBLIC";
|
|
2618
|
+
};
|
|
2619
|
+
/**
|
|
2620
|
+
* @public
|
|
2621
|
+
*/
|
|
2622
|
+
export type SchemaVersionVisibility = (typeof SchemaVersionVisibility)[keyof typeof SchemaVersionVisibility];
|
|
2623
|
+
/**
|
|
2624
|
+
* @public
|
|
2625
|
+
*/
|
|
2626
|
+
export interface GetSchemaVersionResponse {
|
|
2627
|
+
/**
|
|
2628
|
+
* <p>The id of the schema version.</p>
|
|
2629
|
+
* @public
|
|
2630
|
+
*/
|
|
2631
|
+
SchemaId?: string | undefined;
|
|
2632
|
+
/**
|
|
2633
|
+
* <p>The type of schema version.</p>
|
|
2634
|
+
* @public
|
|
2635
|
+
*/
|
|
2636
|
+
Type?: SchemaVersionType | undefined;
|
|
2637
|
+
/**
|
|
2638
|
+
* <p>The description of the schema version.</p>
|
|
2639
|
+
* @public
|
|
2640
|
+
*/
|
|
2641
|
+
Description?: string | undefined;
|
|
2642
|
+
/**
|
|
2643
|
+
* <p>The name of the schema version.</p>
|
|
2644
|
+
* @public
|
|
2645
|
+
*/
|
|
2646
|
+
Namespace?: string | undefined;
|
|
2647
|
+
/**
|
|
2648
|
+
* <p>The schema version. If this is left blank, it defaults to the latest version.</p>
|
|
2649
|
+
* @public
|
|
2650
|
+
*/
|
|
2651
|
+
SemanticVersion?: string | undefined;
|
|
2652
|
+
/**
|
|
2653
|
+
* <p>The visibility of the schema version.</p>
|
|
2654
|
+
* @public
|
|
2655
|
+
*/
|
|
2656
|
+
Visibility?: SchemaVersionVisibility | undefined;
|
|
2657
|
+
/**
|
|
2658
|
+
* <p>The schema of the schema version.</p>
|
|
2659
|
+
* @public
|
|
2660
|
+
*/
|
|
2661
|
+
Schema?: __DocumentType | undefined;
|
|
2662
|
+
}
|
|
2663
|
+
/**
|
|
2664
|
+
* @public
|
|
2665
|
+
*/
|
|
2666
|
+
export interface PutHubConfigurationRequest {
|
|
2667
|
+
/**
|
|
2668
|
+
* <p>A user-defined integer value that represents the hub token timer expiry setting in
|
|
2669
|
+
* seconds.</p>
|
|
2670
|
+
* @public
|
|
2671
|
+
*/
|
|
2672
|
+
HubTokenTimerExpirySettingInSeconds: number | undefined;
|
|
2673
|
+
}
|
|
2674
|
+
/**
|
|
2675
|
+
* @public
|
|
2676
|
+
*/
|
|
2677
|
+
export interface PutHubConfigurationResponse {
|
|
2678
|
+
/**
|
|
2679
|
+
* <p>A user-defined integer value that represents the hub token timer expiry setting in
|
|
2680
|
+
* seconds.</p>
|
|
2681
|
+
* @public
|
|
2682
|
+
*/
|
|
2683
|
+
HubTokenTimerExpirySettingInSeconds?: number | undefined;
|
|
2684
|
+
}
|
|
2685
|
+
/**
|
|
2686
|
+
* @public
|
|
2687
|
+
*/
|
|
2688
|
+
export interface PutDefaultEncryptionConfigurationRequest {
|
|
2689
|
+
/**
|
|
2690
|
+
* <p>The type of encryption used for the encryption configuration.</p>
|
|
2691
|
+
* @public
|
|
2692
|
+
*/
|
|
2693
|
+
encryptionType: EncryptionType | undefined;
|
|
2694
|
+
/**
|
|
2695
|
+
* <p>The Key Amazon Resource Name (ARN) of the AWS KMS key used for KMS encryption if you use
|
|
2696
|
+
* <code>KMS_BASED_ENCRYPTION</code>.</p>
|
|
2697
|
+
* @public
|
|
2698
|
+
*/
|
|
2699
|
+
kmsKeyArn?: string | undefined;
|
|
2700
|
+
}
|
|
2701
|
+
/**
|
|
2702
|
+
* @public
|
|
2703
|
+
*/
|
|
2704
|
+
export interface PutDefaultEncryptionConfigurationResponse {
|
|
2705
|
+
/**
|
|
2706
|
+
* <p>Provides the status of the default encryption configuration for an Amazon Web Services account.</p>
|
|
2707
|
+
* @public
|
|
2708
|
+
*/
|
|
2709
|
+
configurationStatus: ConfigurationStatus | undefined;
|
|
2710
|
+
/**
|
|
2711
|
+
* <p>The type of encryption used for the encryption configuration.</p>
|
|
2712
|
+
* @public
|
|
2713
|
+
*/
|
|
2714
|
+
encryptionType: EncryptionType | undefined;
|
|
2715
|
+
/**
|
|
2716
|
+
* <p>The Key Amazon Resource Name (ARN) of the AWS KMS key used for KMS encryption if you use
|
|
2717
|
+
* <code>KMS_BASED_ENCRYPTION</code>.</p>
|
|
2718
|
+
* @public
|
|
2719
|
+
*/
|
|
2720
|
+
kmsKeyArn?: string | undefined;
|
|
2721
|
+
}
|
|
2722
|
+
/**
|
|
2723
|
+
* @public
|
|
2724
|
+
*/
|
|
2725
|
+
export interface SendManagedThingCommandRequest {
|
|
2726
|
+
/**
|
|
2727
|
+
* <p>The id of the device.</p>
|
|
2728
|
+
* @public
|
|
2729
|
+
*/
|
|
2730
|
+
ManagedThingId: string | undefined;
|
|
2731
|
+
/**
|
|
2732
|
+
* <p>The device endpoint.</p>
|
|
2733
|
+
* @public
|
|
2734
|
+
*/
|
|
2735
|
+
Endpoints: CommandEndpoint[] | undefined;
|
|
2736
|
+
/**
|
|
2737
|
+
* <p>The ID tracking the current discovery process for one connector association.</p>
|
|
2738
|
+
* @public
|
|
2739
|
+
*/
|
|
2740
|
+
ConnectorAssociationId?: string | undefined;
|
|
2741
|
+
}
|
|
2742
|
+
/**
|
|
2743
|
+
* @public
|
|
2744
|
+
*/
|
|
2745
|
+
export interface SendManagedThingCommandResponse {
|
|
2746
|
+
/**
|
|
2747
|
+
* <p>The trace request identifier. This is specified by the device owner, but will be
|
|
2748
|
+
* generated by IoT managed integrations if not provided by the device owner.</p>
|
|
2749
|
+
* @public
|
|
2750
|
+
*/
|
|
2751
|
+
TraceId?: string | undefined;
|
|
2752
|
+
}
|
|
2753
|
+
/**
|
|
2754
|
+
* @public
|
|
2755
|
+
*/
|
|
2756
|
+
export interface ListManagedThingsRequest {
|
|
2757
|
+
/**
|
|
2758
|
+
* <p>Filter on device owners when listing managed things.</p>
|
|
2759
|
+
* @public
|
|
2760
|
+
*/
|
|
2761
|
+
OwnerFilter?: string | undefined;
|
|
2762
|
+
/**
|
|
2763
|
+
* <p>Filter on a credential locker for a managed thing.</p>
|
|
2764
|
+
* @public
|
|
2765
|
+
*/
|
|
2766
|
+
CredentialLockerFilter?: string | undefined;
|
|
2767
|
+
/**
|
|
2768
|
+
* <p>Filter on the type of device used. This will be the Amazon Web Services hub controller, cloud device,
|
|
2769
|
+
* or IoT device.</p>
|
|
2770
|
+
* @public
|
|
2771
|
+
*/
|
|
2772
|
+
RoleFilter?: Role | undefined;
|
|
2773
|
+
/**
|
|
2774
|
+
* <p>Filter on a parent controller id for a managed thing.</p>
|
|
2775
|
+
* @public
|
|
2776
|
+
*/
|
|
2777
|
+
ParentControllerIdentifierFilter?: string | undefined;
|
|
2778
|
+
/**
|
|
2779
|
+
* <p>Filter on a connector policy id for a managed thing.</p>
|
|
2780
|
+
* @public
|
|
2781
|
+
*/
|
|
2782
|
+
ConnectorPolicyIdFilter?: string | undefined;
|
|
2783
|
+
/**
|
|
2784
|
+
* <p>Filter on the serial number of the device.</p>
|
|
2785
|
+
* @public
|
|
2786
|
+
*/
|
|
2787
|
+
SerialNumberFilter?: string | undefined;
|
|
2788
|
+
/**
|
|
2789
|
+
* <p>Filter on the status of the device.</p>
|
|
2790
|
+
* @public
|
|
2791
|
+
*/
|
|
2792
|
+
ProvisioningStatusFilter?: ProvisioningStatus | undefined;
|
|
2793
|
+
/**
|
|
2794
|
+
* <p>A token that can be used to retrieve the next set of results.</p>
|
|
2795
|
+
* @public
|
|
2796
|
+
*/
|
|
2797
|
+
NextToken?: string | undefined;
|
|
2798
|
+
/**
|
|
2799
|
+
* <p>The maximum number of results to return at one time.</p>
|
|
2800
|
+
* @public
|
|
2801
|
+
*/
|
|
2802
|
+
MaxResults?: number | undefined;
|
|
2803
|
+
}
|
|
2804
|
+
/**
|
|
2805
|
+
* <p>Structure representing one managed thing.</p>
|
|
2806
|
+
* @public
|
|
2807
|
+
*/
|
|
2808
|
+
export interface ManagedThingSummary {
|
|
2809
|
+
/**
|
|
2810
|
+
* <p>The id of the device.</p>
|
|
2811
|
+
* @public
|
|
2812
|
+
*/
|
|
2813
|
+
Id?: string | undefined;
|
|
2814
|
+
/**
|
|
2815
|
+
* <p>The Amazon Resource Name (ARN) of the managed thing.</p>
|
|
2816
|
+
* @public
|
|
2817
|
+
*/
|
|
2818
|
+
Arn?: string | undefined;
|
|
2819
|
+
/**
|
|
2820
|
+
* <p>The id of the advertised product.</p>
|
|
2821
|
+
* @public
|
|
2822
|
+
*/
|
|
2823
|
+
AdvertisedProductId?: string | undefined;
|
|
2824
|
+
/**
|
|
2825
|
+
* <p>The brand of the device.</p>
|
|
2826
|
+
* @public
|
|
2827
|
+
*/
|
|
2828
|
+
Brand?: string | undefined;
|
|
2829
|
+
/**
|
|
2830
|
+
* <p>The classification of the managed thing such as light bulb or thermostat.</p>
|
|
2831
|
+
* @public
|
|
2832
|
+
*/
|
|
2833
|
+
Classification?: string | undefined;
|
|
2834
|
+
/**
|
|
2835
|
+
* <p>The third-party device id as defined by the connector. This device id must not contain
|
|
2836
|
+
* personal identifiable information (PII).</p>
|
|
2837
|
+
* <note>
|
|
2838
|
+
* <p>This parameter is used for cloud-to-cloud devices only.</p>
|
|
2839
|
+
* </note>
|
|
2840
|
+
* @public
|
|
2841
|
+
*/
|
|
2842
|
+
ConnectorDeviceId?: string | undefined;
|
|
2843
|
+
/**
|
|
2844
|
+
* <p>The id of the connector policy.</p>
|
|
2845
|
+
* <note>
|
|
2846
|
+
* <p>This parameter is used for cloud-to-cloud devices only.</p>
|
|
2847
|
+
* </note>
|
|
2848
|
+
* @public
|
|
2849
|
+
*/
|
|
2850
|
+
ConnectorPolicyId?: string | undefined;
|
|
2851
|
+
/**
|
|
2852
|
+
* <p>The model of the device.</p>
|
|
2853
|
+
* @public
|
|
2854
|
+
*/
|
|
2855
|
+
Model?: string | undefined;
|
|
2856
|
+
/**
|
|
2857
|
+
* <p>The name of the managed thing representing the physical device.</p>
|
|
2858
|
+
* @public
|
|
2859
|
+
*/
|
|
2860
|
+
Name?: string | undefined;
|
|
2861
|
+
/**
|
|
2862
|
+
* <p>Owner of the device, usually an indication of whom the device belongs to. This value
|
|
2863
|
+
* should not contain personal identifiable information.</p>
|
|
2864
|
+
* @public
|
|
2865
|
+
*/
|
|
2866
|
+
Owner?: string | undefined;
|
|
2867
|
+
/**
|
|
2868
|
+
* <p>The identifier of the credential locker for the managed thing.</p>
|
|
2869
|
+
* @public
|
|
2870
|
+
*/
|
|
2871
|
+
CredentialLockerId?: string | undefined;
|
|
2872
|
+
/**
|
|
2873
|
+
* <p>Id of the controller device used for the discovery job.</p>
|
|
2874
|
+
* @public
|
|
2875
|
+
*/
|
|
2876
|
+
ParentControllerId?: string | undefined;
|
|
2877
|
+
/**
|
|
2878
|
+
* <p>The provisioning status of the device in the provisioning workflow for onboarding to
|
|
2879
|
+
* IoT managed integrations.</p>
|
|
2880
|
+
* @public
|
|
2881
|
+
*/
|
|
2882
|
+
ProvisioningStatus?: ProvisioningStatus | undefined;
|
|
2883
|
+
/**
|
|
2884
|
+
* <p>The type of device used. This will be the Amazon Web Services hub controller, cloud device, or IoT
|
|
2885
|
+
* device.</p>
|
|
2886
|
+
* @public
|
|
2887
|
+
*/
|
|
2888
|
+
Role?: Role | undefined;
|
|
2889
|
+
/**
|
|
2890
|
+
* <p>The serial number of the device.</p>
|
|
2891
|
+
* @public
|
|
2892
|
+
*/
|
|
2893
|
+
SerialNumber?: string | undefined;
|
|
2894
|
+
/**
|
|
2895
|
+
* <p>The timestamp value of when the device creation request occurred.</p>
|
|
2896
|
+
* @public
|
|
2897
|
+
*/
|
|
2898
|
+
CreatedAt?: Date | undefined;
|
|
2899
|
+
/**
|
|
2900
|
+
* <p>The timestamp value of when the managed thing was last updated at.</p>
|
|
2901
|
+
* @public
|
|
2902
|
+
*/
|
|
2903
|
+
UpdatedAt?: Date | undefined;
|
|
2904
|
+
/**
|
|
2905
|
+
* <p>The timestampe value of when the managed thing was activated at.</p>
|
|
2906
|
+
* @public
|
|
2907
|
+
*/
|
|
2908
|
+
ActivatedAt?: Date | undefined;
|
|
2909
|
+
}
|
|
2910
|
+
/**
|
|
2911
|
+
* @public
|
|
2912
|
+
*/
|
|
2913
|
+
export interface ListManagedThingsResponse {
|
|
2914
|
+
/**
|
|
2915
|
+
* <p>The list of managed things.</p>
|
|
2916
|
+
* @public
|
|
2917
|
+
*/
|
|
2918
|
+
Items?: ManagedThingSummary[] | undefined;
|
|
2919
|
+
/**
|
|
2920
|
+
* <p>A token that can be used to retrieve the next set of results.</p>
|
|
2921
|
+
* @public
|
|
2922
|
+
*/
|
|
2923
|
+
NextToken?: string | undefined;
|
|
2924
|
+
}
|
|
2925
|
+
/**
|
|
2926
|
+
* @public
|
|
2927
|
+
*/
|
|
2928
|
+
export interface ListManagedThingSchemasRequest {
|
|
2929
|
+
/**
|
|
2930
|
+
* <p>The managed thing id.</p>
|
|
2931
|
+
* @public
|
|
2932
|
+
*/
|
|
2933
|
+
Identifier: string | undefined;
|
|
2934
|
+
/**
|
|
2935
|
+
* <p>Filter on an endpoint id.</p>
|
|
2936
|
+
* @public
|
|
2937
|
+
*/
|
|
2938
|
+
EndpointIdFilter?: string | undefined;
|
|
2939
|
+
/**
|
|
2940
|
+
* <p>Filter on a capability id.</p>
|
|
2941
|
+
* @public
|
|
2942
|
+
*/
|
|
2943
|
+
CapabilityIdFilter?: string | undefined;
|
|
2944
|
+
/**
|
|
2945
|
+
* <p>A token that can be used to retrieve the next set of results.</p>
|
|
2946
|
+
* @public
|
|
2947
|
+
*/
|
|
2948
|
+
NextToken?: string | undefined;
|
|
2949
|
+
/**
|
|
2950
|
+
* <p>The maximum number of results to return at one time.</p>
|
|
2951
|
+
* @public
|
|
2952
|
+
*/
|
|
2953
|
+
MaxResults?: number | undefined;
|
|
2954
|
+
}
|
|
2955
|
+
/**
|
|
2956
|
+
* <p>Structure representing one schema item associated with a managed thing.</p>
|
|
2957
|
+
* @public
|
|
2958
|
+
*/
|
|
2959
|
+
export interface ManagedThingSchemaListItem {
|
|
2960
|
+
/**
|
|
2961
|
+
* <p>The id of the endpoint for a managed thing.</p>
|
|
2962
|
+
* @public
|
|
2963
|
+
*/
|
|
2964
|
+
EndpointId?: string | undefined;
|
|
2965
|
+
/**
|
|
2966
|
+
* <p>The id of the capability for a managed thing.</p>
|
|
2967
|
+
* @public
|
|
2968
|
+
*/
|
|
2969
|
+
CapabilityId?: string | undefined;
|
|
2970
|
+
/**
|
|
2971
|
+
* <p>The validation schema for one schema item associated with a managed thing.</p>
|
|
2972
|
+
* @public
|
|
2973
|
+
*/
|
|
2974
|
+
Schema?: __DocumentType | undefined;
|
|
2975
|
+
}
|
|
2976
|
+
/**
|
|
2977
|
+
* @public
|
|
2978
|
+
*/
|
|
2979
|
+
export interface ListManagedThingSchemasResponse {
|
|
2980
|
+
/**
|
|
2981
|
+
* <p>The list of managed thing schemas.</p>
|
|
2982
|
+
* @public
|
|
2983
|
+
*/
|
|
2984
|
+
Items?: ManagedThingSchemaListItem[] | undefined;
|
|
2985
|
+
/**
|
|
2986
|
+
* <p>A token that can be used to retrieve the next set of results.</p>
|
|
2987
|
+
* @public
|
|
2988
|
+
*/
|
|
2989
|
+
NextToken?: string | undefined;
|
|
2990
|
+
}
|
|
2991
|
+
/**
|
|
2992
|
+
* @public
|
|
2993
|
+
*/
|
|
2994
|
+
export interface UpdateManagedThingRequest {
|
|
2995
|
+
/**
|
|
2996
|
+
* <p>The id of the managed thing.</p>
|
|
2997
|
+
* @public
|
|
2998
|
+
*/
|
|
2999
|
+
Identifier: string | undefined;
|
|
3000
|
+
/**
|
|
3001
|
+
* <p>Owner of the device, usually an indication of whom the device belongs to. This value
|
|
3002
|
+
* should not contain personal identifiable information.</p>
|
|
3003
|
+
* @public
|
|
3004
|
+
*/
|
|
3005
|
+
Owner?: string | undefined;
|
|
3006
|
+
/**
|
|
3007
|
+
* <p>The identifier of the credential for the managed thing.</p>
|
|
3008
|
+
* @public
|
|
3009
|
+
*/
|
|
3010
|
+
CredentialLockerId?: string | undefined;
|
|
3011
|
+
/**
|
|
3012
|
+
* <p>The serial number of the device.</p>
|
|
3013
|
+
* @public
|
|
3014
|
+
*/
|
|
3015
|
+
SerialNumber?: string | undefined;
|
|
3016
|
+
/**
|
|
3017
|
+
* <p>The brand of the device.</p>
|
|
3018
|
+
* @public
|
|
3019
|
+
*/
|
|
3020
|
+
Brand?: string | undefined;
|
|
3021
|
+
/**
|
|
3022
|
+
* <p>The model of the device.</p>
|
|
3023
|
+
* @public
|
|
3024
|
+
*/
|
|
3025
|
+
Model?: string | undefined;
|
|
3026
|
+
/**
|
|
3027
|
+
* <p>The name of the managed thing representing the physical device.</p>
|
|
3028
|
+
* @public
|
|
3029
|
+
*/
|
|
3030
|
+
Name?: string | undefined;
|
|
3031
|
+
/**
|
|
3032
|
+
* <p>A report of the capabilities for the managed thing.</p>
|
|
3033
|
+
* @public
|
|
3034
|
+
*/
|
|
3035
|
+
CapabilityReport?: CapabilityReport | undefined;
|
|
3036
|
+
/**
|
|
3037
|
+
* <p>The capabilities of the device such as light bulb.</p>
|
|
3038
|
+
* @public
|
|
3039
|
+
*/
|
|
3040
|
+
Capabilities?: string | undefined;
|
|
3041
|
+
/**
|
|
3042
|
+
* <p>The classification of the managed thing such as light bulb or thermostat.</p>
|
|
3043
|
+
* @public
|
|
3044
|
+
*/
|
|
3045
|
+
Classification?: string | undefined;
|
|
3046
|
+
/**
|
|
3047
|
+
* <p>The network mode for the hub-connected device.</p>
|
|
3048
|
+
* @public
|
|
3049
|
+
*/
|
|
3050
|
+
HubNetworkMode?: HubNetworkMode | undefined;
|
|
3051
|
+
/**
|
|
3052
|
+
* <p>The metadata for the managed thing.</p>
|
|
3053
|
+
* @public
|
|
3054
|
+
*/
|
|
3055
|
+
MetaData?: Record<string, string> | undefined;
|
|
3056
|
+
}
|
|
3057
|
+
/**
|
|
3058
|
+
* @public
|
|
3059
|
+
*/
|
|
3060
|
+
export interface ListNotificationConfigurationsRequest {
|
|
3061
|
+
/**
|
|
3062
|
+
* <p>The maximum number of results to return at one time.</p>
|
|
3063
|
+
* @public
|
|
3064
|
+
*/
|
|
3065
|
+
MaxResults?: number | undefined;
|
|
3066
|
+
/**
|
|
3067
|
+
* <p>A token that can be used to retrieve the next set of results.</p>
|
|
3068
|
+
* @public
|
|
3069
|
+
*/
|
|
3070
|
+
NextToken?: string | undefined;
|
|
3071
|
+
}
|
|
3072
|
+
/**
|
|
3073
|
+
* <p>Structure describing a notification configuration.</p>
|
|
3074
|
+
* @public
|
|
3075
|
+
*/
|
|
3076
|
+
export interface NotificationConfigurationSummary {
|
|
3077
|
+
/**
|
|
3078
|
+
* <p>The type of event triggering a device notification to the customer-managed
|
|
3079
|
+
* destination.</p>
|
|
3080
|
+
* @public
|
|
3081
|
+
*/
|
|
3082
|
+
EventType?: EventType | undefined;
|
|
3083
|
+
/**
|
|
3084
|
+
* <p>The name of the destination for the notification configuration.</p>
|
|
3085
|
+
* @public
|
|
3086
|
+
*/
|
|
3087
|
+
DestinationName?: string | undefined;
|
|
3088
|
+
}
|
|
3089
|
+
/**
|
|
3090
|
+
* @public
|
|
3091
|
+
*/
|
|
3092
|
+
export interface ListNotificationConfigurationsResponse {
|
|
3093
|
+
/**
|
|
3094
|
+
* <p>The list of notification configurations.</p>
|
|
3095
|
+
* @public
|
|
3096
|
+
*/
|
|
3097
|
+
NotificationConfigurationList?: NotificationConfigurationSummary[] | undefined;
|
|
3098
|
+
/**
|
|
3099
|
+
* <p>A token that can be used to retrieve the next set of results.</p>
|
|
3100
|
+
* @public
|
|
3101
|
+
*/
|
|
3102
|
+
NextToken?: string | undefined;
|
|
3103
|
+
}
|
|
3104
|
+
/**
|
|
3105
|
+
* @public
|
|
3106
|
+
*/
|
|
3107
|
+
export interface UpdateNotificationConfigurationRequest {
|
|
3108
|
+
/**
|
|
3109
|
+
* <p>The type of event triggering a device notification to the customer-managed
|
|
3110
|
+
* destination.</p>
|
|
3111
|
+
* @public
|
|
3112
|
+
*/
|
|
3113
|
+
EventType: EventType | undefined;
|
|
3114
|
+
/**
|
|
3115
|
+
* <p>The name of the destination for the notification configuration.</p>
|
|
3116
|
+
* @public
|
|
3117
|
+
*/
|
|
3118
|
+
DestinationName: string | undefined;
|
|
3119
|
+
}
|
|
3120
|
+
/**
|
|
3121
|
+
* @public
|
|
3122
|
+
*/
|
|
3123
|
+
export interface ListOtaTaskConfigurationsRequest {
|
|
3124
|
+
/**
|
|
3125
|
+
* <p>A token that can be used to retrieve the next set of results.</p>
|
|
3126
|
+
* @public
|
|
3127
|
+
*/
|
|
3128
|
+
NextToken?: string | undefined;
|
|
3129
|
+
/**
|
|
3130
|
+
* <p>The maximum number of results to return at one time.</p>
|
|
3131
|
+
* @public
|
|
3132
|
+
*/
|
|
3133
|
+
MaxResults?: number | undefined;
|
|
3134
|
+
}
|
|
3135
|
+
/**
|
|
3136
|
+
* <p>Structure representing one over-the-air (OTA) task configuration.</p>
|
|
3137
|
+
* @public
|
|
3138
|
+
*/
|
|
3139
|
+
export interface OtaTaskConfigurationSummary {
|
|
3140
|
+
/**
|
|
3141
|
+
* <p>The id of the over-the-air (OTA) task configuration</p>
|
|
3142
|
+
* @public
|
|
3143
|
+
*/
|
|
3144
|
+
TaskConfigurationId?: string | undefined;
|
|
3145
|
+
/**
|
|
3146
|
+
* <p>The name of the over-the-air (OTA) task configuration.</p>
|
|
3147
|
+
* @public
|
|
3148
|
+
*/
|
|
3149
|
+
Name?: string | undefined;
|
|
3150
|
+
/**
|
|
3151
|
+
* <p>The timestamp value of when the over-the-air (OTA) task configuration was created
|
|
3152
|
+
* at.</p>
|
|
3153
|
+
* @public
|
|
3154
|
+
*/
|
|
3155
|
+
CreatedAt?: Date | undefined;
|
|
3156
|
+
}
|
|
3157
|
+
/**
|
|
3158
|
+
* @public
|
|
3159
|
+
*/
|
|
3160
|
+
export interface ListOtaTaskConfigurationsResponse {
|
|
3161
|
+
/**
|
|
3162
|
+
* <p>The list of the over-the-air (OTA) task configurations.</p>
|
|
3163
|
+
* @public
|
|
3164
|
+
*/
|
|
3165
|
+
Items?: OtaTaskConfigurationSummary[] | undefined;
|
|
3166
|
+
/**
|
|
3167
|
+
* <p>A token that can be used to retrieve the next set of results.</p>
|
|
3168
|
+
* @public
|
|
3169
|
+
*/
|
|
3170
|
+
NextToken?: string | undefined;
|
|
3171
|
+
}
|
|
3172
|
+
/**
|
|
3173
|
+
* @public
|
|
3174
|
+
*/
|
|
3175
|
+
export interface ListOtaTaskExecutionsRequest {
|
|
3176
|
+
/**
|
|
3177
|
+
* <p>The over-the-air (OTA) task id.</p>
|
|
3178
|
+
* @public
|
|
3179
|
+
*/
|
|
3180
|
+
Identifier: string | undefined;
|
|
3181
|
+
/**
|
|
3182
|
+
* <p>A token that can be used to retrieve the next set of results.</p>
|
|
3183
|
+
* @public
|
|
3184
|
+
*/
|
|
3185
|
+
NextToken?: string | undefined;
|
|
3186
|
+
/**
|
|
3187
|
+
* <p>The maximum number of results to return at one time.</p>
|
|
3188
|
+
* @public
|
|
3189
|
+
*/
|
|
3190
|
+
MaxResults?: number | undefined;
|
|
3191
|
+
}
|
|
3192
|
+
/**
|
|
3193
|
+
* @public
|
|
3194
|
+
* @enum
|
|
3195
|
+
*/
|
|
3196
|
+
export declare const OtaTaskExecutionStatus: {
|
|
3197
|
+
readonly CANCELED: "CANCELED";
|
|
3198
|
+
readonly FAILED: "FAILED";
|
|
3199
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
3200
|
+
readonly QUEUED: "QUEUED";
|
|
3201
|
+
readonly REJECTED: "REJECTED";
|
|
3202
|
+
readonly REMOVED: "REMOVED";
|
|
3203
|
+
readonly SUCCEEDED: "SUCCEEDED";
|
|
3204
|
+
readonly TIMED_OUT: "TIMED_OUT";
|
|
3205
|
+
};
|
|
3206
|
+
/**
|
|
3207
|
+
* @public
|
|
3208
|
+
*/
|
|
3209
|
+
export type OtaTaskExecutionStatus = (typeof OtaTaskExecutionStatus)[keyof typeof OtaTaskExecutionStatus];
|
|
3210
|
+
/**
|
|
3211
|
+
* <p>Structure representing one over-the-air (OTA) task execution summary.</p>
|
|
3212
|
+
* @public
|
|
3213
|
+
*/
|
|
3214
|
+
export interface OtaTaskExecutionSummary {
|
|
3215
|
+
/**
|
|
3216
|
+
* <p>The execution number of the over-the-air (OTA) task execution summary.</p>
|
|
3217
|
+
* @public
|
|
3218
|
+
*/
|
|
3219
|
+
ExecutionNumber?: number | undefined;
|
|
3220
|
+
/**
|
|
3221
|
+
* <p>The timestamp value of when the over-the-air (OTA) task execution summary was last
|
|
3222
|
+
* updated.</p>
|
|
3223
|
+
* @public
|
|
3224
|
+
*/
|
|
3225
|
+
LastUpdatedAt?: Date | undefined;
|
|
3226
|
+
/**
|
|
3227
|
+
* <p>The timestamp value of when the over-the-air (OTA) task execution summary is targeted to
|
|
3228
|
+
* start.</p>
|
|
3229
|
+
* @public
|
|
3230
|
+
*/
|
|
3231
|
+
QueuedAt?: Date | undefined;
|
|
3232
|
+
/**
|
|
3233
|
+
* <p>The number of retry attempts for starting the over-the-air (OTA) task execution summary
|
|
3234
|
+
* after a failed attempt.</p>
|
|
3235
|
+
* @public
|
|
3236
|
+
*/
|
|
3237
|
+
RetryAttempt?: number | undefined;
|
|
3238
|
+
/**
|
|
3239
|
+
* <p>The timestamp value of when the over-the-air (OTA) task execution summary
|
|
3240
|
+
* started.</p>
|
|
3241
|
+
* @public
|
|
3242
|
+
*/
|
|
3243
|
+
StartedAt?: Date | undefined;
|
|
3244
|
+
/**
|
|
3245
|
+
* <p>The status of the over-the-air (OTA) task execution summary.</p>
|
|
3246
|
+
* @public
|
|
3247
|
+
*/
|
|
3248
|
+
Status?: OtaTaskExecutionStatus | undefined;
|
|
3249
|
+
}
|
|
3250
|
+
/**
|
|
3251
|
+
* <p>Structure representing one execution summary.</p>
|
|
3252
|
+
* @public
|
|
3253
|
+
*/
|
|
3254
|
+
export interface OtaTaskExecutionSummaries {
|
|
3255
|
+
/**
|
|
3256
|
+
* <p>Structure representing one over-the-air (OTA) task execution summary</p>
|
|
3257
|
+
* @public
|
|
3258
|
+
*/
|
|
3259
|
+
TaskExecutionSummary?: OtaTaskExecutionSummary | undefined;
|
|
3260
|
+
/**
|
|
3261
|
+
* <p>The id of a managed thing.</p>
|
|
3262
|
+
* @public
|
|
3263
|
+
*/
|
|
3264
|
+
ManagedThingId?: string | undefined;
|
|
3265
|
+
}
|
|
3266
|
+
/**
|
|
3267
|
+
* @public
|
|
3268
|
+
*/
|
|
3269
|
+
export interface ListOtaTaskExecutionsResponse {
|
|
3270
|
+
/**
|
|
3271
|
+
* <p>A list of all of the over-the-air (OTA) task executions.</p>
|
|
3272
|
+
* @public
|
|
3273
|
+
*/
|
|
3274
|
+
ExecutionSummaries?: OtaTaskExecutionSummaries[] | undefined;
|
|
3275
|
+
/**
|
|
3276
|
+
* <p>A token that can be used to retrieve the next set of results.</p>
|
|
3277
|
+
* @public
|
|
3278
|
+
*/
|
|
3279
|
+
NextToken?: string | undefined;
|
|
3280
|
+
}
|
|
3281
|
+
/**
|
|
3282
|
+
* @public
|
|
3283
|
+
*/
|
|
3284
|
+
export interface ListOtaTasksRequest {
|
|
3285
|
+
/**
|
|
3286
|
+
* <p>A token that can be used to retrieve the next set of results.</p>
|
|
3287
|
+
* @public
|
|
3288
|
+
*/
|
|
3289
|
+
NextToken?: string | undefined;
|
|
3290
|
+
/**
|
|
3291
|
+
* <p>The maximum number of results to return at one time.</p>
|
|
3292
|
+
* @public
|
|
3293
|
+
*/
|
|
3294
|
+
MaxResults?: number | undefined;
|
|
3295
|
+
}
|
|
3296
|
+
/**
|
|
3297
|
+
* <p>Structure representing one over-the-air (OTA) task.</p>
|
|
3298
|
+
* @public
|
|
3299
|
+
*/
|
|
3300
|
+
export interface OtaTaskSummary {
|
|
3301
|
+
/**
|
|
3302
|
+
* <p>The id of the over-the-air (OTA) task.</p>
|
|
3303
|
+
* @public
|
|
3304
|
+
*/
|
|
3305
|
+
TaskId?: string | undefined;
|
|
3306
|
+
/**
|
|
3307
|
+
* <p>The Amazon Resource Name (ARN) of the over-the-air (OTA) task.</p>
|
|
3308
|
+
* @public
|
|
3309
|
+
*/
|
|
3310
|
+
TaskArn?: string | undefined;
|
|
3311
|
+
/**
|
|
3312
|
+
* <p>The timestamp value of when the over-the-air (OTA) task was created at.</p>
|
|
3313
|
+
* @public
|
|
3314
|
+
*/
|
|
3315
|
+
CreatedAt?: Date | undefined;
|
|
3316
|
+
/**
|
|
3317
|
+
* <p>The timestamp value of when the over-the-air (OTA) task was last updated at.</p>
|
|
3318
|
+
* @public
|
|
3319
|
+
*/
|
|
3320
|
+
LastUpdatedAt?: Date | undefined;
|
|
3321
|
+
/**
|
|
3322
|
+
* <p>The identifier for the over-the-air (OTA) task configuration.</p>
|
|
3323
|
+
* @public
|
|
3324
|
+
*/
|
|
3325
|
+
TaskConfigurationId?: string | undefined;
|
|
3326
|
+
/**
|
|
3327
|
+
* <p>The status of the over-the-air (OTA) task summary.</p>
|
|
3328
|
+
* @public
|
|
3329
|
+
*/
|
|
3330
|
+
Status?: OtaStatus | undefined;
|
|
3331
|
+
}
|
|
3332
|
+
/**
|
|
3333
|
+
* @public
|
|
3334
|
+
*/
|
|
3335
|
+
export interface ListOtaTasksResponse {
|
|
3336
|
+
/**
|
|
3337
|
+
* <p>A list of all of the over-the-air (OTA) tasks.</p>
|
|
3338
|
+
* @public
|
|
3339
|
+
*/
|
|
3340
|
+
Tasks?: OtaTaskSummary[] | undefined;
|
|
3341
|
+
/**
|
|
3342
|
+
* <p>A token that can be used to retrieve the next set of results.</p>
|
|
3343
|
+
* @public
|
|
3344
|
+
*/
|
|
3345
|
+
NextToken?: string | undefined;
|
|
3346
|
+
}
|
|
3347
|
+
/**
|
|
3348
|
+
* @public
|
|
3349
|
+
*/
|
|
3350
|
+
export interface UpdateOtaTaskRequest {
|
|
3351
|
+
/**
|
|
3352
|
+
* <p>The over-the-air (OTA) task id.</p>
|
|
3353
|
+
* @public
|
|
3354
|
+
*/
|
|
3355
|
+
Identifier: string | undefined;
|
|
3356
|
+
/**
|
|
3357
|
+
* <p>The description of the over-the-air (OTA) task.</p>
|
|
3358
|
+
* @public
|
|
3359
|
+
*/
|
|
3360
|
+
Description?: string | undefined;
|
|
3361
|
+
/**
|
|
3362
|
+
* <p>The identifier for the over-the-air (OTA) task configuration.</p>
|
|
3363
|
+
* @public
|
|
3364
|
+
*/
|
|
3365
|
+
TaskConfigurationId?: string | undefined;
|
|
3366
|
+
}
|
|
3367
|
+
/**
|
|
3368
|
+
* @public
|
|
3369
|
+
*/
|
|
3370
|
+
export interface ListProvisioningProfilesRequest {
|
|
3371
|
+
/**
|
|
3372
|
+
* <p>A token that can be used to retrieve the next set of results.</p>
|
|
3373
|
+
* @public
|
|
3374
|
+
*/
|
|
3375
|
+
NextToken?: string | undefined;
|
|
3376
|
+
/**
|
|
3377
|
+
* <p>The maximum number of results to return at one time.</p>
|
|
3378
|
+
* @public
|
|
3379
|
+
*/
|
|
3380
|
+
MaxResults?: number | undefined;
|
|
3381
|
+
}
|
|
3382
|
+
/**
|
|
3383
|
+
* <p>Structure describing a provisioning profile. </p>
|
|
3384
|
+
* @public
|
|
3385
|
+
*/
|
|
3386
|
+
export interface ProvisioningProfileSummary {
|
|
3387
|
+
/**
|
|
3388
|
+
* <p>The name of the provisioning template.</p>
|
|
3389
|
+
* @public
|
|
3390
|
+
*/
|
|
3391
|
+
Name?: string | undefined;
|
|
3392
|
+
/**
|
|
3393
|
+
* <p>The identifier of the provisioning profile.</p>
|
|
3394
|
+
* @public
|
|
3395
|
+
*/
|
|
3396
|
+
Id?: string | undefined;
|
|
3397
|
+
/**
|
|
3398
|
+
* <p>The Amazon Resource Name (ARN) of the provisioning template used in the provisioning
|
|
3399
|
+
* profile.</p>
|
|
3400
|
+
* @public
|
|
3401
|
+
*/
|
|
3402
|
+
Arn?: string | undefined;
|
|
3403
|
+
/**
|
|
3404
|
+
* <p>The type of provisioning workflow the device uses for onboarding to IoT managed integrations.</p>
|
|
3405
|
+
* @public
|
|
3406
|
+
*/
|
|
3407
|
+
ProvisioningType?: ProvisioningType | undefined;
|
|
3408
|
+
}
|
|
3409
|
+
/**
|
|
3410
|
+
* @public
|
|
3411
|
+
*/
|
|
3412
|
+
export interface ListProvisioningProfilesResponse {
|
|
3413
|
+
/**
|
|
3414
|
+
* <p>The list of provisioning profiles.</p>
|
|
3415
|
+
* @public
|
|
3416
|
+
*/
|
|
3417
|
+
Items?: ProvisioningProfileSummary[] | undefined;
|
|
3418
|
+
/**
|
|
3419
|
+
* <p>A token that can be used to retrieve the next set of results.</p>
|
|
3420
|
+
* @public
|
|
3421
|
+
*/
|
|
3422
|
+
NextToken?: string | undefined;
|
|
3423
|
+
}
|
|
3424
|
+
/**
|
|
3425
|
+
* @public
|
|
3426
|
+
*/
|
|
3427
|
+
export interface RegisterCustomEndpointRequest {
|
|
3428
|
+
}
|
|
3429
|
+
/**
|
|
3430
|
+
* @public
|
|
3431
|
+
*/
|
|
3432
|
+
export interface RegisterCustomEndpointResponse {
|
|
3433
|
+
/**
|
|
3434
|
+
* <p>The IoT managed integrations dedicated, custom endpoint for the device to route traffic through.</p>
|
|
3435
|
+
* @public
|
|
3436
|
+
*/
|
|
3437
|
+
EndpointAddress: string | undefined;
|
|
3438
|
+
}
|
|
3439
|
+
/**
|
|
3440
|
+
* @public
|
|
3441
|
+
*/
|
|
3442
|
+
export interface PutRuntimeLogConfigurationRequest {
|
|
3443
|
+
/**
|
|
3444
|
+
* <p>The id for a managed thing.</p>
|
|
3445
|
+
* @public
|
|
3446
|
+
*/
|
|
3447
|
+
ManagedThingId: string | undefined;
|
|
3448
|
+
/**
|
|
3449
|
+
* <p>The runtime log configuration for a managed thing.</p>
|
|
3450
|
+
* @public
|
|
3451
|
+
*/
|
|
3452
|
+
RuntimeLogConfigurations: RuntimeLogConfigurations | undefined;
|
|
3453
|
+
}
|
|
3454
|
+
/**
|
|
3455
|
+
* @public
|
|
3456
|
+
*/
|
|
3457
|
+
export interface ResetRuntimeLogConfigurationRequest {
|
|
3458
|
+
/**
|
|
3459
|
+
* <p>The id of a managed thing.</p>
|
|
3460
|
+
* @public
|
|
3461
|
+
*/
|
|
3462
|
+
ManagedThingId: string | undefined;
|
|
3463
|
+
}
|
|
3464
|
+
/**
|
|
3465
|
+
* @public
|
|
3466
|
+
*/
|
|
3467
|
+
export interface ListSchemaVersionsRequest {
|
|
3468
|
+
/**
|
|
3469
|
+
* <p>Filter on the type of schema version.</p>
|
|
3470
|
+
* @public
|
|
3471
|
+
*/
|
|
3472
|
+
Type: SchemaVersionType | undefined;
|
|
3473
|
+
/**
|
|
3474
|
+
* <p>The maximum number of results to return at one time.</p>
|
|
3475
|
+
* @public
|
|
3476
|
+
*/
|
|
3477
|
+
MaxResults?: number | undefined;
|
|
3478
|
+
/**
|
|
3479
|
+
* <p>A token that can be used to retrieve the next set of results.</p>
|
|
3480
|
+
* @public
|
|
3481
|
+
*/
|
|
3482
|
+
NextToken?: string | undefined;
|
|
3483
|
+
/**
|
|
3484
|
+
* <p>Filter on the id of the schema version.</p>
|
|
3485
|
+
* @public
|
|
3486
|
+
*/
|
|
3487
|
+
SchemaId?: string | undefined;
|
|
3488
|
+
/**
|
|
3489
|
+
* <p>Filter on the name of the schema version.</p>
|
|
3490
|
+
* @public
|
|
3491
|
+
*/
|
|
3492
|
+
Namespace?: string | undefined;
|
|
3493
|
+
/**
|
|
3494
|
+
* <p>The visibility of the schema version.</p>
|
|
3495
|
+
* @public
|
|
3496
|
+
*/
|
|
3497
|
+
Visibility?: SchemaVersionVisibility | undefined;
|
|
3498
|
+
/**
|
|
3499
|
+
* <p>The schema version. If this is left blank, it defaults to the latest version.</p>
|
|
3500
|
+
* @public
|
|
3501
|
+
*/
|
|
3502
|
+
SemanticVersion?: string | undefined;
|
|
3503
|
+
}
|
|
3504
|
+
/**
|
|
3505
|
+
* <p>List item describing a schema version.</p>
|
|
3506
|
+
* @public
|
|
3507
|
+
*/
|
|
3508
|
+
export interface SchemaVersionListItem {
|
|
3509
|
+
/**
|
|
3510
|
+
* <p>The identifier of the schema version.</p>
|
|
3511
|
+
* @public
|
|
3512
|
+
*/
|
|
3513
|
+
SchemaId?: string | undefined;
|
|
3514
|
+
/**
|
|
3515
|
+
* <p>The type of schema version.</p>
|
|
3516
|
+
* @public
|
|
3517
|
+
*/
|
|
3518
|
+
Type?: SchemaVersionType | undefined;
|
|
3519
|
+
/**
|
|
3520
|
+
* <p>A description of the schema version.</p>
|
|
3521
|
+
* @public
|
|
3522
|
+
*/
|
|
3523
|
+
Description?: string | undefined;
|
|
3524
|
+
/**
|
|
3525
|
+
* <p>The name of the schema version.</p>
|
|
3526
|
+
* @public
|
|
3527
|
+
*/
|
|
3528
|
+
Namespace?: string | undefined;
|
|
3529
|
+
/**
|
|
3530
|
+
* <p>The schema version. If this is left blank, it defaults to the latest version.</p>
|
|
3531
|
+
* @public
|
|
3532
|
+
*/
|
|
3533
|
+
SemanticVersion?: string | undefined;
|
|
3534
|
+
/**
|
|
3535
|
+
* <p>The visibility of the schema version.</p>
|
|
3536
|
+
* @public
|
|
3537
|
+
*/
|
|
3538
|
+
Visibility?: SchemaVersionVisibility | undefined;
|
|
3539
|
+
}
|
|
3540
|
+
/**
|
|
3541
|
+
* @public
|
|
3542
|
+
*/
|
|
3543
|
+
export interface ListSchemaVersionsResponse {
|
|
3544
|
+
/**
|
|
3545
|
+
* <p>The list of schema versions.</p>
|
|
3546
|
+
* @public
|
|
3547
|
+
*/
|
|
3548
|
+
Items?: SchemaVersionListItem[] | undefined;
|
|
3549
|
+
/**
|
|
3550
|
+
* <p>A token that can be used to retrieve the next set of results.</p>
|
|
3551
|
+
* @public
|
|
3552
|
+
*/
|
|
3553
|
+
NextToken?: string | undefined;
|
|
3554
|
+
}
|
|
3555
|
+
/**
|
|
3556
|
+
* @internal
|
|
3557
|
+
*/
|
|
3558
|
+
export declare const CapabilityActionFilterSensitiveLog: (obj: CapabilityAction) => any;
|
|
3559
|
+
/**
|
|
3560
|
+
* @internal
|
|
3561
|
+
*/
|
|
3562
|
+
export declare const CommandCapabilityFilterSensitiveLog: (obj: CommandCapability) => any;
|
|
3563
|
+
/**
|
|
3564
|
+
* @internal
|
|
3565
|
+
*/
|
|
3566
|
+
export declare const CommandEndpointFilterSensitiveLog: (obj: CommandEndpoint) => any;
|
|
3567
|
+
/**
|
|
3568
|
+
* @internal
|
|
3569
|
+
*/
|
|
3570
|
+
export declare const CreateCredentialLockerRequestFilterSensitiveLog: (obj: CreateCredentialLockerRequest) => any;
|
|
3571
|
+
/**
|
|
3572
|
+
* @internal
|
|
3573
|
+
*/
|
|
3574
|
+
export declare const CreateDestinationRequestFilterSensitiveLog: (obj: CreateDestinationRequest) => any;
|
|
3575
|
+
/**
|
|
3576
|
+
* @internal
|
|
3577
|
+
*/
|
|
3578
|
+
export declare const CreateManagedThingRequestFilterSensitiveLog: (obj: CreateManagedThingRequest) => any;
|
|
3579
|
+
/**
|
|
3580
|
+
* @internal
|
|
3581
|
+
*/
|
|
3582
|
+
export declare const CreateNotificationConfigurationRequestFilterSensitiveLog: (obj: CreateNotificationConfigurationRequest) => any;
|
|
3583
|
+
/**
|
|
3584
|
+
* @internal
|
|
3585
|
+
*/
|
|
3586
|
+
export declare const CreateOtaTaskRequestFilterSensitiveLog: (obj: CreateOtaTaskRequest) => any;
|
|
3587
|
+
/**
|
|
3588
|
+
* @internal
|
|
3589
|
+
*/
|
|
3590
|
+
export declare const CreateOtaTaskConfigurationRequestFilterSensitiveLog: (obj: CreateOtaTaskConfigurationRequest) => any;
|
|
3591
|
+
/**
|
|
3592
|
+
* @internal
|
|
3593
|
+
*/
|
|
3594
|
+
export declare const CreateProvisioningProfileRequestFilterSensitiveLog: (obj: CreateProvisioningProfileRequest) => any;
|
|
3595
|
+
/**
|
|
3596
|
+
* @internal
|
|
3597
|
+
*/
|
|
3598
|
+
export declare const CreateProvisioningProfileResponseFilterSensitiveLog: (obj: CreateProvisioningProfileResponse) => any;
|
|
3599
|
+
/**
|
|
3600
|
+
* @internal
|
|
3601
|
+
*/
|
|
3602
|
+
export declare const CredentialLockerSummaryFilterSensitiveLog: (obj: CredentialLockerSummary) => any;
|
|
3603
|
+
/**
|
|
3604
|
+
* @internal
|
|
3605
|
+
*/
|
|
3606
|
+
export declare const GetCredentialLockerResponseFilterSensitiveLog: (obj: GetCredentialLockerResponse) => any;
|
|
3607
|
+
/**
|
|
3608
|
+
* @internal
|
|
3609
|
+
*/
|
|
3610
|
+
export declare const ListCredentialLockersResponseFilterSensitiveLog: (obj: ListCredentialLockersResponse) => any;
|
|
3611
|
+
/**
|
|
3612
|
+
* @internal
|
|
3613
|
+
*/
|
|
3614
|
+
export declare const GetDestinationResponseFilterSensitiveLog: (obj: GetDestinationResponse) => any;
|
|
3615
|
+
/**
|
|
3616
|
+
* @internal
|
|
3617
|
+
*/
|
|
3618
|
+
export declare const GetDeviceDiscoveryResponseFilterSensitiveLog: (obj: GetDeviceDiscoveryResponse) => any;
|
|
3619
|
+
/**
|
|
3620
|
+
* @internal
|
|
3621
|
+
*/
|
|
3622
|
+
export declare const StartDeviceDiscoveryRequestFilterSensitiveLog: (obj: StartDeviceDiscoveryRequest) => any;
|
|
3623
|
+
/**
|
|
3624
|
+
* @internal
|
|
3625
|
+
*/
|
|
3626
|
+
export declare const GetManagedThingResponseFilterSensitiveLog: (obj: GetManagedThingResponse) => any;
|
|
3627
|
+
/**
|
|
3628
|
+
* @internal
|
|
3629
|
+
*/
|
|
3630
|
+
export declare const StateCapabilityFilterSensitiveLog: (obj: StateCapability) => any;
|
|
3631
|
+
/**
|
|
3632
|
+
* @internal
|
|
3633
|
+
*/
|
|
3634
|
+
export declare const StateEndpointFilterSensitiveLog: (obj: StateEndpoint) => any;
|
|
3635
|
+
/**
|
|
3636
|
+
* @internal
|
|
3637
|
+
*/
|
|
3638
|
+
export declare const GetManagedThingStateResponseFilterSensitiveLog: (obj: GetManagedThingStateResponse) => any;
|
|
3639
|
+
/**
|
|
3640
|
+
* @internal
|
|
3641
|
+
*/
|
|
3642
|
+
export declare const GetNotificationConfigurationResponseFilterSensitiveLog: (obj: GetNotificationConfigurationResponse) => any;
|
|
3643
|
+
/**
|
|
3644
|
+
* @internal
|
|
3645
|
+
*/
|
|
3646
|
+
export declare const GetOtaTaskConfigurationResponseFilterSensitiveLog: (obj: GetOtaTaskConfigurationResponse) => any;
|
|
3647
|
+
/**
|
|
3648
|
+
* @internal
|
|
3649
|
+
*/
|
|
3650
|
+
export declare const GetProvisioningProfileResponseFilterSensitiveLog: (obj: GetProvisioningProfileResponse) => any;
|
|
3651
|
+
/**
|
|
3652
|
+
* @internal
|
|
3653
|
+
*/
|
|
3654
|
+
export declare const SendManagedThingCommandRequestFilterSensitiveLog: (obj: SendManagedThingCommandRequest) => any;
|
|
3655
|
+
/**
|
|
3656
|
+
* @internal
|
|
3657
|
+
*/
|
|
3658
|
+
export declare const ListManagedThingsRequestFilterSensitiveLog: (obj: ListManagedThingsRequest) => any;
|
|
3659
|
+
/**
|
|
3660
|
+
* @internal
|
|
3661
|
+
*/
|
|
3662
|
+
export declare const ManagedThingSummaryFilterSensitiveLog: (obj: ManagedThingSummary) => any;
|
|
3663
|
+
/**
|
|
3664
|
+
* @internal
|
|
3665
|
+
*/
|
|
3666
|
+
export declare const ListManagedThingsResponseFilterSensitiveLog: (obj: ListManagedThingsResponse) => any;
|
|
3667
|
+
/**
|
|
3668
|
+
* @internal
|
|
3669
|
+
*/
|
|
3670
|
+
export declare const UpdateManagedThingRequestFilterSensitiveLog: (obj: UpdateManagedThingRequest) => any;
|
|
3671
|
+
/**
|
|
3672
|
+
* @internal
|
|
3673
|
+
*/
|
|
3674
|
+
export declare const OtaTaskConfigurationSummaryFilterSensitiveLog: (obj: OtaTaskConfigurationSummary) => any;
|
|
3675
|
+
/**
|
|
3676
|
+
* @internal
|
|
3677
|
+
*/
|
|
3678
|
+
export declare const ListOtaTaskConfigurationsResponseFilterSensitiveLog: (obj: ListOtaTaskConfigurationsResponse) => any;
|