R/replication.R

Defines functions delete_replication put_replication get_replication

Documented in delete_replication get_replication put_replication

#' @rdname replication
#' @title Bucket replication
#' @description Get/Delete the replication configuration for a bucket.
#' @details \code{get_replication} gets the current replication policy. \code{delete_replication} deletes the replication policy for a bucket.
#'
#' @template bucket
#' @param request_body A character string containing an XML request body, as defined in the specification in the \href{http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html}{API Documentation}.
#' @template dots
#'
#' @return For \code{get_replication}: A list containing the replication configuration, if one has been set. For \code{delete_replication}: \code{TRUE} if successful, \code{FALSE} otherwise.
#' @references
#' \href{http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html}{API Documentation: PUT replication}
#' \href{http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETreplication.html}{API Documentation: GET replication}
#' \href{http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketDELETEreplication.html}{API Documentation: DELETE replication}
#' @export
get_replication <- function(bucket, ...){
    r <- s3HTTP(verb = "GET", 
                bucket = bucket,
                query = list(replication = ""),
                ...)
    return(r)
}

#' @rdname replication
#' @export
put_replication <- function(bucket, request_body, ...){
    r <- s3HTTP(verb = "GET", 
                bucket = bucket,
                query = list(replication = ""),
                request_body = request_body,
                ...)
    return(r)
}

#' @rdname replication
#' @export
delete_replication <- function(bucket, ...){
    r <- s3HTTP(verb = "DELETE", 
                bucket = bucket,
                query = list(replication = ""),
                parse_response = FALSE,
                ...)
    return(r)
}
cloudyr/aws.s3 documentation built on May 29, 2020, 7:18 p.m.