Skip to content

delete_resource_data_sync

delete_resource_data_sync(
    sync_name: ResourceDataSyncName,
    *,
    config_overrides: Optional[SSMClientConfig] = None,
    sync_type: Optional[ResourceDataSyncType] = None,
) -> DeleteResourceDataSyncResult

Deletes a resource data sync configuration. After the configuration is deleted, changes to data on managed nodes are no longer synced to or from the target. Deleting a sync configuration doesn't delete data.

Parameters:

Raises:

Source code in docs_src/capo_ssm/_services/ssm.py
def delete_resource_data_sync(
    self,
    sync_name: "capo_ssm.types.resource_data_sync_name.ResourceDataSyncName",
    *,
    config_overrides: Optional[SSMClientConfig] = None,
    sync_type: Optional[
        "capo_ssm.types.resource_data_sync_type.ResourceDataSyncType"
    ] = None,
) -> "capo_ssm.types.delete_resource_data_sync_result.DeleteResourceDataSyncResult":
    """<p>Deletes a resource data sync configuration. After the configuration is deleted, changes to data on managed nodes are no longer synced to or from the target. Deleting a sync configuration doesn't delete data.</p>

    Args:
        sync_name: <p>The name of the configuration to delete.</p>
        sync_type: <p>Specify the type of resource data sync to delete.</p>

    Raises:
        capo_ssm.errors.internal_server_error.InternalServerError: <p>An error occurred on the server side.</p>
        capo_ssm.errors.resource_data_sync_invalid_configuration_exception.ResourceDataSyncInvalidConfigurationException: <p>The specified sync configuration is invalid.</p>
        capo_ssm.errors.resource_data_sync_not_found_exception.ResourceDataSyncNotFoundException: <p>The specified sync name wasn't found.</p>
        capo_ssm.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ssm.types.delete_resource_data_sync_request.DeleteResourceDataSyncRequest]",
    ) -> OperationResponse[
        "capo_ssm.types.delete_resource_data_sync_result.DeleteResourceDataSyncResult"
    ]:
        import capo_ssm._operations.amazon_ssm.delete_resource_data_sync

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteResourceDataSync")
    )
    input_: capo_ssm.types.delete_resource_data_sync_request.DeleteResourceDataSyncRequest = {
        "sync_name": sync_name
    }
    if sync_type is not None:
        input_["sync_type"] = sync_type

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