Expand description
Data structures used by operation inputs/outputs.
Modules§
- builders
- Builders
- error
- Error types that Managed integrations for AWS IoT Device Management can respond with.
Structs§
- Abort
Config Criteria Structure representing one abort config criteria.
- Account
Association Item Structure containing information about an account association, including its identifier, state, and related metadata.
- Auth
Config The authentication configuration details for a connector destination, including OAuth settings and other authentication parameters.
- Auth
Config Update The updated authentication configuration details for a connector destination.
- Capability
Action Action for an Amazon Web Services capability, containing the action parameters for control.
- Capability
Report Report of all capabilities supported by the device.
- Capability
Report Capability The capability used in capability report.
- Capability
Report Endpoint The endpoint used in the capability report.
- Capability
Schema Item Structure representing a capability schema item that defines the functionality and features supported by a managed thing.
- Command
Capability The command capabilities added for the managed thing
- Command
Endpoint The endpoint for a managed thing when sending a command.
- Configuration
Error Provides the default encryption configuration error update details.
- Configuration
Status Provides the status of the default encryption configuration for an Amazon Web Services account.
- Connector
Destination Summary Structure containing summary information about a connector destination, which defines how a cloud-to-cloud connector connects to a customer's AWS account.
- Connector
Item Structure describing a connector.
- Credential
Locker Summary Structure describing one Credential Locker.
- Destination
Summary Structure describing a destination for IoT managed integrations to deliver notifications for a device.
- Device
Describe the device using the relevant metadata and supported clusters for device discovery.
- Device
Discovery Summary Structure containing summary information about a device discovery job, including its identifier, type, and status.
- Discovered
Device Summary Structure containing summary information about a device discovered during a device discovery job.
- Endpoint
Config The configuration details for an endpoint, which defines how to connect to and communicate with external services.
- Event
LogConfiguration Summary List of event log configurations.
- Exponential
Rollout Rate Structure representing exponential rate of rollout for an over-the-air (OTA) task.
- Lambda
Config Configuration details for an AWS Lambda function used as an endpoint for a cloud connector.
- Managed
Thing Association Structure representing an association between a managed thing and an account association, which connects a device to a third-party account.
- Managed
Thing Schema List Item Structure representing one schema item associated with a managed thing.
- Managed
Thing Summary Structure representing one managed thing.
- Matter
Capability Report Matter based capability report.
- Matter
Capability Report Attribute Matter attribute used in capability report.
- Matter
Capability Report Cluster Capability used in Matter capability report.
- Matter
Capability Report Endpoint Matter endpoint used in capability report.
- Matter
Cluster Describe a Matter cluster with an id, and the relevant attributes, commands, and events.
- Matter
Endpoint Structure describing a managed thing.
- Notification
Configuration Summary Structure describing a notification configuration.
- OAuth
Config Configuration details for OAuth authentication with a third-party service.
- OAuth
Update Structure containing updated OAuth configuration settings.
- OtaTask
Abort Config Over-the-air (OTA) task abort config.
- OtaTask
Configuration Summary Structure representing one over-the-air (OTA) task configuration.
- OtaTask
Execution Retry Config Over-the-air (OTA) task retry config.
- OtaTask
Execution Rollout Config Over-the-air (OTA) task rollout config.
- OtaTask
Execution Summaries Structure representing one execution summary.
- OtaTask
Execution Summary Structure representing one over-the-air (OTA) task execution summary.
- OtaTask
Scheduling Config Over-the-air (OTA) task scheduling config.
- OtaTask
Summary Structure representing one over-the-air (OTA) task.
- OtaTask
Timeout Config Over-the-air (OTA) task timeout config.
- Proactive
Refresh Token Renewal Configuration settings for proactively refreshing OAuth tokens before they expire.
- Provisioning
Profile Summary Structure describing a provisioning profile.
- Push
Config Structure representing a push config.
- Retry
Config Criteria Structure representing one retry config criteria.
- Rollout
Rate Increase Criteria Structure representing rollout config criteria.
- Runtime
LogConfigurations The different configurations for runtime logs.
- Schedule
Maintenance Window Structure representing scheduling maintenance window.
- Schema
Version List Item List item describing a schema version.
- Secrets
Manager Configuration for AWS Secrets Manager, used to securely store and manage sensitive information for connector destinations.
- State
Capability State capabilities added for the managed thing.
- State
Endpoint Describe the endpoint with an Id, a name, and the relevant capabilities for reporting state
- Task
Processing Details Details about the over-the-air (OTA) task process.
Enums§
- Abort
Criteria Action - When writing a match expression against
AbortCriteriaAction
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Abort
Criteria Failure Type - When writing a match expression against
AbortCriteriaFailureType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Association
State - When writing a match expression against
AssociationState
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Auth
Material Type - When writing a match expression against
AuthMaterialType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Auth
Type - When writing a match expression against
AuthType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Cloud
Connector Type - When writing a match expression against
CloudConnectorType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Configuration
State - When writing a match expression against
ConfigurationState
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Connector
Event Operation - When writing a match expression against
ConnectorEventOperation
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Delivery
Destination Type - When writing a match expression against
DeliveryDestinationType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Device
Discovery Status - When writing a match expression against
DeviceDiscoveryStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Disconnect
Reason Value - When writing a match expression against
DisconnectReasonValue
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Discovery
Auth Material Type - When writing a match expression against
DiscoveryAuthMaterialType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Discovery
Modification - When writing a match expression against
DiscoveryModification
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Discovery
Type - When writing a match expression against
DiscoveryType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Encryption
Type - When writing a match expression against
EncryptionType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Endpoint
Type - When writing a match expression against
EndpointType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Event
Type - When writing a match expression against
EventType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - HubNetwork
Mode - When writing a match expression against
HubNetworkMode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - LogLevel
- When writing a match expression against
LogLevel
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - OtaMechanism
- When writing a match expression against
OtaMechanism
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - OtaProtocol
- When writing a match expression against
OtaProtocol
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - OtaStatus
- When writing a match expression against
OtaStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - OtaTask
Execution Status - When writing a match expression against
OtaTaskExecutionStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - OtaType
- When writing a match expression against
OtaType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Provisioning
Status - When writing a match expression against
ProvisioningStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Provisioning
Type - When writing a match expression against
ProvisioningType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Retry
Criteria Failure Type - When writing a match expression against
RetryCriteriaFailureType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Role
- When writing a match expression against
Role
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Scheduling
Config EndBehavior - When writing a match expression against
SchedulingConfigEndBehavior
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Schema
Version Format - When writing a match expression against
SchemaVersionFormat
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Schema
Version Type - When writing a match expression against
SchemaVersionType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Schema
Version Visibility - When writing a match expression against
SchemaVersionVisibility
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Token
Endpoint Authentication Scheme - When writing a match expression against
TokenEndpointAuthenticationScheme
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.