Skip to content

get_managed_thing_meta_data

get_managed_thing_meta_data(
    identifier: ManagedThingId,
    *,
    config_overrides: Optional[IoTManagedIntegrationsClientConfig] = None,
) -> GetManagedThingMetaDataResponse

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.

Parameters:

Raises:

Source code in docs_src/capo_iot_managed_integrations/_services/io_t_managed_integrations.py
def get_managed_thing_meta_data(
    self,
    identifier: "capo_iot_managed_integrations.types.managed_thing_id.ManagedThingId",
    *,
    config_overrides: Optional[IoTManagedIntegrationsClientConfig] = None,
) -> "capo_iot_managed_integrations.types.get_managed_thing_meta_data_response.GetManagedThingMetaDataResponse":
    """<p>Get the metadata information for a 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>

    Args:
        identifier: <p>The managed thing id.</p>

    Raises:
        capo_iot_managed_integrations.errors.access_denied_exception.AccessDeniedException: <p>User is not authorized.</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.get_managed_thing_meta_data_request.GetManagedThingMetaDataRequest]",
    ) -> OperationResponse[
        "capo_iot_managed_integrations.types.get_managed_thing_meta_data_response.GetManagedThingMetaDataResponse"
    ]:
        import capo_iot_managed_integrations._operations.iot_managed_integrations.get_managed_thing_meta_data

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetManagedThingMetaData")
    )
    input_: capo_iot_managed_integrations.types.get_managed_thing_meta_data_request.GetManagedThingMetaDataRequest = {
        "identifier": identifier
    }

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