Skip to content

update_cloud_connector

update_cloud_connector(
    cloud_connector_id: CloudConnectorId,
    *,
    config_overrides: Optional[SSMClientConfig] = None,
    display_name: Optional[DisplayName] = None,
    configuration: Optional[CloudConnectorConfiguration] = None,
    description: Optional[CloudConnectorDescription] = None,
) -> UpdateCloudConnectorResult

Updates an existing cloud connector with new configuration details.

Parameters:

Raises:

Source code in docs_src/capo_ssm/_services/ssm.py
def update_cloud_connector(
    self,
    cloud_connector_id: "capo_ssm.types.cloud_connector_id.CloudConnectorId",
    *,
    config_overrides: Optional[SSMClientConfig] = None,
    display_name: Optional["capo_ssm.types.display_name.DisplayName"] = None,
    configuration: Optional[
        "capo_ssm.types.cloud_connector_configuration.CloudConnectorConfiguration"
    ] = None,
    description: Optional[
        "capo_ssm.types.cloud_connector_description.CloudConnectorDescription"
    ] = None,
) -> "capo_ssm.types.update_cloud_connector_result.UpdateCloudConnectorResult":
    """<p>Updates an existing cloud connector with new configuration details.</p>

    Args:
        cloud_connector_id: <p>The ID of the cloud connector to update.</p>
        display_name: <p>A new friendly name for the cloud connector.</p>
        configuration: <p>The updated configuration details for connecting to the third-party cloud environment.</p>
        description: <p>A new description for the cloud connector.</p>

    Raises:
        capo_ssm.errors.conflict_exception.ConflictException: <p>An error occurred because of a conflict with a concurrent request or the current state of the resource. Retry your request.</p>
        capo_ssm.errors.internal_server_error.InternalServerError: <p>An error occurred on the server side.</p>
        capo_ssm.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified parameter to be shared could not be found.</p>
        capo_ssm.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ssm.types.update_cloud_connector_request.UpdateCloudConnectorRequest]",
    ) -> OperationResponse[
        "capo_ssm.types.update_cloud_connector_result.UpdateCloudConnectorResult"
    ]:
        import capo_ssm._operations.amazon_ssm.update_cloud_connector

        output, http_response = (
            capo_ssm._operations.amazon_ssm.update_cloud_connector.update_cloud_connector(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateCloudConnector")
    )
    input_: capo_ssm.types.update_cloud_connector_request.UpdateCloudConnectorRequest = {
        "cloud_connector_id": cloud_connector_id
    }
    if display_name is not None:
        input_["display_name"] = display_name
    if configuration is not None:
        input_["configuration"] = configuration
    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