Skip to content

update_cloud_connector async

update_cloud_connector(
    identifier: CloudConnectorId,
    *,
    config_overrides: Optional[AsyncIoTManagedIntegrationsClientConfig] = None,
    name: Optional[DisplayName] = None,
    description: Optional[CloudConnectorDescription] = None,
) -> None

Update an existing cloud connector.

Parameters:

Raises:

Examples:

UpdateCloudConnector happy path for TP Link to update display name

>>> await client.update_cloud_connector(identifier='123456789012', name='Connector for TP Link Cloud V2')
UpdateCloudConnector error Id for Ring connector which does not exist
>>> await client.update_cloud_connector(identifier='123456789012', name='Connector for Ring Cloud')
Source code in docs_src/capo_iot_managed_integrations/_services/async_io_t_managed_integrations.py
async def update_cloud_connector(
    self,
    identifier: "capo_iot_managed_integrations.types.cloud_connector_id.CloudConnectorId",
    *,
    config_overrides: Optional[AsyncIoTManagedIntegrationsClientConfig] = None,
    name: Optional[
        "capo_iot_managed_integrations.types.display_name.DisplayName"
    ] = None,
    description: Optional[
        "capo_iot_managed_integrations.types.cloud_connector_description.CloudConnectorDescription"
    ] = None,
) -> None:
    """<p>Update an existing cloud connector.</p>

    Args:
        identifier: <p>The unique identifier of the cloud connector to update.</p>
        name: <p>The new display name to assign to the cloud connector.</p>
        description: <p>The new description to assign to the cloud connector.</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.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.

    Examples:
        UpdateCloudConnector happy path for TP Link to update display name

        >>> await client.update_cloud_connector(identifier='123456789012', name='Connector for TP Link Cloud V2')
        UpdateCloudConnector error Id for Ring connector which does not exist

        >>> await client.update_cloud_connector(identifier='123456789012', name='Connector for Ring Cloud')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iot_managed_integrations.types.update_cloud_connector_request.UpdateCloudConnectorRequest]",
    ) -> AsyncOperationResponse[None]:
        import capo_iot_managed_integrations._operations.iot_managed_integrations.update_cloud_connector

        (
            output,
            http_response,
        ) = await capo_iot_managed_integrations._operations.iot_managed_integrations.update_cloud_connector.async_update_cloud_connector(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateCloudConnector")
    )
    input_: capo_iot_managed_integrations.types.update_cloud_connector_request.UpdateCloudConnectorRequest = {
        "identifier": identifier
    }
    if name is not None:
        input_["name"] = name
    if description is not None:
        input_["description"] = description

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output