Managed integrations is a feature of AWS IoT Device Management that enables developers to quickly build innovative IoT solutions. Customers can use managed integrations to automate device setup workflows and support interoperability across many devices, regardless of device vendor or connectivity protocol. This allows developers to use a single user-interface to control, manage, and operate a range of devices.
", "operations": { "CreateAccountAssociation": "Creates a new account association via the destination id.
", "CreateCloudConnector": "Creates a C2C (cloud-to-cloud) connector.
", "CreateConnectorDestination": "Create a connector destination for connecting a cloud-to-cloud (C2C) connector to the customer's Amazon Web Services account.
", "CreateCredentialLocker": "Create a product credential locker. This operation will trigger the creation of all the manufacturing resources including the Wi-Fi setup key pair and device certificate.
", "CreateDestination": "Create a destination. IoT managed integrations uses the destination to determine where to deliver notifications for a device.
", "CreateEventLogConfiguration": "Set the event log configuration for the account, resource type, or specific resource.
", "CreateManagedThing": "Creates a managed thing. A managed thing contains the device identifier, protocol supported, and capabilities of the device in a protocol-specific format.
", "CreateNotificationConfiguration": "Creates a notification configuration. A configuration is a connection between an event type and a destination that you have already created.
", "CreateOtaTask": "Create an over-the-air (OTA) task to update a device.
", "CreateOtaTaskConfiguration": "Create a configuraiton for the over-the-air (OTA) task.
", "CreateProvisioningProfile": "Create a provisioning profile for a device to execute the provisioning flows using a provisioning template. The provisioning template is a document that defines the set of resources and policies applied to a device during the provisioning process.
", "DeleteAccountAssociation": "Remove a third party account and related devices from an end user.
", "DeleteCloudConnector": "Delete a cloud connector.
", "DeleteConnectorDestination": "Delete a connector destination for connecting a cloud-to-cloud (C2C) connector to the customer's Amazon Web Services account.
", "DeleteCredentialLocker": "Delete a credential locker.
This operation can't be undone and any existing device won't be able to use IoT managed integrations.
Deletes a customer-managed destination specified by id.
", "DeleteEventLogConfiguration": "Delete an event log configuration.
", "DeleteManagedThing": "Delete a managed thing. If a controller is deleted, all of the devices connected to it will have their status changed to PENDING. It is not possible to remove a cloud device.
Deletes a notification configuration.
", "DeleteOtaTask": "Delete the over-the-air (OTA) task.
", "DeleteOtaTaskConfiguration": "Delete the over-the-air (OTA) task configuration.
", "DeleteProvisioningProfile": "Delete a provisioning profile.
", "DeregisterAccountAssociation": "Deregisters an account association, removing the connection between a managed thing and a third-party account.
", "GetAccountAssociation": "Get an account association for an Amazon Web Services account linked to a customer-managed destination.
", "GetCloudConnector": "Gets all the information about a connector for a connector developer.
", "GetConnectorDestination": "Get a connector destination of a cloud-to-cloud (C2C) connector connecting to a customer's Amazon Web Services account.
", "GetCredentialLocker": "Get information on an existing credential locker
", "GetCustomEndpoint": "Returns the IoT managed integrations custom endpoint.
", "GetDefaultEncryptionConfiguration": "Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified region. For more information, see Key management in the AWS IoT SiteWise User Guide.
", "GetDestination": "Gets a destination by ID.
", "GetDeviceDiscovery": "Get the current state of a device discovery.
", "GetEventLogConfiguration": "Get an event log configuration.
", "GetHubConfiguration": "Get a hub configuration.
", "GetManagedThing": "Get the attributes and capabilities associated with a managed thing.
", "GetManagedThingCapabilities": "Get the capabilities for a managed thing using the device ID.
", "GetManagedThingConnectivityData": "Get the connectivity status of a managed thing.
", "GetManagedThingMetaData": "Get the metadata information for a managed thing.
The managedThing metadata parameter is used for associating attributes with a managedThing that can be used for grouping over-the-air (OTA) tasks. Name value pairs in metadata can be used in the OtaTargetQueryString parameter for the CreateOtaTask API operation.
Returns the managed thing state for the given device Id.
", "GetNotificationConfiguration": "Get a notification configuration.
", "GetOtaTask": "Get the over-the-air (OTA) task.
", "GetOtaTaskConfiguration": "Get a configuraiton for the over-the-air (OTA) task.
", "GetProvisioningProfile": "Get a provisioning profile by template name.
", "GetRuntimeLogConfiguration": "Get the runtime log configuration for a specific managed thing or for all managed things as a group.
", "GetSchemaVersion": "Gets a schema version with the provided information.
", "ListAccountAssociations": "Lists all account associations, with optional filtering by connector destination ID.
", "ListCloudConnectors": "Returns a list of connectors based on permissions.
", "ListConnectorDestinations": "Lists all connector destinations, with optional filtering by cloud connector ID.
", "ListCredentialLockers": "List information on an existing credential locker.
", "ListDestinations": "List all destination names under one Amazon Web Services account.
", "ListDeviceDiscoveries": "Lists all device discovery tasks, with optional filtering by type and status.
", "ListDiscoveredDevices": "Lists all devices discovered during a specific device discovery task.
", "ListEventLogConfigurations": "List all event log configurations for an account.
", "ListManagedThingAccountAssociations": "Lists all account associations for a specific managed thing.
", "ListManagedThingSchemas": "List schemas associated with a managed thing.
", "ListManagedThings": "Listing all managed things with provision for filters.
", "ListNotificationConfigurations": "List all notification configurations.
", "ListOtaTaskConfigurations": "List all of the over-the-air (OTA) task configurations.
", "ListOtaTaskExecutions": "List all of the over-the-air (OTA) task executions.
", "ListOtaTasks": "List all of the over-the-air (OTA) tasks.
", "ListProvisioningProfiles": "List the provisioning profiles within the Amazon Web Services account.
", "ListSchemaVersions": "Lists schema versions with the provided information.
", "ListTagsForResource": "List tags for the specified resource.
", "PutDefaultEncryptionConfiguration": "Sets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the AWS IoT SiteWise User Guide.
", "PutHubConfiguration": "Update a hub configuration.
", "PutRuntimeLogConfiguration": "Set the runtime log configuration for a specific managed thing or for all managed things as a group.
", "RegisterAccountAssociation": "Registers an account association with a managed thing, establishing a connection between a device and a third-party account.
", "RegisterCustomEndpoint": "Customers can request IoT managed integrations to manage the server trust for them or bring their own external server trusts for the custom domain. Returns an IoT managed integrations endpoint.
", "ResetRuntimeLogConfiguration": "Reset a runtime log configuration for a specific managed thing or for all managed things as a group.
", "SendConnectorEvent": "Relays third-party device events for a connector such as a new device or a device state change event.
", "SendManagedThingCommand": "Send the command to the device represented by the managed thing.
", "StartAccountAssociationRefresh": "Initiates a refresh of an existing account association to update its authorization and connection status.
", "StartDeviceDiscovery": "This API is used to start device discovery for hub-connected and third-party-connected devices. The authentication material (install code) is passed as a message to the controller telling it to start the discovery.
", "TagResource": "Add tags for the specified resource.
", "UntagResource": "Remove tags for the specified resource.
", "UpdateAccountAssociation": "Updates the properties of an existing account association.
", "UpdateCloudConnector": "Update an existing cloud connector.
", "UpdateConnectorDestination": "Updates the properties of an existing connector destination.
", "UpdateDestination": "Update a destination specified by id.
", "UpdateEventLogConfiguration": "Update an event log configuration by log configuration ID.
", "UpdateManagedThing": "Update the attributes and capabilities associated with a managed thing.
", "UpdateNotificationConfiguration": "Update a notification configuration.
", "UpdateOtaTask": "Update an over-the-air (OTA) task.
" }, "shapes": { "AbortConfigCriteria": { "base": "Structure representing one abort config criteria.
", "refs": { "AbortConfigCriteriaList$member": null } }, "AbortConfigCriteriaList": { "base": null, "refs": { "OtaTaskAbortConfig$AbortConfigCriteriaList": "The list of criteria for the abort config.
" } }, "AbortCriteriaAction": { "base": null, "refs": { "AbortConfigCriteria$Action": "The action taken by the abort configuration.
" } }, "AbortCriteriaFailureType": { "base": null, "refs": { "AbortConfigCriteria$FailureType": "Over-the-air (OTA) task abort criteria failure type.
" } }, "AccessDeniedException": { "base": "User is not authorized.
", "refs": { } }, "AccountAssociationArn": { "base": null, "refs": { "AccountAssociationItem$Arn": "The Amazon Resource Name (ARN) of the account association.
", "CreateAccountAssociationResponse$Arn": "The Amazon Resource Name (ARN) of the account association.
", "GetAccountAssociationResponse$Arn": "The Amazon Resource Name (ARN) of the account association.
" } }, "AccountAssociationDescription": { "base": null, "refs": { "AccountAssociationItem$Description": "A description of the account association.
", "CreateAccountAssociationRequest$Description": "A description of the account association request.
", "GetAccountAssociationResponse$Description": "The description of the account association.
", "UpdateAccountAssociationRequest$Description": "The new description to assign to the account association.
" } }, "AccountAssociationErrorMessage": { "base": null, "refs": { "AccountAssociationItem$ErrorMessage": "The error message explaining any issues with the account association, if applicable.
", "GetAccountAssociationResponse$ErrorMessage": "The error message explaining the current account association error.
" } }, "AccountAssociationId": { "base": null, "refs": { "AccountAssociationItem$AccountAssociationId": "The unique identifier of the account association.
", "CreateAccountAssociationResponse$AccountAssociationId": "The identifier for the account association request.
", "DeleteAccountAssociationRequest$AccountAssociationId": "The unique identifier of the account association to be deleted.
", "DeregisterAccountAssociationRequest$AccountAssociationId": "The unique identifier of the account association to be deregistered.
", "GetAccountAssociationRequest$AccountAssociationId": "The unique identifier of the account association to retrieve.
", "GetAccountAssociationResponse$AccountAssociationId": "The unique identifier of the retrieved account association.
", "GetDeviceDiscoveryResponse$AccountAssociationId": "The identifier of the account association used for the device discovery.
", "ListManagedThingAccountAssociationsRequest$AccountAssociationId": "The identifier of the account association to filter results by. When specified, only associations with this account association ID will be returned.
", "ManagedThingAssociation$AccountAssociationId": "The identifier of the account association in the association.
", "RegisterAccountAssociationRequest$AccountAssociationId": "The identifier of the account association to register with the managed thing.
", "RegisterAccountAssociationResponse$AccountAssociationId": "The identifier of the account association that was registered.
", "SendManagedThingCommandRequest$AccountAssociationId": "The identifier of the account association to use when sending a command to a managed thing.
", "StartAccountAssociationRefreshRequest$AccountAssociationId": "The unique identifier of the account association to refresh.
", "StartDeviceDiscoveryRequest$AccountAssociationId": "The identifier of the cloud-to-cloud account association to use for discovery of third-party devices.
", "UpdateAccountAssociationRequest$AccountAssociationId": "The unique identifier of the account association to update.
" } }, "AccountAssociationItem": { "base": "Structure containing information about an account association, including its identifier, state, and related metadata.
", "refs": { "AccountAssociationListDefinition$member": null } }, "AccountAssociationListDefinition": { "base": null, "refs": { "ListAccountAssociationsResponse$Items": "The list of account associations that match the specified criteria.
" } }, "AccountAssociationName": { "base": null, "refs": { "AccountAssociationItem$Name": "The name of the account association.
", "CreateAccountAssociationRequest$Name": "The name of the destination for the new account association.
", "GetAccountAssociationResponse$Name": "The name of the account association.
", "UpdateAccountAssociationRequest$Name": "The new name to assign to the account association.
" } }, "ActionName": { "base": null, "refs": { "CapabilityReportActions$member": null, "MatterCapabilityReportAttribute$name": "Name for the Amazon Web Services Matter capability report attribute.
" } }, "ActionReference": { "base": null, "refs": { "CapabilityAction$ref": "Describe a capability action with an reference.
" } }, "ActionTraceId": { "base": null, "refs": { "CapabilityAction$actionTraceId": "Describe a capability action with an actionTraceId for a response command.
The id of the advertised product.
", "ManagedThingSummary$AdvertisedProductId": "The id of the advertised product.
" } }, "AssociationState": { "base": null, "refs": { "AccountAssociationItem$AssociationState": "The current state of the account association, indicating its status in the association lifecycle.
", "CreateAccountAssociationResponse$AssociationState": "The current state of the account association request.
", "GetAccountAssociationResponse$AssociationState": "The current status state for the account association.
" } }, "AttributeName": { "base": null, "refs": { "MetaData$key": null } }, "AttributeValue": { "base": null, "refs": { "MetaData$value": null } }, "AuthConfig": { "base": "The authentication configuration details for a connector destination, including OAuth settings and other authentication parameters.
", "refs": { "CreateConnectorDestinationRequest$AuthConfig": "The authentication configuration details for the connector destination, including OAuth settings and other authentication parameters.
", "GetConnectorDestinationResponse$AuthConfig": "The authentication configuration details for the connector destination, including OAuth settings and other authentication parameters.
" } }, "AuthConfigUpdate": { "base": "The updated authentication configuration details for a connector destination.
", "refs": { "UpdateConnectorDestinationRequest$AuthConfig": "The updated authentication configuration details for the connector destination.
" } }, "AuthMaterialString": { "base": null, "refs": { "CreateManagedThingRequest$AuthenticationMaterial": "The authentication material defining the device connectivity setup requests. The authentication materials used are the device bar code.
", "DiscoveredDeviceSummary$AuthenticationMaterial": "The authentication material required for connecting to the discovered device, such as credentials or tokens.
" } }, "AuthMaterialType": { "base": null, "refs": { "CreateManagedThingRequest$AuthenticationMaterialType": "The type of authentication material used for device connectivity setup requests.
" } }, "AuthType": { "base": null, "refs": { "CreateConnectorDestinationRequest$AuthType": "The authentication type used for the connector destination, which determines how credentials and access are managed.
", "GetConnectorDestinationResponse$AuthType": "The authentication type used for the connector destination, which determines how credentials and access are managed.
", "UpdateConnectorDestinationRequest$AuthType": "The new authentication type to use for the connector destination.
" } }, "AuthUrl": { "base": null, "refs": { "OAuthConfig$authUrl": "The authorization URL for the OAuth service, where users are directed to authenticate and authorize access.
" } }, "BaseRatePerMinute": { "base": null, "refs": { "ExponentialRolloutRate$BaseRatePerMinute": "The base rate per minute for the rollout of an over-the-air (OTA) task.
" } }, "Boolean": { "base": null, "refs": { "DeleteManagedThingRequest$Force": "When set to TRUE, a forceful deteletion of the managed thing will occur. When set to FALSE, a non-forceful deletion of the managed thing will occur.
Indicates whether proactive refresh token renewal is enabled.
" } }, "Brand": { "base": null, "refs": { "CreateManagedThingRequest$Brand": "The brand of the device.
", "DiscoveredDeviceSummary$Brand": "The brand of the discovered device.
", "GetManagedThingResponse$Brand": "The brand of the device.
", "ManagedThingSummary$Brand": "The brand of the device.
", "UpdateManagedThingRequest$Brand": "The brand of the device.
" } }, "CaCertificate": { "base": null, "refs": { "CreateProvisioningProfileRequest$CaCertificate": "The id of the certificate authority (CA) certificate.
" } }, "Capabilities": { "base": null, "refs": { "CreateManagedThingRequest$Capabilities": "The capabilities of the device such as light bulb.
", "GetManagedThingCapabilitiesResponse$Capabilities": "The capabilities of the device such as light bulb.
", "UpdateManagedThingRequest$Capabilities": "The capabilities of the device such as light bulb.
" } }, "CapabilityAction": { "base": "Action for an Amazon Web Services capability, containing the action parameters for control.
", "refs": { "CapabilityActions$member": null } }, "CapabilityActionName": { "base": null, "refs": { "CapabilityAction$name": "Describe a capability action with a name.
" } }, "CapabilityActions": { "base": null, "refs": { "CommandCapability$actions": "Describe the command capability with the actions it supports.
" } }, "CapabilityId": { "base": null, "refs": { "ListManagedThingSchemasRequest$CapabilityIdFilter": "Filter on a capability id.
", "ManagedThingSchemaListItem$CapabilityId": "The id of the capability for a managed thing.
" } }, "CapabilityName": { "base": null, "refs": { "CapabilityReportCapability$name": "The name of the capability.
", "CommandCapability$name": "Describe the capability with an name.
", "MatterCapabilityReportCluster$name": "The capability name used in the Amazon Web Services Matter capability report.
", "StateCapability$name": "Name for the Amazon Web Services capability.
" } }, "CapabilityProperties": { "base": null, "refs": { "CapabilityAction$parameters": "Describe a capability action with a capability property.
", "StateCapability$properties": "Describe the command capability with the properties it supports.
" } }, "CapabilityReport": { "base": "Report of all capabilities supported by the device.
", "refs": { "CreateManagedThingRequest$CapabilityReport": "A report of the capabilities for the managed thing.
", "GetManagedThingCapabilitiesResponse$CapabilityReport": "A report of the capabilities for the managed thing.
", "UpdateManagedThingRequest$CapabilityReport": "A report of the capabilities for the managed thing.
" } }, "CapabilityReportActions": { "base": null, "refs": { "CapabilityReportCapability$actions": "The capability actions used in the capability report.
" } }, "CapabilityReportCapabilities": { "base": null, "refs": { "CapabilityReportEndpoint$capabilities": "The capabilities used in the capability report.
" } }, "CapabilityReportCapability": { "base": "The capability used in capability report.
", "refs": { "CapabilityReportCapabilities$member": null } }, "CapabilityReportEndpoint": { "base": "The endpoint used in the capability report.
", "refs": { "CapabilityReportEndpoints$member": null } }, "CapabilityReportEndpoints": { "base": null, "refs": { "CapabilityReport$endpoints": "The endpoints used in the capability report.
" } }, "CapabilityReportEvents": { "base": null, "refs": { "CapabilityReportCapability$events": "The capability events used in the capability report.
" } }, "CapabilityReportProperties": { "base": null, "refs": { "CapabilityReportCapability$properties": "The capability properties used in the capability report.
" } }, "CapabilityReportVersion": { "base": null, "refs": { "CapabilityReport$version": "The version of the capability report.
", "MatterCapabilityReport$version": "The version of the capability report.
" } }, "CapabilitySchemaItem": { "base": "Structure representing a capability schema item that defines the functionality and features supported by a managed thing.
", "refs": { "CapabilitySchemas$member": null } }, "CapabilitySchemas": { "base": null, "refs": { "CreateManagedThingRequest$CapabilitySchemas": "The capability schemas that define the functionality and features supported by the managed thing, including device capabilities and their associated properties.
", "Device$CapabilitySchemas": "Report of all capabilities supported by the device.
", "UpdateManagedThingRequest$CapabilitySchemas": "The updated capability schemas that define the functionality and features supported by the managed thing.
" } }, "CapabilityVersion": { "base": null, "refs": { "CapabilityReportCapability$version": "The version of the capability.
", "CommandCapability$version": "Describe the capability with a version.
", "StateCapability$version": "Version for the Amazon Web Services capability.
" } }, "ClaimCertificate": { "base": null, "refs": { "CreateProvisioningProfileResponse$ClaimCertificate": "The id of the claim certificate.
", "GetProvisioningProfileResponse$ClaimCertificate": "The id of the claim certificate.
" } }, "ClaimCertificatePrivateKey": { "base": null, "refs": { "CreateProvisioningProfileResponse$ClaimCertificatePrivateKey": "The private key of the claim certificate. This is stored securely on the device for validating the connection endpoint with IoT managed integrations using the public key.
" } }, "Classification": { "base": null, "refs": { "CreateManagedThingRequest$Classification": "The classification of the managed thing such as light bulb or thermostat.
", "GetManagedThingResponse$Classification": "The classification of the managed thing such as light bulb or thermostat.
", "ManagedThingSummary$Classification": "The classification of the managed thing such as light bulb or thermostat.
", "UpdateManagedThingRequest$Classification": "The classification of the managed thing such as light bulb or thermostat.
" } }, "ClientToken": { "base": null, "refs": { "CreateAccountAssociationRequest$ClientToken": "An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.
", "CreateCloudConnectorRequest$ClientToken": "An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.
", "CreateConnectorDestinationRequest$ClientToken": "An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.
", "CreateCredentialLockerRequest$ClientToken": "An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.
", "CreateDestinationRequest$ClientToken": "An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.
", "CreateEventLogConfigurationRequest$ClientToken": "An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.
", "CreateManagedThingRequest$ClientToken": "An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.
", "CreateNotificationConfigurationRequest$ClientToken": "An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.
", "CreateOtaTaskConfigurationRequest$ClientToken": "An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.
", "CreateOtaTaskRequest$ClientToken": "An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.
", "CreateProvisioningProfileRequest$ClientToken": "An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.
", "StartDeviceDiscoveryRequest$ClientToken": "An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.
" } }, "CloudConnectorDescription": { "base": null, "refs": { "ConnectorItem$Description": "A description of the C2C connector.
", "CreateCloudConnectorRequest$Description": "A description of the C2C connector.
", "GetCloudConnectorResponse$Description": "A description of the C2C connector.
", "UpdateCloudConnectorRequest$Description": "The new description to assign to the cloud connector.
" } }, "CloudConnectorId": { "base": null, "refs": { "ConnectorDestinationSummary$CloudConnectorId": "The identifier of the cloud connector associated with this connector destination.
", "ConnectorItem$Id": "The identifier of the C2C connector.
", "CreateCloudConnectorResponse$Id": "The unique identifier assigned to the newly created cloud connector.
", "CreateConnectorDestinationRequest$CloudConnectorId": "The identifier of the C2C connector.
", "DeleteCloudConnectorRequest$Identifier": "The identifier of the cloud connector.
", "GetCloudConnectorRequest$Identifier": "The identifier of the C2C connector.
", "GetCloudConnectorResponse$Id": "The unique identifier of the cloud connector.
", "GetConnectorDestinationResponse$CloudConnectorId": "The identifier of the C2C connector.
", "ListConnectorDestinationsRequest$CloudConnectorId": "The identifier of the cloud connector to filter connector destinations by.
", "UpdateCloudConnectorRequest$Identifier": "The unique identifier of the cloud connector to update.
" } }, "CloudConnectorType": { "base": null, "refs": { "ConnectorItem$Type": "The type of cloud connector created.
", "GetCloudConnectorResponse$Type": "The type of cloud connector created.
", "ListCloudConnectorsRequest$Type": "The type of cloud connectors to filter by when listing available connectors.
" } }, "ClusterId": { "base": null, "refs": { "MatterCapabilityReportCluster$id": "The id of the Amazon Web Services Matter capability report cluster.
", "MatterCapabilityReportEndpointClientClusters$member": null, "MatterCluster$id": "The cluster id.
" } }, "CommandCapabilities": { "base": null, "refs": { "CommandEndpoint$capabilities": "Describe the endpoint with an id, a name, and the relevant capabilities for sending commands.
" } }, "CommandCapability": { "base": "The command capabilities added for the managed thing
", "refs": { "CommandCapabilities$member": null } }, "CommandEndpoint": { "base": "The endpoint for a managed thing when sending a command.
", "refs": { "CommandEndpoints$member": null } }, "CommandEndpoints": { "base": null, "refs": { "SendManagedThingCommandRequest$Endpoints": "The device endpoint.
" } }, "ConfigurationError": { "base": "Provides the default encryption configuration error update details.
", "refs": { "ConfigurationStatus$error": "The error details describing a failed default encryption configuration update.
" } }, "ConfigurationErrorCode": { "base": null, "refs": { "ConfigurationError$code": "The error code returned when the default encryption configuration update fails.
" } }, "ConfigurationErrorMessage": { "base": null, "refs": { "ConfigurationError$message": "The error message returned when the default encryption configuration update fails.
" } }, "ConfigurationState": { "base": null, "refs": { "ConfigurationStatus$state": "The status state describing the default encryption configuration update.
" } }, "ConfigurationStatus": { "base": "Provides the status of the default encryption configuration for an Amazon Web Services account.
", "refs": { "GetDefaultEncryptionConfigurationResponse$configurationStatus": "Provides the status of the default encryption configuration for an Amazon Web Services account.
", "PutDefaultEncryptionConfigurationResponse$configurationStatus": "Provides the status of the default encryption configuration for an Amazon Web Services account.
" } }, "ConflictException": { "base": "There is a conflict with the request.
", "refs": { } }, "ConnectivityStatus": { "base": null, "refs": { "GetManagedThingConnectivityDataResponse$Connected": "The connectivity status for a managed thing.
" } }, "ConnectivityTimestamp": { "base": null, "refs": { "GetManagedThingConnectivityDataResponse$Timestamp": "The timestamp value of when the connectivity status for a managed thing was last taken.
" } }, "ConnectorAssociationId": { "base": null, "refs": { "GetDeviceDiscoveryResponse$ConnectorAssociationId": "The ID tracking the current discovery process for one connector association.
", "SendManagedThingCommandRequest$ConnectorAssociationId": "The ID tracking the current discovery process for one connector association.
", "StartDeviceDiscoveryRequest$ConnectorAssociationIdentifier": "The id of the connector association.
" } }, "ConnectorDestinationDescription": { "base": null, "refs": { "ConnectorDestinationSummary$Description": "A description of the connector destination.
", "CreateConnectorDestinationRequest$Description": "A description of the connector destination.
", "GetConnectorDestinationResponse$Description": "A description of the connector destination.
", "UpdateConnectorDestinationRequest$Description": "The new description to assign to the connector destination.
" } }, "ConnectorDestinationId": { "base": null, "refs": { "AccountAssociationItem$ConnectorDestinationId": "The identifier of the connector destination associated with this account association.
", "ConnectorDestinationSummary$Id": "The unique identifier of the connector destination.
", "CreateAccountAssociationRequest$ConnectorDestinationId": "The identifier of the connector destination.
", "CreateConnectorDestinationResponse$Id": "The identifier of the C2C connector destination creation request.
", "DeleteConnectorDestinationRequest$Identifier": "The identifier of the connector destination.
", "GetAccountAssociationResponse$ConnectorDestinationId": "The identifier of the connector destination associated with this account association.
", "GetConnectorDestinationRequest$Identifier": "The identifier of the C2C connector destination.
", "GetConnectorDestinationResponse$Id": "The unique identifier of the connector destination.
", "GetManagedThingResponse$ConnectorDestinationId": "The identifier of the connector destination associated with this managed thing.
", "ListAccountAssociationsRequest$ConnectorDestinationId": "The identifier of the connector destination to filter account associations by.
", "ListManagedThingsRequest$ConnectorDestinationIdFilter": "Filter managed things by the connector destination ID they are associated with.
", "ManagedThingSummary$ConnectorDestinationId": "The identifier of the connector destination associated with this managed thing, if applicable.
", "UpdateConnectorDestinationRequest$Identifier": "The unique identifier of the connector destination to update.
" } }, "ConnectorDestinationListDefinition": { "base": null, "refs": { "ListConnectorDestinationsResponse$ConnectorDestinationList": "The list of connector destinations that match the specified criteria.
" } }, "ConnectorDestinationName": { "base": null, "refs": { "ConnectorDestinationSummary$Name": "The display name of the connector destination.
", "CreateConnectorDestinationRequest$Name": "The display name of the connector destination.
", "GetConnectorDestinationResponse$Name": "The display name of the connector destination.
", "UpdateConnectorDestinationRequest$Name": "The new display name to assign to the connector destination.
" } }, "ConnectorDestinationSummary": { "base": "Structure containing summary information about a connector destination, which defines how a cloud-to-cloud connector connects to a customer's AWS account.
", "refs": { "ConnectorDestinationListDefinition$member": null } }, "ConnectorDeviceId": { "base": null, "refs": { "Device$ConnectorDeviceId": "The device id as defined by the connector.
This parameter is used for cloud-to-cloud devices only.
The third-party device identifier as defined by the connector. This identifier must not contain personal identifiable information (PII).
", "GetManagedThingResponse$ConnectorDeviceId": "The third-party device id as defined by the connector. This device id must not contain personal identifiable information (PII).
This parameter is used for cloud-to-cloud devices only.
Filter managed things by the connector device ID they are associated with. When specified, only managed things with this connector device ID will be returned.
", "ManagedThingSummary$ConnectorDeviceId": "The third-party device id as defined by the connector. This device id must not contain personal identifiable information (PII).
This parameter is used for cloud-to-cloud devices only.
The third-party device id as defined by the connector. This device id must not contain personal identifiable information (PII).
This parameter is used for cloud-to-cloud devices only.
The name of the device as defined by the connector.
", "DiscoveredDeviceSummary$ConnectorDeviceName": "The name of the device as defined by the connector or third-party system.
" } }, "ConnectorEventMessage": { "base": null, "refs": { "SendConnectorEventRequest$Message": "The device state change event payload.
This parameter will include the following three fields:
uri: schema auc://<PARTNER-DEVICE-ID>/ResourcePath (The Resourcepath corresponds to an OCF resource.)
op: For device state changes, this field must populate as n+d.
cn: The content depends on the OCF resource referenced in ResourcePath.
The Open Connectivity Foundation (OCF) operation requested to be performed on the managed thing.
The field op can have a value of \"I\" or \"U\". The field \"cn\" will contain the capability types.
The Open Connectivity Foundation (OCF) security specification version for the operation being requested on the managed thing. For more information, see OCF Security Specification.
" } }, "ConnectorEventStatusCode": { "base": null, "refs": { "SendConnectorEventRequest$StatusCode": "The status code of the Open Connectivity Foundation (OCF) operation being performed on the managed thing.
" } }, "ConnectorId": { "base": null, "refs": { "SendConnectorEventRequest$ConnectorId": "The id of the connector between the third-party cloud provider and IoT managed integrations.
", "SendConnectorEventResponse$ConnectorId": "The id of the connector between the third-party cloud provider and IoT managed integrations.
" } }, "ConnectorItem": { "base": "Structure describing a connector.
", "refs": { "ConnectorList$member": null } }, "ConnectorList": { "base": null, "refs": { "ListCloudConnectorsResponse$Items": "The list of connectors.
" } }, "ConnectorPolicyId": { "base": null, "refs": { "GetManagedThingResponse$ConnectorPolicyId": "The id of the connector policy.
This parameter is used for cloud-to-cloud devices only.
Filter on a connector policy id for a managed thing.
", "ManagedThingSummary$ConnectorPolicyId": "The id of the connector policy.
This parameter is used for cloud-to-cloud devices only.
The timestamp value of when the device creation request occurred.
", "GetManagedThingResponse$CreatedAt": "The timestamp value of when the device creation request occurred.
", "GetOtaTaskConfigurationResponse$CreatedAt": "The timestamp value of when the over-the-air (OTA) task configuration was created at.
", "GetOtaTaskResponse$CreatedAt": "The timestamp value of when the over-the-air (OTA) task was created.
", "ManagedThingSummary$CreatedAt": "The timestamp value of when the device creation request occurred.
", "ManagedThingSummary$UpdatedAt": "The timestamp value of when the managed thing was last updated at.
", "OtaTaskConfigurationSummary$CreatedAt": "The timestamp value of when the over-the-air (OTA) task configuration was created at.
", "OtaTaskSummary$CreatedAt": "The timestamp value of when the over-the-air (OTA) task was created at.
" } }, "CredentialLockerArn": { "base": null, "refs": { "CreateCredentialLockerResponse$Arn": "The Amazon Resource Name (ARN) of the credential locker.
", "CredentialLockerSummary$Arn": "The Amazon Resource Name (ARN) of the credential locker.
", "GetCredentialLockerResponse$Arn": "The Amazon Resource Name (ARN) of the credential locker.
" } }, "CredentialLockerCreatedAt": { "base": null, "refs": { "CreateCredentialLockerResponse$CreatedAt": "The timestamp value of when the credential locker request occurred.
", "CredentialLockerSummary$CreatedAt": "The timestampe value of when the credential locker was created at.
", "GetCredentialLockerResponse$CreatedAt": "The timestamp value of when the credential locker requset occurred.
" } }, "CredentialLockerId": { "base": null, "refs": { "CreateCredentialLockerResponse$Id": "The identifier of the credential locker creation request.
", "CreateManagedThingRequest$CredentialLockerId": "The identifier of the credential for the managed thing.
", "CredentialLockerSummary$Id": "The id of the credential locker.
", "DeleteCredentialLockerRequest$Identifier": "The identifier of the credential locker.
", "GetCredentialLockerRequest$Identifier": "The identifier of the credential locker.
", "GetCredentialLockerResponse$Id": "The identifier of the credential locker.
", "GetManagedThingResponse$CredentialLockerId": "The identifier of the credential locker for the managed thing.
", "ListManagedThingsRequest$CredentialLockerFilter": "Filter on a credential locker for a managed thing.
", "ManagedThingSummary$CredentialLockerId": "The identifier of the credential locker for the managed thing.
", "UpdateManagedThingRequest$CredentialLockerId": "The identifier of the credential for the managed thing.
" } }, "CredentialLockerListDefinition": { "base": null, "refs": { "ListCredentialLockersResponse$Items": "The list of credential lockers.
" } }, "CredentialLockerName": { "base": null, "refs": { "CreateCredentialLockerRequest$Name": "The name of the credential locker.
", "CredentialLockerSummary$Name": "The name of the credential locker.
", "GetCredentialLockerResponse$Name": "The name of the credential locker.
" } }, "CredentialLockerSummary": { "base": "Structure describing one Credential Locker.
", "refs": { "CredentialLockerListDefinition$member": null } }, "CustomProtocolDetail": { "base": null, "refs": { "StartDeviceDiscoveryRequest$CustomProtocolDetail": "Additional protocol-specific details required for device discovery, which vary based on the discovery type.
For a DiscoveryType of CUSTOM, the string-to-string map must have a key value of Name set to a non-empty-string.
Configuration to enable or disable deleting of runtime logs in the device once uploaded to the cloud.
" } }, "DeleteManagedThingRequest": { "base": null, "refs": { } }, "DeleteNotificationConfigurationRequest": { "base": null, "refs": { } }, "DeleteOtaTaskConfigurationRequest": { "base": null, "refs": { } }, "DeleteOtaTaskRequest": { "base": null, "refs": { } }, "DeleteProvisioningProfileRequest": { "base": null, "refs": { } }, "DeliveryDestinationArn": { "base": null, "refs": { "CreateDestinationRequest$DeliveryDestinationArn": "The Amazon Resource Name (ARN) of the customer-managed destination.
", "DestinationSummary$DeliveryDestinationArn": "The Amazon Resource Name (ARN) of the customer-managed destination.
", "GetDestinationResponse$DeliveryDestinationArn": "The Amazon Resource Name (ARN) of the customer-managed destination.
", "UpdateDestinationRequest$DeliveryDestinationArn": "The Amazon Resource Name (ARN) of the customer-managed destination.
" } }, "DeliveryDestinationRoleArn": { "base": null, "refs": { "CreateDestinationRequest$RoleArn": "The Amazon Resource Name (ARN) of the delivery destination role.
", "DestinationSummary$RoleArn": "The Amazon Resource Name (ARN) of the delivery destination.
", "GetDestinationResponse$RoleArn": "The Amazon Resource Name (ARN) of the delivery destination role.
", "UpdateDestinationRequest$RoleArn": "The Amazon Resource Name (ARN) of the delivery destination role.
" } }, "DeliveryDestinationType": { "base": null, "refs": { "CreateDestinationRequest$DeliveryDestinationType": "The destination type for the customer-managed destination.
", "DestinationSummary$DeliveryDestinationType": "The destination type for the customer-managed destination.
", "GetDestinationResponse$DeliveryDestinationType": "The destination type for the customer-managed destination.
", "UpdateDestinationRequest$DeliveryDestinationType": "The destination type for the customer-managed destination.
" } }, "DeregisterAccountAssociationRequest": { "base": "Request for deregister a managed thing from account association
", "refs": { } }, "DestinationCreatedAt": { "base": null, "refs": { "GetDestinationResponse$CreatedAt": "The timestamp value of when the destination creation requset occurred.
" } }, "DestinationDescription": { "base": null, "refs": { "CreateDestinationRequest$Description": "The description of the customer-managed destination.
", "DestinationSummary$Description": "The description of the customer-managed destination.
", "GetDestinationResponse$Description": "The description of the customer-managed destination.
", "UpdateDestinationRequest$Description": "The description of the customer-managed destination.
" } }, "DestinationListDefinition": { "base": null, "refs": { "ListDestinationsResponse$DestinationList": "The list of destinations.
" } }, "DestinationName": { "base": null, "refs": { "CreateDestinationRequest$Name": "The name of the customer-managed destination.
", "CreateDestinationResponse$Name": "The name of the customer-managed destination.
", "CreateNotificationConfigurationRequest$DestinationName": "The name of the destination for the notification configuration.
", "DeleteDestinationRequest$Name": "The id of the customer-managed destination.
", "DestinationSummary$Name": "The name of the customer-managed destination.
", "GetDestinationRequest$Name": "The name of the customer-managed destination.
", "GetDestinationResponse$Name": "The name of the customer-managed destination.
", "GetNotificationConfigurationResponse$DestinationName": "The name of the destination for the notification configuration.
", "NotificationConfigurationSummary$DestinationName": "The name of the destination for the notification configuration.
", "UpdateDestinationRequest$Name": "The name of the customer-managed destination.
", "UpdateNotificationConfigurationRequest$DestinationName": "The name of the destination for the notification configuration.
" } }, "DestinationSummary": { "base": "Structure describing a destination for IoT managed integrations to deliver notifications for a device.
", "refs": { "DestinationListDefinition$member": null } }, "DestinationUpdatedAt": { "base": null, "refs": { "GetDestinationResponse$UpdatedAt": "The timestamp value of when the destination update requset occurred.
" } }, "Device": { "base": "Describe the device using the relevant metadata and supported clusters for device discovery.
", "refs": { "Devices$member": null } }, "DeviceDiscoveryArn": { "base": null, "refs": { "GetDeviceDiscoveryResponse$Arn": "The Amazon Resource Name (ARN) of the device discovery job request.
" } }, "DeviceDiscoveryId": { "base": null, "refs": { "DeviceDiscoverySummary$Id": "The unique identifier of the device discovery job.
", "GetDeviceDiscoveryRequest$Identifier": "The id of the device discovery job request.
", "GetDeviceDiscoveryResponse$Id": "The id of the device discovery job request.
", "ListDiscoveredDevicesRequest$Identifier": "The identifier of the device discovery job to list discovered devices for.
", "RegisterAccountAssociationRequest$DeviceDiscoveryId": "The identifier of the device discovery job associated with this registration.
", "RegisterAccountAssociationResponse$DeviceDiscoveryId": "The identifier of the device discovery job associated with this registration.
", "SendConnectorEventRequest$DeviceDiscoveryId": "The id for the device discovery job.
", "StartDeviceDiscoveryResponse$Id": "The id of the device discovery job request.
" } }, "DeviceDiscoveryListDefinition": { "base": null, "refs": { "ListDeviceDiscoveriesResponse$Items": "The list of device discovery jobs that match the specified criteria.
" } }, "DeviceDiscoveryStatus": { "base": null, "refs": { "DeviceDiscoverySummary$Status": "The current status of the device discovery job.
", "GetDeviceDiscoveryResponse$Status": "The status of the device discovery job request.
", "ListDeviceDiscoveriesRequest$StatusFilter": "The status to filter device discovery jobs by.
" } }, "DeviceDiscoverySummary": { "base": "Structure containing summary information about a device discovery job, including its identifier, type, and status.
", "refs": { "DeviceDiscoveryListDefinition$member": null } }, "DeviceMetadata": { "base": null, "refs": { "Device$DeviceMetadata": "The metadata attributes for a device.
" } }, "DeviceSpecificKey": { "base": null, "refs": { "GetManagedThingResponse$DeviceSpecificKey": "A Zwave device-specific key used during device activation.
This parameter is used for Zwave devices only.
The list of device types or categories that the discovered device belongs to.
" } }, "DeviceTypes": { "base": null, "refs": { "CapabilityReportEndpoint$deviceTypes": "The type of device.
", "MatterCapabilityReportEndpoint$deviceTypes": "The type of device.
" } }, "Devices": { "base": null, "refs": { "SendConnectorEventRequest$Devices": "The list of devices.
" } }, "DisconnectReasonValue": { "base": null, "refs": { "GetManagedThingConnectivityDataResponse$DisconnectReason": "The reason for the connectivity disconnect with the managed thing.
" } }, "DiscoveredAt": { "base": null, "refs": { "DiscoveredDeviceSummary$DiscoveredAt": "The timestamp indicating when the device was discovered.
" } }, "DiscoveredDeviceListDefinition": { "base": null, "refs": { "ListDiscoveredDevicesResponse$Items": "The list of discovered devices that match the specified criteria.
" } }, "DiscoveredDeviceSummary": { "base": "Structure containing summary information about a device discovered during a device discovery job.
", "refs": { "DiscoveredDeviceListDefinition$member": null } }, "DiscoveryAuthMaterialString": { "base": null, "refs": { "StartDeviceDiscoveryRequest$AuthenticationMaterial": "The authentication material required to start the local device discovery job request.
" } }, "DiscoveryAuthMaterialType": { "base": null, "refs": { "StartDeviceDiscoveryRequest$AuthenticationMaterialType": "The type of authentication material used for device discovery jobs.
" } }, "DiscoveryFinishedAt": { "base": null, "refs": { "GetDeviceDiscoveryResponse$FinishedAt": "The timestamp value for the completion time of the device discovery.
" } }, "DiscoveryModification": { "base": null, "refs": { "DiscoveredDeviceSummary$Modification": "The status of the discovered device, indicating whether it has been added, removed, or modified since the last discovery.
" } }, "DiscoveryStartedAt": { "base": null, "refs": { "GetDeviceDiscoveryResponse$StartedAt": "The timestamp value for the start time of the device discovery.
", "StartDeviceDiscoveryResponse$StartedAt": "The timestamp value for the start time of the device discovery.
" } }, "DiscoveryType": { "base": null, "refs": { "DeviceDiscoverySummary$DiscoveryType": "The type of discovery process used to find devices.
", "GetDeviceDiscoveryResponse$DiscoveryType": "The discovery type supporting the type of device to be discovered in the device discovery job request.
", "ListDeviceDiscoveriesRequest$TypeFilter": "The discovery type to filter device discovery jobs by.
", "StartDeviceDiscoveryRequest$DiscoveryType": "The discovery type supporting the type of device to be discovered in the device discovery task request.
" } }, "DisplayName": { "base": null, "refs": { "ConnectorItem$Name": "The display name of the C2C connector.
", "CreateCloudConnectorRequest$Name": "The display name of the C2C connector.
", "GetCloudConnectorResponse$Name": "The display name of the C2C connector.
", "UpdateCloudConnectorRequest$Name": "The new display name to assign to the cloud connector.
" } }, "DurationInMinutes": { "base": null, "refs": { "ScheduleMaintenanceWindow$DurationInMinutes": "Displays the duration of the next maintenance window.
" } }, "EncryptionType": { "base": null, "refs": { "GetDefaultEncryptionConfigurationResponse$encryptionType": "The type of encryption used for the encryption configuration.
", "PutDefaultEncryptionConfigurationRequest$encryptionType": "The type of encryption used for the encryption configuration.
", "PutDefaultEncryptionConfigurationResponse$encryptionType": "The type of encryption used for the encryption configuration.
" } }, "EndTime": { "base": null, "refs": { "OtaTaskSchedulingConfig$EndTime": "The time an over-the-air (OTA) task will stop.
" } }, "EndpointAddress": { "base": null, "refs": { "GetCustomEndpointResponse$EndpointAddress": "The IoT managed integrations dedicated, custom endpoint for the device to route traffic through.
", "RegisterCustomEndpointResponse$EndpointAddress": "The IoT managed integrations dedicated, custom endpoint for the device to route traffic through.
" } }, "EndpointConfig": { "base": "The configuration details for an endpoint, which defines how to connect to and communicate with external services.
", "refs": { "ConnectorItem$EndpointConfig": "The configuration details for the cloud connector endpoint, including connection parameters and authentication requirements.
", "CreateCloudConnectorRequest$EndpointConfig": "The configuration details for the cloud connector endpoint, including connection parameters and authentication requirements.
", "GetCloudConnectorResponse$EndpointConfig": "The configuration details for the cloud connector endpoint, including connection parameters and authentication requirements.
" } }, "EndpointId": { "base": null, "refs": { "CapabilityReportEndpoint$id": "The id of the endpoint used in the capability report.
", "CommandEndpoint$endpointId": "The id of the endpoint for a managed thing.
", "ListManagedThingSchemasRequest$EndpointIdFilter": "Filter on an endpoint id.
", "ManagedThingSchemaListItem$EndpointId": "The id of the endpoint for a managed thing.
", "MatterCapabilityReportEndpoint$id": "The id of the Amazon Web Services Matter capability report endpoint.
", "MatterCapabilityReportEndpointParts$member": null, "MatterEndpoint$id": "The Matter endpoint id.
", "StateEndpoint$endpointId": "Numeric identifier of the endpoint
" } }, "EndpointSemanticTag": { "base": null, "refs": { "MatterCapabilityReportEndpointSemanticTags$member": null } }, "EndpointType": { "base": null, "refs": { "ConnectorItem$EndpointType": "The type of endpoint used for the C2C connector.
", "CreateCloudConnectorRequest$EndpointType": "The type of endpoint used for the cloud connector, which defines how the connector communicates with external services.
", "GetCloudConnectorResponse$EndpointType": "The type of endpoint used for the cloud connector, which defines how the connector communicates with external services.
" } }, "ErrorMessage": { "base": null, "refs": { "AccessDeniedException$Message": null, "ConflictException$Message": null, "InternalFailureException$Message": null, "InternalServerException$Message": null, "InvalidRequestException$Message": null, "LimitExceededException$Message": null, "ResourceNotFoundException$Message": null, "ServiceQuotaExceededException$Message": null, "ServiceUnavailableException$Message": null, "ThrottlingException$Message": null, "UnauthorizedException$Message": null, "ValidationException$Message": null } }, "ErrorResourceId": { "base": null, "refs": { "ResourceNotFoundException$ResourceId": "Id of the affected resource
" } }, "ErrorResourceType": { "base": null, "refs": { "ResourceNotFoundException$ResourceType": "Type of the affected resource
" } }, "EventLogConfigurationListDefinition": { "base": null, "refs": { "ListEventLogConfigurationsResponse$EventLogConfigurationList": "A list of each event log configuration and pertinent information.
" } }, "EventLogConfigurationSummary": { "base": "List of event log configurations.
", "refs": { "EventLogConfigurationListDefinition$member": null } }, "EventName": { "base": null, "refs": { "CapabilityReportEvents$member": null } }, "EventType": { "base": null, "refs": { "CreateNotificationConfigurationRequest$EventType": "The type of event triggering a device notification to the customer-managed destination.
", "CreateNotificationConfigurationResponse$EventType": "The type of event triggering a device notification to the customer-managed destination.
", "DeleteNotificationConfigurationRequest$EventType": "The type of event triggering a device notification to the customer-managed destination.
", "GetNotificationConfigurationRequest$EventType": "The type of event triggering a device notification to the customer-managed destination.
", "GetNotificationConfigurationResponse$EventType": "The type of event triggering a device notification to the customer-managed destination.
", "NotificationConfigurationSummary$EventType": "The type of event triggering a device notification to the customer-managed destination.
", "UpdateNotificationConfigurationRequest$EventType": "The type of event triggering a device notification to the customer-managed destination.
" } }, "ExecutionNumber": { "base": null, "refs": { "OtaTaskExecutionSummary$ExecutionNumber": "The execution number of the over-the-air (OTA) task execution summary.
" } }, "ExponentialRolloutRate": { "base": "Structure representing exponential rate of rollout for an over-the-air (OTA) task.
", "refs": { "OtaTaskExecutionRolloutConfig$ExponentialRolloutRate": "Structure representing exponential rate of rollout for an over-the-air (OTA) task.
" } }, "ExtrinsicSchemaId": { "base": null, "refs": { "CapabilitySchemaItem$ExtrinsicId": "The external identifier for the capability, used when referencing the capability outside of the AWS ecosystem.
" } }, "GetAccountAssociationRequest": { "base": null, "refs": { } }, "GetAccountAssociationResponse": { "base": null, "refs": { } }, "GetCloudConnectorRequest": { "base": null, "refs": { } }, "GetCloudConnectorResponse": { "base": null, "refs": { } }, "GetConnectorDestinationRequest": { "base": null, "refs": { } }, "GetConnectorDestinationResponse": { "base": null, "refs": { } }, "GetCredentialLockerRequest": { "base": null, "refs": { } }, "GetCredentialLockerResponse": { "base": null, "refs": { } }, "GetCustomEndpointRequest": { "base": null, "refs": { } }, "GetCustomEndpointResponse": { "base": null, "refs": { } }, "GetDefaultEncryptionConfigurationRequest": { "base": null, "refs": { } }, "GetDefaultEncryptionConfigurationResponse": { "base": null, "refs": { } }, "GetDestinationRequest": { "base": null, "refs": { } }, "GetDestinationResponse": { "base": null, "refs": { } }, "GetDeviceDiscoveryRequest": { "base": null, "refs": { } }, "GetDeviceDiscoveryResponse": { "base": null, "refs": { } }, "GetEventLogConfigurationRequest": { "base": null, "refs": { } }, "GetEventLogConfigurationResponse": { "base": null, "refs": { } }, "GetHubConfigurationRequest": { "base": null, "refs": { } }, "GetHubConfigurationResponse": { "base": null, "refs": { } }, "GetManagedThingCapabilitiesRequest": { "base": null, "refs": { } }, "GetManagedThingCapabilitiesResponse": { "base": null, "refs": { } }, "GetManagedThingConnectivityDataRequest": { "base": null, "refs": { } }, "GetManagedThingConnectivityDataResponse": { "base": null, "refs": { } }, "GetManagedThingMetaDataRequest": { "base": null, "refs": { } }, "GetManagedThingMetaDataResponse": { "base": null, "refs": { } }, "GetManagedThingRequest": { "base": null, "refs": { } }, "GetManagedThingResponse": { "base": null, "refs": { } }, "GetManagedThingStateRequest": { "base": null, "refs": { } }, "GetManagedThingStateResponse": { "base": null, "refs": { } }, "GetNotificationConfigurationRequest": { "base": null, "refs": { } }, "GetNotificationConfigurationResponse": { "base": null, "refs": { } }, "GetOtaTaskConfigurationRequest": { "base": null, "refs": { } }, "GetOtaTaskConfigurationResponse": { "base": null, "refs": { } }, "GetOtaTaskRequest": { "base": null, "refs": { } }, "GetOtaTaskResponse": { "base": null, "refs": { } }, "GetProvisioningProfileRequest": { "base": null, "refs": { } }, "GetProvisioningProfileResponse": { "base": null, "refs": { } }, "GetRuntimeLogConfigurationRequest": { "base": null, "refs": { } }, "GetRuntimeLogConfigurationResponse": { "base": null, "refs": { } }, "GetSchemaVersionRequest": { "base": null, "refs": { } }, "GetSchemaVersionResponse": { "base": null, "refs": { } }, "HubConfigurationUpdatedAt": { "base": null, "refs": { "GetHubConfigurationResponse$UpdatedAt": "The timestamp value of when the hub configuration was updated.
" } }, "HubNetworkMode": { "base": null, "refs": { "GetManagedThingResponse$HubNetworkMode": "The network mode for the hub-connected device.
", "UpdateManagedThingRequest$HubNetworkMode": "The network mode for the hub-connected device.
" } }, "HubTokenTimerExpirySettingInSeconds": { "base": null, "refs": { "GetHubConfigurationResponse$HubTokenTimerExpirySettingInSeconds": "A user-defined integer value that represents the hub token timer expiry setting in seconds.
", "PutHubConfigurationRequest$HubTokenTimerExpirySettingInSeconds": "A user-defined integer value that represents the hub token timer expiry setting in seconds.
", "PutHubConfigurationResponse$HubTokenTimerExpirySettingInSeconds": "A user-defined integer value that represents the hub token timer expiry setting in seconds.
" } }, "InProgressTimeoutInMinutes": { "base": null, "refs": { "OtaTaskTimeoutConfig$InProgressTimeoutInMinutes": "Specifies the amount of time the device has to finish execution of this task. The timeout interval can be anywhere between 1 minute and 7 days.
" } }, "IncrementFactor": { "base": null, "refs": { "ExponentialRolloutRate$IncrementFactor": "The incremental factor for increasing the rollout rate of an over-the-air (OTA) task.
" } }, "Integer": { "base": null, "refs": { "TaskProcessingDetails$NumberOfCanceledThings": "The number of canceled things in an over-the-air (OTA) task.
", "TaskProcessingDetails$NumberOfFailedThings": "The number of failed things in an over-the-air (OTA) task.
", "TaskProcessingDetails$NumberOfInProgressThings": "The number of in progress things in an over-the-air (OTA) task.
", "TaskProcessingDetails$numberOfQueuedThings": "The number of queued things in an over-the-air (OTA) task.
", "TaskProcessingDetails$numberOfRejectedThings": "The number of rejected things in an over-the-air (OTA) task.
", "TaskProcessingDetails$numberOfRemovedThings": "The number of removed things in an over-the-air (OTA) task.
", "TaskProcessingDetails$numberOfSucceededThings": "The number of succeeded things in an over-the-air (OTA) task.
", "TaskProcessingDetails$numberOfTimedOutThings": "The number of timed out things in an over-the-air (OTA) task.
" } }, "InternalFailureException": { "base": "An unexpected error has occurred.
", "refs": { } }, "InternalServerException": { "base": "Internal error from the service that indicates an unexpected error or that the service is unavailable.
", "refs": { } }, "InternationalArticleNumber": { "base": null, "refs": { "GetManagedThingResponse$InternationalArticleNumber": "The unique 13 digit number that identifies the managed thing.
" } }, "InvalidRequestException": { "base": "The request is not valid.
", "refs": { } }, "IoTManagedIntegrationsResourceARN": { "base": null, "refs": { "ListTagsForResourceRequest$ResourceArn": "The ARN of the resource for which to list tags.
", "TagResourceRequest$ResourceArn": "The ARN of the resource to which to add tags.
", "UntagResourceRequest$ResourceArn": "The ARN of the resource to which to add tags.
" } }, "KmsKeyArn": { "base": null, "refs": { "GetDefaultEncryptionConfigurationResponse$kmsKeyArn": "The Key Amazon Resource Name (ARN) of the AWS KMS key used for KMS encryption if you use KMS_BASED_ENCRYPTION.
The Key Amazon Resource Name (ARN) of the AWS KMS key used for KMS encryption if you use KMS_BASED_ENCRYPTION.
The Key Amazon Resource Name (ARN) of the AWS KMS key used for KMS encryption if you use KMS_BASED_ENCRYPTION.
The Amazon Resource Name (ARN) of the Lambda function used as an endpoint.
", "ListCloudConnectorsRequest$LambdaArn": "The Amazon Resource Name (ARN) of the Lambda function to filter cloud connectors by.
" } }, "LambdaConfig": { "base": "Configuration details for an AWS Lambda function used as an endpoint for a cloud connector.
", "refs": { "EndpointConfig$lambda": "The Lambda function configuration for the endpoint, used when the endpoint communicates through an AWS Lambda function.
" } }, "LastUpdatedAt": { "base": null, "refs": { "GetOtaTaskResponse$LastUpdatedAt": "The timestamp value of when the over-the-air (OTA) task was last updated at.
", "OtaTaskExecutionSummary$LastUpdatedAt": "The timestamp value of when the over-the-air (OTA) task execution summary was last updated.
", "OtaTaskSummary$LastUpdatedAt": "The timestamp value of when the over-the-air (OTA) task was last updated at.
" } }, "LimitExceededException": { "base": "The request exceeds a service limit or quota. Adjust your request parameters and try again.
", "refs": { } }, "ListAccountAssociationsRequest": { "base": null, "refs": { } }, "ListAccountAssociationsResponse": { "base": null, "refs": { } }, "ListCloudConnectorsRequest": { "base": null, "refs": { } }, "ListCloudConnectorsResponse": { "base": null, "refs": { } }, "ListConnectorDestinationsRequest": { "base": null, "refs": { } }, "ListConnectorDestinationsResponse": { "base": null, "refs": { } }, "ListCredentialLockersRequest": { "base": null, "refs": { } }, "ListCredentialLockersResponse": { "base": null, "refs": { } }, "ListDestinationsRequest": { "base": null, "refs": { } }, "ListDestinationsResponse": { "base": null, "refs": { } }, "ListDeviceDiscoveriesRequest": { "base": null, "refs": { } }, "ListDeviceDiscoveriesResponse": { "base": null, "refs": { } }, "ListDiscoveredDevicesRequest": { "base": null, "refs": { } }, "ListDiscoveredDevicesResponse": { "base": null, "refs": { } }, "ListEventLogConfigurationsRequest": { "base": null, "refs": { } }, "ListEventLogConfigurationsResponse": { "base": null, "refs": { } }, "ListManagedThingAccountAssociationsRequest": { "base": null, "refs": { } }, "ListManagedThingAccountAssociationsResponse": { "base": null, "refs": { } }, "ListManagedThingSchemasRequest": { "base": null, "refs": { } }, "ListManagedThingSchemasResponse": { "base": null, "refs": { } }, "ListManagedThingsRequest": { "base": null, "refs": { } }, "ListManagedThingsResponse": { "base": null, "refs": { } }, "ListNotificationConfigurationsRequest": { "base": null, "refs": { } }, "ListNotificationConfigurationsResponse": { "base": null, "refs": { } }, "ListOtaTaskConfigurationsRequest": { "base": null, "refs": { } }, "ListOtaTaskConfigurationsResponse": { "base": null, "refs": { } }, "ListOtaTaskExecutionsRequest": { "base": null, "refs": { } }, "ListOtaTaskExecutionsResponse": { "base": null, "refs": { } }, "ListOtaTasksRequest": { "base": null, "refs": { } }, "ListOtaTasksResponse": { "base": null, "refs": { } }, "ListProvisioningProfilesRequest": { "base": null, "refs": { } }, "ListProvisioningProfilesResponse": { "base": null, "refs": { } }, "ListSchemaVersionsRequest": { "base": null, "refs": { } }, "ListSchemaVersionsResponse": { "base": null, "refs": { } }, "ListTagsForResourceRequest": { "base": null, "refs": { } }, "ListTagsForResourceResponse": { "base": null, "refs": { } }, "LocalStoreFileRotationMaxBytes": { "base": null, "refs": { "RuntimeLogConfigurations$LocalStoreFileRotationMaxBytes": "Configuration to set the maximum bytes of runtime logs that can be stored on the device before the oldest logs are deleted or overwritten.
" } }, "LocalStoreFileRotationMaxFiles": { "base": null, "refs": { "RuntimeLogConfigurations$LocalStoreFileRotationMaxFiles": "Configuration to set the maximum number of runtime log files that can be stored on the device before the oldest files are deleted or overwritten.
" } }, "LocalStoreLocation": { "base": null, "refs": { "RuntimeLogConfigurations$LocalStoreLocation": "Configuration of where to store runtime logs in the device.
" } }, "LogConfigurationId": { "base": null, "refs": { "CreateEventLogConfigurationResponse$Id": "The identifier of the event log configuration request.
", "DeleteEventLogConfigurationRequest$Id": "The identifier of the event log configuration.
", "EventLogConfigurationSummary$Id": "The identifier of the event log configuration.
", "GetEventLogConfigurationRequest$Id": "The identifier of the event log configuration.
", "GetEventLogConfigurationResponse$Id": "The identifier of the event log configuration.
", "UpdateEventLogConfigurationRequest$Id": "The log configuration id.
" } }, "LogLevel": { "base": null, "refs": { "CreateEventLogConfigurationRequest$EventLogLevel": "The logging level for the event log configuration.
", "EventLogConfigurationSummary$EventLogLevel": "The logging level for the event log configuration.
", "GetEventLogConfigurationResponse$EventLogLevel": "The logging level for the event log configuration.
", "RuntimeLogConfigurations$LogLevel": "The different log levels available for configuration.
", "RuntimeLogConfigurations$LogFlushLevel": "The different log levels available for configuration.
", "UpdateEventLogConfigurationRequest$EventLogLevel": "The log level for the event in terms of severity.
" } }, "MacAddress": { "base": null, "refs": { "GetManagedThingResponse$MacAddress": "The media access control (MAC) address for the device represented by the managed thing.
This parameter is used for Zigbee devices only.
The Amazon Resource Name (ARN) of the managed thing.
", "GetManagedThingResponse$Arn": "The Amazon Resource Name (ARN) of the managed thing.
", "ManagedThingSummary$Arn": "The Amazon Resource Name (ARN) of the managed thing.
" } }, "ManagedThingAssociation": { "base": "Structure representing an association between a managed thing and an account association, which connects a device to a third-party account.
", "refs": { "ManagedThingAssociationList$member": null } }, "ManagedThingAssociationList": { "base": null, "refs": { "ListManagedThingAccountAssociationsResponse$Items": "The list of managed thing associations that match the specified criteria, including the managed thing ID and account association ID for each association.
" } }, "ManagedThingId": { "base": null, "refs": { "CreateManagedThingResponse$Id": "The id of the managed thing.
", "DeleteManagedThingRequest$Identifier": "The id of the managed thing.
", "DeregisterAccountAssociationRequest$ManagedThingId": "The identifier of the managed thing to be deregistered from the account association.
", "DiscoveredDeviceSummary$ManagedThingId": "The identifier of the managed thing created for this discovered device, if one exists.
", "GetDeviceDiscoveryResponse$ControllerId": "The id of the end-user's IoT hub.
", "GetManagedThingCapabilitiesRequest$Identifier": "The id of the device.
", "GetManagedThingCapabilitiesResponse$ManagedThingId": "The id of the device.
", "GetManagedThingConnectivityDataRequest$Identifier": "The identifier of a managed thing.
", "GetManagedThingConnectivityDataResponse$ManagedThingId": "The id of a managed thing.
", "GetManagedThingMetaDataRequest$Identifier": "The managed thing id.
", "GetManagedThingMetaDataResponse$ManagedThingId": "The managed thing id.
", "GetManagedThingRequest$Identifier": "The id of the managed thing.
", "GetManagedThingResponse$Id": "The id of the managed thing.
", "GetManagedThingStateRequest$ManagedThingId": "The id of the device.
", "GetRuntimeLogConfigurationRequest$ManagedThingId": "The id for a managed thing.
", "GetRuntimeLogConfigurationResponse$ManagedThingId": "The id for a managed thing.
", "ListManagedThingAccountAssociationsRequest$ManagedThingId": "The identifier of the managed thing to list account associations for.
", "ListManagedThingSchemasRequest$Identifier": "The managed thing id.
", "ManagedThingAssociation$ManagedThingId": "The identifier of the managed thing in the association.
", "ManagedThingSummary$Id": "The id of the device.
", "OtaTaskExecutionSummaries$ManagedThingId": "The id of a managed thing.
", "PutRuntimeLogConfigurationRequest$ManagedThingId": "The id for a managed thing.
", "RegisterAccountAssociationRequest$ManagedThingId": "The identifier of the managed thing to register with the account association.
", "RegisterAccountAssociationResponse$ManagedThingId": "The identifier of the managed thing that was registered with the account association.
", "ResetRuntimeLogConfigurationRequest$ManagedThingId": "The id of a managed thing.
", "SendManagedThingCommandRequest$ManagedThingId": "The id of the device.
", "StartDeviceDiscoveryRequest$ControllerIdentifier": "The id of the end-user's IoT hub.
", "UpdateManagedThingRequest$Identifier": "The id of the managed thing.
" } }, "ManagedThingListDefinition": { "base": null, "refs": { "ListManagedThingsResponse$Items": "The list of managed things.
" } }, "ManagedThingSchemaListDefinition": { "base": null, "refs": { "ListManagedThingSchemasResponse$Items": "The list of managed thing schemas.
" } }, "ManagedThingSchemaListItem": { "base": "Structure representing one schema item associated with a managed thing.
", "refs": { "ManagedThingSchemaListDefinition$member": null } }, "ManagedThingSummary": { "base": "Structure representing one managed thing.
", "refs": { "ManagedThingListDefinition$member": null } }, "MatterAttributeId": { "base": null, "refs": { "MatterCapabilityReportAttribute$id": "The id of the Matter attribute.
" } }, "MatterAttributes": { "base": null, "refs": { "MatterCluster$attributes": "The Matter attributes.
" } }, "MatterCapabilityReport": { "base": "Matter based capability report.
", "refs": { "Device$CapabilityReport": "The capability report for the device.
" } }, "MatterCapabilityReportAttribute": { "base": "Matter attribute used in capability report.
", "refs": { "MatterCapabilityReportAttributes$member": null } }, "MatterCapabilityReportAttributeValue": { "base": null, "refs": { "MatterCapabilityReportAttribute$value": "Value for the Amazon Web Services Matter capability report attribute.
" } }, "MatterCapabilityReportAttributes": { "base": null, "refs": { "MatterCapabilityReportCluster$attributes": "The attributes of the Amazon Web Services Matter capability report.
" } }, "MatterCapabilityReportCluster": { "base": "Capability used in Matter capability report.
", "refs": { "MatterCapabilityReportClusters$member": null } }, "MatterCapabilityReportClusterRevisionId": { "base": null, "refs": { "CapabilitySchemaItem$ExtrinsicVersion": "The version of the external capability definition, used to track compatibility with external systems.
", "MatterCapabilityReportCluster$revision": "The id of the revision for the Amazon Web Services Matter capability report.
" } }, "MatterCapabilityReportClusters": { "base": null, "refs": { "MatterCapabilityReportEndpoint$clusters": "Matter clusters used in capability report.
" } }, "MatterCapabilityReportCommands": { "base": null, "refs": { "MatterCapabilityReportCluster$commands": "The commands used with the Amazon Web Services Matter capability report.
" } }, "MatterCapabilityReportEndpoint": { "base": "Matter endpoint used in capability report.
", "refs": { "MatterCapabilityReportEndpoints$member": null } }, "MatterCapabilityReportEndpointClientClusters": { "base": null, "refs": { "MatterCapabilityReportEndpoint$clientClusters": "Semantic information related to endpoint.
" } }, "MatterCapabilityReportEndpointParts": { "base": null, "refs": { "MatterCapabilityReportEndpoint$parts": "Heirachy of child endpoints contained in the given endpoint.
" } }, "MatterCapabilityReportEndpointSemanticTags": { "base": null, "refs": { "MatterCapabilityReportEndpoint$semanticTags": "Semantic information related to endpoint.
" } }, "MatterCapabilityReportEndpoints": { "base": null, "refs": { "MatterCapabilityReport$endpoints": "The endpoints used in the capability report.
" } }, "MatterCapabilityReportEvents": { "base": null, "refs": { "MatterCapabilityReportCluster$events": "The events used with the Amazon Web Services Matter capability report.
" } }, "MatterCapabilityReportFabricIndex": { "base": null, "refs": { "MatterCapabilityReportCluster$fabricIndex": "The fabric index for the Amazon Web Services Matter capability report.
" } }, "MatterCapabilityReportFeatureMap": { "base": null, "refs": { "MatterCapabilityReportCluster$featureMap": "32 bit-map used to indicate which features a cluster supports.
" } }, "MatterCapabilityReportGeneratedCommands": { "base": null, "refs": { "MatterCapabilityReportCluster$generatedCommands": "Matter clusters used in capability report.
" } }, "MatterCluster": { "base": "Describe a Matter cluster with an id, and the relevant attributes, commands, and events.
", "refs": { "MatterClusters$member": null } }, "MatterClusters": { "base": null, "refs": { "MatterEndpoint$clusters": "A list of Matter clusters for a managed thing.
" } }, "MatterCommandId": { "base": null, "refs": { "MatterCapabilityReportCommands$member": null, "MatterCapabilityReportGeneratedCommands$member": null, "MatterCommands$key": null } }, "MatterCommands": { "base": null, "refs": { "MatterCluster$commands": "Describe the Matter commands with the Matter command identifier mapped to the command fields.
" } }, "MatterEndpoint": { "base": "Structure describing a managed thing.
", "refs": { "SendConnectorEventRequest$MatterEndpoint": "The device endpoint.
" } }, "MatterEventId": { "base": null, "refs": { "MatterCapabilityReportEvents$member": null, "MatterEvents$key": null } }, "MatterEvents": { "base": null, "refs": { "MatterCluster$events": "Describe the Matter events with the Matter event identifier mapped to the event fields.
" } }, "MatterFields": { "base": null, "refs": { "MatterCommands$value": null, "MatterEvents$value": null } }, "MaxResults": { "base": null, "refs": { "ListAccountAssociationsRequest$MaxResults": "The maximum number of account associations to return in a single response.
", "ListCloudConnectorsRequest$MaxResults": "The maximum number of results to return at one time.
", "ListConnectorDestinationsRequest$MaxResults": "The maximum number of connector destinations to return in a single response.
", "ListCredentialLockersRequest$MaxResults": "The maximum number of results to return at one time.
", "ListDestinationsRequest$MaxResults": "The maximum number of results to return at one time.
", "ListDeviceDiscoveriesRequest$MaxResults": "The maximum number of device discovery jobs to return in a single response.
", "ListDiscoveredDevicesRequest$MaxResults": "The maximum number of discovered devices to return in a single response.
", "ListEventLogConfigurationsRequest$MaxResults": "The maximum number of results to return at one time.
", "ListManagedThingAccountAssociationsRequest$MaxResults": "The maximum number of account associations to return in a single response.
", "ListManagedThingSchemasRequest$MaxResults": "The maximum number of results to return at one time.
", "ListManagedThingsRequest$MaxResults": "The maximum number of results to return at one time.
", "ListNotificationConfigurationsRequest$MaxResults": "The maximum number of results to return at one time.
", "ListOtaTaskConfigurationsRequest$MaxResults": "The maximum number of results to return at one time.
", "ListOtaTaskExecutionsRequest$MaxResults": "The maximum number of results to return at one time.
", "ListOtaTasksRequest$MaxResults": "The maximum number of results to return at one time.
", "ListProvisioningProfilesRequest$MaxResults": "The maximum number of results to return at one time.
", "ListSchemaVersionsRequest$MaxResults": "The maximum number of results to return at one time.
" } }, "MaximumPerMinute": { "base": null, "refs": { "OtaTaskExecutionRolloutConfig$MaximumPerMinute": "The maximum number of things that will be notified of a pending task, per minute.
" } }, "MetaData": { "base": null, "refs": { "CreateManagedThingRequest$MetaData": "The metadata for the managed thing.
The managedThing metadata parameter is used for associating attributes with a managedThing that can be used for grouping over-the-air (OTA) tasks. Name value pairs in metadata can be used in the OtaTargetQueryString parameter for the CreateOtaTask API operation.
The metadata for the managed thing.
", "GetManagedThingResponse$MetaData": "The metadata for the managed thing.
", "UpdateManagedThingRequest$MetaData": "The metadata for the managed thing.
" } }, "MinNumberOfExecutedThings": { "base": null, "refs": { "AbortConfigCriteria$MinNumberOfExecutedThings": "The minimum number of things that must receive task execution notifications before the task can be aborted.
" } }, "MinNumberOfRetries": { "base": null, "refs": { "RetryConfigCriteria$MinNumberOfRetries": "The number of retries allowed for a failure type for the over-the-air (OTA) task.
" } }, "Model": { "base": null, "refs": { "CreateManagedThingRequest$Model": "The model of the device.
", "DiscoveredDeviceSummary$Model": "The model of the discovered device.
", "GetManagedThingResponse$Model": "The model of the device.
", "ManagedThingSummary$Model": "The model of the device.
", "UpdateManagedThingRequest$Model": "The model of the device.
" } }, "Name": { "base": null, "refs": { "CreateManagedThingRequest$Name": "The name of the managed thing representing the physical device.
", "GetManagedThingResponse$Name": "The name of the managed thing representing the physical device.
", "ManagedThingSummary$Name": "The name of the managed thing representing the physical device.
", "UpdateManagedThingRequest$Name": "The name of the managed thing representing the physical device.
" } }, "NextToken": { "base": null, "refs": { "ListAccountAssociationsRequest$NextToken": "A token used for pagination of results.
", "ListAccountAssociationsResponse$NextToken": "A token used for pagination of results when there are more account associations than can be returned in a single response.
", "ListCloudConnectorsRequest$NextToken": "A token that can be used to retrieve the next set of results.
", "ListCloudConnectorsResponse$NextToken": "A token that can be used to retrieve the next set of results.
", "ListConnectorDestinationsRequest$NextToken": "A token used for pagination of results.
", "ListConnectorDestinationsResponse$NextToken": "A token used for pagination of results when there are more connector destinations than can be returned in a single response.
", "ListCredentialLockersRequest$NextToken": "A token that can be used to retrieve the next set of results.
", "ListCredentialLockersResponse$NextToken": "A token that can be used to retrieve the next set of results.
", "ListDestinationsRequest$NextToken": "A token that can be used to retrieve the next set of results.
", "ListDestinationsResponse$NextToken": "A token that can be used to retrieve the next set of results.
", "ListDeviceDiscoveriesRequest$NextToken": "A token used for pagination of results.
", "ListDeviceDiscoveriesResponse$NextToken": "A token used for pagination of results when there are more device discovery jobs than can be returned in a single response.
", "ListDiscoveredDevicesRequest$NextToken": "A token used for pagination of results.
", "ListDiscoveredDevicesResponse$NextToken": "A token used for pagination of results when there are more discovered devices than can be returned in a single response.
", "ListEventLogConfigurationsRequest$NextToken": "A token that can be used to retrieve the next set of results.
", "ListEventLogConfigurationsResponse$NextToken": "A token that can be used to retrieve the next set of results.
", "ListManagedThingAccountAssociationsRequest$NextToken": "A token used for pagination of results.
", "ListManagedThingSchemasRequest$NextToken": "A token that can be used to retrieve the next set of results.
", "ListManagedThingSchemasResponse$NextToken": "A token that can be used to retrieve the next set of results.
", "ListManagedThingsRequest$NextToken": "A token that can be used to retrieve the next set of results.
", "ListManagedThingsResponse$NextToken": "A token that can be used to retrieve the next set of results.
", "ListNotificationConfigurationsRequest$NextToken": "A token that can be used to retrieve the next set of results.
", "ListNotificationConfigurationsResponse$NextToken": "A token that can be used to retrieve the next set of results.
", "ListOtaTaskConfigurationsRequest$NextToken": "A token that can be used to retrieve the next set of results.
", "ListOtaTaskConfigurationsResponse$NextToken": "A token that can be used to retrieve the next set of results.
", "ListProvisioningProfilesRequest$NextToken": "A token that can be used to retrieve the next set of results.
", "ListProvisioningProfilesResponse$NextToken": "A token that can be used to retrieve the next set of results.
", "ListSchemaVersionsRequest$NextToken": "A token that can be used to retrieve the next set of results.
", "ListSchemaVersionsResponse$NextToken": "A token that can be used to retrieve the next set of results.
" } }, "NodeId": { "base": null, "refs": { "CapabilityReport$nodeId": "The numeric identifier of the node.
", "MatterCapabilityReport$nodeId": "The numeric identifier of the node.
" } }, "NotificationConfigurationCreatedAt": { "base": null, "refs": { "GetNotificationConfigurationResponse$CreatedAt": "The timestamp value of when the notification configuration was created.
" } }, "NotificationConfigurationListDefinition": { "base": null, "refs": { "ListNotificationConfigurationsResponse$NotificationConfigurationList": "The list of notification configurations.
" } }, "NotificationConfigurationSummary": { "base": "Structure describing a notification configuration.
", "refs": { "NotificationConfigurationListDefinition$member": null } }, "NotificationConfigurationUpdatedAt": { "base": null, "refs": { "GetNotificationConfigurationResponse$UpdatedAt": "The timestamp value of when the notification configuration was last updated.
" } }, "NumberOfNotifiedThings": { "base": null, "refs": { "RolloutRateIncreaseCriteria$numberOfNotifiedThings": "The threshold for number of notified things that will initiate the increase in rate of rollout.
" } }, "NumberOfSucceededThings": { "base": null, "refs": { "RolloutRateIncreaseCriteria$numberOfSucceededThings": "The threshold for number of succeeded things that will initiate the increase in rate of rollout.
" } }, "OAuthAuthorizationUrl": { "base": null, "refs": { "CreateAccountAssociationResponse$OAuthAuthorizationUrl": "Third-party IoT platform OAuth authorization server URL backed with all the required parameters to perform end-user authentication.
", "GetAccountAssociationResponse$OAuthAuthorizationUrl": "Third party IoT platform OAuth authorization server URL backed with all the required parameters to perform end-user authentication.
", "StartAccountAssociationRefreshResponse$OAuthAuthorizationUrl": "Third-party IoT platform OAuth authorization server URL with all required parameters to perform end-user authentication during the refresh process.
" } }, "OAuthCompleteRedirectUrl": { "base": null, "refs": { "GetConnectorDestinationResponse$OAuthCompleteRedirectUrl": "The URL where users are redirected after completing the OAuth authorization process for the connector destination.
" } }, "OAuthConfig": { "base": "Configuration details for OAuth authentication with a third-party service.
", "refs": { "AuthConfig$oAuth": "The OAuth configuration settings used for authentication with the third-party service.
" } }, "OAuthUpdate": { "base": "Structure containing updated OAuth configuration settings.
", "refs": { "AuthConfigUpdate$oAuthUpdate": "The updated OAuth configuration settings for the authentication configuration.
" } }, "OtaDescription": { "base": null, "refs": { "CreateOtaTaskConfigurationRequest$Description": "A description of the over-the-air (OTA) task configuration.
", "CreateOtaTaskRequest$Description": "The description of the over-the-air (OTA) task.
", "CreateOtaTaskResponse$Description": "A description of the over-the-air (OTA) task.
", "GetOtaTaskConfigurationResponse$Description": "A description of the over-the-air (OTA) task configuration.
", "GetOtaTaskResponse$Description": "The description of the over-the-air (OTA) task.
", "UpdateOtaTaskRequest$Description": "The description of the over-the-air (OTA) task.
" } }, "OtaMechanism": { "base": null, "refs": { "CreateOtaTaskRequest$OtaMechanism": "The deployment mechanism for the over-the-air (OTA) task.
", "GetOtaTaskResponse$OtaMechanism": "The deployment mechanism for the over-the-air (OTA) task.
" } }, "OtaNextToken": { "base": null, "refs": { "ListOtaTaskExecutionsRequest$NextToken": "A token that can be used to retrieve the next set of results.
", "ListOtaTaskExecutionsResponse$NextToken": "A token that can be used to retrieve the next set of results.
", "ListOtaTasksRequest$NextToken": "A token that can be used to retrieve the next set of results.
", "ListOtaTasksResponse$NextToken": "A token that can be used to retrieve the next set of results.
" } }, "OtaProtocol": { "base": null, "refs": { "CreateOtaTaskRequest$Protocol": "The connection protocol the over-the-air (OTA) task uses to update the device.
", "GetOtaTaskResponse$Protocol": "The connection protocol the over-the-air (OTA) task uses to update the device.
" } }, "OtaStatus": { "base": null, "refs": { "GetOtaTaskResponse$Status": "The status of the over-the-air (OTA) task.
", "OtaTaskSummary$Status": "The status of the over-the-air (OTA) task summary.
" } }, "OtaTargetQueryString": { "base": null, "refs": { "CreateOtaTaskRequest$OtaTargetQueryString": "The query string to add things to the thing group.
", "GetOtaTaskResponse$OtaTargetQueryString": "The query string to add things to the thing group.
" } }, "OtaTaskAbortConfig": { "base": "Over-the-air (OTA) task abort config.
", "refs": { "PushConfig$AbortConfig": "Structure representing one abort config.
" } }, "OtaTaskArn": { "base": null, "refs": { "CreateOtaTaskResponse$TaskArn": "The Amazon Resource Name (ARN) of the over-the-air (OTA) task.
", "GetOtaTaskResponse$TaskArn": "The Amazon Resource Name (ARN) of the over-the-air (OTA) task
", "OtaTaskSummary$TaskArn": "The Amazon Resource Name (ARN) of the over-the-air (OTA) task.
" } }, "OtaTaskConfigurationId": { "base": null, "refs": { "CreateOtaTaskConfigurationResponse$TaskConfigurationId": "The identifier of the over-the-air (OTA) task configuration.
", "CreateOtaTaskRequest$TaskConfigurationId": "The identifier for the over-the-air (OTA) task configuration.
", "DeleteOtaTaskConfigurationRequest$Identifier": "The identifier of the over-the-air (OTA) task configuration.
", "GetOtaTaskConfigurationRequest$Identifier": "The over-the-air (OTA) task configuration id.
", "GetOtaTaskConfigurationResponse$TaskConfigurationId": "The over-the-air (OTA) task configuration id.
", "GetOtaTaskResponse$TaskConfigurationId": "The identifier for the over-the-air (OTA) task configuration.
", "OtaTaskConfigurationSummary$TaskConfigurationId": "The id of the over-the-air (OTA) task configuration
", "OtaTaskSummary$TaskConfigurationId": "The identifier for the over-the-air (OTA) task configuration.
", "UpdateOtaTaskRequest$TaskConfigurationId": "The identifier for the over-the-air (OTA) task configuration.
" } }, "OtaTaskConfigurationListDefinition": { "base": null, "refs": { "ListOtaTaskConfigurationsResponse$Items": "The list of the over-the-air (OTA) task configurations.
" } }, "OtaTaskConfigurationName": { "base": null, "refs": { "CreateOtaTaskConfigurationRequest$Name": "The name of the over-the-air (OTA) task.
", "GetOtaTaskConfigurationResponse$Name": "The name of the over-the-air (OTA) task configuration.
", "OtaTaskConfigurationSummary$Name": "The name of the over-the-air (OTA) task configuration.
" } }, "OtaTaskConfigurationSummary": { "base": "Structure representing one over-the-air (OTA) task configuration.
", "refs": { "OtaTaskConfigurationListDefinition$member": null } }, "OtaTaskExecutionRetryConfig": { "base": "Over-the-air (OTA) task retry config.
", "refs": { "CreateOtaTaskRequest$OtaTaskExecutionRetryConfig": null, "GetOtaTaskResponse$OtaTaskExecutionRetryConfig": null } }, "OtaTaskExecutionRolloutConfig": { "base": "Over-the-air (OTA) task rollout config.
", "refs": { "PushConfig$RolloutConfig": "Structure representing one rollout config.
" } }, "OtaTaskExecutionStatus": { "base": null, "refs": { "OtaTaskExecutionSummary$Status": "The status of the over-the-air (OTA) task execution summary.
" } }, "OtaTaskExecutionSummaries": { "base": "Structure representing one execution summary.
", "refs": { "OtaTaskExecutionSummariesListDefinition$member": null } }, "OtaTaskExecutionSummariesListDefinition": { "base": null, "refs": { "ListOtaTaskExecutionsResponse$ExecutionSummaries": "A list of all of the over-the-air (OTA) task executions.
" } }, "OtaTaskExecutionSummary": { "base": "Structure representing one over-the-air (OTA) task execution summary.
", "refs": { "OtaTaskExecutionSummaries$TaskExecutionSummary": "Structure representing one over-the-air (OTA) task execution summary
" } }, "OtaTaskId": { "base": null, "refs": { "CreateOtaTaskResponse$TaskId": "The identifier of the over-the-air (OTA) task.
", "DeleteOtaTaskRequest$Identifier": "The identifier of the over-the-air (OTA) task.
", "GetOtaTaskRequest$Identifier": "The over-the-air (OTA) task id.
", "GetOtaTaskResponse$TaskId": "The id of the over-the-air (OTA) task.
", "ListOtaTaskExecutionsRequest$Identifier": "The over-the-air (OTA) task id.
", "OtaTaskSummary$TaskId": "The id of the over-the-air (OTA) task.
", "UpdateOtaTaskRequest$Identifier": "The over-the-air (OTA) task id.
" } }, "OtaTaskListDefinition": { "base": null, "refs": { "ListOtaTasksResponse$Tasks": "A list of all of the over-the-air (OTA) tasks.
" } }, "OtaTaskSchedulingConfig": { "base": "Over-the-air (OTA) task scheduling config.
", "refs": { "CreateOtaTaskRequest$OtaSchedulingConfig": null, "GetOtaTaskResponse$OtaSchedulingConfig": null } }, "OtaTaskSummary": { "base": "Structure representing one over-the-air (OTA) task.
", "refs": { "OtaTaskListDefinition$member": null } }, "OtaTaskTimeoutConfig": { "base": "Over-the-air (OTA) task timeout config.
", "refs": { "PushConfig$TimeoutConfig": "Structure representing one timeout config.
" } }, "OtaType": { "base": null, "refs": { "CreateOtaTaskRequest$OtaType": "The frequency type for the over-the-air (OTA) task.
", "GetOtaTaskResponse$OtaType": "The frequency type for the over-the-air (OTA) task.
" } }, "Owner": { "base": null, "refs": { "CreateManagedThingRequest$Owner": "Owner of the device, usually an indication of whom the device belongs to. This value should not contain personal identifiable information.
", "GetManagedThingResponse$Owner": "Owner of the device, usually an indication of whom the device belongs to. This value should not contain personal identifiable information.
", "ListManagedThingsRequest$OwnerFilter": "Filter on device owners when listing managed things.
", "ManagedThingSummary$Owner": "Owner of the device, usually an indication of whom the device belongs to. This value should not contain personal identifiable information.
", "UpdateManagedThingRequest$Owner": "Owner of the device, usually an indication of whom the device belongs to. This value should not contain personal identifiable information.
" } }, "ParentControllerId": { "base": null, "refs": { "GetManagedThingResponse$ParentControllerId": "Id of the controller device used for the discovery job.
", "ListManagedThingsRequest$ParentControllerIdentifierFilter": "Filter on a parent controller id for a managed thing.
", "ManagedThingSummary$ParentControllerId": "Id of the controller device used for the discovery job.
" } }, "ProactiveRefreshTokenRenewal": { "base": "Configuration settings for proactively refreshing OAuth tokens before they expire.
", "refs": { "OAuthConfig$proactiveRefreshTokenRenewal": "Configuration for proactively refreshing OAuth tokens before they expire.
", "OAuthUpdate$proactiveRefreshTokenRenewal": "Updated configuration for proactively refreshing OAuth tokens before they expire.
" } }, "ProactiveRefreshTokenRenewalDaysBeforeRenewalInteger": { "base": null, "refs": { "ProactiveRefreshTokenRenewal$DaysBeforeRenewal": "The days before token expiration when the system should attempt to renew the token, specified in days.
" } }, "PropertyName": { "base": null, "refs": { "CapabilityReportProperties$member": null } }, "ProvisioningProfileArn": { "base": null, "refs": { "CreateProvisioningProfileResponse$Arn": "The Amazon Resource Name (ARN) of the provisioning template used in the provisioning profile.
", "GetProvisioningProfileResponse$Arn": "The Amazon Resource Name (ARN) of the provisioning template used in the provisioning profile.
", "ProvisioningProfileSummary$Arn": "The Amazon Resource Name (ARN) of the provisioning template used in the provisioning profile.
" } }, "ProvisioningProfileId": { "base": null, "refs": { "CreateProvisioningProfileResponse$Id": "The identifier of the provisioning profile.
", "DeleteProvisioningProfileRequest$Identifier": "The name of the provisioning template.
", "GetProvisioningProfileRequest$Identifier": "The provisioning template the device uses for the provisioning process.
", "GetProvisioningProfileResponse$Id": "The provisioning profile id..
", "ProvisioningProfileSummary$Id": "The identifier of the provisioning profile.
" } }, "ProvisioningProfileListDefinition": { "base": null, "refs": { "ListProvisioningProfilesResponse$Items": "The list of provisioning profiles.
" } }, "ProvisioningProfileName": { "base": null, "refs": { "CreateProvisioningProfileRequest$Name": "The name of the provisioning template.
", "CreateProvisioningProfileResponse$Name": "The name of the provisioning template.
", "GetProvisioningProfileResponse$Name": "The name of the provisioning template.
", "ProvisioningProfileSummary$Name": "The name of the provisioning template.
" } }, "ProvisioningProfileSummary": { "base": "Structure describing a provisioning profile.
", "refs": { "ProvisioningProfileListDefinition$member": null } }, "ProvisioningStatus": { "base": null, "refs": { "GetManagedThingResponse$ProvisioningStatus": "The provisioning status of the device in the provisioning workflow for onboarding to IoT managed integrations.
", "ListManagedThingsRequest$ProvisioningStatusFilter": "Filter on the status of the device.
", "ManagedThingSummary$ProvisioningStatus": "The provisioning status of the device in the provisioning workflow for onboarding to IoT managed integrations.
" } }, "ProvisioningType": { "base": null, "refs": { "CreateProvisioningProfileRequest$ProvisioningType": "The type of provisioning workflow the device uses for onboarding to IoT managed integrations.
", "CreateProvisioningProfileResponse$ProvisioningType": "The type of provisioning workflow the device uses for onboarding to IoT managed integrations.
", "GetProvisioningProfileResponse$ProvisioningType": "The type of provisioning workflow the device uses for onboarding to IoT managed integrations.
", "ProvisioningProfileSummary$ProvisioningType": "The type of provisioning workflow the device uses for onboarding to IoT managed integrations.
" } }, "PushConfig": { "base": "Structure representing a push config.
", "refs": { "CreateOtaTaskConfigurationRequest$PushConfig": "Describes the type of configuration used for the over-the-air (OTA) task.
", "GetOtaTaskConfigurationResponse$PushConfig": "Describes the type of configuration used for the over-the-air (OTA) task.
" } }, "PutDefaultEncryptionConfigurationRequest": { "base": null, "refs": { } }, "PutDefaultEncryptionConfigurationResponse": { "base": null, "refs": { } }, "PutHubConfigurationRequest": { "base": null, "refs": { } }, "PutHubConfigurationResponse": { "base": null, "refs": { } }, "PutRuntimeLogConfigurationRequest": { "base": null, "refs": { } }, "QueuedAt": { "base": null, "refs": { "OtaTaskExecutionSummary$QueuedAt": "The timestamp value of when the over-the-air (OTA) task execution summary is targeted to start.
" } }, "RegisterAccountAssociationRequest": { "base": null, "refs": { } }, "RegisterAccountAssociationResponse": { "base": null, "refs": { } }, "RegisterCustomEndpointRequest": { "base": null, "refs": { } }, "RegisterCustomEndpointResponse": { "base": null, "refs": { } }, "ResetRuntimeLogConfigurationRequest": { "base": null, "refs": { } }, "ResourceNotFoundException": { "base": "The specified resource does not exist.
", "refs": { } }, "RetryAttempt": { "base": null, "refs": { "OtaTaskExecutionSummary$RetryAttempt": "The number of retry attempts for starting the over-the-air (OTA) task execution summary after a failed attempt.
" } }, "RetryConfigCriteria": { "base": "Structure representing one retry config criteria.
", "refs": { "RetryConfigCriteriaList$member": null } }, "RetryConfigCriteriaList": { "base": null, "refs": { "OtaTaskExecutionRetryConfig$RetryConfigCriteria": "The list of retry config criteria.
" } }, "RetryCriteriaFailureType": { "base": null, "refs": { "RetryConfigCriteria$FailureType": "Over-the-air (OTA) retry criteria failure type.
" } }, "Role": { "base": null, "refs": { "CreateManagedThingRequest$Role": "The type of device used. This will be the hub controller, cloud device, or AWS IoT device.
", "GetManagedThingResponse$Role": "The type of device used. This will be the Amazon Web Services hub controller, cloud device, or IoT device.
", "ListManagedThingsRequest$RoleFilter": "Filter on the type of device used. This will be the Amazon Web Services hub controller, cloud device, or IoT device.
", "ManagedThingSummary$Role": "The type of device used. This will be the Amazon Web Services hub controller, cloud device, or IoT device.
" } }, "RolloutRateIncreaseCriteria": { "base": "Structure representing rollout config criteria.
", "refs": { "ExponentialRolloutRate$RateIncreaseCriteria": "The criteria for increasing the rollout rate of an over-the-air (OTA) task.
" } }, "RuntimeLogConfigurations": { "base": "The different configurations for runtime logs.
", "refs": { "GetRuntimeLogConfigurationResponse$RuntimeLogConfigurations": "The runtime log configuration for a managed thing.
", "PutRuntimeLogConfigurationRequest$RuntimeLogConfigurations": "The runtime log configuration for a managed thing.
" } }, "S3Url": { "base": null, "refs": { "CreateOtaTaskRequest$S3Url": "The URL to the Amazon S3 bucket where the over-the-air (OTA) task is stored.
", "GetOtaTaskResponse$S3Url": "The URL to the Amazon S3 bucket where the over-the-air (OTA) task is stored.
" } }, "ScheduleMaintenanceWindow": { "base": "Structure representing scheduling maintenance window.
", "refs": { "ScheduleMaintenanceWindowList$member": null } }, "ScheduleMaintenanceWindowList": { "base": null, "refs": { "OtaTaskSchedulingConfig$MaintenanceWindows": "Maintenance window list for over-the-air (OTA) task scheduling config.
" } }, "ScheduleStartTime": { "base": null, "refs": { "OtaTaskSchedulingConfig$StartTime": "The time an over-the-air (OTA) task will start.
" } }, "SchedulingConfigEndBehavior": { "base": null, "refs": { "OtaTaskSchedulingConfig$EndBehavior": "Specifies the end behavior for all task executions after a task reaches the selected endTime. If endTime is not selected when creating the task, then endBehavior does not apply.
The id of the schema version.
", "ListSchemaVersionsRequest$SchemaId": "Filter on the id of the schema version.
", "SchemaVersionListItem$SchemaId": "The identifier of the schema version.
" } }, "SchemaVersionDescription": { "base": null, "refs": { "GetSchemaVersionResponse$Description": "The description of the schema version.
", "SchemaVersionListItem$Description": "A description of the schema version.
" } }, "SchemaVersionFormat": { "base": null, "refs": { "CapabilitySchemaItem$Format": "The format of the capability schema, which defines how the schema is structured and interpreted.
", "GetSchemaVersionRequest$Format": "The format of the schema version.
" } }, "SchemaVersionList": { "base": null, "refs": { "ListSchemaVersionsResponse$Items": "The list of schema versions.
" } }, "SchemaVersionListItem": { "base": "List item describing a schema version.
", "refs": { "SchemaVersionList$member": null } }, "SchemaVersionNamespaceName": { "base": null, "refs": { "GetSchemaVersionResponse$Namespace": "The name of the schema version.
", "ListSchemaVersionsRequest$Namespace": "Filter on the name of the schema version.
", "SchemaVersionListItem$Namespace": "The name of the schema version.
" } }, "SchemaVersionSchema": { "base": null, "refs": { "GetSchemaVersionResponse$Schema": "The schema of the schema version.
" } }, "SchemaVersionType": { "base": null, "refs": { "GetSchemaVersionRequest$Type": "The type of schema version.
", "GetSchemaVersionResponse$Type": "The type of schema version.
", "ListSchemaVersionsRequest$Type": "Filter on the type of schema version.
", "SchemaVersionListItem$Type": "The type of schema version.
" } }, "SchemaVersionVersion": { "base": null, "refs": { "GetSchemaVersionResponse$SemanticVersion": "The schema version. If this is left blank, it defaults to the latest version.
", "ListSchemaVersionsRequest$SemanticVersion": "The schema version. If this is left blank, it defaults to the latest version.
", "SchemaVersionListItem$SemanticVersion": "The schema version. If this is left blank, it defaults to the latest version.
" } }, "SchemaVersionVisibility": { "base": null, "refs": { "GetSchemaVersionResponse$Visibility": "The visibility of the schema version.
", "ListSchemaVersionsRequest$Visibility": "The visibility of the schema version.
", "SchemaVersionListItem$Visibility": "The visibility of the schema version.
" } }, "SchemaVersionedId": { "base": null, "refs": { "CapabilityReportCapability$id": "The id of the schema version.
", "CapabilitySchemaItem$CapabilityId": "The unique identifier of the capability defined in the schema.
", "CommandCapability$id": "Describe the capability with an id.
", "GetSchemaVersionRequest$SchemaVersionedId": "Schema id with a version specified. If the version is missing, it defaults to latest version.
", "MatterCapabilityReportCluster$publicId": "The id of the schema version.
", "StateCapability$id": "The id of the managed thing in the capability report.
" } }, "SecretsManager": { "base": "Configuration for AWS Secrets Manager, used to securely store and manage sensitive information for connector destinations.
", "refs": { "CreateConnectorDestinationRequest$SecretsManager": "The AWS Secrets Manager configuration used to securely store and manage sensitive information for the connector destination.
", "GetConnectorDestinationResponse$SecretsManager": "The AWS Secrets Manager configuration used to securely store and manage sensitive information for the connector destination.
", "UpdateConnectorDestinationRequest$SecretsManager": "The updated AWS Secrets Manager configuration for the connector destination.
" } }, "SecretsManagerArn": { "base": null, "refs": { "SecretsManager$arn": "The Amazon Resource Name (ARN) of the AWS Secrets Manager secret.
" } }, "SecretsManagerVersionId": { "base": null, "refs": { "SecretsManager$versionId": "The version ID of the AWS Secrets Manager secret.
" } }, "SendConnectorEventRequest": { "base": null, "refs": { } }, "SendConnectorEventResponse": { "base": null, "refs": { } }, "SendManagedThingCommandRequest": { "base": null, "refs": { } }, "SendManagedThingCommandResponse": { "base": null, "refs": { } }, "SerialNumber": { "base": null, "refs": { "CreateManagedThingRequest$SerialNumber": "The serial number of the device.
", "GetManagedThingResponse$SerialNumber": "The serial number of the device.
", "ListManagedThingsRequest$SerialNumberFilter": "Filter on the serial number of the device.
", "ManagedThingSummary$SerialNumber": "The serial number of the device.
", "UpdateManagedThingRequest$SerialNumber": "The serial number of the device.
" } }, "ServiceQuotaExceededException": { "base": "The service quota has been exceeded for this request.
", "refs": { } }, "ServiceUnavailableException": { "base": "The service is temporarily unavailable.
", "refs": { } }, "SetupAt": { "base": null, "refs": { "GetManagedThingResponse$ActivatedAt": "The timestampe value of when the device was activated.
", "ManagedThingSummary$ActivatedAt": "The timestampe value of when the managed thing was activated at.
" } }, "SmartHomeResourceId": { "base": null, "refs": { "CreateEventLogConfigurationRequest$ResourceId": "The identifier of the resource for the event log configuration.
", "EventLogConfigurationSummary$ResourceId": "The identifier of the resource for the event log configuration.
", "GetEventLogConfigurationResponse$ResourceId": "The identifier of the resource for the event log configuration.
" } }, "SmartHomeResourceType": { "base": null, "refs": { "CreateEventLogConfigurationRequest$ResourceType": "The type of resource for the event log configuration.
", "EventLogConfigurationSummary$ResourceType": "The type of resource for the event log configuration.
", "GetEventLogConfigurationResponse$ResourceType": "The type of resource for the event log configuration.
" } }, "SpecVersion": { "base": null, "refs": { "MatterCapabilityReportCluster$specVersion": "The spec version used in the Amazon Web Services Matter capability report.
" } }, "StartAccountAssociationRefreshRequest": { "base": null, "refs": { } }, "StartAccountAssociationRefreshResponse": { "base": null, "refs": { } }, "StartDeviceDiscoveryRequest": { "base": null, "refs": { } }, "StartDeviceDiscoveryResponse": { "base": null, "refs": { } }, "StartTime": { "base": null, "refs": { "ScheduleMaintenanceWindow$StartTime": "Displays the start time of the next maintenance window.
" } }, "StartedAt": { "base": null, "refs": { "OtaTaskExecutionSummary$StartedAt": "The timestamp value of when the over-the-air (OTA) task execution summary started.
" } }, "StateCapabilities": { "base": null, "refs": { "StateEndpoint$capabilities": "Describe the endpoint with an id, a name, and the relevant capabilities for the reporting state.
" } }, "StateCapability": { "base": "State capabilities added for the managed thing.
", "refs": { "StateCapabilities$member": null } }, "StateEndpoint": { "base": "Describe the endpoint with an Id, a name, and the relevant capabilities for reporting state
", "refs": { "StateEndpoints$member": null } }, "StateEndpoints": { "base": null, "refs": { "GetManagedThingStateResponse$Endpoints": "The device endpoint.
" } }, "String": { "base": null, "refs": { "ListManagedThingAccountAssociationsResponse$NextToken": "A token used for pagination of results when there are more account associations than can be returned in a single response.
", "OAuthConfig$scope": "The OAuth scopes requested during authorization, which define the permissions granted to the application.
", "OAuthConfig$oAuthCompleteRedirectUrl": "The URL where users are redirected after completing the OAuth authorization process.
", "OAuthUpdate$oAuthCompleteRedirectUrl": "The updated URL where users are redirected after completing the OAuth authorization process.
", "Target$member": null } }, "TagKey": { "base": null, "refs": { "TagKeyList$member": null, "TagsMap$key": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$TagKeys": "A list of tag keys to remove from the resource.
" } }, "TagResourceRequest": { "base": null, "refs": { } }, "TagResourceResponse": { "base": null, "refs": { } }, "TagValue": { "base": null, "refs": { "TagsMap$value": null } }, "TagsMap": { "base": null, "refs": { "CreateAccountAssociationRequest$Tags": "A set of key/value pairs that are used to manage the account association.
", "CreateCredentialLockerRequest$Tags": "A set of key/value pairs that are used to manage the credential locker.
", "CreateDestinationRequest$Tags": "A set of key/value pairs that are used to manage the destination.
", "CreateManagedThingRequest$Tags": "A set of key/value pairs that are used to manage the managed thing.
", "CreateNotificationConfigurationRequest$Tags": "A set of key/value pairs that are used to manage the notification configuration.
", "CreateOtaTaskRequest$Tags": "A set of key/value pairs that are used to manage the over-the-air (OTA) task.
", "CreateProvisioningProfileRequest$Tags": "A set of key/value pairs that are used to manage the provisioning profile.
", "GetAccountAssociationResponse$Tags": "A set of key/value pairs that are used to manage the account association.
", "GetCredentialLockerResponse$Tags": "A set of key/value pairs that are used to manage the credential locker.
", "GetDestinationResponse$Tags": "A set of key/value pairs that are used to manage the customer-managed destination.
", "GetDeviceDiscoveryResponse$Tags": "A set of key/value pairs that are used to manage the device discovery request.
", "GetManagedThingResponse$Tags": "A set of key/value pairs that are used to manage the managed thing.
", "GetNotificationConfigurationResponse$Tags": "A set of key/value pairs that are used to manage the notification configuration.
", "GetOtaTaskResponse$Tags": "A set of key/value pairs that are used to manage the over-the-air (OTA) task.
", "GetProvisioningProfileResponse$Tags": "A set of key/value pairs that are used to manage the provisioning profile.
", "ListTagsForResourceResponse$tags": "A set of key/value pairs that are used to manage the resource.
", "StartDeviceDiscoveryRequest$Tags": "A set of key/value pairs that are used to manage the device discovery request.
", "TagResourceRequest$Tags": "A set of key/value pairs that are used to manage the resource
" } }, "Target": { "base": null, "refs": { "CreateOtaTaskRequest$Target": "The device targeted for the over-the-air (OTA) task.
", "GetOtaTaskResponse$Target": "The device targeted for the over-the-air (OTA) task.
", "TaskProcessingDetails$processingTargets": "The targets of the over-the-air (OTA) task.
" } }, "TaskProcessingDetails": { "base": "Details about the over-the-air (OTA) task process.
", "refs": { "GetOtaTaskResponse$TaskProcessingDetails": "The processing details of all over-the-air (OTA) tasks.
" } }, "ThirdPartyUserId": { "base": null, "refs": { "SendConnectorEventRequest$UserId": "The id of the third-party cloud provider.
" } }, "ThresholdPercentage": { "base": null, "refs": { "AbortConfigCriteria$ThresholdPercentage": "The minimum percentage of over-the-air (OTA) task execution failures that must occur to initiate the last abort.
" } }, "ThrottlingException": { "base": "The rate exceeds the limit.
", "refs": { } }, "TokenEndpointAuthenticationScheme": { "base": null, "refs": { "OAuthConfig$tokenEndpointAuthenticationScheme": "The authentication scheme used when requesting tokens from the token endpoint.
" } }, "TokenUrl": { "base": null, "refs": { "OAuthConfig$tokenUrl": "The token URL for the OAuth service, where authorization codes are exchanged for access tokens.
" } }, "TraceId": { "base": null, "refs": { "SendConnectorEventRequest$TraceId": "The trace request identifier used to correlate a command request and response. This is specified by the device owner, but will be generated by IoT managed integrations if not provided by the device owner.
", "SendManagedThingCommandResponse$TraceId": "The trace request identifier. This is specified by the device owner, but will be generated by IoT managed integrations if not provided by the device owner.
" } }, "UnauthorizedException": { "base": "You are not authorized to perform this operation.
", "refs": { } }, "UniversalProductCode": { "base": null, "refs": { "GetManagedThingResponse$UniversalProductCode": "The universal product code (UPC) of the device model. The UPC is typically used in the United States of America and Canada.
" } }, "UntagResourceRequest": { "base": null, "refs": { } }, "UntagResourceResponse": { "base": null, "refs": { } }, "UpdateAccountAssociationRequest": { "base": null, "refs": { } }, "UpdateCloudConnectorRequest": { "base": null, "refs": { } }, "UpdateConnectorDestinationRequest": { "base": null, "refs": { } }, "UpdateDestinationRequest": { "base": null, "refs": { } }, "UpdateEventLogConfigurationRequest": { "base": null, "refs": { } }, "UpdateManagedThingRequest": { "base": null, "refs": { } }, "UpdateNotificationConfigurationRequest": { "base": null, "refs": { } }, "UpdateOtaTaskRequest": { "base": null, "refs": { } }, "UpdatedAt": { "base": null, "refs": { "GetManagedThingResponse$UpdatedAt": "The timestamp value of when the managed thing was last updated at.
" } }, "UploadLog": { "base": null, "refs": { "RuntimeLogConfigurations$UploadLog": "Configuration to enable or disable uploading of runtime logs to the cloud.
" } }, "UploadPeriodMinutes": { "base": null, "refs": { "RuntimeLogConfigurations$UploadPeriodMinutes": "Configuration to set the time interval in minutes between each batch of runtime logs that the device uploads to the cloud.
" } }, "ValidationException": { "base": "A validation error occurred when performing the API request.
", "refs": { } }, "ValidationSchema": { "base": null, "refs": { "CapabilitySchemaItem$Schema": "The actual schema definition that describes the capability's properties, actions, and events.
", "ManagedThingSchemaListItem$Schema": "The validation schema for one schema item associated with a managed thing.
" } } } }