create_managed_thing ¶

def create_managed_thing(
    self,
    role: "capo_iot_managed_integrations.types.role.Role",
    authentication_material: "capo_iot_managed_integrations.types.auth_material_string.AuthMaterialString",
    authentication_material_type: "capo_iot_managed_integrations.types.auth_material_type.AuthMaterialType",
    *,
    config_overrides: Optional[IoTManagedIntegrationsClientConfig] = None,
    owner: Optional["capo_iot_managed_integrations.types.owner.Owner"] = None,
    credential_locker_id: Optional[
        "capo_iot_managed_integrations.types.credential_locker_id.CredentialLockerId"
    ] = None,
    wi_fi_simple_setup_configuration: Optional[
        "capo_iot_managed_integrations.types.wi_fi_simple_setup_configuration.WiFiSimpleSetupConfiguration"
    ] = None,
    serial_number: Optional[
        "capo_iot_managed_integrations.types.serial_number.SerialNumber"
    ] = None,
    brand: Optional["capo_iot_managed_integrations.types.brand.Brand"] = None,
    model: Optional["capo_iot_managed_integrations.types.model.Model"] = None,
    name: Optional["capo_iot_managed_integrations.types.name.Name"] = None,
    capability_report: Optional[
        "capo_iot_managed_integrations.types.capability_report.CapabilityReport"
    ] = None,
    capability_schemas: Optional[
        "capo_iot_managed_integrations.types.capability_schemas.CapabilitySchemas"
    ] = None,
    capabilities: Optional[
        "capo_iot_managed_integrations.types.capabilities.Capabilities"
    ] = None,
    client_token: Optional[
        "capo_iot_managed_integrations.types.client_token.ClientToken"
    ] = None,
    classification: Optional[
        "capo_iot_managed_integrations.types.classification.Classification"
    ] = None,
    tags: Optional["capo_iot_managed_integrations.types.tags_map.TagsMap"] = None,
    meta_data: Optional[
        "capo_iot_managed_integrations.types.meta_data.MetaData"
    ] = None,
) -> "capo_iot_managed_integrations.types.create_managed_thing_response.CreateManagedThingResponse":
    """<p>Creates a managed thing. A managed thing contains the device identifier, protocol supported, and capabilities of the device in a data model format defined by Managed integrations.</p>

    Args:
        role: <p>The type of device used. This will be the hub controller, cloud device, or AWS IoT device.</p>
        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: <p>The identifier of the credential for the managed thing.</p>
        authentication_material: <p>The authentication material defining the device connectivity setup requests. The authorization materials used are the device bar code.</p>
        authentication_material_type: <p>The type of authentication material used for device connectivity setup requests.</p>
        wi_fi_simple_setup_configuration: <p>The Wi-Fi Simple Setup configuration for the managed thing, which defines provisioning capabilities and timeout settings.</p>
        serial_number: <p>The serial number of the device.</p>
        brand: <p>The brand of the device.</p>
        model: <p>The model of the device.</p>
        name: <p>The name of the managed thing representing the physical device.</p>
        capability_report: <p>A report of the capabilities for the managed thing.</p>
        capability_schemas: <p>The capability schemas that define the functionality and features supported by the managed thing, including device capabilities and their associated properties.</p>
        capabilities: <p>The capabilities of the device such as light bulb.</p>
        client_token: <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: <p>The classification of the managed thing such as light bulb or thermostat.</p>
        tags: <p>A set of key/value pairs that are used to manage the managed thing.</p>
        meta_data: <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>

    Raises:
        capo_iot_managed_integrations.errors.access_denied_exception.AccessDeniedException: <p>User is not authorized.</p>
        capo_iot_managed_integrations.errors.conflict_exception.ConflictException: <p>There is a conflict with the request.</p>
        capo_iot_managed_integrations.errors.internal_server_exception.InternalServerException: <p>Internal error from the service that indicates an unexpected error or that the service is unavailable.</p>
        capo_iot_managed_integrations.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</p>
        capo_iot_managed_integrations.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is temporarily unavailable.</p>
        capo_iot_managed_integrations.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
        capo_iot_managed_integrations.errors.unauthorized_exception.UnauthorizedException: <p>You are not authorized to perform this operation.</p>
        capo_iot_managed_integrations.errors.validation_exception.ValidationException: <p>A validation error occurred when performing the API request.</p>
        capo_iot_managed_integrations.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iot_managed_integrations.types.create_managed_thing_request.CreateManagedThingRequest]",
    ) -> OperationResponse[
        "capo_iot_managed_integrations.types.create_managed_thing_response.CreateManagedThingResponse"
    ]:
        import capo_iot_managed_integrations._operations.iot_managed_integrations.create_managed_thing

        output, http_response = (
            capo_iot_managed_integrations._operations.iot_managed_integrations.create_managed_thing.create_managed_thing(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_iot_managed_integrations.types.create_managed_thing_request.CreateManagedThingRequest",
    ) -> dict[str, Any]:
        import capo_iot_managed_integrations.types.create_managed_thing_request

        return capo_iot_managed_integrations.types.create_managed_thing_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CreateManagedThing", redact_input=_redact_input),
    )
    input_: capo_iot_managed_integrations.types.create_managed_thing_request.CreateManagedThingRequest = {
        "role": role,
        "authentication_material": authentication_material,
        "authentication_material_type": authentication_material_type,
    }
    if owner is not None:
        input_["owner"] = owner
    if credential_locker_id is not None:
        input_["credential_locker_id"] = credential_locker_id
    if wi_fi_simple_setup_configuration is not None:
        input_["wi_fi_simple_setup_configuration"] = (
            wi_fi_simple_setup_configuration
        )
    if serial_number is not None:
        input_["serial_number"] = serial_number
    if brand is not None:
        input_["brand"] = brand
    if model is not None:
        input_["model"] = model
    if name is not None:
        input_["name"] = name
    if capability_report is not None:
        input_["capability_report"] = capability_report
    if capability_schemas is not None:
        input_["capability_schemas"] = capability_schemas
    if capabilities is not None:
        input_["capabilities"] = capabilities
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if classification is not None:
        input_["classification"] = classification
    if tags is not None:
        input_["tags"] = tags
    if meta_data is not None:
        input_["meta_data"] = meta_data

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output