DiscoveredDeviceSummary
Structure containing summary information about a device discovered during a device discovery job.
Contents
- AuthenticationMaterial
-
The authentication material required for connecting to the discovered device, such as credentials or tokens.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
[0-9A-Za-z!#$%&()*\+\-;<=>?@^_`{|}~\/: {},\\"]+
Required: No
- Brand
-
The brand of the discovered device.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[A-Za-z0-9-_ ]+
Required: No
- ConnectorDeviceId
-
The third-party device identifier as defined by the connector. This identifier must not contain personal identifiable information (PII).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9_.,@-]+
Required: No
- ConnectorDeviceName
-
The name of the device as defined by the connector or third-party system.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\p{L}\p{N} ._-]+
Required: No
- DeviceTypes
-
The list of device types or categories that the discovered device belongs to.
Type: Array of strings
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
[a-zA-Z0-9=_. ,@\+\-/]+
Required: No
- DiscoveredAt
-
The timestamp indicating when the device was discovered.
Type: Timestamp
Required: No
- ManagedThingId
-
The identifier of the managed thing created for this discovered device, if one exists.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9:_-]*
Required: No
- Model
-
The model of the discovered device.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[A-Za-z0-9-_ ]+
Required: No
- Modification
-
The status of the discovered device, indicating whether it has been added, removed, or modified since the last discovery.
Type: String
Valid Values:
DISCOVERED | UPDATED | NO_CHANGE
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: