Skip to content

update_device_metadata

update_device_metadata(
    device_id: DeviceId,
    *,
    config_overrides: Optional[PanoramaClientConfig] = None,
    description: Optional[Description] = None,
) -> UpdateDeviceMetadataResponse

Updates a device's metadata.

Parameters:

Raises:

Source code in docs_src/capo_panorama/_services/panorama.py
def update_device_metadata(
    self,
    device_id: "capo_panorama.types.device_id.DeviceId",
    *,
    config_overrides: Optional[PanoramaClientConfig] = None,
    description: Optional["capo_panorama.types.description.Description"] = None,
) -> "capo_panorama.types.update_device_metadata_response.UpdateDeviceMetadataResponse":
    """<p>Updates a device's metadata.</p>

    Args:
        device_id: <p>The device's ID.</p>
        description: <p>A description for the device.</p>

    Raises:
        capo_panorama.errors.access_denied_exception.AccessDeniedException: <p>The requestor does not have permission to access the target action or resource.</p>
        capo_panorama.errors.conflict_exception.ConflictException: <p>The target resource is in use.</p>
        capo_panorama.errors.internal_server_exception.InternalServerException: <p>An internal error occurred.</p>
        capo_panorama.errors.resource_not_found_exception.ResourceNotFoundException: <p>The target resource was not found.</p>
        capo_panorama.errors.validation_exception.ValidationException: <p>The request contains an invalid parameter value.</p>
        capo_panorama.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_panorama.types.update_device_metadata_request.UpdateDeviceMetadataRequest]",
    ) -> OperationResponse[
        "capo_panorama.types.update_device_metadata_response.UpdateDeviceMetadataResponse"
    ]:
        import capo_panorama._operations.omni_cloud_service_lambda.update_device_metadata

        output, http_response = (
            capo_panorama._operations.omni_cloud_service_lambda.update_device_metadata.update_device_metadata(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateDeviceMetadata")
    )
    input_: capo_panorama.types.update_device_metadata_request.UpdateDeviceMetadataRequest = {
        "device_id": device_id
    }
    if description is not None:
        input_["description"] = description

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