Skip to content

CreateManagedThingRequest

Source code in docs_src/capo_iot_managed_integrations/types/create_managed_thing_request.py
class CreateManagedThingRequest(TypedDict, closed=True):
    role: "capo_iot_managed_integrations.types.role.Role"
    """<p>The type of device used. This will be the hub controller, cloud device, or AWS IoT device.</p>"""
    owner: NotRequired["capo_iot_managed_integrations.types.owner.Owner"]
    """<p>Owner of the device, usually an indication of whom the device belongs to. This value should not contain personal identifiable information.</p>"""
    credential_locker_id: NotRequired[
        "capo_iot_managed_integrations.types.credential_locker_id.CredentialLockerId"
    ]
    """<p>The identifier of the credential for the managed thing.</p>"""
    authentication_material: (
        "capo_iot_managed_integrations.types.auth_material_string.AuthMaterialString"
    )
    """<p>The authentication material defining the device connectivity setup requests. The authorization materials used are the device bar code.</p>"""
    authentication_material_type: (
        "capo_iot_managed_integrations.types.auth_material_type.AuthMaterialType"
    )
    """<p>The type of authentication material used for device connectivity setup requests.</p>"""
    wi_fi_simple_setup_configuration: NotRequired[
        "capo_iot_managed_integrations.types.wi_fi_simple_setup_configuration.WiFiSimpleSetupConfiguration"
    ]
    """<p>The Wi-Fi Simple Setup configuration for the managed thing, which defines provisioning capabilities and timeout settings.</p>"""
    serial_number: NotRequired[
        "capo_iot_managed_integrations.types.serial_number.SerialNumber"
    ]
    """<p>The serial number of the device.</p>"""
    brand: NotRequired["capo_iot_managed_integrations.types.brand.Brand"]
    """<p>The brand of the device.</p>"""
    model: NotRequired["capo_iot_managed_integrations.types.model.Model"]
    """<p>The model of the device.</p>"""
    name: NotRequired["capo_iot_managed_integrations.types.name.Name"]
    """<p>The name of the managed thing representing the physical device.</p>"""
    capability_report: NotRequired[
        "capo_iot_managed_integrations.types.capability_report.CapabilityReport"
    ]
    """<p>A report of the capabilities for the managed thing.</p>"""
    capability_schemas: NotRequired[
        "capo_iot_managed_integrations.types.capability_schemas.CapabilitySchemas"
    ]
    """<p>The capability schemas that define the functionality and features supported by the managed thing, including device capabilities and their associated properties.</p>"""
    capabilities: NotRequired[
        "capo_iot_managed_integrations.types.capabilities.Capabilities"
    ]
    """<p>The capabilities of the device such as light bulb.</p>"""
    client_token: NotRequired[
        "capo_iot_managed_integrations.types.client_token.ClientToken"
    ]
    """<p>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.</p>"""
    classification: NotRequired[
        "capo_iot_managed_integrations.types.classification.Classification"
    ]
    """<p>The classification of the managed thing such as light bulb or thermostat.</p>"""
    tags: NotRequired["capo_iot_managed_integrations.types.tags_map.TagsMap"]
    """<p>A set of key/value pairs that are used to manage the managed thing.</p>"""
    meta_data: NotRequired["capo_iot_managed_integrations.types.meta_data.MetaData"]
    """<p>The metadata for the managed thing.</p> <note> <p>The <code>managedThing</code> <code>metadata</code> parameter is used for associating attributes with a <code>managedThing</code> that can be used for grouping over-the-air (OTA) tasks. Name value pairs in <code>metadata</code> can be used in the <code>OtaTargetQueryString</code> parameter for the <code>CreateOtaTask</code> API operation.</p> </note>"""

authentication_material instance-attribute

authentication_material: AuthMaterialString

The authentication material defining the device connectivity setup requests. The authorization materials used are the device bar code.

authentication_material_type instance-attribute

authentication_material_type: AuthMaterialType

The type of authentication material used for device connectivity setup requests.

brand instance-attribute

brand: NotRequired[Brand]

The brand of the device.

capabilities instance-attribute

capabilities: NotRequired[Capabilities]

The capabilities of the device such as light bulb.

capability_report instance-attribute

capability_report: NotRequired[CapabilityReport]

A report of the capabilities for the managed thing.

capability_schemas instance-attribute

capability_schemas: NotRequired[CapabilitySchemas]

The capability schemas that define the functionality and features supported by the managed thing, including device capabilities and their associated properties.

classification instance-attribute

classification: NotRequired[Classification]

The classification of the managed thing such as light bulb or thermostat.

client_token instance-attribute

client_token: NotRequired[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.

credential_locker_id instance-attribute

credential_locker_id: NotRequired[CredentialLockerId]

The identifier of the credential for the managed thing.

meta_data instance-attribute

meta_data: NotRequired[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.

model instance-attribute

model: NotRequired[Model]

The model of the device.

name instance-attribute

name: NotRequired[Name]

The name of the managed thing representing the physical device.

owner instance-attribute

owner: NotRequired[Owner]

Owner of the device, usually an indication of whom the device belongs to. This value should not contain personal identifiable information.

role instance-attribute

role: Role

The type of device used. This will be the hub controller, cloud device, or AWS IoT device.

serial_number instance-attribute

serial_number: NotRequired[SerialNumber]

The serial number of the device.

tags instance-attribute

tags: NotRequired[TagsMap]

A set of key/value pairs that are used to manage the managed thing.

wi_fi_simple_setup_configuration instance-attribute

wi_fi_simple_setup_configuration: NotRequired[WiFiSimpleSetupConfiguration]

The Wi-Fi Simple Setup configuration for the managed thing, which defines provisioning capabilities and timeout settings.