diff --git a/R/board_s3.R b/R/board_s3.R index a876513ff..76b5c5ee3 100644 --- a/R/board_s3.R +++ b/R/board_s3.R @@ -41,13 +41,15 @@ #' #' # Details #' -#' * If you point at a bucket that's not created by pins, some functions -#' like `pins_list()` will work, but won't return useful output. +#' * The functions in pins do not create a new bucket. You can create +#' a new bucket from R with [paws][paws.storage::s3_create_bucket]. +#' * Some functions like [pin_list()] will work for an S3 board, but don't +#' return useful output. #' * You can pass arguments for [paws.storage::s3_put_object] such as `Tagging` #' and `ServerSideEncryption` through the dots of `pin_write()`. #' #' @inheritParams new_board -#' @param bucket Bucket name. +#' @param bucket Bucket name. You can only write to an existing bucket. #' @param prefix Prefix within this bucket that this board will occupy. #' You can use this to maintain multiple independent pin boards within #' a single S3 bucket. Will typically end with `/` to take advantage of diff --git a/man/board_s3.Rd b/man/board_s3.Rd index 267b7f18b..947e8f149 100644 --- a/man/board_s3.Rd +++ b/man/board_s3.Rd @@ -19,7 +19,7 @@ board_s3( ) } \arguments{ -\item{bucket}{Bucket name.} +\item{bucket}{Bucket name. You can only write to an existing bucket.} \item{prefix}{Prefix within this bucket that this board will occupy. You can use this to maintain multiple independent pin boards within @@ -81,8 +81,10 @@ authentication. \section{Details}{ \itemize{ -\item If you point at a bucket that's not created by pins, some functions -like \code{pins_list()} will work, but won't return useful output. +\item The functions in pins do not create a new bucket. You can create +a new bucket from R with \link[paws.storage:s3_create_bucket]{paws}. +\item Some functions like \code{\link[=pin_list]{pin_list()}} will work for an S3 board, but don't +return useful output. \item You can pass arguments for \link[paws.storage:s3_put_object]{paws.storage::s3_put_object} such as \code{Tagging} and \code{ServerSideEncryption} through the dots of \code{pin_write()}. }