diff --git a/articles/contributing.html b/articles/contributing.html index fbf040f..49dc706 100644 --- a/articles/contributing.html +++ b/articles/contributing.html @@ -143,22 +143,28 @@

Testing

We use two tools to replace real AWS accounts: Minio, Localstack.

+

+
+

Minio

-

We use Minio for testing functions in -this package (functions that start with aws_bucket and -aws_file) for interacting with S3.

+

We use Minio for testing two sets of +functions in this package for interacting with S3:

+

Local

-

If you want to run tests while contributing to -sixtyfour, the tests that use Minio will just be skipped if +

sixtyfour tests that use Minio will just be skipped if you don’t have Minio running.

To use Minio, first install it for your platform: MacOS, Windows, Linux.

Next, start Minio. Within this package is a make target -minio_start for starting Minio locally. That make target -should only work on Linux and MacOS platforms. To start Minio on the -command line see the docs links above for each platform.

+minio_start for starting Minio locally; it should only work +on Linux and MacOS platforms.

Upon starting Minio it will display URLs for both the Minio API and WebUI - and your username/password to login to the WebUI. You can open up the WebUI as a nice visual dashboard of what’s going on.

@@ -174,9 +180,9 @@

GitHub Actions

Minio Details

-

The following (collapsed) bullets list information for those who want -to know more about the minio setup, and that may want to tweak it or add -minio setup to other tests.

+

The following information (collapsed) is for those who want to know +more about the minio setup, and may want to tweak it or add minio setup +to other tests.

Expand for details
    @@ -192,17 +198,26 @@

    Minio Details
    -Sys.setenv(AWS_PROFILE = "minio")
-buckets_empty() # empty buckets so we're starting from an empty slate

+Sys.setenv(AWS_PROFILE = "minio")
-buckets_empty() # empty buckets
-Sys.unsetenv("AWS_PROFILE")
+Sys.unsetenv("AWS_PROFILE")

Internally we grab client objects for paws and s3fs as needed and use AWS_PROFILE env var to toggle on/off using Minio.

+

For Minio we use the default credentials:

+ +

You can override these defaults by setting the env vars above to your +own values.

@@ -210,20 +225,32 @@

Minio DetailsLocalstack

We use Localstack for -testing some functions in this package.

+testing some functions in this package:

+

Local

-

If you want to run tests while contributing to -sixtyfour, the tests that use Localstack will just be -skipped if you don’t have Minio running.

+

sixtyfour tests that use Localstack will just be skipped +if you don’t have Localstack running.

To use Localstack, first install it for your platform https://docs.localstack.cloud/getting-started/installation/.

Next, start Localstack. Within this package is a make target localstack_start for starting Localstack locally. That make -target should only work on Linux and MacOS platforms. To start -Localstack on the command line see the docs links above for each -platform. You’ll need Docker installed and running to run Localstack. -There are probably non-Docker ways to run Localstack.

+target should only work on Linux and MacOS platforms.

For a GUI interface to the locally running localstack you can install the Desktop client - which isn’t very good - at https://docs.localstack.cloud/getting-started/installation/#localstack-desktop. Better yet, login to the cloud Localstack site and you can interface @@ -267,6 +294,17 @@

Localstack Details Bigger changes","what":"Pull request process","title":"Contributing","text":"Fork package clone onto computer Create Git branch pull request (PR) title PR briefly describe change. body PR contain Fixes #issue-number. user-facing changes, add bullet NEWS.md file.","code":""},{"path":"/articles/contributing.html","id":"code-style","dir":"Articles","previous_headings":"General guidelines > Bigger changes","what":"Code style","title":"Contributing","text":"New code follow WILDS style guide.","code":""},{"path":"/articles/contributing.html","id":"testing","dir":"Articles","previous_headings":"","what":"Testing","title":"Contributing","text":"strive tests HTTP requests resources actual AWS accounts given drawbacks using real accounts, e.g., setting can difficult organizations; forgotten resources can expensive; accidentally making unwated changes account, etc. use two tools replace real AWS accounts: Minio, Localstack.","code":""},{"path":"/articles/contributing.html","id":"minio","dir":"Articles","previous_headings":"Testing","what":"Minio","title":"Contributing","text":"use Minio testing functions package (functions start aws_bucket aws_file) interacting S3.","code":""},{"path":"/articles/contributing.html","id":"local","dir":"Articles","previous_headings":"Testing > Minio","what":"Local","title":"Contributing","text":"want run tests contributing sixtyfour, tests use Minio just skipped don’t Minio running. use Minio, first install platform: MacOS, Windows, Linux. Next, start Minio. Within package make target minio_start starting Minio locally. make target work Linux MacOS platforms. start Minio command line see docs links platform. Upon starting Minio display URLs Minio API WebUI - username/password login WebUI. can open WebUI nice visual dashboard ’s going .","code":""},{"path":"/articles/contributing.html","id":"github-actions","dir":"Articles","previous_headings":"Testing > Minio","what":"GitHub Actions","title":"Contributing","text":"R-CMD-check workflow .github/workflows/ includes spinning Minio running unit tests - Linux; tests require Minio skipped MacOS WIndows platforms GitHub Actions.","code":""},{"path":"/articles/contributing.html","id":"minio-details","dir":"Articles","previous_headings":"Testing > Minio","what":"Minio Details","title":"Contributing","text":"following (collapsed) bullets list information want know minio setup, may want tweak add minio setup tests. tests/testthat/helper-minio.R helper functions Minio. bucket_delete buckets_empty make easier cleanup tests. minio_available function used inside skip_if_not skip tests file Minio available, like: skip_if_not(minio_available(), \"Minio Available\") top file uses Minio, setup interfaces Minio like: unset bottom file cleanup: Internally grab client objects paws s3fs needed use AWS_PROFILE env var toggle /using Minio.","code":"Sys.setenv(AWS_PROFILE = \"minio\") buckets_empty() # empty buckets so we're starting from an empty slate buckets_empty() # empty buckets Sys.unsetenv(\"AWS_PROFILE\")"},{"path":"/articles/contributing.html","id":"localstack","dir":"Articles","previous_headings":"Testing","what":"Localstack","title":"Contributing","text":"use Localstack testing functions package.","code":""},{"path":"/articles/contributing.html","id":"local-1","dir":"Articles","previous_headings":"Testing > Localstack","what":"Local","title":"Contributing","text":"want run tests contributing sixtyfour, tests use Localstack just skipped don’t Minio running. use Localstack, first install platform https://docs.localstack.cloud/getting-started/installation/. Next, start Localstack. Within package make target localstack_start starting Localstack locally. make target work Linux MacOS platforms. start Localstack command line see docs links platform. ’ll need Docker installed running run Localstack. probably non-Docker ways run Localstack. GUI interface locally running localstack can install Desktop client - isn’t good - https://docs.localstack.cloud/getting-started/installation/#localstack-desktop. Better yet, login cloud Localstack site can interface locally running Localstack better interface . Login https://app.localstack.cloud/.","code":""},{"path":"/articles/contributing.html","id":"github-actions-1","dir":"Articles","previous_headings":"Testing > Localstack","what":"GitHub Actions","title":"Contributing","text":"R-CMD-check workflow .github/workflows/ includes spinning Localstack running unit tests - Linux; tests require Localstack skipped MacOS WIndows platforms GitHub Actions.","code":""},{"path":"/articles/contributing.html","id":"localstack-details","dir":"Articles","previous_headings":"Testing > Localstack","what":"Localstack Details","title":"Contributing","text":"following (collapsed) bullets list information want know Localstack setup, may want tweak add Localstack setup tests. tests/testthat/helper-localstack.R helper functions Localstack. localstack_available function used inside skip_if_not skip tests file Localstack available, like: skip_if_not(localstack_available(), \"Localstack Available\") top file uses Localstack, setup interfaces Localstack like: unset bottom file cleanup: Internally grab client objects paws s3fs needed use AWS_PROFILE env var toggle /using Localstack.","code":"Sys.setenv(AWS_PROFILE = \"localstack\") Sys.unsetenv(\"AWS_PROFILE\")"},{"path":"/articles/contributing.html","id":"code-of-conduct","dir":"Articles","previous_headings":"","what":"Code of Conduct","title":"Contributing","text":"Please note project released Contributor Code Conduct. contributing project agree abide terms.","code":""},{"path":"/articles/databases.html","id":"redshift","dir":"Articles","previous_headings":"","what":"Redshift","title":"Databases","text":"aws_db_redshift_create function creates cluster (Redshift instance called “cluster”). ’s important distinction Redshift RDS. Redshift uses IAM username/password, whereas RDS can use username/password setup instance RDS database, authentication IAM. However, RDS can’t simply pass IAM username/password (see notes ). First, let’s create security group ingress rule can access Redshift cluster. Notes parameters used example : id: ID come , must unique clusters within AWS account user/pwd: IAM username password security_group_ids: ’s best first create security group handle permissions Redshift cluster. See example . Pass ’s identifier wait: Since ’re using wait=TRUE call aws_db_redshift_create likely take 3 minutes run. can set wait=FALSE wait, ’ll want check instance available. Connect cluster List tables, create table, etc Use dplyr/et al. Important: Remember delete cluster done!","code":"my_security_group <- aws_vpc_sg_with_ingresss(\"redshift\") aws_db_redshift_create( id = \"some-id\", user = \"your-username\", pwd = \"your-pwd\", security_group_ids = list(my_security_group), wait = TRUE ) con <- aws_db_redshift_con( user = \"your-username\", pwd = \"your-pwd\", id = \"some-id\" ) library(DBI) dbListTables(con) dbWriteTable(con, \"mtcars\", mtcars) dbListTables(con) dbReadTable(con, \"mtcars\") library(dplyr) tbl(con, \"mtcars\") %>% filter(mpg == 4)"},{"path":"/articles/databases.html","id":"rds","dir":"Articles","previous_headings":"","what":"RDS","title":"Databases","text":"process MariaDB, MySQL, Postgres less , ’ll demonstrate MariaDB. future version package ’ll able use IAM authenticate RDS, now sixtyfour support IAM RDS. current “happy path” (read: easy) process starting RDS instance aws_db_rds_create follows: Supply ID (identifier) instance create random username created used database authentication random password created (via AWS Secretamanager) used database authentication ingress rule added security group IP address RDS instance creation, use username, password, security group username, password, security group information stored AWS Secretamanager subsequent use connect RDS instance, use aws_db_rds_con. “happy path” connecting : Pass ID used fetch secrets AWS Secretamanager ask ’d like use gather necessary details connect instance Return DBI connection object, e.g., MariaDBConnection MariaDB Let’s walk steps code. First, create RDS instance - case MariaDB. Notes parameters used example : id: ID come . see ?aws_db_rds_create constraints class: compute memory capacity instance; see AWS docs instance class options. default parameter (db.t3.micro) gives instance relatively small capacity terms memory compute - set way minimize costs case forget turn ’re using ! engine: default mariadb; options mysql postgres wait: Since ’re using wait=TRUE (default function) call aws_db_rds_create likely take 5 minutes run. can set wait=FALSE wait, ’ll want check instance available. Connect instance List tables, create table, etc Use dplyr/et al.","code":"aws_db_rds_create( id = \"myinstance\", class = \"db.t3.micro\", engine = \"mariadb\", wait = TRUE ) con <- aws_db_rds_con(id = \"myinstance\") library(DBI) dbListTables(con) dbWriteTable(con, \"mtcars\", mtcars) dbListTables(con) dbReadTable(con, \"mtcars\") library(dplyr) tbl(con, \"mtcars\") %>% filter(mpg == 4)"},{"path":"/articles/sixtyfour.html","id":"authentication","dir":"Articles","previous_headings":"","what":"Authentication","title":"Getting Started","text":"able use package ’ll need two AWS secrets AWS region following three environment variables: AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION can set within R current R session like: set variety ways available across R sessions. See R Startup chapter Forgot Teach R book details.","code":"Sys.setenv( AWS_ACCESS_KEY_ID = \"\", AWS_SECRET_ACCESS_KEY = \"\", AWS_REGION = \"us-west-2\" )"},{"path":"/articles/sixtyfour.html","id":"package-api-overview","dir":"Articles","previous_headings":"","what":"Package API Overview","title":"Getting Started","text":"aws_billing*: manage AWS billing details aws_bucket*: manage S3 buckets aws_file_*: manage files S3 buckets aws_user*: manage AWS users aws_group*: manage AWS groups aws_role*: manage AWS roles aws_policy*: manage AWS policies aws_db*: interact AWS database services Redshift RDS aws_secrets*: secrets manager aws_vpc_security*: VPC security groups","code":""},{"path":"/articles/sixtyfour.html","id":"working-with-s3","dir":"Articles","previous_headings":"","what":"Working with S3","title":"Getting Started","text":"vignette won’t touch parts package API - instead cover working files ’s likely common use case sixtyfour users.","code":""},{"path":"/articles/sixtyfour.html","id":"buckets","dir":"Articles","previous_headings":"Working with S3","what":"Buckets","title":"Getting Started","text":"Make random bucket name Create bucket - check exists first Create files different directories Upload newly created bucket List objects bucket Cleanup - delete bucket. ’s files bucket can delete . Delete files, delete bucket ","code":"random_bucket_name <- function() { glue::glue(\"egs-{paste0(sample(letters, size = 12), collapse = '')}\") } bucket <- random_bucket_name() exists <- aws_bucket_exists(bucket) if (!exists) { aws_bucket_create(bucket) } #> [1] \"http://egs-tnxoekbrjcdl.s3.amazonaws.com/\" library(fs) tdir <- fs::path(tempdir(), \"apples\") fs::dir_create(tdir) tfiles <- replicate(n = 10, fs::file_temp(tmp_dir = tdir, ext = \".txt\")) invisible(lapply(tfiles, function(x) write.csv(mtcars, x))) aws_bucket_upload(path = tdir, bucket = bucket) #> [1] \"s3://private/var/folders/qt/fzq1m_bj2yb_7b2jz57s9q7c0000gp/T/RtmpyTGZNW/apples\" objects <- aws_bucket_list_objects(bucket) objects #> # A tibble: 10 × 8 #> bucket_name key uri size type owner etag last_modified #> #> 1 egs-tnxoekbrjcdl file102ee… s3:/… 1.74K file \"\\\"6… 2024-03-19 23:28:06 #> 2 egs-tnxoekbrjcdl file102ee… s3:/… 1.74K file \"\\\"6… 2024-03-19 23:28:06 #> 3 egs-tnxoekbrjcdl file102ee… s3:/… 1.74K file \"\\\"6… 2024-03-19 23:28:06 #> 4 egs-tnxoekbrjcdl file102ee… s3:/… 1.74K file \"\\\"6… 2024-03-19 23:28:06 #> 5 egs-tnxoekbrjcdl file102ee… s3:/… 1.74K file \"\\\"6… 2024-03-19 23:28:06 #> 6 egs-tnxoekbrjcdl file102ee… s3:/… 1.74K file \"\\\"6… 2024-03-19 23:28:07 #> 7 egs-tnxoekbrjcdl file102ee… s3:/… 1.74K file \"\\\"6… 2024-03-19 23:28:07 #> 8 egs-tnxoekbrjcdl file102ee… s3:/… 1.74K file \"\\\"6… 2024-03-19 23:28:07 #> 9 egs-tnxoekbrjcdl file102ee… s3:/… 1.74K file \"\\\"6… 2024-03-19 23:28:07 #> 10 egs-tnxoekbrjcdl file102ee… s3:/… 1.74K file \"\\\"6… 2024-03-19 23:28:07 aws_bucket_delete(bucket) #> Error: BucketNotEmpty (HTTP 409). The bucket you tried to delete is not empty aws_file_delete(objects$uri) aws_bucket_delete(bucket)"},{"path":"/articles/sixtyfour.html","id":"files","dir":"Articles","previous_headings":"Working with S3","what":"Files","title":"Getting Started","text":"file functions built around accepting returning character vectors length one greater. includes functions take two inputs, source destination file. Rather using paws package hood functions package use, file functions use s3fs hood (built paws) ’s cleaner interface S3. First, create bucket: , upload files List files bucket Fetch file attributes Check one files exist Copy Download Rename","code":"my_bucket <- random_bucket_name() aws_bucket_create(my_bucket) #> [1] \"http://egs-fzpqkyhmtxlg.s3.amazonaws.com/\" temp_files <- replicate(n = 3, tempfile(fileext = \".txt\")) for (i in temp_files) cat(letters, \"\\n\", file = i) remote_files <- s3_path(my_bucket, basename(temp_files)) aws_file_upload(path = temp_files, remote_path = remote_files) #> [1] \"s3://egs-fzpqkyhmtxlg/file102ee45c0b74.txt\" #> [2] \"s3://egs-fzpqkyhmtxlg/file102ee36f3eee8.txt\" #> [3] \"s3://egs-fzpqkyhmtxlg/file102ee48c9dd87.txt\" obs <- aws_bucket_list_objects(my_bucket) obs #> # A tibble: 3 × 8 #> bucket_name key uri size type owner etag last_modified #> #> 1 egs-fzpqkyhmtxlg file102ee3… s3:/… 53 file \"\\\"a… 2024-03-19 23:28:10 #> 2 egs-fzpqkyhmtxlg file102ee4… s3:/… 53 file \"\\\"a… 2024-03-19 23:28:10 #> 3 egs-fzpqkyhmtxlg file102ee4… s3:/… 53 file \"\\\"a… 2024-03-19 23:28:10 aws_file_attr(remote_files) #> # A tibble: 3 × 38 #> bucket_name key uri size type etag last_modified delete_marker #> #> 1 egs-fzpqkyhmt… file… s3:/… 53 file \"\\\"a… 2024-03-19 23:28:10 NA #> 2 egs-fzpqkyhmt… file… s3:/… 53 file \"\\\"a… 2024-03-19 23:28:10 NA #> 3 egs-fzpqkyhmt… file… s3:/… 53 file \"\\\"a… 2024-03-19 23:28:10 NA #> # ℹ 30 more variables: accept_ranges , expiration , restore , #> # archive_status , checksum_crc32 , checksum_crc32_c , #> # checksum_sha1 , checksum_sha256 , missing_meta , #> # version_id , cache_control , content_disposition , #> # content_encoding , content_language , content_type , #> # expires , website_redirect_location , #> # server_side_encryption , metadata , … aws_file_exists(remote_files[1]) #> [1] TRUE aws_file_exists(remote_files) #> [1] TRUE TRUE TRUE new_bucket <- random_bucket_name() aws_bucket_create(new_bucket) #> [1] \"http://egs-gqalfwjhukzr.s3.amazonaws.com/\" # add existing files to the new bucket aws_file_copy(remote_files, new_bucket) #> [1] \"s3://egs-gqalfwjhukzr/file102ee45c0b74.txt\" #> [2] \"s3://egs-gqalfwjhukzr/file102ee36f3eee8.txt\" #> [3] \"s3://egs-gqalfwjhukzr/file102ee48c9dd87.txt\" # create bucket that doesn't exist yet # the force=TRUE makes this work non-interactively aws_file_copy(remote_files, random_bucket_name(), force = TRUE) #> [1] \"s3://egs-tsadhcfyrjmo/file102ee45c0b74.txt\" #> [2] \"s3://egs-tsadhcfyrjmo/file102ee36f3eee8.txt\" #> [3] \"s3://egs-tsadhcfyrjmo/file102ee48c9dd87.txt\" tfile <- tempfile() aws_file_download(remote_files[1], tfile) #> [1] \"/var/folders/qt/fzq1m_bj2yb_7b2jz57s9q7c0000gp/T//RtmpyTGZNW/file102ee497415cd\" readLines(tfile) #> [1] \"a b c d e f g h i j k l m n o p q r s t u v w x y z \" aws_file_exists(remote_files[1]) #> [1] TRUE aws_file_rename(remote_files[1], s3_path(dirname(remote_files[1]), \"myfile.txt\")) #> [1] \"s3://egs-fzpqkyhmtxlg/myfile.txt\" aws_file_exists(remote_files[1]) #> [1] FALSE"},{"path":"/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Sean Kross. Author. Scott Chamberlain. Author, maintainer.","code":""},{"path":"/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Kross S, Chamberlain S (2024). sixtyfour: Humane Interface AWS. R package version 0.0.0.98, https://github.com/getwilds/sixtyfour.","code":"@Manual{, title = {sixtyfour: Humane Interface to AWS}, author = {Sean Kross and Scott Chamberlain}, year = {2024}, note = {R package version 0.0.0.98}, url = {https://github.com/getwilds/sixtyfour}, }"},{"path":"/index.html","id":"sixtyfour","dir":"","previous_headings":"","what":"Humane Interface to AWS","title":"Humane Interface to AWS","text":"science-focused, humane R interface AWS.","code":""},{"path":"/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Humane Interface to AWS","text":"Development version","code":"# install.packages(\"pak\") pak::pak(\"getwilds/sixtyfour\")"},{"path":"/index.html","id":"documentation","dir":"","previous_headings":"","what":"Documentation","title":"Humane Interface to AWS","text":"Go http://getwilds.org/sixtyfour/ sixtyfour package documentation. Go Get Started vignette get started. package leans primarily packages paws s3fs.","code":""},{"path":"/index.html","id":"bugs-features","dir":"","previous_headings":"","what":"Bugs? Features?","title":"Humane Interface to AWS","text":"Open issue issue tracker.","code":""},{"path":"/index.html","id":"contributors","dir":"","previous_headings":"","what":"Contributors","title":"Humane Interface to AWS","text":"See Contributing article","code":""},{"path":"/index.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"Humane Interface to AWS","text":"Please note sixtyfour project released Contributor Code Conduct. contributing project, agree abide terms.","code":""},{"path":"/reference/account_id.html","id":null,"dir":"Reference","previous_headings":"","what":"Get account ID of current user — account_id","title":"Get account ID of current user — account_id","text":"Get account ID current user","code":""},{"path":"/reference/account_id.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get account ID of current user — account_id","text":"","code":"account_id()"},{"path":"/reference/account_id.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get account ID of current user — account_id","text":"list 3 elements: UserId: ID user Account: account ID user Arn: arn user","code":""},{"path":"/reference/account_id.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get account ID of current user — account_id","text":"env var AWS_PROFILE == \"localstack\", return \"000000000000\"","code":""},{"path":"/reference/as_policy_arn.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert a policy name to a policy ARN — as_policy_arn","title":"Convert a policy name to a policy ARN — as_policy_arn","text":"function simply constructs string, checks ARN valid using get_policy","code":""},{"path":"/reference/as_policy_arn.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert a policy name to a policy ARN — as_policy_arn","text":"","code":"as_policy_arn(name, local = FALSE, path = NULL)"},{"path":"/reference/as_policy_arn.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert a policy name to a policy ARN — as_policy_arn","text":"name (character) policy name arn local (logical) TRUE use AWS account managed policies. FALSE, AWS managed policies path (character) NULL, add path ARN name value","code":""},{"path":"/reference/as_policy_arn.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convert a policy name to a policy ARN — as_policy_arn","text":"policy ARN (character)","code":""},{"path":[]},{"path":"/reference/as_policy_arn.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Convert a policy name to a policy ARN — as_policy_arn","text":"","code":"if (FALSE) { as_policy_arn(\"ReadOnlyAccess\") as_policy_arn(\"arn:aws:iam::aws:policy/ReadOnlyAccess\") as_policy_arn(\"AmazonRDSDataFullAccess\") # as_policy_arn(\"Blarp\") # as_policy_arn(letters) # as_policy_arn(5) as_policy_arn(\"MyTestPolicy\", local = TRUE) # returns an arn - and if given an arn returns self as_policy_arn(\"MyTestPolicy\", local = TRUE) %>% as_policy_arn() # path = Job function as_policy_arn(\"Billing\", path = \"job-function\") # path = Service role as_policy_arn(\"AWSCostAndUsageReportAutomationPolicy\", path = \"service-role\" ) }"},{"path":"/reference/aws_billing.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch billing data - with some internal munging for ease of use — aws_billing","title":"Fetch billing data - with some internal munging for ease of use — aws_billing","text":"Fetch billing data - internal munging ease use","code":""},{"path":"/reference/aws_billing.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch billing data - with some internal munging for ease of use — aws_billing","text":"","code":"aws_billing(date_start, date_end = as.character(Sys.Date()))"},{"path":"/reference/aws_billing.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch billing data - with some internal munging for ease of use — aws_billing","text":"date_start, date_end Start end date get billing data . Date format expected: yyyy-MM-dd. required","code":""},{"path":"/reference/aws_billing.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch billing data - with some internal munging for ease of use — aws_billing","text":"tibble columns: id: \"blended\", \"unblended\" date: date, format yyyy-MM-dd service: AWS service name, spelled full linked_account: account number cost: cost USD acronym: short code service; none known, row value service","code":""},{"path":"/reference/aws_billing.html","id":"blended-vs-unblended","dir":"Reference","previous_headings":"","what":"Blended vs. Unblended","title":"Fetch billing data - with some internal munging for ease of use — aws_billing","text":"Unblended: Unblended costs represent usage costs day charged Blended: Blended costs calculated multiplying account’s service usage something called blended rate. blended rate average rate -demand usage, well Savings Plans- reservation-related usage, consumed member accounts organization particular service.","code":""},{"path":"/reference/aws_billing.html","id":"historical-data","dir":"Reference","previous_headings":"","what":"Historical data","title":"Fetch billing data - with some internal munging for ease of use — aws_billing","text":"supply date_start older 14 months prior today's date likely see error like \"enabled historical data beyond 14 months\". See https://docs.aws.amazon.com/cost-management/latest/userguide/ce-advanced-cost-analysis.html #nolint help","code":""},{"path":"/reference/aws_billing.html","id":"references","dir":"Reference","previous_headings":"","what":"References","title":"Fetch billing data - with some internal munging for ease of use — aws_billing","text":"https://www.paws-r-sdk.com/docs/costexplorer/","code":""},{"path":[]},{"path":"/reference/aws_billing.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch billing data - with some internal munging for ease of use — aws_billing","text":"","code":"if (FALSE) { # interactive() library(lubridate) library(dplyr) start_date <- today() - months(13) z <- aws_billing(date_start = start_date) z %>% filter(id == \"blended\") %>% group_by(service) %>% summarise(sum_cost = sum(cost)) %>% filter(sum_cost > 0) %>% arrange(desc(sum_cost)) z %>% filter(id == \"blended\") %>% filter(cost > 0) %>% arrange(service) z %>% filter(id == \"blended\") %>% group_by(service) %>% summarise(sum_cost = sum(cost)) %>% filter(service == \"Amazon Relational Database Service\") }"},{"path":"/reference/aws_billing_raw.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch billing data - rawest form — aws_billing_raw","title":"Fetch billing data - rawest form — aws_billing_raw","text":"Fetch billing data - rawest form","code":""},{"path":"/reference/aws_billing_raw.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch billing data - rawest form — aws_billing_raw","text":"","code":"aws_billing_raw( date_start, metrics, granularity = \"daily\", filter = NULL, group_by = NULL, date_end = as.character(Sys.Date()) )"},{"path":"/reference/aws_billing_raw.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch billing data - rawest form — aws_billing_raw","text":"date_start, date_end Start end date get billing data . Date format expected: yyyy-MM-dd. required metrics (character) metrics return. required. One : AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, UsageQuantity granularity (character) monthly, daily, hourly. required. filter (list) filters costs different dimensions. optional. group_by (list) group costs using two different groups, either dimensions, tag keys, cost categories, two group types. optional.","code":""},{"path":"/reference/aws_billing_raw.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch billing data - rawest form — aws_billing_raw","text":"list slots : NextPageToken GroupDefinitions ResultsByTime DimensionValueAttributes","code":""},{"path":[]},{"path":"/reference/aws_billing_raw.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch billing data - rawest form — aws_billing_raw","text":"","code":"if (FALSE) { # interactive() aws_billing_x(date_start = \"2023-02-01\", metrics = \"BlendedCost\") }"},{"path":"/reference/aws_bucket_create.html","id":null,"dir":"Reference","previous_headings":"","what":"Create an S3 bucket — aws_bucket_create","title":"Create an S3 bucket — aws_bucket_create","text":"Create S3 bucket","code":""},{"path":"/reference/aws_bucket_create.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create an S3 bucket — aws_bucket_create","text":"","code":"aws_bucket_create(bucket, ...)"},{"path":"/reference/aws_bucket_create.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create an S3 bucket — aws_bucket_create","text":"bucket (character) bucket name. required ... named parameters passed create_bucket","code":""},{"path":"/reference/aws_bucket_create.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create an S3 bucket — aws_bucket_create","text":"bucket path (character)","code":""},{"path":"/reference/aws_bucket_create.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Create an S3 bucket — aws_bucket_create","text":"Requires env var AWS_REGION","code":""},{"path":[]},{"path":"/reference/aws_bucket_create.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create an S3 bucket — aws_bucket_create","text":"","code":"if (FALSE) { aws_bucket_create(bucket = \"s64-test-2\") }"},{"path":"/reference/aws_bucket_delete.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete an S3 bucket — aws_bucket_delete","title":"Delete an S3 bucket — aws_bucket_delete","text":"Delete S3 bucket","code":""},{"path":"/reference/aws_bucket_delete.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete an S3 bucket — aws_bucket_delete","text":"","code":"aws_bucket_delete(bucket, force = FALSE, ...)"},{"path":"/reference/aws_bucket_delete.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete an S3 bucket — aws_bucket_delete","text":"bucket (character) bucket name. required force (logical) force deletion without going prompt. default: FALSE. set TRUE required non-interactive use. ... named parameters passed delete_bucket","code":""},{"path":"/reference/aws_bucket_delete.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete an S3 bucket — aws_bucket_delete","text":"NULL, invisibly","code":""},{"path":"/reference/aws_bucket_delete.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Delete an S3 bucket — aws_bucket_delete","text":"Requires env var AWS_REGION. function prompts make sure want delete bucket.","code":""},{"path":[]},{"path":"/reference/aws_bucket_delete.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Delete an S3 bucket — aws_bucket_delete","text":"","code":"if (FALSE) { # interactive() bucket_name <- \"bucket-to-delete-113\" if (!aws_bucket_exists(bucket_name)) { aws_bucket_create(bucket = bucket_name) aws_buckets() aws_bucket_delete(bucket = bucket_name) aws_buckets() } }"},{"path":"/reference/aws_bucket_download.html","id":null,"dir":"Reference","previous_headings":"","what":"Download an S3 bucket — aws_bucket_download","title":"Download an S3 bucket — aws_bucket_download","text":"Download S3 bucket","code":""},{"path":"/reference/aws_bucket_download.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Download an S3 bucket — aws_bucket_download","text":"","code":"aws_bucket_download(bucket, dest_path, ...)"},{"path":"/reference/aws_bucket_download.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Download an S3 bucket — aws_bucket_download","text":"bucket (character) bucket name. required dest_path (character) destination directory store files. required ... named parameters passed s3fs::s3_dir_download()","code":""},{"path":"/reference/aws_bucket_download.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Download an S3 bucket — aws_bucket_download","text":"Requires env var AWS_REGION. function prompts make sure want delete bucket.","code":""},{"path":[]},{"path":"/reference/aws_bucket_download.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Download an S3 bucket — aws_bucket_download","text":"","code":"if (FALSE) { # interactive() bucket <- random_string(\"bucket\") aws_bucket_create(bucket = bucket) desc_file <- file.path(system.file(), \"DESCRIPTION\") aws_file_upload(desc_file, s3_path(bucket, \"DESCRIPTION.txt\")) aws_file_upload(desc_file, s3_path(bucket, \"d_file.txt\")) temp_dir <- file.path(tempdir(), bucket) aws_bucket_download(bucket = bucket, dest_path = temp_dir) fs::dir_ls(temp_dir) # cleanup aws_bucket_delete(\"tmp-bucket-369\") }"},{"path":"/reference/aws_bucket_exists.html","id":null,"dir":"Reference","previous_headings":"","what":"Check if an S3 bucket exists — aws_bucket_exists","title":"Check if an S3 bucket exists — aws_bucket_exists","text":"Check S3 bucket exists","code":""},{"path":"/reference/aws_bucket_exists.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check if an S3 bucket exists — aws_bucket_exists","text":"","code":"aws_bucket_exists(bucket)"},{"path":"/reference/aws_bucket_exists.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check if an S3 bucket exists — aws_bucket_exists","text":"bucket (character) bucket name; must length 1. required","code":""},{"path":"/reference/aws_bucket_exists.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check if an S3 bucket exists — aws_bucket_exists","text":"single boolean (logical)","code":""},{"path":"/reference/aws_bucket_exists.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Check if an S3 bucket exists — aws_bucket_exists","text":"internally uses head_bucket","code":""},{"path":[]},{"path":"/reference/aws_bucket_exists.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Check if an S3 bucket exists — aws_bucket_exists","text":"","code":"if (FALSE) { # exists aws_bucket_exists(bucket = \"s64-test-2\") # does not exist aws_bucket_exists(bucket = \"no-bucket\") }"},{"path":"/reference/aws_bucket_list_objects.html","id":null,"dir":"Reference","previous_headings":"","what":"List objects in an S3 bucket — aws_bucket_list_objects","title":"List objects in an S3 bucket — aws_bucket_list_objects","text":"List objects S3 bucket","code":""},{"path":"/reference/aws_bucket_list_objects.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List objects in an S3 bucket — aws_bucket_list_objects","text":"","code":"aws_bucket_list_objects(bucket, ...)"},{"path":"/reference/aws_bucket_list_objects.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List objects in an S3 bucket — aws_bucket_list_objects","text":"bucket (character) bucket name. required ... named parameters passed list_objects","code":""},{"path":"/reference/aws_bucket_list_objects.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List objects in an S3 bucket — aws_bucket_list_objects","text":"objects found, empty tibble. tibble rows S3 bucket, 8 columns: bucket_name (character) key (character) uri (character) size (fs::bytes) type (character) owner (character) etag (character) last_modified (dttm)","code":""},{"path":[]},{"path":"/reference/aws_bucket_list_objects.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List objects in an S3 bucket — aws_bucket_list_objects","text":"","code":"if (FALSE) { # interactive() bucket_name <- random_string(\"bucket\") if (!aws_bucket_exists(bucket_name)) aws_bucket_create(bucket_name) links_file <- file.path(system.file(), \"Meta/links.rds\") aws_file_upload( links_file, s3_path(bucket_name, basename(links_file)) ) aws_bucket_list_objects(bucket = bucket_name) }"},{"path":"/reference/aws_bucket_tree.html","id":null,"dir":"Reference","previous_headings":"","what":"Print a tree of the objects in a bucket — aws_bucket_tree","title":"Print a tree of the objects in a bucket — aws_bucket_tree","text":"Print tree objects bucket","code":""},{"path":"/reference/aws_bucket_tree.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Print a tree of the objects in a bucket — aws_bucket_tree","text":"","code":"aws_bucket_tree(bucket, recurse = TRUE, ...)"},{"path":"/reference/aws_bucket_tree.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Print a tree of the objects in a bucket — aws_bucket_tree","text":"bucket (character) bucket name; must length 1. required recurse (logical) returns AWS S3 objects lower sub directories, default: TRUE ... Additional arguments passed s3fs::s3_dir_tree()","code":""},{"path":"/reference/aws_bucket_tree.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Print a tree of the objects in a bucket — aws_bucket_tree","text":"character vector objects/files within bucket, printed tree","code":""},{"path":[]},{"path":"/reference/aws_bucket_tree.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Print a tree of the objects in a bucket — aws_bucket_tree","text":"","code":"if (FALSE) { # interactive() bucket_name <- random_string(\"bucket\") if (!aws_bucket_exists(bucket_name)) aws_bucket_create(bucket_name) links_file <- file.path(system.file(), \"Meta/links.rds\") pkgs_file <- file.path(system.file(), \"Meta/package.rds\") demo_file <- file.path(system.file(), \"Meta/demo.rds\") aws_file_upload( c(links_file, pkgs_file, demo_file), s3_path( bucket_name, c( basename(links_file), basename(pkgs_file), basename(demo_file) ) ) ) aws_bucket_tree(bucket_name) # cleanup objs <- aws_bucket_list_objects(bucket_name) aws_file_delete(objs$uri) aws_bucket_delete(bucket_name, force = TRUE) aws_bucket_exists(bucket_name) }"},{"path":"/reference/aws_bucket_upload.html","id":null,"dir":"Reference","previous_headings":"","what":"Upload a folder of files to create an S3 bucket — aws_bucket_upload","title":"Upload a folder of files to create an S3 bucket — aws_bucket_upload","text":"Upload folder files create S3 bucket","code":""},{"path":"/reference/aws_bucket_upload.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Upload a folder of files to create an S3 bucket — aws_bucket_upload","text":"","code":"aws_bucket_upload( path, bucket, max_batch = fs::fs_bytes(\"100MB\"), force = FALSE, ... )"},{"path":"/reference/aws_bucket_upload.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Upload a folder of files to create an S3 bucket — aws_bucket_upload","text":"path (character) local path directory. required bucket (character) bucket name. required max_batch (fs_bytes) maximum batch size uploaded multipart force (logical) force deletion without going prompt. default: FALSE. set TRUE required non-interactive use. ... named parameters passed s3fs::s3_dir_upload()","code":""},{"path":"/reference/aws_bucket_upload.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Upload a folder of files to create an S3 bucket — aws_bucket_upload","text":"s3 format path bucket uploaded ","code":""},{"path":"/reference/aws_bucket_upload.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Upload a folder of files to create an S3 bucket — aws_bucket_upload","text":"upload individual files see aws_file_upload()","code":""},{"path":"/reference/aws_bucket_upload.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Upload a folder of files to create an S3 bucket — aws_bucket_upload","text":"Requires env var AWS_REGION. function prompts make sure want delete bucket.","code":""},{"path":[]},{"path":"/reference/aws_bucket_upload.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Upload a folder of files to create an S3 bucket — aws_bucket_upload","text":"","code":"if (FALSE) { # interactive() library(fs) tdir <- path(tempdir(), \"apples\") dir.create(tdir) tfiles <- replicate(n = 10, file_temp(tmp_dir = tdir, ext = \".txt\")) invisible(lapply(tfiles, function(x) write.csv(mtcars, x))) bucket_name <- random_string(\"bucket\") if (!aws_bucket_exists(bucket_name)) aws_bucket_create(bucket_name) aws_bucket_upload(path = tdir, bucket = bucket_name) aws_bucket_list_objects(bucket_name) # cleanup objs <- aws_bucket_list_objects(bucket_name) aws_file_delete(objs$uri) aws_bucket_list_objects(bucket_name) aws_bucket_delete(bucket_name, force = TRUE) aws_bucket_exists(bucket_name) }"},{"path":"/reference/aws_buckets.html","id":null,"dir":"Reference","previous_headings":"","what":"List S3 buckets — aws_buckets","title":"List S3 buckets — aws_buckets","text":"List S3 buckets","code":""},{"path":"/reference/aws_buckets.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List S3 buckets — aws_buckets","text":"","code":"aws_buckets(...)"},{"path":"/reference/aws_buckets.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List S3 buckets — aws_buckets","text":"... named parameters passed list_objects","code":""},{"path":"/reference/aws_buckets.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List S3 buckets — aws_buckets","text":"objects found, empty tibble. tibble rows S3 bucket, 8 columns: bucket_name (character) key (character) uri (character) size (fs::bytes) type (character) owner (character) etag (character) last_modified (dttm)","code":""},{"path":"/reference/aws_buckets.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"List S3 buckets — aws_buckets","text":"internally uses s3fs::s3_dir_info()","code":""},{"path":"/reference/aws_buckets.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"List S3 buckets — aws_buckets","text":"set refresh=TRUE internally make sure return date information buckets rather cached locally","code":""},{"path":[]},{"path":"/reference/aws_buckets.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List S3 buckets — aws_buckets","text":"","code":"if (FALSE) { aws_buckets() }"},{"path":"/reference/aws_db_cluster_status.html","id":null,"dir":"Reference","previous_headings":"","what":"Get cluster status — aws_db_cluster_status","title":"Get cluster status — aws_db_cluster_status","text":"Get cluster status","code":""},{"path":"/reference/aws_db_cluster_status.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get cluster status — aws_db_cluster_status","text":"","code":"aws_db_cluster_status(id)"},{"path":"/reference/aws_db_cluster_status.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get cluster status — aws_db_cluster_status","text":"id (character) Cluster identifier. Use identifier refer cluster subsequent cluster operations deleting modifying. identifier also appears Amazon Redshift console. Must unique clusters within Amazon Web Services account.","code":""},{"path":"/reference/aws_db_cluster_status.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get cluster status — aws_db_cluster_status","text":"(character) status cluster, e.g., \"creating\", \"available\", \"found\"","code":""},{"path":[]},{"path":"/reference/aws_db_cluster_status.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get cluster status — aws_db_cluster_status","text":"","code":"if (FALSE) { aws_db_cluster_status(id = \"scotts-test-cluster-456\") }"},{"path":"/reference/aws_db_instance_status.html","id":null,"dir":"Reference","previous_headings":"","what":"Get instance status — aws_db_instance_status","title":"Get instance status — aws_db_instance_status","text":"Get instance status","code":""},{"path":"/reference/aws_db_instance_status.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get instance status — aws_db_instance_status","text":"","code":"aws_db_instance_status(id)"},{"path":"/reference/aws_db_instance_status.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get instance status — aws_db_instance_status","text":"id (character) required. instance identifier. identifier DB instance. parameter stored lowercase string. Constraints: must contain 1 63 letters, numbers, hyphens; first character must letter; end hyphen contain two consecutive hyphens. required.","code":""},{"path":"/reference/aws_db_instance_status.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get instance status — aws_db_instance_status","text":"(character) status instance, e.g., \"creating\", \"available\", \"found\"","code":""},{"path":[]},{"path":"/reference/aws_db_instance_status.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get instance status — aws_db_instance_status","text":"","code":"if (FALSE) { aws_db_instance_status(id = \"thedbinstance\") }"},{"path":"/reference/aws_db_rds_con.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a database connection to Amazon RDS — aws_db_rds_con","title":"Get a database connection to Amazon RDS — aws_db_rds_con","text":"Supports: MariaDB, MySQL, Postgres","code":""},{"path":"/reference/aws_db_rds_con.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a database connection to Amazon RDS — aws_db_rds_con","text":"","code":"aws_db_rds_con( user = NULL, pwd = NULL, id = NULL, host = NULL, port = NULL, dbname = NULL, engine = NULL, ... )"},{"path":"/reference/aws_db_rds_con.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a database connection to Amazon RDS — aws_db_rds_con","text":"user, pwd, host, port, dbname, ... named parameters passed DBI::dbConnect. Note user pwd AWS IAM account; used create cluster aws_db_redshift_create() id (character) Cluster identifier. supply id, fetch host, port, dbname. id supplied. supply host, port, dbname. Refer parameter definition aws_db_redshift_create() details. engine (character) engine use. optional user, pwd, id supplied - otherwise required","code":""},{"path":"/reference/aws_db_rds_con.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get a database connection to Amazon RDS — aws_db_rds_con","text":"RDS supports many databases, provide support MariaDB, MySQL, Postgres engine chosen RDS instance supported function, can likely connect ","code":""},{"path":[]},{"path":"/reference/aws_db_rds_con.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get a database connection to Amazon RDS — aws_db_rds_con","text":"","code":"if (FALSE) { con_rds <- aws_db_rds_con(\"\") con_rds library(DBI) library(RMariaDB) dbListTables(con_rds) dbWriteTable(con_rds, \"mtcars\", mtcars) dbListTables(con_rds) dbReadTable(con_rds, \"mtcars\") library(dplyr) tbl(con_rds, \"mtcars\") }"},{"path":"/reference/aws_db_rds_create.html","id":null,"dir":"Reference","previous_headings":"","what":"Create an RDS cluster — aws_db_rds_create","title":"Create an RDS cluster — aws_db_rds_create","text":"Create RDS cluster","code":""},{"path":"/reference/aws_db_rds_create.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create an RDS cluster — aws_db_rds_create","text":"","code":"aws_db_rds_create( id, class, user = NULL, pwd = NULL, dbname = \"dev\", engine = \"mariadb\", storage = 20, storage_encrypted = TRUE, security_group_ids = NULL, wait = TRUE, verbose = TRUE, aws_secrets = TRUE, iam_database_auth = FALSE, ... )"},{"path":"/reference/aws_db_rds_create.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create an RDS cluster — aws_db_rds_create","text":"id (character) required. instance identifier. identifier DB instance. parameter stored lowercase string. Constraints: must contain 1 63 letters, numbers, hyphens; first character must letter; end hyphen contain two consecutive hyphens. required. class (character) required. compute memory capacity DB instance, example db.m5.large. user (character) User name associated admin user account cluster created. NULL, generate random user name, see random_user() pwd (character) Password associated admin user account cluster created. NULL, generate random password aws_secrets_pwd() (uses AWS Secrets Manager service) dbname (character) name first database created cluster created. default: \"dev\". additional databases can created within cluster engine (character) engine use. default: \"mariadb\". required. one : mariadb, mysql, postgres storage (character) amount storage gibibytes (GiB) allocate DB instance. default: 20 storage_encrypted (logical) Whether DB instance encrypted. default: TRUE security_group_ids (character) VPC security group identifiers; one . none supplied, go AWS Redshift dashboard add appropriate VPC security group. wait (logical) wait cluster initialize? default: TRUE. wait (FALSE) many operations can cluster available. wait=FALSE use aws_db_instance_status() check cluster status. verbose (logical) verbose informational output? default: TRUE aws_secrets (logical) manage database credentials AWS Secrets Manager? default: TRUE iam_database_auth (logical) Use IAM database authentication? default: FALSE ... named parameters passed create_db_instance","code":""},{"path":"/reference/aws_db_rds_create.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create an RDS cluster — aws_db_rds_create","text":"returns NULL, function called side effect creating RDS instance","code":""},{"path":"/reference/aws_db_rds_create.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Create an RDS cluster — aws_db_rds_create","text":"See link create_db_instance docs details requirements parameter Note even though can use option engine function, may provide ability connect chosen data source package.","code":""},{"path":"/reference/aws_db_rds_create.html","id":"waiting","dir":"Reference","previous_headings":"","what":"Waiting","title":"Create an RDS cluster — aws_db_rds_create","text":"Note wait = TRUE function waits instance available returning. wait can around 5 - 7 minutes. can instead set wait = FALSE check status instance AWS dashboard.","code":""},{"path":[]},{"path":"/reference/aws_db_rds_list.html","id":null,"dir":"Reference","previous_headings":"","what":"Get information for all RDS instances — aws_db_rds_list","title":"Get information for all RDS instances — aws_db_rds_list","text":"Get information RDS instances","code":""},{"path":"/reference/aws_db_rds_list.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get information for all RDS instances — aws_db_rds_list","text":"","code":"aws_db_rds_list()"},{"path":"/reference/aws_db_rds_list.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get information for all RDS instances — aws_db_rds_list","text":"tibble instance details; see https://www.paws-r-sdk.com/docs/describe_db_instances/ empty tibble instances found","code":""},{"path":[]},{"path":"/reference/aws_db_rds_list.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get information for all RDS instances — aws_db_rds_list","text":"","code":"if (FALSE) { # interactive() aws_db_rds_list() }"},{"path":"/reference/aws_db_redshift_con.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a database connection to Amazon Redshift — aws_db_redshift_con","title":"Get a database connection to Amazon Redshift — aws_db_redshift_con","text":"Get database connection Amazon Redshift","code":""},{"path":"/reference/aws_db_redshift_con.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a database connection to Amazon Redshift — aws_db_redshift_con","text":"","code":"aws_db_redshift_con( user, pwd, id = NULL, host = NULL, port = NULL, dbname = NULL, ... )"},{"path":"/reference/aws_db_redshift_con.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a database connection to Amazon Redshift — aws_db_redshift_con","text":"user, pwd, host, port, dbname, ... named parameters passed DBI::dbConnect. Note user pwd AWS IAM account; used create cluster aws_db_redshift_create() id (character) Cluster identifier. supply id, fetch host, port, dbname. id supplied. supply host, port, dbname. Refer parameter definition aws_db_redshift_create() details.","code":""},{"path":"/reference/aws_db_redshift_con.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a database connection to Amazon Redshift — aws_db_redshift_con","text":"object class RedshiftConnection","code":""},{"path":"/reference/aws_db_redshift_con.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get a database connection to Amazon Redshift — aws_db_redshift_con","text":"connection returned created using RPostgres can manage Redshift programatically via paws::redshift","code":""},{"path":[]},{"path":"/reference/aws_db_redshift_con.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get a database connection to Amazon Redshift — aws_db_redshift_con","text":"","code":"if (FALSE) { library(DBI) library(RPostgres) con_rshift <- aws_db_redshift_con(\"\") con_rshift library(RPostgres) dbListTables(con_rshift) dbWriteTable(con_rshift, \"mtcars\", mtcars) dbListTables(con_rshift) library(dplyr) tbl(con_rshift, \"mtcars\") }"},{"path":"/reference/aws_db_redshift_create.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a Redshift cluster — aws_db_redshift_create","title":"Create a Redshift cluster — aws_db_redshift_create","text":"Create Redshift cluster","code":""},{"path":"/reference/aws_db_redshift_create.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a Redshift cluster — aws_db_redshift_create","text":"","code":"aws_db_redshift_create( id, user, pwd, dbname = \"dev\", cluster_type = \"multi-node\", node_type = \"dc2.large\", number_nodes = 2, security_group_ids = NULL, wait = TRUE, verbose = TRUE, ... )"},{"path":"/reference/aws_db_redshift_create.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a Redshift cluster — aws_db_redshift_create","text":"id (character) Cluster identifier. Use identifier refer cluster subsequent cluster operations deleting modifying. identifier also appears Amazon Redshift console. Must unique clusters within Amazon Web Services account. user (character) User name associated admin user account cluster created. username IAM account pwd (character) Password associated admin user account cluster created. password IAM account dbname (character) name first database created cluster created. default: \"dev\". additional databases can created within cluster cluster_type (character) type cluster: \"single-node\" \"multi-node\" (default). node_type (character) node type provisioned cluster. defaul: \"dc2.large\" number_nodes (integer/numeric) number nodes; multi-node cluster type, must 2 greater. default: 2 security_group_ids (character) VPC security group identifiers; one . none supplied, go AWS Redshift dashboard add appropriate VPC security group. wait (logical) wait cluster initialize? default: TRUE. wait (FALSE) many operations can cluster available. wait=FALSE use aws_db_cluster_status() check cluster status. verbose (logical) verbose informational output? default: TRUE ... named parameters passed create_cluster","code":""},{"path":"/reference/aws_db_redshift_create.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a Redshift cluster — aws_db_redshift_create","text":"returns NULL, function called side effect creating Redshift instance","code":""},{"path":"/reference/aws_db_redshift_create.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Create a Redshift cluster — aws_db_redshift_create","text":"See link create_cluster docs details requirements parameter","code":""},{"path":"/reference/aws_db_redshift_create.html","id":"waiting","dir":"Reference","previous_headings":"","what":"Waiting","title":"Create a Redshift cluster — aws_db_redshift_create","text":"Note wait = TRUE function waits instance available returning. wait can around 5 - 7 minutes. can instead set wait = FALSE check status instance AWS dashboard.","code":""},{"path":[]},{"path":"/reference/aws_file_attr.html","id":null,"dir":"Reference","previous_headings":"","what":"File attributes — aws_file_attr","title":"File attributes — aws_file_attr","text":"File attributes","code":""},{"path":"/reference/aws_file_attr.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"File attributes — aws_file_attr","text":"","code":"aws_file_attr(remote_path)"},{"path":"/reference/aws_file_attr.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"File attributes — aws_file_attr","text":"remote_path (character) one remote S3 paths. required","code":""},{"path":"/reference/aws_file_attr.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"File attributes — aws_file_attr","text":"tibble many columns, number rows matching length remote_path","code":""},{"path":"/reference/aws_file_attr.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"File attributes — aws_file_attr","text":"uses s3fs::s3_file_info() internally","code":""},{"path":[]},{"path":"/reference/aws_file_attr.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"File attributes — aws_file_attr","text":"","code":"if (FALSE) { # files one by one aws_file_attr(s3_path(\"s64-test-2\", \"DESCRIPTION\")) aws_file_attr(s3_path(\"s64-test-2\", \"ddd\")) aws_file_attr(s3_path(\"s64-test-2\", \"doesntexist\")) # or all together aws_file_attr(s3_path(\"s64-test-2\", c(\"DESCRIPTION\", \"ddd\"))) }"},{"path":"/reference/aws_file_copy.html","id":null,"dir":"Reference","previous_headings":"","what":"Copy files between buckets — aws_file_copy","title":"Copy files between buckets — aws_file_copy","text":"Copy files buckets","code":""},{"path":"/reference/aws_file_copy.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Copy files between buckets — aws_file_copy","text":"","code":"aws_file_copy(remote_path, bucket, force = FALSE, ...)"},{"path":"/reference/aws_file_copy.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Copy files between buckets — aws_file_copy","text":"remote_path (character) one remote S3 paths. required bucket (character) bucket copy files . required. bucket exist prompt asking like bucket created force (logical) force bucket creation without going prompt. default: FALSE. set TRUE required non-interactive use. ... named parameters passed s3fs::s3_file_copy()","code":""},{"path":"/reference/aws_file_copy.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Copy files between buckets — aws_file_copy","text":"vector paths, length matches length(remote_path)","code":""},{"path":[]},{"path":"/reference/aws_file_copy.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Copy files between buckets — aws_file_copy","text":"","code":"if (FALSE) { # create files in an existing bucket tfiles <- replicate(n = 3, tempfile()) for (i in tfiles) cat(\"Hello\\nWorld\\n\", file = i) paths <- s3_path(\"s64-test-2\", c(\"aaa\", \"bbb\", \"ccc\"), ext = \"txt\") aws_file_upload(tfiles, paths) # create a new bucket new_bucket <- aws_bucket_create(bucket = \"s64-test-3\") # add existing files to the new bucket aws_file_copy(paths, path_as_s3(new_bucket)) # create bucket that doesn't exist yet aws_file_copy(paths, \"s64-test-4\") }"},{"path":"/reference/aws_file_delete.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete a file — aws_file_delete","title":"Delete a file — aws_file_delete","text":"Delete file","code":""},{"path":"/reference/aws_file_delete.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete a file — aws_file_delete","text":"","code":"aws_file_delete(remote_path, ...)"},{"path":"/reference/aws_file_delete.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete a file — aws_file_delete","text":"remote_path (character) one remote S3 paths. required ... named parameters passed delete_object","code":""},{"path":"/reference/aws_file_delete.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete a file — aws_file_delete","text":"NULL invisibly","code":""},{"path":[]},{"path":"/reference/aws_file_delete.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Delete a file — aws_file_delete","text":"","code":"if (FALSE) { # create a file tfile <- tempfile() cat(\"Hello World!\", file = tfile) aws_file_upload(remote_path = \"s3://s64-test-2\", path = tfile) # delete the file aws_file_delete(s3_path(\"s64-test-2\", basename(tfile))) # file does not exist - no error is raised aws_file_delete(s3_path(\"s64-test-2\", \"TESTING123\")) }"},{"path":"/reference/aws_file_download.html","id":null,"dir":"Reference","previous_headings":"","what":"Download a file — aws_file_download","title":"Download a file — aws_file_download","text":"Download file","code":""},{"path":"/reference/aws_file_download.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Download a file — aws_file_download","text":"","code":"aws_file_download(remote_path, path, ...)"},{"path":"/reference/aws_file_download.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Download a file — aws_file_download","text":"remote_path (character) one remote S3 paths. required path (character) one file paths write . required ... named parameters passed s3fs::s3_file_download()","code":""},{"path":"/reference/aws_file_download.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Download a file — aws_file_download","text":"(character) vector local file paths","code":""},{"path":[]},{"path":"/reference/aws_file_download.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Download a file — aws_file_download","text":"","code":"if (FALSE) { tfile <- tempfile() aws_file_download(remote_path = \"s3://s64-test-2/DESCRIPTION\", path = tfile) # many files tfiles <- replicate(n = 3, tempfile()) aws_file_download( remote_path = s3_path(\"s64-test-2\", c(\"a_file\", \"c_file\", \"d_file\")), path = tfiles ) ## length of `remote_path` and `path` must be the same tfiles <- replicate(n = 2, tempfile()) aws_file_download( remote_path = s3_path(\"s64-test-2\", c(\"a_file\", \"c_file\", \"d_file\")), path = tfiles ) # S3 file does not exist temp_path <- tempfile() aws_file_download(s3_path(\"s64-test-2\", \"TESTING123\"), temp_path) }"},{"path":"/reference/aws_file_exists.html","id":null,"dir":"Reference","previous_headings":"","what":"Check if a file exists — aws_file_exists","title":"Check if a file exists — aws_file_exists","text":"Check file exists","code":""},{"path":"/reference/aws_file_exists.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check if a file exists — aws_file_exists","text":"","code":"aws_file_exists(remote_path)"},{"path":"/reference/aws_file_exists.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check if a file exists — aws_file_exists","text":"remote_path (character) one remote S3 paths. required","code":""},{"path":"/reference/aws_file_exists.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check if a file exists — aws_file_exists","text":"vector booleans (TRUE FALSE), length matches length(remote_path)","code":""},{"path":[]},{"path":"/reference/aws_file_exists.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Check if a file exists — aws_file_exists","text":"","code":"if (FALSE) { aws_file_exists(s3_path(\"s64-test-2\", \"DESCRIPTION\")) aws_file_exists(s3_path(\"s64-test-2\", \"doesntexist\")) aws_file_exists(s3_path(\"s64-test-2\", c(\"DESCRIPTION\", \"doesntexist\"))) }"},{"path":"/reference/aws_file_rename.html","id":null,"dir":"Reference","previous_headings":"","what":"Rename a remote file — aws_file_rename","title":"Rename a remote file — aws_file_rename","text":"Rename remote file","code":""},{"path":"/reference/aws_file_rename.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Rename a remote file — aws_file_rename","text":"","code":"aws_file_rename(remote_path, new_remote_path, ...)"},{"path":"/reference/aws_file_rename.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rename a remote file — aws_file_rename","text":"remote_path (character) one remote S3 paths. required new_remote_path (character) one remote S3 paths. required. length must match remote_path ... named parameters passed s3fs::s3_file_move()","code":""},{"path":"/reference/aws_file_rename.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Rename a remote file — aws_file_rename","text":"vector paths, length matches length(remote_path)","code":""},{"path":[]},{"path":"/reference/aws_file_rename.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Rename a remote file — aws_file_rename","text":"","code":"if (FALSE) { aws_file_rename( s3_path(\"s64-test-2\", \"DESCRIPTION\"), s3_path(\"s64-test-2\", \"DESC\") ) tfiles <- replicate(n = 3, tempfile()) for (i in tfiles) cat(\"Hello\\nWorld\\n\", file = i) paths <- s3_path(\"s64-test-2\", c(\"aaa\", \"bbb\", \"ccc\"), ext = \"txt\") aws_file_upload(tfiles, paths) new_paths <- s3_path(\"s64-test-2\", c(\"new_aaa\", \"new_bbb\", \"new_ccc\"), ext = \"txt\" ) aws_file_rename(paths, new_paths) }"},{"path":"/reference/aws_file_upload.html","id":null,"dir":"Reference","previous_headings":"","what":"Upload a file — aws_file_upload","title":"Upload a file — aws_file_upload","text":"Upload file","code":""},{"path":"/reference/aws_file_upload.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Upload a file — aws_file_upload","text":"","code":"aws_file_upload(path, remote_path, ...)"},{"path":"/reference/aws_file_upload.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Upload a file — aws_file_upload","text":"path (character) file path read . required remote_path (character) remote path file go. required ... named parameters passed s3fs::s3_file_copy()","code":""},{"path":"/reference/aws_file_upload.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Upload a file — aws_file_upload","text":"(character) vector remote s3 paths","code":""},{"path":"/reference/aws_file_upload.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Upload a file — aws_file_upload","text":"upload folder files see aws_bucket_upload()","code":""},{"path":[]},{"path":"/reference/aws_file_upload.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Upload a file — aws_file_upload","text":"","code":"if (FALSE) { # interactive() bucket <- random_string(\"bucket\") aws_bucket_create(bucket) demo_rds_file <- file.path(system.file(), \"Meta/demo.rds\") aws_file_upload( demo_rds_file, s3_path(bucket, basename(demo_rds_file)) ) ## many files at once links_file <- file.path(system.file(), \"Meta/links.rds\") aws_file_upload( c(demo_rds_file, links_file), s3_path(\"s64-test-2\", c(basename(demo_rds_file), basename(links_file))) ) # set expiration, expire 1 minute from now aws_file_upload(demo_rds_file, s3_path(\"s64-test-2\", \"ddd.rds\"), Expires = Sys.time() + 60 ) # bucket doesn't exist aws_file_upload(demo_rds_file, \"s3://not-a-bucket/eee.rds\") # path doesn't exist aws_file_upload( \"file_doesnt_exist.txt\", s3_path(\"s64-test-2\", \"file_doesnt_exist.txt\") ) # Path's without file extensions behave a little weird ## With extension ## Both of these lines do the same exact thing: make a file in the ## same path in a bucket aws_file_upload(\"LICENSE.md\", s3_path(bucket, \"LICENSE.md\")) aws_file_upload(\"LICENSE.md\", s3_path(bucket)) ## Without extension ## However, it's different for a file without an extension ## This makes a file in the bucket at path DESCRIPTION aws_file_upload(\"DESCRIPTION\", s3_path(bucket)) ## Whereas this creates a directory called DESCRIPTION with ## a file DESCRIPTION within it aws_file_upload(\"DESCRIPTION\", s3_path(bucket, \"DESCRIPTION\")) }"},{"path":"/reference/aws_group.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a group — aws_group","title":"Get a group — aws_group","text":"Get group","code":""},{"path":"/reference/aws_group.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a group — aws_group","text":"","code":"aws_group(name)"},{"path":"/reference/aws_group.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a group — aws_group","text":"name (character) group name","code":""},{"path":"/reference/aws_group.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a group — aws_group","text":"named list slots : group: information group (tibble) users: users group (tibble) policies (character) attached_policies (tibble)","code":""},{"path":"/reference/aws_group.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get a group — aws_group","text":"see docs https://www.paws-r-sdk.com/docs/iam_get_group/","code":""},{"path":[]},{"path":"/reference/aws_group.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get a group — aws_group","text":"","code":"if (FALSE) { aws_group(name = \"users\") }"},{"path":"/reference/aws_group_create.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a group — aws_group_create","title":"Create a group — aws_group_create","text":"Create group","code":""},{"path":"/reference/aws_group_create.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a group — aws_group_create","text":"","code":"aws_group_create(name, path = NULL)"},{"path":"/reference/aws_group_create.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a group — aws_group_create","text":"name (character) group name. required path (character) path group name. optional. included, defaults slash (/).","code":""},{"path":"/reference/aws_group_create.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a group — aws_group_create","text":"tibble information group created","code":""},{"path":"/reference/aws_group_create.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Create a group — aws_group_create","text":"See https://www.paws-r-sdk.com/docs/iam_create_group/ docs details parameters","code":""},{"path":[]},{"path":"/reference/aws_group_create.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a group — aws_group_create","text":"","code":"if (FALSE) { aws_group_create(\"testgroup\") }"},{"path":"/reference/aws_group_delete.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete a group — aws_group_delete","title":"Delete a group — aws_group_delete","text":"Delete group","code":""},{"path":"/reference/aws_group_delete.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete a group — aws_group_delete","text":"","code":"aws_group_delete(name)"},{"path":"/reference/aws_group_delete.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete a group — aws_group_delete","text":"name (character) group name. required","code":""},{"path":"/reference/aws_group_delete.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete a group — aws_group_delete","text":"empty list","code":""},{"path":"/reference/aws_group_delete.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Delete a group — aws_group_delete","text":"See https://www.paws-r-sdk.com/docs/iam_delete_group/ docs details","code":""},{"path":[]},{"path":"/reference/aws_group_delete.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Delete a group — aws_group_delete","text":"","code":"if (FALSE) { aws_group_delete(name = \"testgroup\") }"},{"path":"/reference/aws_group_exists.html","id":null,"dir":"Reference","previous_headings":"","what":"Check if a group exists — aws_group_exists","title":"Check if a group exists — aws_group_exists","text":"Check group exists","code":""},{"path":"/reference/aws_group_exists.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check if a group exists — aws_group_exists","text":"","code":"aws_group_exists(name)"},{"path":"/reference/aws_group_exists.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check if a group exists — aws_group_exists","text":"name (character) group name","code":""},{"path":"/reference/aws_group_exists.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check if a group exists — aws_group_exists","text":"single boolean","code":""},{"path":"/reference/aws_group_exists.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Check if a group exists — aws_group_exists","text":"uses aws_group internally. see docs https://www.paws-r-sdk.com/docs/iam_get_group/","code":""},{"path":[]},{"path":"/reference/aws_group_exists.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Check if a group exists — aws_group_exists","text":"","code":"if (FALSE) { aws_group_exists(name = \"users\") aws_group_exists(name = \"apples\") }"},{"path":"/reference/aws_groups.html","id":null,"dir":"Reference","previous_headings":"","what":"List all groups or groups for a single user — aws_groups","title":"List all groups or groups for a single user — aws_groups","text":"List groups groups single user","code":""},{"path":"/reference/aws_groups.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List all groups or groups for a single user — aws_groups","text":"","code":"aws_groups(username = NULL, ...)"},{"path":"/reference/aws_groups.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List all groups or groups for a single user — aws_groups","text":"username (character) username. optional ... parameters passed paws list_groups_for_user username non-NULL, otherwise passed list_users","code":""},{"path":"/reference/aws_groups.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List all groups or groups for a single user — aws_groups","text":"tibble information groups","code":""},{"path":[]},{"path":"/reference/aws_groups.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List all groups or groups for a single user — aws_groups","text":"","code":"if (FALSE) { aws_groups() aws_groups(username = aws_user_current()) }"},{"path":"/reference/aws_policies.html","id":null,"dir":"Reference","previous_headings":"","what":"List policies — aws_policies","title":"List policies — aws_policies","text":"List policies","code":""},{"path":"/reference/aws_policies.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List policies — aws_policies","text":"","code":"aws_policies(refresh = FALSE, ...)"},{"path":"/reference/aws_policies.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List policies — aws_policies","text":"refresh (logical) refresh results? default: FALSE. invalidate cache refresh policy data, set refresh=TRUE ... named arguments passed list_policies","code":""},{"path":"/reference/aws_policies.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List policies — aws_policies","text":"tibble information policies. row policy. Columns: PolicyName PolicyId Path Arn CreateDate UpdateDate AttachmentCount PermissionsBoundaryUsageCount IsAttachable Description Tags","code":""},{"path":"/reference/aws_policies.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"List policies — aws_policies","text":"uses memoise internally cache results speed subsequent calls function","code":""},{"path":[]},{"path":"/reference/aws_policies.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List policies — aws_policies","text":"","code":"if (FALSE) { aws_policies() aws_policies() aws_policies(refresh = TRUE) }"},{"path":"/reference/aws_policy.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a policy — aws_policy","title":"Get a policy — aws_policy","text":"Get policy","code":""},{"path":"/reference/aws_policy.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a policy — aws_policy","text":"","code":"aws_policy(name, local = FALSE, path = NULL)"},{"path":"/reference/aws_policy.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a policy — aws_policy","text":"name (character) policy name arn local (logical) TRUE use AWS account managed policies. FALSE, AWS managed policies path (character) NULL, add path ARN name value","code":""},{"path":"/reference/aws_policy.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a policy — aws_policy","text":"tibble policy details","code":""},{"path":"/reference/aws_policy.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get a policy — aws_policy","text":"see docs https://www.paws-r-sdk.com/docs/iam_get_policy/","code":""},{"path":[]},{"path":"/reference/aws_policy.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get a policy — aws_policy","text":"","code":"if (FALSE) { aws_policy(\"ReadOnlyAccess\") aws_policy(\"arn:aws:iam::aws:policy/ReadOnlyAccess\") }"},{"path":"/reference/aws_policy_attach.html","id":null,"dir":"Reference","previous_headings":"","what":"Attach a policy to a user, group, or role — aws_policy_attach","title":"Attach a policy to a user, group, or role — aws_policy_attach","text":"Attach policy user, group, role","code":""},{"path":"/reference/aws_policy_attach.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Attach a policy to a user, group, or role — aws_policy_attach","text":"","code":"aws_policy_attach(.x, policy)"},{"path":"/reference/aws_policy_attach.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Attach a policy to a user, group, or role — aws_policy_attach","text":".x result call create get method user, group, role policy (character) policy name ARN","code":""},{"path":"/reference/aws_policy_attach.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Attach a policy to a user, group, or role — aws_policy_attach","text":"tibble information policies","code":""},{"path":[]},{"path":"/reference/aws_policy_attach.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Attach a policy to a user, group, or role — aws_policy_attach","text":"","code":"if (FALSE) { aws_policy(\"AmazonRDSDataFullAccess\") aws_user() %>% aws_policy_attach(\"AmazonRDSDataFullAccess\") aws_user()$attached_policies # aws_role(\"OrganizationAccountSecurityRole\") %>% # aws_policy_attach(\"ReadOnlyAccess\") }"},{"path":"/reference/aws_policy_create.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a policy — aws_policy_create","title":"Create a policy — aws_policy_create","text":"Create policy","code":""},{"path":"/reference/aws_policy_create.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a policy — aws_policy_create","text":"","code":"aws_policy_create(name, document, path = NULL, description = NULL, tags = NULL)"},{"path":"/reference/aws_policy_create.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a policy — aws_policy_create","text":"name (character) policy name. required document (character) policy document want use content new policy. required. path (character) path policy. given default \"/\". optional description (character) friendly description policy. optional. changed assigning tags (character) vector tags want attach new IAM policy. tag consists key name associated value. optional","code":""},{"path":"/reference/aws_policy_create.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a policy — aws_policy_create","text":"tibble policy details","code":""},{"path":"/reference/aws_policy_create.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Create a policy — aws_policy_create","text":"see docs https://www.paws-r-sdk.com/docs/iam_create_policy/","code":""},{"path":[]},{"path":"/reference/aws_policy_create.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a policy — aws_policy_create","text":"","code":"if (FALSE) { # interactive() doc <- aws_policy_document_create( region = \"us-east-2\", account_id = \"1234567890\", resource_id = \"*\", user = \"jane_doe\", action = \"rds-db:connect\" ) aws_policy_create(\"RdsAllow123\", document = doc) # cleanup aws_policy_delete(\"RdsAllow123\") }"},{"path":"/reference/aws_policy_delete.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete a user managed policy — aws_policy_delete","title":"Delete a user managed policy — aws_policy_delete","text":"Delete user managed policy","code":""},{"path":"/reference/aws_policy_delete.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete a user managed policy — aws_policy_delete","text":"","code":"aws_policy_delete(name)"},{"path":"/reference/aws_policy_delete.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete a user managed policy — aws_policy_delete","text":"name (character) policy name. required. within function lookup policy arn passed AWS API","code":""},{"path":"/reference/aws_policy_delete.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete a user managed policy — aws_policy_delete","text":"invisibly returns nothing","code":""},{"path":"/reference/aws_policy_delete.html","id":"aws-managed-policies","dir":"Reference","previous_headings":"","what":"AWS managed policies","title":"Delete a user managed policy — aws_policy_delete","text":"can delete AWS managed policies.","code":""},{"path":"/reference/aws_policy_delete.html","id":"deleting-process-adapted-from-paws-docs-","dir":"Reference","previous_headings":"","what":"Deleting process (adapted from paws docs)","title":"Delete a user managed policy — aws_policy_delete","text":"can delete managed policy, must first detach policy users, groups, roles attached . addition, must delete policy's versions. following steps describe process deleting managed policy: Detach policy users, groups, roles policy attached using aws_policy_attach(). list users, groups, roles policy attached use aws_policy_list_entities() Delete versions policy using aws_policy_delete_version(). list policy's versions, use aws_policy_list_versions(). use aws_policy_delete_version() delete version marked default version. delete policy's default version next step process. Delete policy using function (automatically deletes policy's default version)","code":""},{"path":"/reference/aws_policy_delete.html","id":"references","dir":"Reference","previous_headings":"","what":"References","title":"Delete a user managed policy — aws_policy_delete","text":"delete_policy","code":""},{"path":[]},{"path":"/reference/aws_policy_delete.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Delete a user managed policy — aws_policy_delete","text":"","code":"if (FALSE) { # interactive() doc <- aws_policy_document_create( region = \"us-east-2\", account_id = \"1234567890\", resource_id = \"*\", user = \"jane_doe\", action = \"rds-db:connect\" ) aws_policy_create(\"RdsAllow456\", document = doc) aws_policy_delete(\"RdsAllow456\") }"},{"path":"/reference/aws_policy_delete_version.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete a policy version — aws_policy_delete_version","title":"Delete a policy version — aws_policy_delete_version","text":"Delete policy version","code":""},{"path":"/reference/aws_policy_delete_version.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete a policy version — aws_policy_delete_version","text":"","code":"aws_policy_delete_version(name, version_id)"},{"path":"/reference/aws_policy_delete_version.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete a policy version — aws_policy_delete_version","text":"name (character) policy name. required. within function lookup policy arn passed AWS API version_id (character) policy version delete. required. Allows (via regex) string characters consists lowercase letter 'v' followed one two digits, optionally followed period '.' string letters digits.","code":""},{"path":"/reference/aws_policy_delete_version.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete a policy version — aws_policy_delete_version","text":"invisibly returns nothing","code":""},{"path":"/reference/aws_policy_delete_version.html","id":"references","dir":"Reference","previous_headings":"","what":"References","title":"Delete a policy version — aws_policy_delete_version","text":"https://www.paws-r-sdk.com/docs/iam_delete_policy_version/","code":""},{"path":[]},{"path":"/reference/aws_policy_delete_version.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Delete a policy version — aws_policy_delete_version","text":"","code":"if (FALSE) { # interactive() doc <- aws_policy_document_create( region = \"us-east-2\", account_id = \"1234567890\", resource_id = \"*\", user = \"jane_doe\", action = \"rds-db:connect\" ) aws_policy_create(\"RdsAllow456\", document = doc) aws_policy_delete_version(\"RdsAllow456\", \"v1\") }"},{"path":"/reference/aws_policy_detach.html","id":null,"dir":"Reference","previous_headings":"","what":"Detach a policy from a user, group, or role — aws_policy_detach","title":"Detach a policy from a user, group, or role — aws_policy_detach","text":"Detach policy user, group, role","code":""},{"path":"/reference/aws_policy_detach.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Detach a policy from a user, group, or role — aws_policy_detach","text":"","code":"aws_policy_detach(.x, policy)"},{"path":"/reference/aws_policy_detach.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Detach a policy from a user, group, or role — aws_policy_detach","text":".x result call create get method user, group, role policy (character) policy name ARN","code":""},{"path":"/reference/aws_policy_detach.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Detach a policy from a user, group, or role — aws_policy_detach","text":"tibble information policies","code":""},{"path":[]},{"path":"/reference/aws_policy_detach.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Detach a policy from a user, group, or role — aws_policy_detach","text":"","code":"if (FALSE) { aws_user() %>% aws_policy_detach(\"AmazonRDSDataFullAccess\") aws_user()$attached_policies # aws_role(\"OrganizationAccountSecurityRole\") %>% # aws_policy_detach(\"ReadOnlyAccess\") }"},{"path":"/reference/aws_policy_document_create.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a policy document — aws_policy_document_create","title":"Create a policy document — aws_policy_document_create","text":"Create policy document","code":""},{"path":"/reference/aws_policy_document_create.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a policy document — aws_policy_document_create","text":"","code":"aws_policy_document_create(..., .list = NULL)"},{"path":"/reference/aws_policy_document_create.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a policy document — aws_policy_document_create","text":"..., .list policy statements created aws_policy_statement() created manually. Pass 1 statements via ... like statement1, statement2 pass list like .list = list(statement1, statement2). element must named list.","code":""},{"path":"/reference/aws_policy_document_create.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a policy document — aws_policy_document_create","text":"json class string. use .character() coerce regular string","code":""},{"path":"/reference/aws_policy_document_create.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Create a policy document — aws_policy_document_create","text":"document item hard-coded: Version set 2012-10-17\"","code":""},{"path":"/reference/aws_policy_document_create.html","id":"actions","dir":"Reference","previous_headings":"","what":"Actions","title":"Create a policy document — aws_policy_document_create","text":"Actions documentation appears web. start: S3: https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazons3.html # nolint EC2: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Operations.html # nolint IAM: https://docs.aws.amazon.com/IAM/latest/APIReference/API_Operations.html # nolint","code":""},{"path":"/reference/aws_policy_document_create.html","id":"references","dir":"Reference","previous_headings":"","what":"References","title":"Create a policy document — aws_policy_document_create","text":"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html # nolint","code":""},{"path":"/reference/aws_policy_document_create.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a policy document — aws_policy_document_create","text":"","code":"if (FALSE) { # interactive() st8ment1 <- aws_policy_statement(\"iam:GetUser\", \"*\") st8ment2 <- aws_policy_statement(\"s3:ListAllMyBuckets\", \"*\") st8ment3 <- aws_policy_statement(\"s3-object-lambda:List*\", \"*\") aws_policy_document_create(st8ment1, st8ment2) aws_policy_document_create(.list = list(st8ment1, st8ment2)) aws_policy_document_create(st8ment3, .list = list(st8ment1, st8ment2)) # Policy document to give a user access to RDS resource <- \"arn:aws:rds-db:us-east-2:1234567890:dbuser:db-ABCDE1212/jane\" st8ment_rds <- aws_policy_statement( action = \"rds-db:connect\", resource = resource ) aws_policy_document_create(st8ment_rds) ### DB account = user in a database that has access to it # all DB instances & DB accounts for a AWS account and AWS Region aws_policy_document_create( aws_policy_statement( action = \"rds-db:connect\", resource = resource_rds(\"*\", \"*\") ) ) # all DB instances for a AWS account and AWS Region, single DB account aws_policy_document_create( aws_policy_statement( action = \"rds-db:connect\", resource = resource_rds(\"jane_doe\", \"*\") ) ) # single DB instasnce, single DB account aws_policy_document_create( aws_policy_statement( action = \"rds-db:connect\", resource = resource_rds(\"jane_doe\", \"db-ABCDEFGHIJKL01234\") ) ) # single DB instance, many users aws_policy_document_create( aws_policy_statement( action = \"rds-db:connect\", resource = resource_rds(c(\"jane_doe\", \"mary_roe\"), \"db-ABCDEFGHIJKL01\") ) ) }"},{"path":"/reference/aws_policy_exists.html","id":null,"dir":"Reference","previous_headings":"","what":"Check if a policy exists — aws_policy_exists","title":"Check if a policy exists — aws_policy_exists","text":"Checks customer managed AWS managed policies","code":""},{"path":"/reference/aws_policy_exists.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check if a policy exists — aws_policy_exists","text":"","code":"aws_policy_exists(name)"},{"path":"/reference/aws_policy_exists.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check if a policy exists — aws_policy_exists","text":"name (character) policy name arn","code":""},{"path":"/reference/aws_policy_exists.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check if a policy exists — aws_policy_exists","text":"single logical, TRUE FALSE","code":""},{"path":[]},{"path":"/reference/aws_policy_exists.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Check if a policy exists — aws_policy_exists","text":"","code":"if (FALSE) { # interactive() # just the policy name aws_policy_exists(\"ReadOnlyAccess\") # as an ARN aws_policy_exists(\"arn:aws:iam::aws:policy/ReadOnlyAccess\") # includes job-function in path aws_policy_exists(\"Billing\") # includes service-role in path aws_policy_exists(\"AWSCostAndUsageReportAutomationPolicy\") }"},{"path":"/reference/aws_policy_list_entities.html","id":null,"dir":"Reference","previous_headings":"","what":"List policy entities — aws_policy_list_entities","title":"List policy entities — aws_policy_list_entities","text":"List policy entities","code":""},{"path":"/reference/aws_policy_list_entities.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List policy entities — aws_policy_list_entities","text":"","code":"aws_policy_list_entities(name, ...)"},{"path":"/reference/aws_policy_list_entities.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List policy entities — aws_policy_list_entities","text":"name (character) policy name. required. within function lookup policy arn passed AWS API ... additional named arguments passed internal paws method (see link docs)","code":""},{"path":"/reference/aws_policy_list_entities.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List policy entities — aws_policy_list_entities","text":"tibble columns: type: one Users, Roles, Groups name: user, role group name id: id user, role group name Zero row tibble entities","code":""},{"path":"/reference/aws_policy_list_entities.html","id":"references","dir":"Reference","previous_headings":"","what":"References","title":"List policy entities — aws_policy_list_entities","text":"https://www.paws-r-sdk.com/docs/iam_list_entities_for_policy/","code":""},{"path":[]},{"path":"/reference/aws_policy_list_entities.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List policy entities — aws_policy_list_entities","text":"","code":"if (FALSE) { # interactive() pols <- aws_policies(Scope = \"Local\") for (policy in pols$PolicyName) { cat(\"\\n\\n\", policy, \"\\n\") print(aws_policy_list_entities(policy)) } aws_policy_list_entities(\"S3ReadOnlyAccessS64Test22\") }"},{"path":"/reference/aws_policy_list_versions.html","id":null,"dir":"Reference","previous_headings":"","what":"List policy versions — aws_policy_list_versions","title":"List policy versions — aws_policy_list_versions","text":"List policy versions","code":""},{"path":"/reference/aws_policy_list_versions.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List policy versions — aws_policy_list_versions","text":"","code":"aws_policy_list_versions(name, ...)"},{"path":"/reference/aws_policy_list_versions.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List policy versions — aws_policy_list_versions","text":"name (character) policy name. required. within function lookup policy arn passed AWS API ... additional named arguments passed internal paws method (see link docs)","code":""},{"path":"/reference/aws_policy_list_versions.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List policy versions — aws_policy_list_versions","text":"tibble columns: Document VersionId IsDefaultVersion CreateDate","code":""},{"path":"/reference/aws_policy_list_versions.html","id":"references","dir":"Reference","previous_headings":"","what":"References","title":"List policy versions — aws_policy_list_versions","text":"https://www.paws-r-sdk.com/docs/iam_list_policy_versions/","code":""},{"path":[]},{"path":"/reference/aws_policy_list_versions.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List policy versions — aws_policy_list_versions","text":"","code":"if (FALSE) { # interactive() pols <- aws_policies() aws_policy_list_versions(pols$PolicyName[1]) }"},{"path":"/reference/aws_policy_statement.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a policy statement — aws_policy_statement","title":"Create a policy statement — aws_policy_statement","text":"Create policy statement","code":""},{"path":"/reference/aws_policy_statement.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a policy statement — aws_policy_statement","text":"","code":"aws_policy_statement(action, resource, effect = \"Allow\", ...)"},{"path":"/reference/aws_policy_statement.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a policy statement — aws_policy_statement","text":"action (character) action. required. see Actions . resource (character) object objects statement covers; see link information effect (character) valid values: \"Allow\" (default), \"Deny\". length==1 ... Additional named arguments. See link Details options, examples ","code":""},{"path":"/reference/aws_policy_statement.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a policy statement — aws_policy_statement","text":"named list","code":""},{"path":"/reference/aws_policy_statement.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Create a policy statement — aws_policy_statement","text":"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html #nolint","code":""},{"path":"/reference/aws_policy_statement.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a policy statement — aws_policy_statement","text":"","code":"if (FALSE) { # interactive() aws_policy_statement(\"iam:GetUser\", \"*\") aws_policy_statement(\"iam:GetUser\", \"*\", Sid = \"MyStatementId\") aws_policy_statement(\"iam:GetUser\", \"*\", Condition = list( StringEqualsIgnoreCase = list(\"aws:username\" = \"johndoe\") ) ) aws_policy_statement(\"iam:GetUser\", \"*\", Principal = list(Service = \"s3.amazonaws.com\") ) }"},{"path":"/reference/aws_role.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a role — aws_role","title":"Get a role — aws_role","text":"Get role","code":""},{"path":"/reference/aws_role.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a role — aws_role","text":"","code":"aws_role(name)"},{"path":"/reference/aws_role.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a role — aws_role","text":"name (character) role name","code":""},{"path":"/reference/aws_role.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a role — aws_role","text":"named list slots : role (tibble) policies (character) attached_policies (tibble)","code":""},{"path":"/reference/aws_role.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get a role — aws_role","text":"see docs https://www.paws-r-sdk.com/docs/iam_get_role/; also includes policies attached policies calling list_role_policies list_attached_role_policies","code":""},{"path":[]},{"path":"/reference/aws_role.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get a role — aws_role","text":"","code":"if (FALSE) { res <- aws_role(name = \"OrganizationAccountSecurityRole\") res res$role res$policies res$attached_policies aws_role(\"AWSServiceRoleForCloudTrail\") aws_role(\"AWSServiceRoleForRedshift\") }"},{"path":"/reference/aws_role_create.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a role — aws_role_create","title":"Create a role — aws_role_create","text":"Create role","code":""},{"path":"/reference/aws_role_create.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a role — aws_role_create","text":"","code":"aws_role_create( name, assume_role_policy_document, path = NULL, description = NULL, max_session_duration = NULL, permission_boundary = NULL, tags = NULL )"},{"path":"/reference/aws_role_create.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a role — aws_role_create","text":"name (character) role name. required assume_role_policy_document (character) trust relationship policy document grants entity permission assume role. json string. required path (character) path role name. optional. included, defaults slash (/). description (character) description fo role. optional max_session_duration (character) maximum session duration (seconds) want set specified role. optional permission_boundary (character) ARN managed policy used set permissions boundary role. optional tags (list) list tags want attach new user. optional","code":""},{"path":"/reference/aws_role_create.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a role — aws_role_create","text":"tibble information role created","code":""},{"path":"/reference/aws_role_create.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Create a role — aws_role_create","text":"See https://www.paws-r-sdk.com/docs/iam_create_role/ docs details parameters","code":""},{"path":[]},{"path":"/reference/aws_role_create.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a role — aws_role_create","text":"","code":"if (FALSE) { role_name <- \"MyRole\" trust_policy <- list( Version = \"2012-10-17\", Statement = list( list( Effect = \"Allow\", Principal = list( Service = \"lambda.amazonaws.com\" ), Action = \"sts:AssumeRole\" ) ) ) doc <- jsonlite::toJSON(trust_policy, auto_unbox = TRUE) desc <- \"My test role\" z <- aws_role_create(role_name, assume_role_policy_document = doc, description = desc ) z # attach a policy z %>% aws_policy_attach(\"AWSLambdaBasicExecutionRole\") }"},{"path":"/reference/aws_role_delete.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete a role — aws_role_delete","title":"Delete a role — aws_role_delete","text":"Delete role","code":""},{"path":"/reference/aws_role_delete.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete a role — aws_role_delete","text":"","code":"aws_role_delete(name)"},{"path":"/reference/aws_role_delete.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete a role — aws_role_delete","text":"name (character) role name. required","code":""},{"path":"/reference/aws_role_delete.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete a role — aws_role_delete","text":"empty list","code":""},{"path":"/reference/aws_role_delete.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Delete a role — aws_role_delete","text":"See https://www.paws-r-sdk.com/docs/iam_delete_role/ docs details","code":""},{"path":[]},{"path":"/reference/aws_role_delete.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Delete a role — aws_role_delete","text":"","code":"if (FALSE) { aws_role_delete(name = \"MyRole\") }"},{"path":"/reference/aws_role_exists.html","id":null,"dir":"Reference","previous_headings":"","what":"Check if a role exists — aws_role_exists","title":"Check if a role exists — aws_role_exists","text":"Check role exists","code":""},{"path":"/reference/aws_role_exists.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check if a role exists — aws_role_exists","text":"","code":"aws_role_exists(name)"},{"path":"/reference/aws_role_exists.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check if a role exists — aws_role_exists","text":"name (character) role name","code":""},{"path":"/reference/aws_role_exists.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check if a role exists — aws_role_exists","text":"single boolean","code":""},{"path":[]},{"path":"/reference/aws_roles.html","id":null,"dir":"Reference","previous_headings":"","what":"List roles — aws_roles","title":"List roles — aws_roles","text":"List roles","code":""},{"path":"/reference/aws_roles.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List roles — aws_roles","text":"","code":"aws_roles(...)"},{"path":"/reference/aws_roles.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List roles — aws_roles","text":"... parameters passed paws list_users method","code":""},{"path":"/reference/aws_roles.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List roles — aws_roles","text":"tibble information roles","code":""},{"path":[]},{"path":"/reference/aws_roles.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List roles — aws_roles","text":"","code":"if (FALSE) { aws_roles() }"},{"path":"/reference/aws_s3_policy_doc_create.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a policy document for an S3 bucket — aws_s3_policy_doc_create","title":"Create a policy document for an S3 bucket — aws_s3_policy_doc_create","text":"Create policy document S3 bucket","code":""},{"path":"/reference/aws_s3_policy_doc_create.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a policy document for an S3 bucket — aws_s3_policy_doc_create","text":"","code":"aws_s3_policy_doc_create( bucket, action, resource, effect = \"Allow\", sid = NULL, ... )"},{"path":"/reference/aws_s3_policy_doc_create.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a policy document for an S3 bucket — aws_s3_policy_doc_create","text":"bucket (character) bucket name. required action (character) action. required. see Actions . resource (character) object objects statement covers; see link information effect (character) valid values: \"Allow\" (default), \"Deny\". length==1 sid (character) statement id. optional ... Additional named arguments. See link Details options, examples ","code":""},{"path":"/reference/aws_s3_policy_doc_create.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a policy document for an S3 bucket — aws_s3_policy_doc_create","text":"policy document JSON (class json)","code":""},{"path":"/reference/aws_s3_policy_doc_create.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Create a policy document for an S3 bucket — aws_s3_policy_doc_create","text":"separate function creating policy docs S3 buckets globally unique, AWS figures region account ID .","code":""},{"path":"/reference/aws_s3_policy_doc_create.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a policy document for an S3 bucket — aws_s3_policy_doc_create","text":"","code":"if (FALSE) { # interactive() bucket <- random_string(\"bucket\") aws_s3_policy_doc_create( bucket = bucket, action = s3_actions_read(), resource = c(bucket_arn(bucket), bucket_arn(bucket, objects = \"*\")) ) }"},{"path":"/reference/aws_secrets_all.html","id":null,"dir":"Reference","previous_headings":"","what":"Get all secret values — aws_secrets_all","title":"Get all secret values — aws_secrets_all","text":"Get secret values","code":""},{"path":"/reference/aws_secrets_all.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get all secret values — aws_secrets_all","text":"","code":"aws_secrets_all()"},{"path":"/reference/aws_secrets_all.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get all secret values — aws_secrets_all","text":"(tbl) secrets","code":""},{"path":"/reference/aws_secrets_all.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get all secret values — aws_secrets_all","text":"","code":"if (FALSE) { aws_secrets_all() }"},{"path":"/reference/aws_secrets_create.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a secret — aws_secrets_create","title":"Create a secret — aws_secrets_create","text":"function create database username /password. Instead, creates \"secret\", typically combination credentials (username + password + metadata)","code":""},{"path":"/reference/aws_secrets_create.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a secret — aws_secrets_create","text":"","code":"aws_secrets_create(name, secret, description = NULL, ...)"},{"path":"/reference/aws_secrets_create.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a secret — aws_secrets_create","text":"name (character) name new secret. required secret (character/raw) text raw data encrypt store new version secret. AWS recommends text use JSON structure key/value pairs secret value (see examples ). required description (character) description secret. optional ... named parameters passed create_secret https://www.paws-r-sdk.com/docs/secretsmanager_create_secret/","code":""},{"path":"/reference/aws_secrets_create.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a secret — aws_secrets_create","text":"(list) fields: ARN Name VersionId ReplicationStatus","code":""},{"path":"/reference/aws_secrets_create.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Create a secret — aws_secrets_create","text":"Note autogenerate random UUID pass ClientRequestToken parameter paws function create_secret used internally function. function creates new secret. See aws_secrets_update() update existing secret. function fails call existing secret name ARN","code":""},{"path":"/reference/aws_secrets_create.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a secret — aws_secrets_create","text":"","code":"if (FALSE) { # Text secret x <- aws_secrets_create( name = \"MyTestDatabaseSecret\", secret = '{\"username\":\"david\",\"password\":\"EXAMPLE-PASSWORD\"}', description = \"My test database secret as a string\" ) # Raw secret x <- aws_secrets_create( name = \"MyRawDatabaseSecret\", secret = charToRaw('{\"username\":\"david\",\"password\":\"EXAMPLE-PASSWORD\"}'), description = \"My test database secret as raw\" ) }"},{"path":"/reference/aws_secrets_delete.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete a secret — aws_secrets_delete","title":"Delete a secret — aws_secrets_delete","text":"Delete secret","code":""},{"path":"/reference/aws_secrets_delete.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete a secret — aws_secrets_delete","text":"","code":"aws_secrets_delete(id, ...)"},{"path":"/reference/aws_secrets_delete.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete a secret — aws_secrets_delete","text":"id (character) name ARN secret. required ... named parameters passed delete_secret https://www.paws-r-sdk.com/docs/secretsmanager_delete_secret/","code":""},{"path":"/reference/aws_secrets_delete.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete a secret — aws_secrets_delete","text":"(list) fields: ARN Name DeletionDate","code":""},{"path":"/reference/aws_secrets_delete.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Delete a secret — aws_secrets_delete","text":"","code":"if (FALSE) { # Does exist aws_secrets_delete(id = \"MyTestDatabaseSecret\") # Does not exist # aws_secrets_get(id = \"DoesntExist\") #> Error: ResourceNotFoundException (HTTP 400). Secrets Manager #> can't find the specified secret. }"},{"path":"/reference/aws_secrets_get.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a secret — aws_secrets_get","title":"Get a secret — aws_secrets_get","text":"Get secret","code":""},{"path":"/reference/aws_secrets_get.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a secret — aws_secrets_get","text":"","code":"aws_secrets_get(id, ...)"},{"path":"/reference/aws_secrets_get.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a secret — aws_secrets_get","text":"id (character) name ARN secret. required ... named parameters passed get_secret_value https://www.paws-r-sdk.com/docs/secretsmanager_get_secret_value/","code":""},{"path":"/reference/aws_secrets_get.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a secret — aws_secrets_get","text":"(list) fields: ARN Name VersionId SecretBinary SecretString VersionStages CreatedDate","code":""},{"path":"/reference/aws_secrets_get.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get a secret — aws_secrets_get","text":"","code":"if (FALSE) { # Does exist aws_secrets_get(id = \"MyTestDatabaseSecret\") # Does not exist # aws_secrets_get(id = \"DoesntExist\") #> Error: ResourceNotFoundException (HTTP 400). Secrets Manager #> can't find the specified secret. }"},{"path":"/reference/aws_secrets_list.html","id":null,"dir":"Reference","previous_headings":"","what":"List secrets — aws_secrets_list","title":"List secrets — aws_secrets_list","text":"List secrets","code":""},{"path":"/reference/aws_secrets_list.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List secrets — aws_secrets_list","text":"","code":"aws_secrets_list(...)"},{"path":"/reference/aws_secrets_list.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List secrets — aws_secrets_list","text":"... parameters passed paws method","code":""},{"path":"/reference/aws_secrets_list.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List secrets — aws_secrets_list","text":"(list) list secrets","code":""},{"path":"/reference/aws_secrets_list.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"List secrets — aws_secrets_list","text":"see https://www.paws-r-sdk.com/docs/secretsmanager_list_secrets/ available parameters","code":""},{"path":"/reference/aws_secrets_list.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List secrets — aws_secrets_list","text":"","code":"if (FALSE) { aws_secrets_list() }"},{"path":"/reference/aws_secrets_pwd.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a random password — aws_secrets_pwd","title":"Get a random password — aws_secrets_pwd","text":"Get random password","code":""},{"path":"/reference/aws_secrets_pwd.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a random password — aws_secrets_pwd","text":"","code":"aws_secrets_pwd(...)"},{"path":"/reference/aws_secrets_pwd.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a random password — aws_secrets_pwd","text":"... named parameters passed get_random_password https://www.paws-r-sdk.com/docs/secretsmanager_get_random_password/","code":""},{"path":"/reference/aws_secrets_pwd.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get a random password — aws_secrets_pwd","text":"","code":"if (FALSE) { aws_secrets_pwd() aws_secrets_pwd(ExcludeNumbers = TRUE) }"},{"path":"/reference/aws_secrets_rotate.html","id":null,"dir":"Reference","previous_headings":"","what":"Rotate a secret — aws_secrets_rotate","title":"Rotate a secret — aws_secrets_rotate","text":"Rotate secret","code":""},{"path":"/reference/aws_secrets_rotate.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Rotate a secret — aws_secrets_rotate","text":"","code":"aws_secrets_rotate(id, lambda_arn = NULL, rules = NULL, immediately = TRUE)"},{"path":"/reference/aws_secrets_rotate.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rotate a secret — aws_secrets_rotate","text":"id (character) name ARN secret. required lambda_arn (character) ARN Lambda rotation function. supply secrets use Lambda rotation function rotate rules (list) asdfadf immediately (logical) whether rotate secret immediately . default: TRUE","code":""},{"path":"/reference/aws_secrets_rotate.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Rotate a secret — aws_secrets_rotate","text":"(list) fields: ARN Name VersionId","code":""},{"path":"/reference/aws_secrets_rotate.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Rotate a secret — aws_secrets_rotate","text":"Note autogenerate random UUID pass ClientRequestToken parameter paws function used internally","code":""},{"path":"/reference/aws_secrets_rotate.html","id":"references","dir":"Reference","previous_headings":"","what":"References","title":"Rotate a secret — aws_secrets_rotate","text":"https://www.paws-r-sdk.com/docs/secretsmanager_rotate_secret/","code":""},{"path":"/reference/aws_secrets_rotate.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Rotate a secret — aws_secrets_rotate","text":"","code":"if (FALSE) { aws_secrets_rotate(id = \"MyTestDatabaseSecret\") aws_secrets_rotate(id = \"MyTestDatabaseSecret\", rules = list( Duration = \"2h\", ScheduleExpression = \"cron(0 16 1,15 * ? *)\" )) }"},{"path":"/reference/aws_secrets_update.html","id":null,"dir":"Reference","previous_headings":"","what":"Update a secret — aws_secrets_update","title":"Update a secret — aws_secrets_update","text":"Update secret","code":""},{"path":"/reference/aws_secrets_update.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Update a secret — aws_secrets_update","text":"","code":"aws_secrets_update(id, secret, ...)"},{"path":"/reference/aws_secrets_update.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Update a secret — aws_secrets_update","text":"id (character) name ARN secret. required secret (character/raw) text raw data encrypt store new version secret. AWS recommends text use JSON structure key/value pairs secret value (see examples ). required ... named parameters passed put_secret_value https://www.paws-r-sdk.com/docs/secretsmanager_put_secret_value/","code":""},{"path":"/reference/aws_secrets_update.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Update a secret — aws_secrets_update","text":"(list) fields: ARN Name VersionId VersionStages","code":""},{"path":"/reference/aws_secrets_update.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Update a secret — aws_secrets_update","text":"Note autogenerate random UUID pass ClientRequestToken parameter paws function used internally","code":""},{"path":"/reference/aws_secrets_update.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Update a secret — aws_secrets_update","text":"","code":"if (FALSE) { # Create a secret aws_secrets_create( name = \"TheSecret\", secret = '{\"username\":\"jane\",\"password\":\"cat\"}', description = \"A string\" ) aws_secrets_get(\"TheSecret\") # Update the secret aws_secrets_update( id = \"TheSecret\", secret = '{\"username\":\"jane\",\"password\":\"kitten\"}' ) aws_secrets_get(\"TheSecret\") }"},{"path":"/reference/aws_user.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a user — aws_user","title":"Get a user — aws_user","text":"Gets user information, including policies, groups, attached policies","code":""},{"path":"/reference/aws_user.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a user — aws_user","text":"","code":"aws_user(username = NULL)"},{"path":"/reference/aws_user.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a user — aws_user","text":"username (character) user name. required","code":""},{"path":"/reference/aws_user.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a user — aws_user","text":"named list slots : user (tibble) policies (list) attached_policies (list) groups (list)","code":""},{"path":"/reference/aws_user.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get a user — aws_user","text":"See following docs links details https://www.paws-r-sdk.com/docs/iam_get_user/ https://www.paws-r-sdk.com/docs/iam_list_user_policies/ https://www.paws-r-sdk.com/docs/iam_list_groups_for_user/ https://www.paws-r-sdk.com/docs/iam_list_attached_user_policies/","code":""},{"path":"/reference/aws_user.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Get a user — aws_user","text":"username supplied, gets logged user","code":""},{"path":[]},{"path":"/reference/aws_user.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get a user — aws_user","text":"","code":"if (FALSE) { # if username not supplied, gets logged in user aws_user() # supply a username to get that user's information aws_user_create(\"testBlueBird\") aws_user(username = \"testBlueBird\") aws_user_delete(\"testBlueBird\") # cleanup user }"},{"path":"/reference/aws_user_access_key.html","id":null,"dir":"Reference","previous_headings":"","what":"Get AWS Access Key for a user — aws_user_access_key","title":"Get AWS Access Key for a user — aws_user_access_key","text":"IMPORTANT: secret access key accessible key user creation","code":""},{"path":"/reference/aws_user_access_key.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get AWS Access Key for a user — aws_user_access_key","text":"","code":"aws_user_access_key(username = NULL, ...)"},{"path":"/reference/aws_user_access_key.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get AWS Access Key for a user — aws_user_access_key","text":"username (character) user name. required ... named args passed list_access_keys","code":""},{"path":"/reference/aws_user_access_key.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get AWS Access Key for a user — aws_user_access_key","text":"tibble key details","code":""},{"path":"/reference/aws_user_access_key.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get AWS Access Key for a user — aws_user_access_key","text":"See https://www.paws-r-sdk.com/docs/iam_list_access_keys/ docs details","code":""},{"path":[]},{"path":"/reference/aws_user_access_key_delete.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete current user's AWS Access Key — aws_user_access_key_delete","title":"Delete current user's AWS Access Key — aws_user_access_key_delete","text":"Delete current user's AWS Access Key","code":""},{"path":"/reference/aws_user_access_key_delete.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete current user's AWS Access Key — aws_user_access_key_delete","text":"","code":"aws_user_access_key_delete(access_key_id, username = NULL)"},{"path":"/reference/aws_user_access_key_delete.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete current user's AWS Access Key — aws_user_access_key_delete","text":"access_key_id (character) access key ID access key ID secret access key want delete. required. username (character) user name. optional. however, supply username, paws likely use current user, may user access key id associated - get error like NoSuchEntity (HTTP 404). Access Key id xx found","code":""},{"path":"/reference/aws_user_access_key_delete.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete current user's AWS Access Key — aws_user_access_key_delete","text":"NULL, invisibly","code":""},{"path":"/reference/aws_user_access_key_delete.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Delete current user's AWS Access Key — aws_user_access_key_delete","text":"See https://www.paws-r-sdk.com/docs/iam_delete_access_key/ docs details","code":""},{"path":[]},{"path":"/reference/aws_user_access_key_delete.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Delete current user's AWS Access Key — aws_user_access_key_delete","text":"","code":"if (FALSE) { # interactive() aws_user_access_key_delete(access_key_id = \"adfasdfadfadfasdf\") aws_user_access_key_delete(access_key_id = \"adfasdf\", username = \"jane\") }"},{"path":"/reference/aws_user_add_to_group.html","id":null,"dir":"Reference","previous_headings":"","what":"Add or remove a user to/from a group — aws_user_add_to_group","title":"Add or remove a user to/from a group — aws_user_add_to_group","text":"Add remove user /group","code":""},{"path":"/reference/aws_user_add_to_group.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Add or remove a user to/from a group — aws_user_add_to_group","text":"","code":"aws_user_add_to_group(username, groupname) aws_user_remove_from_group(username, groupname)"},{"path":"/reference/aws_user_add_to_group.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Add or remove a user to/from a group — aws_user_add_to_group","text":"username (character) user name. required groupname (character) group name. required","code":""},{"path":"/reference/aws_user_add_to_group.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Add or remove a user to/from a group — aws_user_add_to_group","text":"named list slots : user (tibble) policies (list) attached_policies (list) groups (list)","code":""},{"path":"/reference/aws_user_add_to_group.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Add or remove a user to/from a group — aws_user_add_to_group","text":"See https://www.paws-r-sdk.com/docs/iam_add_user_to_group/ https://www.paws-r-sdk.com/docs/iam_remove_user_from_group/ docs details","code":""},{"path":[]},{"path":"/reference/aws_user_add_to_group.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Add or remove a user to/from a group — aws_user_add_to_group","text":"","code":"if (FALSE) { if (!aws_group_exists(\"testgroup3\")) { aws_group_create(\"testgroup3\") } if (!aws_user_exists(\"testBlueBird3\")) { aws_user_create(\"testBlueBird3\") } aws_user_add_to_group(\"testBlueBird3\", \"testgroup3\") aws_user_remove_from_group(\"testBlueBird3\", \"testgroup3\") }"},{"path":"/reference/aws_user_create.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a user — aws_user_create","title":"Create a user — aws_user_create","text":"Create user","code":""},{"path":"/reference/aws_user_create.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a user — aws_user_create","text":"","code":"aws_user_create(username, path = NULL, permission_boundary = NULL, tags = NULL)"},{"path":"/reference/aws_user_create.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a user — aws_user_create","text":"username (character) user name. required path (character) path user name. optional. included, defaults slash (/). permission_boundary (character) ARN managed policy used set permissions boundary user. optional tags (list) list tags want attach new user. optional","code":""},{"path":"/reference/aws_user_create.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a user — aws_user_create","text":"tibble information user created","code":""},{"path":"/reference/aws_user_create.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Create a user — aws_user_create","text":"See https://www.paws-r-sdk.com/docs/iam_create_user/ docs details parameters","code":""},{"path":[]},{"path":"/reference/aws_user_create.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a user — aws_user_create","text":"","code":"if (FALSE) { aws_user_create(\"testBlueBird\") }"},{"path":"/reference/aws_user_current.html","id":null,"dir":"Reference","previous_headings":"","what":"Get the current logged-in username as a string — aws_user_current","title":"Get the current logged-in username as a string — aws_user_current","text":"Get current logged-username string","code":""},{"path":"/reference/aws_user_current.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get the current logged-in username as a string — aws_user_current","text":"","code":"aws_user_current()"},{"path":"/reference/aws_user_current.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get the current logged-in username as a string — aws_user_current","text":"username character","code":""},{"path":[]},{"path":"/reference/aws_user_delete.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete a user — aws_user_delete","title":"Delete a user — aws_user_delete","text":"Delete user","code":""},{"path":"/reference/aws_user_delete.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete a user — aws_user_delete","text":"","code":"aws_user_delete(username)"},{"path":"/reference/aws_user_delete.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete a user — aws_user_delete","text":"username (character) user name. required","code":""},{"path":"/reference/aws_user_delete.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete a user — aws_user_delete","text":"NULL invisibly","code":""},{"path":"/reference/aws_user_delete.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Delete a user — aws_user_delete","text":"See https://www.paws-r-sdk.com/docs/iam_delete_user/ docs details","code":""},{"path":[]},{"path":"/reference/aws_user_delete.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Delete a user — aws_user_delete","text":"","code":"if (FALSE) { aws_user_delete(username = \"testBlueBird\") }"},{"path":"/reference/aws_user_exists.html","id":null,"dir":"Reference","previous_headings":"","what":"Check if a user exists — aws_user_exists","title":"Check if a user exists — aws_user_exists","text":"Check user exists","code":""},{"path":"/reference/aws_user_exists.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check if a user exists — aws_user_exists","text":"","code":"aws_user_exists(username)"},{"path":"/reference/aws_user_exists.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check if a user exists — aws_user_exists","text":"username (character) user name","code":""},{"path":"/reference/aws_user_exists.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check if a user exists — aws_user_exists","text":"single boolean","code":""},{"path":"/reference/aws_user_exists.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Check if a user exists — aws_user_exists","text":"uses aws_user() internally. see docs https://www.paws-r-sdk.com/docs/iam_get_user/","code":""},{"path":[]},{"path":"/reference/aws_user_exists.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Check if a user exists — aws_user_exists","text":"","code":"if (FALSE) { aws_user_exists(aws_user_current()) aws_user_exists(\"blueberry\") }"},{"path":"/reference/aws_users.html","id":null,"dir":"Reference","previous_headings":"","what":"List Users — aws_users","title":"List Users — aws_users","text":"List Users","code":""},{"path":"/reference/aws_users.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List Users — aws_users","text":"","code":"aws_users(...)"},{"path":"/reference/aws_users.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List Users — aws_users","text":"... parameters passed paws list_users method","code":""},{"path":"/reference/aws_users.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List Users — aws_users","text":"tibble information user accounts, columns: UserName UserId Path Arn CreateDate PasswordLastUsed","code":""},{"path":[]},{"path":"/reference/aws_users.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List Users — aws_users","text":"","code":"if (FALSE) { aws_users() }"},{"path":"/reference/aws_vpc.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a VPC by id — aws_vpc","title":"Get a VPC by id — aws_vpc","text":"Get VPC id","code":""},{"path":"/reference/aws_vpc.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a VPC by id — aws_vpc","text":"","code":"aws_vpc(id, ...)"},{"path":"/reference/aws_vpc.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a VPC by id — aws_vpc","text":"id (character) id VPC. required ... parameters passed describe_vpcs","code":""},{"path":"/reference/aws_vpc.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a VPC by id — aws_vpc","text":"(list) fields: Vpcs (list) VPC group NextToken (character) token paginating element Vpcs list slots: CidrBlock DhcpOptionsId State VpcId OwnerId InstanceTenancy Ipv6CidrBlockAssociationSet CidrBlockAssociationSet IsDefault Tags","code":""},{"path":"/reference/aws_vpc_sec_group_rules.html","id":null,"dir":"Reference","previous_headings":"","what":"Modify security group rules — aws_vpc_sec_group_rules","title":"Modify security group rules — aws_vpc_sec_group_rules","text":"Modify security group rules","code":""},{"path":"/reference/aws_vpc_sec_group_rules.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Modify security group rules — aws_vpc_sec_group_rules","text":"","code":"aws_vpc_sec_group_rules(id, rules, ...)"},{"path":"/reference/aws_vpc_sec_group_rules.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Modify security group rules — aws_vpc_sec_group_rules","text":"id (character) security group id rules list rules add/modify security group id ... named parameters passed modify_security_group_rules","code":""},{"path":[]},{"path":"/reference/aws_vpc_sec_group_rules.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Modify security group rules — aws_vpc_sec_group_rules","text":"","code":"if (FALSE) { # interactive() aws_vpc_sec_group_rules( id = \"someid\", rules = list( SecurityGroupRuleId = \"sgr-07de36a0521f39c8b\", SecurityGroupRule = list( IpProtocol = \"tcp\", FromPort = 22, ToPort = 22, CidrIpv4 = \"3.3.3.3/32\", Description = \"added ssh port\" ) ) ) }"},{"path":"/reference/aws_vpc_security_group.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a security group by ID — aws_vpc_security_group","title":"Get a security group by ID — aws_vpc_security_group","text":"Get security group ID","code":""},{"path":"/reference/aws_vpc_security_group.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a security group by ID — aws_vpc_security_group","text":"","code":"aws_vpc_security_group(id, ...)"},{"path":"/reference/aws_vpc_security_group.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a security group by ID — aws_vpc_security_group","text":"id (character) id security group. required ... named parameters passed describe_security_groups","code":""},{"path":"/reference/aws_vpc_security_group.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a security group by ID — aws_vpc_security_group","text":"(list) fields: SecurityGroups (list) security group Description GroupName IpPermissions OwnerId GroupId IpPermissionsEgress Tags VpcId NextToken (character) token paginating","code":""},{"path":[]},{"path":"/reference/aws_vpc_security_group_create.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a security group — aws_vpc_security_group_create","title":"Create a security group — aws_vpc_security_group_create","text":"Create security group","code":""},{"path":"/reference/aws_vpc_security_group_create.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a security group — aws_vpc_security_group_create","text":"","code":"aws_vpc_security_group_create( name, engine = \"mariadb\", description = NULL, vpc_id = NULL, tags = NULL, ... )"},{"path":"/reference/aws_vpc_security_group_create.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a security group — aws_vpc_security_group_create","text":"name (character) name new secret. required engine (character) engine use. default: \"mariadb\". required. one : mariadb, mysql, postgres description (character) description secret. optional vpc_id (character) VPC id. optional. supplied default VPC used. get VPCs, see aws_vpcs() tags (character) tags assign security group. optional ... named parameters passed create_security_group","code":""},{"path":"/reference/aws_vpc_security_group_create.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a security group — aws_vpc_security_group_create","text":"(list) fields: GroupId (character) Tags (list)","code":""},{"path":[]},{"path":"/reference/aws_vpc_security_group_create.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a security group — aws_vpc_security_group_create","text":"","code":"if (FALSE) { # create security group x <- aws_vpc_security_group_create( name = \"testing1\", description = \"Testing security group creation\" ) aws_vpc_security_group_create(name = \"testing2\") aws_vpc_security_group_create( name = \"testing4\", tags = list( list( ResourceType = \"security-group\", Tags = list( list( Key = \"sky\", Value = \"blue\" ) ) ) ) ) # add ingress aws_vpc_security_group_ingress( id = x$GroupId, ip_permissions = ip_permissions_generator(\"mariadb\") ) }"},{"path":"/reference/aws_vpc_security_group_ingress.html","id":null,"dir":"Reference","previous_headings":"","what":"Authorize Security Group Ingress — aws_vpc_security_group_ingress","title":"Authorize Security Group Ingress — aws_vpc_security_group_ingress","text":"Authorize Security Group Ingress","code":""},{"path":"/reference/aws_vpc_security_group_ingress.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Authorize Security Group Ingress — aws_vpc_security_group_ingress","text":"","code":"aws_vpc_security_group_ingress(id, ip_permissions = NULL, ...)"},{"path":"/reference/aws_vpc_security_group_ingress.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Authorize Security Group Ingress — aws_vpc_security_group_ingress","text":"id (character) security group id. required ip_permissions (list) list persmissions. see link paws docs use ip_permissions_generator() generate list parameter ... named parameters passed authorize_security_group_ingress","code":""},{"path":"/reference/aws_vpc_security_group_ingress.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Authorize Security Group Ingress — aws_vpc_security_group_ingress","text":"list slots: Return (boolean) SecurityGroupRules (list) SecurityGroupRuleId GroupId GroupOwnerId IsEgress IpProtocol FromPort ToPort CidrIpv4 CidrIpv6 PrefixListId ReferencedGroupInfo Description Tags","code":""},{"path":[]},{"path":"/reference/aws_vpc_security_groups.html","id":null,"dir":"Reference","previous_headings":"","what":"List VPC security groups — aws_vpc_security_groups","title":"List VPC security groups — aws_vpc_security_groups","text":"List VPC security groups","code":""},{"path":"/reference/aws_vpc_security_groups.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List VPC security groups — aws_vpc_security_groups","text":"","code":"aws_vpc_security_groups(...)"},{"path":"/reference/aws_vpc_security_groups.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List VPC security groups — aws_vpc_security_groups","text":"... named parameters passed describe_security_groups","code":""},{"path":"/reference/aws_vpc_security_groups.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List VPC security groups — aws_vpc_security_groups","text":"(list) list security groups","code":""},{"path":[]},{"path":"/reference/aws_vpc_security_groups.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List VPC security groups — aws_vpc_security_groups","text":"","code":"if (FALSE) { # interactive() aws_vpc_security_groups() aws_vpc_security_groups(MaxResults = 6) }"},{"path":"/reference/aws_vpc_sg_with_ingresss.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a security group with one ingress rule based on the engine — aws_vpc_sg_with_ingresss","title":"Get a security group with one ingress rule based on the engine — aws_vpc_sg_with_ingresss","text":"Get security group one ingress rule based engine","code":""},{"path":"/reference/aws_vpc_sg_with_ingresss.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a security group with one ingress rule based on the engine — aws_vpc_sg_with_ingresss","text":"","code":"aws_vpc_sg_with_ingresss(engine)"},{"path":"/reference/aws_vpc_sg_with_ingresss.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a security group with one ingress rule based on the engine — aws_vpc_sg_with_ingresss","text":"engine (character) engine use. default: \"mariadb\". required. one : mariadb, mysql, postgres, redshift","code":""},{"path":"/reference/aws_vpc_sg_with_ingresss.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a security group with one ingress rule based on the engine — aws_vpc_sg_with_ingresss","text":"(character) security group ID","code":""},{"path":"/reference/aws_vpc_sg_with_ingresss.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get a security group with one ingress rule based on the engine — aws_vpc_sg_with_ingresss","text":"Adds ingress rule specific engine supplied (port changes based engine), IP address. create security group ingress rules see aws_vpc_security_group_create() aws_vpc_security_group_ingress()","code":""},{"path":[]},{"path":"/reference/aws_vpcs.html","id":null,"dir":"Reference","previous_headings":"","what":"List VPCs — aws_vpcs","title":"List VPCs — aws_vpcs","text":"List VPCs","code":""},{"path":"/reference/aws_vpcs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List VPCs — aws_vpcs","text":"","code":"aws_vpcs(...)"},{"path":"/reference/aws_vpcs.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List VPCs — aws_vpcs","text":"... parameters passed describe_vpcs","code":""},{"path":"/reference/aws_vpcs.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List VPCs — aws_vpcs","text":"(list) list VPCs","code":""},{"path":"/reference/aws_vpcs.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List VPCs — aws_vpcs","text":"","code":"if (FALSE) { # interactive() aws_vpcs() aws_vpcs(MaxResults = 6) }"},{"path":"/reference/bucket_arn.html","id":null,"dir":"Reference","previous_headings":"","what":"Get bucket ARN — bucket_arn","title":"Get bucket ARN — bucket_arn","text":"Get bucket ARN","code":""},{"path":"/reference/bucket_arn.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get bucket ARN — bucket_arn","text":"","code":"bucket_arn(bucket, objects = \"\")"},{"path":"/reference/bucket_arn.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get bucket ARN — bucket_arn","text":"bucket (character) bucket name. required. objects (character) path object(s). default: \"\"","code":""},{"path":"/reference/bucket_arn.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get bucket ARN — bucket_arn","text":"character string bucket arn","code":""},{"path":"/reference/bucket_arn.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get bucket ARN — bucket_arn","text":"","code":"bucket_arn(\"somebucket\") #> arn:aws:s3:::somebucket bucket_arn(\"somebucket\", objects = \"*\") #> arn:aws:s3:::somebucket/* bucket_arn(\"somebucket\", objects = \"data.csv\") #> arn:aws:s3:::somebucket/data.csv bucket_arn(\"somebucket\", objects = \"myfolder/subset/data.csv\") #> arn:aws:s3:::somebucket/myfolder/subset/data.csv bucket_arn(\"somebucket\", objects = \"myfolder/subset/*\") #> arn:aws:s3:::somebucket/myfolder/subset/*"},{"path":"/reference/bucket_create_if_not.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a bucket if it does not exist — bucket_create_if_not","title":"Create a bucket if it does not exist — bucket_create_if_not","text":"Create bucket exist","code":""},{"path":"/reference/bucket_create_if_not.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a bucket if it does not exist — bucket_create_if_not","text":"","code":"bucket_create_if_not(bucket, force = FALSE)"},{"path":"/reference/bucket_create_if_not.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a bucket if it does not exist — bucket_create_if_not","text":"bucket (character) bucket name. required force (logical) force deletion without going prompt. default: FALSE. set TRUE required non-interactive use.","code":""},{"path":"/reference/bucket_region.html","id":null,"dir":"Reference","previous_headings":"","what":"Get bucket region — bucket_region","title":"Get bucket region — bucket_region","text":"Get bucket region","code":""},{"path":"/reference/bucket_region.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get bucket region — bucket_region","text":"","code":"bucket_region(bucket)"},{"path":"/reference/bucket_region.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get bucket region — bucket_region","text":"character string bucket region; NULL bucket found","code":""},{"path":"/reference/cluster_con_info.html","id":null,"dir":"Reference","previous_headings":"","what":"Get connection information for all clusters — cluster_con_info","title":"Get connection information for all clusters — cluster_con_info","text":"Get connection information clusters","code":""},{"path":"/reference/cluster_con_info.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get connection information for all clusters — cluster_con_info","text":"","code":"cluster_con_info(id)"},{"path":"/reference/cluster_con_info.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get connection information for all clusters — cluster_con_info","text":"id (character) Cluster identifier. Use identifier refer cluster subsequent cluster operations deleting modifying. identifier also appears Amazon Redshift console. Must unique clusters within Amazon Web Services account.","code":""},{"path":"/reference/cluster_con_info.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get connection information for all clusters — cluster_con_info","text":"list cluster details","code":""},{"path":"/reference/cluster_details.html","id":null,"dir":"Reference","previous_headings":"","what":"Get information for all clusters — cluster_details","title":"Get information for all clusters — cluster_details","text":"Get information clusters","code":""},{"path":"/reference/cluster_details.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get information for all clusters — cluster_details","text":"","code":"cluster_details()"},{"path":"/reference/cluster_details.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get information for all clusters — cluster_details","text":"list cluster details, see link format, slots: Marker (pagination) Clusters (cluster; empty list clusters)","code":""},{"path":"/reference/cluster_details.html","id":"references","dir":"Reference","previous_headings":"","what":"References","title":"Get information for all clusters — cluster_details","text":"https://www.paws-r-sdk.com/docs/redshift_describe_clusters/","code":""},{"path":"/reference/con_factory.html","id":null,"dir":"Reference","previous_headings":"","what":"paws connection factory — con_factory","title":"paws connection factory — con_factory","text":"paws connection factory","code":""},{"path":"/reference/con_factory.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"paws connection factory — con_factory","text":"","code":"con_factory(service)"},{"path":"/reference/con_factory.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"paws connection factory — con_factory","text":"service (character) service supported paws","code":""},{"path":"/reference/con_factory.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"paws connection factory — con_factory","text":"function returning client service service parameter","code":""},{"path":"/reference/con_iam.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a paws client for a service — con_iam","title":"Get a paws client for a service — con_iam","text":"Get paws client service","code":""},{"path":"/reference/con_iam.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a paws client for a service — con_iam","text":"","code":"con_iam() con_s3() con_sm() con_ec2() con_rds() con_redshift() con_ce()"},{"path":"/reference/con_iam.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a paws client for a service — con_iam","text":"con_s3: list methods interfacing S3; https://www.paws-r-sdk.com/docs/s3/ con_iam: list methods interfacing IAM; https://www.paws-r-sdk.com/docs/iam/ con_sm: list methods interfacing Secrets Manager; https://www.paws-r-sdk.com/docs/secretsmanager/ con_ec2: list methods interfacing EC2; https://www.paws-r-sdk.com/docs/ec2/ con_rds: list methods interfacing RDS; https://www.paws-r-sdk.com/docs/rds/ con_redshift: list methods interfacing Redshift; https://www.paws-r-sdk.com/docs/redshift/ con_ce: list methods interfacing Cost Explorer; https://www.paws-r-sdk.com/docs/costexplorer/","code":""},{"path":"/reference/con_iam.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get a paws client for a service — con_iam","text":"Toggles credentials used based environment variable AWS_PROFILE one : minio, localstack, aws. AWS_PROFILE \"minio\" set following credentials connection: access_key_id uses env var MINIO_USER, default \"minioadmin\" secret_access_key uses env var MINIO_PWD, default \"minioadmin\" endpoint uses env var MINIO_ENDPOINT, default \"http://127.0.0.1:9000\" AWS_PROFILE \"localstack\" set following credentials connection: access_key_id uses env var LOCALSTACK_KEY, default string essentially ignored. need set LOCALSTACK_KEY env var. However, want set account ID Localstack can set env var used. see https://docs.localstack.cloud/references/credentials/ secret_access_key uses env var LOCALSTACK_SECRET, default string ignored; value set LOCALSTACK_SECRET ignored Localstack well. see https://docs.localstack.cloud/references/credentials/ endpoint uses env var LOCALSTACK_ENDPOINT. can set URL Localstack running . Default http://localhost.localstack.cloud:4566 AWS_PROFILE set, set \"aws\", anything else (\"localstack\") set credentials internally, paws gather credentials set via env vars, config files, etc.-","code":""},{"path":[]},{"path":"/reference/con_iam.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get a paws client for a service — con_iam","text":"","code":"if (FALSE) { # interactive() z <- con_iam() z z$get_group withr::with_envvar( c(\"AWS_PROFILE\" = \"localstack\"), con_iam() ) withr::with_envvar( c(\"AWS_PROFILE\" = \"minio\"), con_s3() ) }"},{"path":"/reference/con_s3fs.html","id":null,"dir":"Reference","previous_headings":"","what":"s3fs connection — con_s3fs","title":"s3fs connection — con_s3fs","text":"s3fs connection","code":""},{"path":"/reference/con_s3fs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"s3fs connection — con_s3fs","text":"","code":"con_s3fs()"},{"path":"/reference/con_s3fs.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"s3fs connection — con_s3fs","text":"S3 list class 'sixtyfour_client'","code":""},{"path":"/reference/con_s3fs.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"s3fs connection — con_s3fs","text":"set refresh=TRUE s3fs::s3_file_system() can change s3 interface within R session can toggle interface set one minio, localstack, aws. See connections information.","code":""},{"path":[]},{"path":"/reference/con_s3fs.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"s3fs connection — con_s3fs","text":"","code":"if (FALSE) { # interactive() con <- con_s3fs() con con_s3fs()$file_copy }"},{"path":"/reference/construct_db_secret.html","id":null,"dir":"Reference","previous_headings":"","what":"Construct a database secret string or raw version of it — construct_db_secret","title":"Construct a database secret string or raw version of it — construct_db_secret","text":"Construct database secret string raw version ","code":""},{"path":"/reference/construct_db_secret.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Construct a database secret string or raw version of it — construct_db_secret","text":"","code":"construct_db_secret( engine, host = \"\", username = \"\", password = \"\", dbname = \"\", port = \"\", as = \"string\" )"},{"path":"/reference/construct_db_secret.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Construct a database secret string or raw version of it — construct_db_secret","text":"engine, host, username, password, dbname, port supply parameters go either json string raw version json string (character) one \"string\" \"raw\"","code":""},{"path":"/reference/construct_db_secret.html","id":"references","dir":"Reference","previous_headings":"","what":"References","title":"Construct a database secret string or raw version of it — construct_db_secret","text":"https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_secret_json_structure.html # nolint","code":""},{"path":"/reference/construct_db_secret.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Construct a database secret string or raw version of it — construct_db_secret","text":"","code":"if (FALSE) { construct_db_secret(\"redshift\", dbname = \"hello\", port = 5439) construct_db_secret(\"mariadb\", dbname = \"world\", port = 3306) construct_db_secret(\"postgresql\", dbname = \"bears\", port = 5432, as = \"raw\") }"},{"path":"/reference/figure_out_policy_arn.html","id":null,"dir":"Reference","previous_headings":"","what":"Figure out policy Arn from a name — figure_out_policy_arn","title":"Figure out policy Arn from a name — figure_out_policy_arn","text":"Figure policy Arn name","code":""},{"path":"/reference/figure_out_policy_arn.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Figure out policy Arn from a name — figure_out_policy_arn","text":"","code":"figure_out_policy_arn(name)"},{"path":"/reference/figure_out_policy_arn.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Figure out policy Arn from a name — figure_out_policy_arn","text":"","code":"if (FALSE) { # interactive() # user managed, exists figure_out_policy_arn(\"MyTestPolicy\") # user managed, doesn't exist figure_out_policy_arn(\"DoesNotExist\") # aws managed figure_out_policy_arn(\"AmazonS3ReadOnlyAccess\") # aws managed, job function figure_out_policy_arn(\"Billing\") figure_out_policy_arn(\"DataScientist\") }"},{"path":"/reference/group_policies.html","id":null,"dir":"Reference","previous_headings":"","what":"Preset group policies — group_policies","title":"Preset group policies — group_policies","text":"Preset group policies","code":""},{"path":"/reference/group_policies.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Preset group policies — group_policies","text":"","code":"group_policies(group)"},{"path":"/reference/group_policies.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Preset group policies — group_policies","text":"group (character)","code":""},{"path":"/reference/group_policies.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Preset group policies — group_policies","text":"character vector policy names","code":""},{"path":"/reference/group_policies.html","id":"admin-group-policies","dir":"Reference","previous_headings":"","what":"Admin group policies","title":"Preset group policies — group_policies","text":"AdministratorAccess Billing CostOptimizationHubAdminAccess AWSBillingReadOnlyAccess AWSCostAndUsageReportAutomationPolicy","code":""},{"path":"/reference/group_policies.html","id":"user-group-policies","dir":"Reference","previous_headings":"","what":"User group policies","title":"Preset group policies — group_policies","text":"AmazonRDSReadOnlyAccess AmazonRedshiftReadOnlyAccess AmazonS3ReadOnlyAccess AWSBillingReadOnlyAccess IAMReadOnlyAccess","code":""},{"path":"/reference/group_policies.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Preset group policies — group_policies","text":"","code":"group_policies(\"admin\") #> [1] \"AdministratorAccess\" #> [2] \"Billing\" #> [3] \"CostOptimizationHubAdminAccess\" #> [4] \"AWSBillingReadOnlyAccess\" #> [5] \"AWSCostAndUsageReportAutomationPolicy\" group_policies(\"users\") #> [1] \"AmazonRDSReadOnlyAccess\" \"AmazonRedshiftReadOnlyAccess\" #> [3] \"AmazonS3ReadOnlyAccess\" \"AWSBillingReadOnlyAccess\" #> [5] \"IAMReadOnlyAccess\""},{"path":"/reference/instance_con_info.html","id":null,"dir":"Reference","previous_headings":"","what":"Get connection information for all instances — instance_con_info","title":"Get connection information for all instances — instance_con_info","text":"Get connection information instances","code":""},{"path":"/reference/instance_con_info.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get connection information for all instances — instance_con_info","text":"","code":"instance_con_info(id)"},{"path":"/reference/instance_con_info.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get connection information for all instances — instance_con_info","text":"id (character) Cluster identifier. Use identifier refer cluster subsequent cluster operations deleting modifying. identifier also appears Amazon Redshift console. Must unique clusters within Amazon Web Services account.","code":""},{"path":"/reference/instance_con_info.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get connection information for all instances — instance_con_info","text":"list cluster details","code":""},{"path":"/reference/instance_details.html","id":null,"dir":"Reference","previous_headings":"","what":"Get information for all RDS instances — instance_details","title":"Get information for all RDS instances — instance_details","text":"Get information RDS instances","code":""},{"path":"/reference/instance_details.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get information for all RDS instances — instance_details","text":"","code":"instance_details()"},{"path":"/reference/instance_details.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get information for all RDS instances — instance_details","text":"list RDS instance details, see link format, slots: Marker (pagination) DBInstances (instance; empty list instances)","code":""},{"path":"/reference/instance_details.html","id":"references","dir":"Reference","previous_headings":"","what":"References","title":"Get information for all RDS instances — instance_details","text":"https://www.paws-r-sdk.com/docs/describe_db_instances/","code":""},{"path":"/reference/ip_address.html","id":null,"dir":"Reference","previous_headings":"","what":"Get your IP address using https://ifconfig.me/ip — ip_address","title":"Get your IP address using https://ifconfig.me/ip — ip_address","text":"Get IP address using https://ifconfig./ip","code":""},{"path":"/reference/ip_address.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get your IP address using https://ifconfig.me/ip — ip_address","text":"","code":"ip_address()"},{"path":"/reference/ip_address.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get your IP address using https://ifconfig.me/ip — ip_address","text":"(character) ip address","code":""},{"path":"/reference/ip_permissions_generator.html","id":null,"dir":"Reference","previous_headings":"","what":"Ip Permissions generator — ip_permissions_generator","title":"Ip Permissions generator — ip_permissions_generator","text":"Ip Permissions generator","code":""},{"path":"/reference/ip_permissions_generator.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Ip Permissions generator — ip_permissions_generator","text":"","code":"ip_permissions_generator(engine, port = NULL, description = NULL)"},{"path":"/reference/ip_permissions_generator.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Ip Permissions generator — ip_permissions_generator","text":"engine (character) one mariadb, mysql, postgres port (character) port number. port determined engine port given. default: NULL description (character) description. given, autogenerated depending value engine","code":""},{"path":"/reference/ip_permissions_generator.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Ip Permissions generator — ip_permissions_generator","text":"list slots: FromPort, ToPort, IpProtocol, IpRanges","code":""},{"path":"/reference/last.html","id":null,"dir":"Reference","previous_headings":"","what":"Get the last element of a vector — last","title":"Get the last element of a vector — last","text":"Get last element vector","code":""},{"path":"/reference/last.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get the last element of a vector — last","text":"","code":"last(x)"},{"path":"/reference/last.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get the last element of a vector — last","text":"x vector","code":""},{"path":"/reference/last.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get the last element of a vector — last","text":"last element vector","code":""},{"path":"/reference/paginate_aws_marker.html","id":null,"dir":"Reference","previous_headings":"","what":"Paginate over list_* methods with Marker/IsTruncated — paginate_aws_marker","title":"Paginate over list_* methods with Marker/IsTruncated — paginate_aws_marker","text":"Currently works IAM - .e., IAM hard-coded internally","code":""},{"path":"/reference/paginate_aws_marker.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Paginate over list_* methods with Marker/IsTruncated — paginate_aws_marker","text":"","code":"paginate_aws_marker(fun, target, ...)"},{"path":"/reference/paginate_aws_marker.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Paginate over list_* methods with Marker/IsTruncated — paginate_aws_marker","text":"fun (character) name function call - function target (character) list element get ... named args passed fun","code":""},{"path":"/reference/paginate_aws_token.html","id":null,"dir":"Reference","previous_headings":"","what":"Paginate over list_* methods with NextToken — paginate_aws_token","title":"Paginate over list_* methods with NextToken — paginate_aws_token","text":"Paginate list_* methods NextToken","code":""},{"path":"/reference/paginate_aws_token.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Paginate over list_* methods with NextToken — paginate_aws_token","text":"","code":"paginate_aws_token(fun, target, ...)"},{"path":"/reference/paginate_aws_token.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Paginate over list_* methods with NextToken — paginate_aws_token","text":"fun (character) name function call - function target (character) list element get ... named args passed fun","code":""},{"path":"/reference/paginate_aws_token.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Paginate over list_* methods with NextToken — paginate_aws_token","text":"","code":"if (FALSE) { paginate_aws_token( fun = con_sm()$list_secrets, target = \"SecretList\" ) }"},{"path":"/reference/path_as_s3.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert a s3 like path to a single format — path_as_s3","title":"Convert a s3 like path to a single format — path_as_s3","text":"Convert s3 like path single format","code":""},{"path":"/reference/path_as_s3.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert a s3 like path to a single format — path_as_s3","text":"","code":"path_as_s3(paths)"},{"path":"/reference/path_as_s3.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert a s3 like path to a single format — path_as_s3","text":"paths (character) one s3 paths","code":""},{"path":"/reference/path_as_s3.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convert a s3 like path to a single format — path_as_s3","text":"vector s3 paths (character), form: s3:////","code":""},{"path":"/reference/path_as_s3.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Convert a s3 like path to a single format — path_as_s3","text":"","code":"if (FALSE) { # interactive() path_as_s3(\"http://s64-test-3.s3.amazonaws.com/\") path_as_s3(\"https://s64-test-3.s3.amazonaws.com/\") path_as_s3(c( \"https://s64-test-3.s3.amazonaws.com/\", \"https://mybucket.s3.amazonaws.com/\" )) path_as_s3(c(\"apple\", \"banana\", \"pear\", \"pineapple\")) }"},{"path":"/reference/path_s3_build.html","id":null,"dir":"Reference","previous_headings":"","what":"Build s3 paths — path_s3_build","title":"Build s3 paths — path_s3_build","text":"Build s3 paths","code":""},{"path":"/reference/path_s3_build.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build s3 paths — path_s3_build","text":"","code":"path_s3_build(x)"},{"path":"/reference/path_s3_build.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build s3 paths — path_s3_build","text":"x unnamed list parsed paths, path_s3_parse()","code":""},{"path":"/reference/path_s3_build.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Build s3 paths — path_s3_build","text":"","code":"if (FALSE) { # interactive() paths <- c( \"s3://s64-test-2/DESCRIPTION\", \"s3://s64-test-2/stuff.txt\", \"s3://s64-test-2/some/other/path/things.csv\" ) x <- path_s3_parse(paths) path_s3_build(x) }"},{"path":"/reference/path_s3_parse.html","id":null,"dir":"Reference","previous_headings":"","what":"Parse s3 paths — path_s3_parse","title":"Parse s3 paths — path_s3_parse","text":"Parse s3 paths","code":""},{"path":"/reference/path_s3_parse.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Parse s3 paths — path_s3_parse","text":"","code":"path_s3_parse(paths)"},{"path":"/reference/path_s3_parse.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Parse s3 paths — path_s3_parse","text":"paths (character) one s3 paths","code":""},{"path":"/reference/path_s3_parse.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Parse s3 paths — path_s3_parse","text":"unnamed list slot named list bucket, path, file","code":""},{"path":"/reference/path_s3_parse.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Parse s3 paths — path_s3_parse","text":"","code":"if (FALSE) { # interactive() path_s3_parse(\"s3://s64-test-2/DESCRIPTION\") path_s3_parse(\"s3://s64-test-2/some/other/path/things.csv\") paths <- c( \"s3://s64-test-2/DESCRIPTION\", \"s3://s64-test-2/stuff.txt\", \"s3://s64-test-2/some/other/path/things.csv\" ) path_s3_parse(paths) # if a path is not an s3 path paths <- c( \"s3://s64-test-2/DESCRIPTION\", \"s3://s64-test-2/stuff.txt\", \"s64-test-2/some/other/path/things.csv\" ) path_s3_parse(paths) }"},{"path":"/reference/random_string.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a random string with prefix — random_string","title":"Get a random string with prefix — random_string","text":"Get random string prefix","code":""},{"path":"/reference/random_string.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a random string with prefix — random_string","text":"","code":"random_string(prefix, size = 8)"},{"path":"/reference/random_string.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a random string with prefix — random_string","text":"prefix (character) string. required. size (character) length random part (including prefix)","code":""},{"path":"/reference/random_string.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a random string with prefix — random_string","text":"(character) string prefix beginning","code":""},{"path":"/reference/random_string.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get a random string with prefix — random_string","text":"","code":"random_string(\"bucket\") #> bucketmwlefoud replicate(10, random_string(\"bucket\")) #> [1] \"bucketfiexombk\" \"bucketkeulbfdp\" \"bucketbcvkgufi\" \"bucketvjubqtaf\" #> [5] \"bucketbsnaoreh\" \"bucketalspkcbj\" \"bucketcfdjagys\" \"bucketybhawgli\" #> [9] \"bucketjbfglnew\" \"bucketslqexmfa\""},{"path":"/reference/random_user.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a random user — random_user","title":"Get a random user — random_user","text":"Get random user","code":""},{"path":"/reference/random_user.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a random user — random_user","text":"","code":"random_user()"},{"path":"/reference/random_user.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a random user — random_user","text":"(character) username random adjective plus random noun combined one string, shortened longer 16 characters longer 16","code":""},{"path":"/reference/random_user.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get a random user — random_user","text":"","code":"random_user() #> [1] \"InsensibleParson\" replicate(10, random_user()) #> [1] \"FamousCountdown\" \"UnintendedMonume\" \"UnattractiveDomi\" \"SanctionedLoathi\" #> [5] \"PacedLeopard\" \"UntimelyEstimati\" \"HandheldRecurren\" \"WidowDenominatio\" #> [9] \"OrdinateTourist\" \"ConsequentialAnn\""},{"path":"/reference/reexports.html","id":null,"dir":"Reference","previous_headings":"","what":"Objects exported from other packages — reexports","title":"Objects exported from other packages — reexports","text":"objects imported packages. Follow links see documentation. s3fs s3_path","code":""},{"path":"/reference/resource_rds.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a resource string for a policy statement for RDS — resource_rds","title":"Create a resource string for a policy statement for RDS — resource_rds","text":"Create resource string policy statement RDS","code":""},{"path":"/reference/resource_rds.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a resource string for a policy statement for RDS — resource_rds","text":"","code":"resource_rds( user, resource_id, region = Sys.getenv(\"AWS_REGION\"), account = account_id() )"},{"path":"/reference/resource_rds.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a resource string for a policy statement for RDS — resource_rds","text":"user (character) user name IAM account. length>=1. required resource_id (character) identifier DB instance. length==1. required region (character) AWS Region DB instance. length==1 account (character) AWS account number DB instance. length==1. user must account account DB instance. default calls account_id()","code":""},{"path":"/reference/resource_rds.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a resource string for a policy statement for RDS — resource_rds","text":"resource ARN (character)","code":""},{"path":"/reference/s3_actions_full.html","id":null,"dir":"Reference","previous_headings":"","what":"S3 actions for full access (read and write), from the AWS\nmanaged policy AmazonS3FullAccess — s3_actions_full","title":"S3 actions for full access (read and write), from the AWS\nmanaged policy AmazonS3FullAccess — s3_actions_full","text":"S3 actions full access (read write), AWS managed policy AmazonS3FullAccess","code":""},{"path":"/reference/s3_actions_full.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"S3 actions for full access (read and write), from the AWS\nmanaged policy AmazonS3FullAccess — s3_actions_full","text":"","code":"s3_actions_full()"},{"path":"/reference/s3_actions_full.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"S3 actions for full access (read and write), from the AWS\nmanaged policy AmazonS3FullAccess — s3_actions_full","text":"character vector actions","code":""},{"path":"/reference/s3_actions_read.html","id":null,"dir":"Reference","previous_headings":"","what":"S3 actions for reading, from the AWS managed policy\nAmazonS3ReadOnlyAccess — s3_actions_read","title":"S3 actions for reading, from the AWS managed policy\nAmazonS3ReadOnlyAccess — s3_actions_read","text":"S3 actions reading, AWS managed policy AmazonS3ReadOnlyAccess","code":""},{"path":"/reference/s3_actions_read.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"S3 actions for reading, from the AWS managed policy\nAmazonS3ReadOnlyAccess — s3_actions_read","text":"","code":"s3_actions_read()"},{"path":"/reference/s3_actions_read.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"S3 actions for reading, from the AWS managed policy\nAmazonS3ReadOnlyAccess — s3_actions_read","text":"character vector actions","code":""},{"path":"/reference/service_map.html","id":null,"dir":"Reference","previous_headings":"","what":"Mapping of full names of AWS services to acronyms — service_map","title":"Mapping of full names of AWS services to acronyms — service_map","text":"Mapping full names AWS services acronyms","code":""},{"path":"/reference/service_map.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Mapping of full names of AWS services to acronyms — service_map","text":"","code":"service_map"},{"path":[]},{"path":"/reference/service_map.html","id":"service-map","dir":"Reference","previous_headings":"","what":"service_map","title":"Mapping of full names of AWS services to acronyms — service_map","text":"data frame 178 rows 2 columns: service Service name full acronym acronym, 2 5 characters length","code":""},{"path":"/reference/service_map.html","id":"source","dir":"Reference","previous_headings":"","what":"Source","title":"Mapping of full names of AWS services to acronyms — service_map","text":"https://tommymaynard.com/aws-service-acronyms/","code":""},{"path":"/reference/set_s3_interface.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the S3 compatible interface to use — set_s3_interface","title":"Set the S3 compatible interface to use — set_s3_interface","text":"Set S3 compatible interface use","code":""},{"path":"/reference/set_s3_interface.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the S3 compatible interface to use — set_s3_interface","text":"","code":"set_s3_interface(interface = \"aws\")"},{"path":"/reference/set_s3_interface.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the S3 compatible interface to use — set_s3_interface","text":"interface s3 compatible interface use. options: \"aws\" (default), \"minio\", \"localstack\"","code":""},{"path":"/reference/set_s3_interface.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set the S3 compatible interface to use — set_s3_interface","text":"paws s3 client object class list","code":""},{"path":"/reference/set_s3_interface.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Set the S3 compatible interface to use — set_s3_interface","text":"function sets connection details paws s3fs packages, returns something paws function expects access following environment variables: AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION MINIO_USER MINIO_PWD MINIO_ENDPOINT s3fs::s3_file_system() set refresh=TRUE can change s3 interface within R session.","code":""},{"path":"/reference/six_admin_setup.html","id":null,"dir":"Reference","previous_headings":"","what":"AWS account setup for administrators — six_admin_setup","title":"AWS account setup for administrators — six_admin_setup","text":"AWS account setup administrators","code":""},{"path":"/reference/six_admin_setup.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"AWS account setup for administrators — six_admin_setup","text":"","code":"six_admin_setup(users_group = \"users\", admin_group = \"admin\")"},{"path":"/reference/six_admin_setup.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"AWS account setup for administrators — six_admin_setup","text":"users_group (character) name users group. default: \"users\" admin_group (character) name admin group. default: \"admin\"","code":""},{"path":"/reference/six_admin_setup.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"AWS account setup for administrators — six_admin_setup","text":"NULL invisibly","code":""},{"path":"/reference/six_admin_setup.html","id":"what-is-magical","dir":"Reference","previous_headings":"","what":"What is magical","title":"AWS account setup for administrators — six_admin_setup","text":"Setup users IAM group: users require admin persmissions Add policies users group Setup admin IAM group: users require admin permissions Add policies admin group","code":""},{"path":[]},{"path":"/reference/six_bucket_add_user.html","id":null,"dir":"Reference","previous_headings":"","what":"Add a user to a bucket — six_bucket_add_user","title":"Add a user to a bucket — six_bucket_add_user","text":"Add user bucket","code":""},{"path":"/reference/six_bucket_add_user.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Add a user to a bucket — six_bucket_add_user","text":"","code":"six_bucket_add_user(bucket, username, permissions)"},{"path":"/reference/six_bucket_add_user.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Add a user to a bucket — six_bucket_add_user","text":"bucket (character) bucket name. required username (character) user name. required permissions (character) user permissions, one read write. write includes read","code":""},{"path":"/reference/six_bucket_add_user.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Add a user to a bucket — six_bucket_add_user","text":"invisibly returns nothing","code":""},{"path":"/reference/six_bucket_add_user.html","id":"permissions","dir":"Reference","previous_headings":"","what":"Permissions","title":"Add a user to a bucket — six_bucket_add_user","text":"read: read ; allowed write admin tasks write: write (addition read); includes deleting files; include deleting buckets admin: change user permissions (addition read write); includes deleting buckets (OPTION ACCEPTED YET!)","code":""},{"path":"/reference/six_bucket_add_user.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Add a user to a bucket — six_bucket_add_user","text":"","code":"if (FALSE) { # interactive() # create a bucket bucket <- random_string(\"bucket\") if (!aws_bucket_exists(bucket)) { aws_bucket_create(bucket) } # create a user user <- random_user() if (!aws_user_exists(user)) { aws_user_create(user) } six_bucket_add_user( bucket = bucket, username = user, permissions = \"read\" ) # cleanup six_user_delete(user) aws_bucket_delete(bucket, force = TRUE) if (FALSE) { # not a valid permissions string six_bucket_add_user( bucket = \"mybucket\", username = \"userdmgziqpt\", permissions = \"notavalidpermission\" ) } }"},{"path":"/reference/six_bucket_change_user.html","id":null,"dir":"Reference","previous_headings":"","what":"Change user permissions for a bucket — six_bucket_change_user","title":"Change user permissions for a bucket — six_bucket_change_user","text":"Change user permissions bucket","code":""},{"path":"/reference/six_bucket_change_user.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Change user permissions for a bucket — six_bucket_change_user","text":"","code":"six_bucket_change_user(bucket, username, permissions)"},{"path":"/reference/six_bucket_change_user.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Change user permissions for a bucket — six_bucket_change_user","text":"bucket (character) bucket name. required username (character) user name. required permissions (character) user permissions, one read write. write includes read","code":""},{"path":"/reference/six_bucket_change_user.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Change user permissions for a bucket — six_bucket_change_user","text":"invisibly returns nothing","code":""},{"path":"/reference/six_bucket_change_user.html","id":"important","dir":"Reference","previous_headings":"","what":"Important","title":"Change user permissions for a bucket — six_bucket_change_user","text":"function built around policies named package. use policies name function may work.","code":""},{"path":"/reference/six_bucket_change_user.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Change user permissions for a bucket — six_bucket_change_user","text":"","code":"if (FALSE) { # interactive() # create a bucket bucket <- random_string(\"bucket\") if (!aws_bucket_exists(bucket)) { aws_bucket_create(bucket) } # create user user <- random_user() if (!aws_user_exists(user)) { aws_user_create(user) } # user doesn't have any permissions for the bucket # - use six_bucket_add_user to add permissions six_bucket_change_user( bucket = bucket, username = user, permissions = \"read\" ) six_bucket_add_user( bucket = bucket, username = user, permissions = \"read\" ) # want to change to read to write, makes the change six_bucket_change_user( bucket = bucket, username = user, permissions = \"write\" ) # want to change to write - but already has write six_bucket_change_user( bucket = bucket, username = user, permissions = \"write\" ) # cleanup six_user_delete(user) aws_bucket_delete(bucket, force = TRUE) }"},{"path":"/reference/six_bucket_delete.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete an S3 bucket — six_bucket_delete","title":"Delete an S3 bucket — six_bucket_delete","text":"Takes care deleting bucket objects, bucket can deleted cleanly","code":""},{"path":"/reference/six_bucket_delete.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete an S3 bucket — six_bucket_delete","text":"","code":"six_bucket_delete(bucket, force = FALSE, ...)"},{"path":"/reference/six_bucket_delete.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete an S3 bucket — six_bucket_delete","text":"bucket (character) bucket name. required force (logical) force deletion without going prompt. default: FALSE. set TRUE required non-interactive use. ... named parameters passed delete_bucket","code":""},{"path":"/reference/six_bucket_delete.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete an S3 bucket — six_bucket_delete","text":"NULL, invisibly","code":""},{"path":"/reference/six_bucket_delete.html","id":"what-is-magical","dir":"Reference","previous_headings":"","what":"What is magical","title":"Delete an S3 bucket — six_bucket_delete","text":"Exits early bucket exist Checks objects bucket deletes present Deletes bucket deleting objects","code":""},{"path":[]},{"path":"/reference/six_bucket_delete.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Delete an S3 bucket — six_bucket_delete","text":"","code":"if (FALSE) { # interactive() # bucket does not exist six_bucket_delete(\"notabucket\") # bucket exists w/o objects bucket <- random_string(\"bucket\") aws_bucket_create(bucket) six_bucket_delete(bucket) # bucket exists w/ objects (files and directories with files) bucket <- random_string(\"bucket\") aws_bucket_create(bucket) demo_rds_file <- file.path(system.file(), \"Meta/demo.rds\") links_file <- file.path(system.file(), \"Meta/links.rds\") aws_file_upload( c(demo_rds_file, links_file), s3_path(bucket, c(basename(demo_rds_file), basename(links_file))) ) aws_file_upload( c(demo_rds_file, links_file), s3_path( bucket, \"newfolder\", c(basename(demo_rds_file), basename(links_file)) ) ) aws_bucket_list_objects(bucket) six_bucket_delete(bucket) }"},{"path":"/reference/six_bucket_permissions.html","id":null,"dir":"Reference","previous_headings":"","what":"Get permissions for a bucket — six_bucket_permissions","title":"Get permissions for a bucket — six_bucket_permissions","text":"Get permissions bucket","code":""},{"path":"/reference/six_bucket_permissions.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get permissions for a bucket — six_bucket_permissions","text":"","code":"six_bucket_permissions(bucket)"},{"path":"/reference/six_bucket_permissions.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get permissions for a bucket — six_bucket_permissions","text":"bucket (character) bucket name. required","code":""},{"path":"/reference/six_bucket_permissions.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get permissions for a bucket — six_bucket_permissions","text":"tibble row user, columns: user (always present) permissions (always present) policy_read (optionally present) policy name behind \"read\" permission (present) policy_admin (optionally present) policy name behind \"admin\" permission (present) Note users persmissions shown; see aws_users()","code":""},{"path":"/reference/six_bucket_permissions.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get permissions for a bucket — six_bucket_permissions","text":"","code":"if (FALSE) { # interactive() # create a bucket bucket <- random_string(\"bucket\") if (!aws_bucket_exists(bucket)) aws_bucket_create(bucket) # create user user <- random_user() if (!aws_user_exists(user)) aws_user_create(user) six_bucket_permissions(bucket) six_bucket_add_user(bucket, user, permissions = \"read\") six_bucket_permissions(bucket) six_bucket_remove_user(bucket, user) six_bucket_permissions(bucket) # cleanup six_user_delete(user) aws_bucket_delete(bucket, force = TRUE) }"},{"path":"/reference/six_bucket_remove_user.html","id":null,"dir":"Reference","previous_headings":"","what":"Remove a user from a bucket — six_bucket_remove_user","title":"Remove a user from a bucket — six_bucket_remove_user","text":"Remove user bucket","code":""},{"path":"/reference/six_bucket_remove_user.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Remove a user from a bucket — six_bucket_remove_user","text":"","code":"six_bucket_remove_user(bucket, username)"},{"path":"/reference/six_bucket_remove_user.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Remove a user from a bucket — six_bucket_remove_user","text":"bucket (character) bucket name. required username (character) user name. required","code":""},{"path":"/reference/six_bucket_remove_user.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Remove a user from a bucket — six_bucket_remove_user","text":"invisibly returns nothing","code":""},{"path":"/reference/six_bucket_remove_user.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Remove a user from a bucket — six_bucket_remove_user","text":"function detaches policy user accessing bucket; policy untouched","code":""},{"path":"/reference/six_bucket_remove_user.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Remove a user from a bucket — six_bucket_remove_user","text":"","code":"if (FALSE) { # interactive() # create a bucket bucket <- random_string(\"bucket\") if (!aws_bucket_exists(bucket)) aws_bucket_create(bucket) # create user user <- random_user() if (!aws_user_exists(user)) aws_user_create(user) six_bucket_add_user(bucket, user, permissions = \"read\") six_bucket_remove_user(bucket, user) # cleanup six_user_delete(user) aws_bucket_delete(bucket, force = TRUE) }"},{"path":"/reference/six_file_upload.html","id":null,"dir":"Reference","previous_headings":"","what":"Magically upload a file — six_file_upload","title":"Magically upload a file — six_file_upload","text":"Magically upload file","code":""},{"path":"/reference/six_file_upload.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Magically upload a file — six_file_upload","text":"","code":"six_file_upload(path, bucket, force = FALSE, ...)"},{"path":"/reference/six_file_upload.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Magically upload a file — six_file_upload","text":"path (character) one file paths add bucket. required. include directories bucket (character) bucket copy files . required. bucket exist prompt asking like bucket created force (logical) force bucket creation without going prompt. default: FALSE. set TRUE required non-interactive use. ... named params passed put_object","code":""},{"path":"/reference/six_file_upload.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Magically upload a file — six_file_upload","text":"(character) vector remote s3 paths files located","code":""},{"path":"/reference/six_file_upload.html","id":"what-is-magical","dir":"Reference","previous_headings":"","what":"What is magical","title":"Magically upload a file — six_file_upload","text":"Exits early files exist Exits early path values directories Creates bucket exist Adds files bucket, figuring key use supplied path Function vectoried path argument; can pass many file paths","code":""},{"path":[]},{"path":"/reference/six_file_upload.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Magically upload a file — six_file_upload","text":"","code":"if (FALSE) { # interactive() bucket <- random_string(\"bucket\") demo_rds_file <- file.path(system.file(), \"Meta/demo.rds\") six_file_upload(demo_rds_file, bucket) ## many files at once links_file <- file.path(system.file(), \"Meta/links.rds\") six_file_upload(c(demo_rds_file, links_file), bucket) # set expiration, expire 1 minute from now six_file_upload(demo_rds_file, bucket, Expires = Sys.time() + 60) # bucket doesn't exist, ask if you want to create it six_file_upload(demo_rds_file, \"not-a-buckets\") # path doesn't exist # six_file_upload(\"file_doesnt_exist.txt\", random_string(\"bucket\")) # directories not supported mydir <- tempdir() # six_file_upload(mydir, random_string(\"bucket\")) }"},{"path":"/reference/six_user_create.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a user — six_user_create","title":"Create a user — six_user_create","text":"Create user","code":""},{"path":"/reference/six_user_create.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a user — six_user_create","text":"","code":"six_user_create(username, path = NULL, permission_boundary = NULL, tags = NULL)"},{"path":"/reference/six_user_create.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a user — six_user_create","text":"username (character) user name. required path (character) path user name. optional. included, defaults slash (/). permission_boundary (character) ARN managed policy used set permissions boundary user. optional tags (list) list tags want attach new user. optional","code":""},{"path":"/reference/six_user_create.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a user — six_user_create","text":"NULL invisibly. draft email copied clipboard","code":""},{"path":"/reference/six_user_create.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Create a user — six_user_create","text":"See aws_user_create() details. function creates user, adds policies user can access account, grants access key. Add policies using aws_polic* functions","code":""},{"path":"/reference/six_user_create.html","id":"what-is-magical","dir":"Reference","previous_headings":"","what":"What is magical","title":"Create a user — six_user_create","text":"Adds GetUser policy account exist yet Attaches GetUser policy user created Grants access key","code":""},{"path":[]},{"path":"/reference/six_user_create.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a user — six_user_create","text":"","code":"if (FALSE) { # interactive() name <- random_user() six_user_create(name) }"},{"path":"/reference/six_user_creds.html","id":null,"dir":"Reference","previous_headings":"","what":"Create access keys for a user — six_user_creds","title":"Create access keys for a user — six_user_creds","text":"Creates new Amazon Web Services secret access key corresponding Amazon Web Services access key ID","code":""},{"path":"/reference/six_user_creds.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create access keys for a user — six_user_creds","text":"","code":"six_user_creds(username, copy_to_cp = FALSE)"},{"path":"/reference/six_user_creds.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create access keys for a user — six_user_creds","text":"username (character) user name. required copy_to_cp (logical) Copy clipboard. Default: FALSE. See section \"Clipboard\" details.","code":""},{"path":"/reference/six_user_creds.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create access keys for a user — six_user_creds","text":"invisibly returns named list slots: UserName (character) AccessKeyId (character) Status (character) SecretAccessKey (character) CreateDate (POSIXct)","code":""},{"path":"/reference/six_user_creds.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Create access keys for a user — six_user_creds","text":"user can one pair access keys. default user can 2 pairs access keys. Using function replace existing set keys; instead adds additional set keys. See https://rstats.wtf/r-startup.html help bringing secrets R session. Note although return AWS Region output function IAM regional resources. can however use IAM manage regions account access , etc. See https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-regions.html #nolint","code":""},{"path":"/reference/six_user_creds.html","id":"important","dir":"Reference","previous_headings":"","what":"Important","title":"Create access keys for a user — six_user_creds","text":"Save secret key running function can viewed .","code":""},{"path":"/reference/six_user_creds.html","id":"clipboard","dir":"Reference","previous_headings":"","what":"Clipboard","title":"Create access keys for a user — six_user_creds","text":"set copy_to_cp=TRUE copy clipboard email template credentials small amount instructions. Please edit email information tailored group like store secrets.","code":""},{"path":"/reference/six_user_creds.html","id":"known-error-behaviors","dir":"Reference","previous_headings":"","what":"Known error behaviors","title":"Create access keys for a user — six_user_creds","text":"LimitExceeded (HTTP 409). exceed quota AccessKeysPerUser: 2 NoSuchEntity (HTTP 404). user name xxx found.","code":""},{"path":[]},{"path":"/reference/six_user_creds.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create access keys for a user — six_user_creds","text":"","code":"if (FALSE) { # interactive() user <- random_user() if (!aws_user_exists(user)) aws_user_create(user) six_user_creds(user) aws_user_access_key(user) six_user_creds(user, copy_to_cp = TRUE) aws_user_access_key(user) # cleanup six_user_delete(user) }"},{"path":"/reference/six_user_delete.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete a user — six_user_delete","title":"Delete a user — six_user_delete","text":"Delete user","code":""},{"path":"/reference/six_user_delete.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete a user — six_user_delete","text":"","code":"six_user_delete(username)"},{"path":"/reference/six_user_delete.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete a user — six_user_delete","text":"username (character) user name. required","code":""},{"path":"/reference/six_user_delete.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete a user — six_user_delete","text":"empty list","code":""},{"path":"/reference/six_user_delete.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Delete a user — six_user_delete","text":"See https://www.paws-r-sdk.com/docs/iam_delete_user/ docs details","code":""},{"path":"/reference/six_user_delete.html","id":"what-is-magical","dir":"Reference","previous_headings":"","what":"What is magical","title":"Delete a user — six_user_delete","text":"Detaches attached policies Deletes access keys deletes user","code":""},{"path":[]},{"path":"/reference/six_user_delete.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Delete a user — six_user_delete","text":"","code":"if (FALSE) { # interactive() name <- random_user() six_user_create(name) six_user_delete(name) }"},{"path":"/reference/sixtyfour-package.html","id":null,"dir":"Reference","previous_headings":"","what":"sixtyfour: Humane Interface to AWS — sixtyfour-package","title":"sixtyfour: Humane Interface to AWS — sixtyfour-package","text":"Write things give folks sense goal package , high level entrypoints, etc.","code":""},{"path":[]},{"path":"/reference/sixtyfour-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"sixtyfour: Humane Interface to AWS — sixtyfour-package","text":"Maintainer: Scott Chamberlain sachamber@fredhutch.org (ORCID) Authors: Sean Kross","code":""},{"path":"/reference/ui_fetch_secret.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch secrets — ui_fetch_secret","title":"Fetch secrets — ui_fetch_secret","text":"Fetch secrets","code":""},{"path":"/reference/ui_fetch_secret.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch secrets — ui_fetch_secret","text":"","code":"ui_fetch_secret(user = NULL, password = NULL, engine = NULL, id = NULL)"},{"path":"/reference/ui_fetch_secret.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch secrets — ui_fetch_secret","text":"user (character) xx password (character) password engine (character) engine filter secrets . supplied (NULL) secrets considered id (character) id instance. supplied, filter secret names id","code":""},{"path":"/reference/ui_fetch_secret.html","id":"how-the-function-works","dir":"Reference","previous_headings":"","what":"How the function works","title":"Fetch secrets — ui_fetch_secret","text":"user password supplied returned immediately user password supplied, fetch secrets secrets manager service, ask one like use. choose none function returns NULL user password","code":""},{"path":"/reference/ui_fetch_secret.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch secrets — ui_fetch_secret","text":"","code":"if (FALSE) { # user,pwd supplied, return them right away at top of fxn ui_fetch_secret(engine = \"mariadb\", user = \"jane\", password = \"apple\") # user,pwd null ui_fetch_secret(engine = \"redshift\") ui_fetch_secret(engine = \"mariadb\") }"},{"path":"/reference/wait_for_cluster.html","id":null,"dir":"Reference","previous_headings":"","what":"Wait for a Redshift cluster to have a certain status — wait_for_cluster","title":"Wait for a Redshift cluster to have a certain status — wait_for_cluster","text":"Wait Redshift cluster certain status","code":""},{"path":"/reference/wait_for_cluster.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Wait for a Redshift cluster to have a certain status — wait_for_cluster","text":"","code":"wait_for_cluster(id, sleep = 2, status_target = \"available\")"},{"path":"/reference/wait_for_cluster.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Wait for a Redshift cluster to have a certain status — wait_for_cluster","text":"id (character) Cluster identifier. Use identifier refer cluster subsequent cluster operations deleting modifying. identifier also appears Amazon Redshift console. Must unique clusters within Amazon Web Services account. sleep (integer/numeric) number seconds wait checks cluster status (.e., http requests) status_target (character) status wait . default: \"available\" fun (function) function check status something; must return single boolean, e.g., aws_db_cluster_status aws_db_instance_status","code":""},{"path":"/reference/wait_for_cluster.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Wait for a Redshift cluster to have a certain status — wait_for_cluster","text":"nothing, exits error, loop completes","code":""},{"path":"/reference/wait_for_cluster.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Wait for a Redshift cluster to have a certain status — wait_for_cluster","text":"","code":"if (FALSE) { wait_for_cluster(id = \"scotts-test-cluster-456\") }"},{"path":"/reference/wait_for_instance.html","id":null,"dir":"Reference","previous_headings":"","what":"Wait for an RDS instance to have a certain status — wait_for_instance","title":"Wait for an RDS instance to have a certain status — wait_for_instance","text":"Wait RDS instance certain status","code":""},{"path":"/reference/wait_for_instance.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Wait for an RDS instance to have a certain status — wait_for_instance","text":"","code":"wait_for_instance(id, sleep = 2, status_target = \"available\")"},{"path":"/reference/wait_for_instance.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Wait for an RDS instance to have a certain status — wait_for_instance","text":"id (character) Cluster identifier. Use identifier refer cluster subsequent cluster operations deleting modifying. identifier also appears Amazon Redshift console. Must unique clusters within Amazon Web Services account. sleep (integer/numeric) number seconds wait checks cluster status (.e., http requests) status_target (character) status wait . default: \"available\"","code":""},{"path":"/reference/wait_for_instance.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Wait for an RDS instance to have a certain status — wait_for_instance","text":"nothing, exits error, loop completes","code":""},{"path":"/reference/wait_for_instance.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Wait for an RDS instance to have a certain status — wait_for_instance","text":"","code":"if (FALSE) { wait_for_instance(id = \"scotts-test-cluster-456\") }"}] +[{"path":[]},{"path":"/CODE_OF_CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"members, contributors, leaders pledge make participation community harassment-free experience everyone, regardless age, body size, visible invisible disability, ethnicity, sex characteristics, gender identity expression, level experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"/CODE_OF_CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes positive environment community include: Demonstrating empathy kindness toward people respectful differing opinions, viewpoints, experiences Giving gracefully accepting constructive feedback Accepting responsibility apologizing affected mistakes, learning experience Focusing best just us individuals, overall community Examples unacceptable behavior include: use sexualized language imagery, sexual attention advances kind Trolling, insulting derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical email address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"/CODE_OF_CONDUCT.html","id":"enforcement-responsibilities","dir":"","previous_headings":"","what":"Enforcement Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Community leaders responsible clarifying enforcing standards acceptable behavior take appropriate fair corrective action response behavior deem inappropriate, threatening, offensive, harmful. Community leaders right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, communicate reasons moderation decisions appropriate.","code":""},{"path":"/CODE_OF_CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within community spaces, also applies individual officially representing community public spaces. Examples representing community include using official e-mail address, posting via official social media account, acting appointed representative online offline event.","code":""},{"path":"/CODE_OF_CONDUCT.html","id":"enforcement","dir":"","previous_headings":"","what":"Enforcement","title":"Contributor Covenant Code of Conduct","text":"Instances abusive, harassing, otherwise unacceptable behavior may reported community leaders responsible enforcement sachamber@fredhutch.org. complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"/CODE_OF_CONDUCT.html","id":"enforcement-guidelines","dir":"","previous_headings":"","what":"Enforcement Guidelines","title":"Contributor Covenant Code of Conduct","text":"Community leaders follow Community Impact Guidelines determining consequences action deem violation Code Conduct:","code":""},{"path":"/CODE_OF_CONDUCT.html","id":"id_1-correction","dir":"","previous_headings":"Enforcement Guidelines","what":"1. Correction","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Use inappropriate language behavior deemed unprofessional unwelcome community. Consequence: private, written warning community leaders, providing clarity around nature violation explanation behavior inappropriate. public apology may requested.","code":""},{"path":"/CODE_OF_CONDUCT.html","id":"id_2-warning","dir":"","previous_headings":"Enforcement Guidelines","what":"2. Warning","title":"Contributor Covenant Code of Conduct","text":"Community Impact: violation single incident series actions. Consequence: warning consequences continued behavior. interaction people involved, including unsolicited interaction enforcing Code Conduct, specified period time. includes avoiding interactions community spaces well external channels like social media. Violating terms may lead temporary permanent ban.","code":""},{"path":"/CODE_OF_CONDUCT.html","id":"id_3-temporary-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"3. Temporary Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: serious violation community standards, including sustained inappropriate behavior. Consequence: temporary ban sort interaction public communication community specified period time. public private interaction people involved, including unsolicited interaction enforcing Code Conduct, allowed period. Violating terms may lead permanent ban.","code":""},{"path":"/CODE_OF_CONDUCT.html","id":"id_4-permanent-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"4. Permanent Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Demonstrating pattern violation community standards, including sustained inappropriate behavior, harassment individual, aggression toward disparagement classes individuals. Consequence: permanent ban sort public interaction within community.","code":""},{"path":"/CODE_OF_CONDUCT.html","id":"attribution","dir":"","previous_headings":"","what":"Attribution","title":"Contributor Covenant Code of Conduct","text":"Code Conduct adapted Contributor Covenant, version 2.1, available https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. Community Impact Guidelines inspired [Mozilla’s code conduct enforcement ladder][https://github.com/mozilla/inclusion]. answers common questions code conduct, see FAQ https://www.contributor-covenant.org/faq. Translations available https://www.contributor-covenant.org/translations.","code":""},{"path":"/CONTRIBUTING.html","id":"contributing","dir":"","previous_headings":"","what":"Contributing","title":"NA","text":"Please see Contributing article documentation site.","code":""},{"path":"/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2023 sixtyfour authors Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"/articles/contributing.html","id":"general-guidelines","dir":"Articles","previous_headings":"","what":"General guidelines","title":"Contributing","text":"article outlines propose change sixtyfour. information contributing , WILDS projects, please see WILDS Contributing Guide.","code":""},{"path":"/articles/contributing.html","id":"fixing-typosdocs-changes","dir":"Articles","previous_headings":"General guidelines","what":"Fixing typos/docs changes","title":"Contributing","text":"can fix typos, spelling mistakes, grammatical errors documentation directly using GitHub web interface, long changes made source file.","code":""},{"path":"/articles/contributing.html","id":"bigger-changes","dir":"Articles","previous_headings":"General guidelines","what":"Bigger changes","title":"Contributing","text":"want make bigger change, ’s good idea first file issue make sure someone team agrees ’s needed. ’ve found bug, please file issue illustrates bug minimal reproducible example using reprex. Note package Makefile root repository - see targets Makefile various package maintenance tasks.","code":""},{"path":"/articles/contributing.html","id":"pull-request-process","dir":"Articles","previous_headings":"General guidelines > Bigger changes","what":"Pull request process","title":"Contributing","text":"Fork package clone onto computer Create Git branch pull request (PR) title PR briefly describe change. body PR contain Fixes #issue-number. user-facing changes, add bullet NEWS.md file.","code":""},{"path":"/articles/contributing.html","id":"code-style","dir":"Articles","previous_headings":"General guidelines > Bigger changes","what":"Code style","title":"Contributing","text":"New code follow WILDS style guide.","code":""},{"path":"/articles/contributing.html","id":"testing","dir":"Articles","previous_headings":"","what":"Testing","title":"Contributing","text":"strive tests HTTP requests resources actual AWS accounts given drawbacks using real accounts, e.g., setting can difficult organizations; forgotten resources can expensive; accidentally making unwated changes account, etc. use two tools replace real AWS accounts: Minio, Localstack.","code":""},{"path":[]},{"path":"/articles/contributing.html","id":"minio","dir":"Articles","previous_headings":"Testing","what":"Minio","title":"Contributing","text":"use Minio testing two sets functions package interacting S3: tests test-buckets.R tests test-files.R","code":""},{"path":"/articles/contributing.html","id":"local","dir":"Articles","previous_headings":"Testing > Minio","what":"Local","title":"Contributing","text":"sixtyfour tests use Minio just skipped don’t Minio running. use Minio, first install platform: MacOS, Windows, Linux. Next, start Minio. Within package make target minio_start starting Minio locally; work Linux MacOS platforms. Upon starting Minio display URLs Minio API WebUI - username/password login WebUI. can open WebUI nice visual dashboard ’s going .","code":""},{"path":"/articles/contributing.html","id":"github-actions","dir":"Articles","previous_headings":"Testing > Minio","what":"GitHub Actions","title":"Contributing","text":"R-CMD-check workflow .github/workflows/ includes spinning Minio running unit tests - Linux; tests require Minio skipped MacOS WIndows platforms GitHub Actions.","code":""},{"path":"/articles/contributing.html","id":"minio-details","dir":"Articles","previous_headings":"Testing > Minio","what":"Minio Details","title":"Contributing","text":"following information (collapsed) want know minio setup, may want tweak add minio setup tests. tests/testthat/helper-minio.R helper functions Minio. bucket_delete buckets_empty make easier cleanup tests. minio_available function used inside skip_if_not skip tests file Minio available, like: skip_if_not(minio_available(), \"Minio Available\") top file uses Minio, setup interfaces Minio like: unset bottom file cleanup: Internally grab client objects paws s3fs needed use AWS_PROFILE env var toggle /using Minio. Minio use default credentials: Access key id: minioadmin (override env var MINIO_USER) Secret access key: minioadmin (override env var MINIO_PWD) Endpoint: http://127.0.0.1:9000 (override env var MINIO_ENDPOINT) can override defaults setting env vars values.","code":"Sys.setenv(AWS_PROFILE = \"minio\") Sys.unsetenv(\"AWS_PROFILE\")"},{"path":"/articles/contributing.html","id":"localstack","dir":"Articles","previous_headings":"Testing","what":"Localstack","title":"Contributing","text":"use Localstack testing functions package: tests test-groups.R tests test-policies.R tests test-roles.R tests test-s3.R tests test-secrets_manager.R tests test-users.R tests test-vpc.R","code":""},{"path":"/articles/contributing.html","id":"local-1","dir":"Articles","previous_headings":"Testing > Localstack","what":"Local","title":"Contributing","text":"sixtyfour tests use Localstack just skipped don’t Localstack running. use Localstack, first install platform https://docs.localstack.cloud/getting-started/installation/. Next, start Localstack. Within package make target localstack_start starting Localstack locally. make target work Linux MacOS platforms. GUI interface locally running localstack can install Desktop client - isn’t good - https://docs.localstack.cloud/getting-started/installation/#localstack-desktop. Better yet, login cloud Localstack site can interface locally running Localstack better interface . Login https://app.localstack.cloud/.","code":""},{"path":"/articles/contributing.html","id":"github-actions-1","dir":"Articles","previous_headings":"Testing > Localstack","what":"GitHub Actions","title":"Contributing","text":"R-CMD-check workflow .github/workflows/ includes spinning Localstack running unit tests - Linux; tests require Localstack skipped MacOS WIndows platforms GitHub Actions.","code":""},{"path":"/articles/contributing.html","id":"localstack-details","dir":"Articles","previous_headings":"Testing > Localstack","what":"Localstack Details","title":"Contributing","text":"following (collapsed) bullets list information want know Localstack setup, may want tweak add Localstack setup tests. tests/testthat/helper-localstack.R helper functions Localstack. localstack_available function used inside skip_if_not skip tests file Localstack available, like: skip_if_not(localstack_available(), \"Localstack Available\") top file uses Localstack, setup interfaces Localstack like: unset bottom file cleanup: Internally grab client objects paws s3fs needed use AWS_PROFILE env var toggle /using Localstack. Localstack use default credentials: Access key id: NOTAREALKEY (override env var LOCALSTACK_KEY) Secret access key: AREALLYFAKETOKEN (override env var LOCALSTACK_SECRET) Endpoint: http://localhost.localstack.cloud:4566 (override env var LOCALSTACK_ENDPOINT) can override defaults setting env vars values.","code":"Sys.setenv(AWS_PROFILE = \"localstack\") Sys.unsetenv(\"AWS_PROFILE\")"},{"path":"/articles/contributing.html","id":"code-of-conduct","dir":"Articles","previous_headings":"","what":"Code of Conduct","title":"Contributing","text":"Please note project released Contributor Code Conduct. contributing project agree abide terms.","code":""},{"path":"/articles/databases.html","id":"redshift","dir":"Articles","previous_headings":"","what":"Redshift","title":"Databases","text":"aws_db_redshift_create function creates cluster (Redshift instance called “cluster”). ’s important distinction Redshift RDS. Redshift uses IAM username/password, whereas RDS can use username/password setup instance RDS database, authentication IAM. However, RDS can’t simply pass IAM username/password (see notes ). First, let’s create security group ingress rule can access Redshift cluster. Notes parameters used example : id: ID come , must unique clusters within AWS account user/pwd: IAM username password security_group_ids: ’s best first create security group handle permissions Redshift cluster. See example . Pass ’s identifier wait: Since ’re using wait=TRUE call aws_db_redshift_create likely take 3 minutes run. can set wait=FALSE wait, ’ll want check instance available. Connect cluster List tables, create table, etc Use dplyr/et al. Important: Remember delete cluster done!","code":"my_security_group <- aws_vpc_sg_with_ingresss(\"redshift\") aws_db_redshift_create( id = \"some-id\", user = \"your-username\", pwd = \"your-pwd\", security_group_ids = list(my_security_group), wait = TRUE ) con <- aws_db_redshift_con( user = \"your-username\", pwd = \"your-pwd\", id = \"some-id\" ) library(DBI) dbListTables(con) dbWriteTable(con, \"mtcars\", mtcars) dbListTables(con) dbReadTable(con, \"mtcars\") library(dplyr) tbl(con, \"mtcars\") %>% filter(mpg == 4)"},{"path":"/articles/databases.html","id":"rds","dir":"Articles","previous_headings":"","what":"RDS","title":"Databases","text":"process MariaDB, MySQL, Postgres less , ’ll demonstrate MariaDB. future version package ’ll able use IAM authenticate RDS, now sixtyfour support IAM RDS. current “happy path” (read: easy) process starting RDS instance aws_db_rds_create follows: Supply ID (identifier) instance create random username created used database authentication random password created (via AWS Secretamanager) used database authentication ingress rule added security group IP address RDS instance creation, use username, password, security group username, password, security group information stored AWS Secretamanager subsequent use connect RDS instance, use aws_db_rds_con. “happy path” connecting : Pass ID used fetch secrets AWS Secretamanager ask ’d like use gather necessary details connect instance Return DBI connection object, e.g., MariaDBConnection MariaDB Let’s walk steps code. First, create RDS instance - case MariaDB. Notes parameters used example : id: ID come . see ?aws_db_rds_create constraints class: compute memory capacity instance; see AWS docs instance class options. default parameter (db.t3.micro) gives instance relatively small capacity terms memory compute - set way minimize costs case forget turn ’re using ! engine: default mariadb; options mysql postgres wait: Since ’re using wait=TRUE (default function) call aws_db_rds_create likely take 5 minutes run. can set wait=FALSE wait, ’ll want check instance available. Connect instance List tables, create table, etc Use dplyr/et al.","code":"aws_db_rds_create( id = \"myinstance\", class = \"db.t3.micro\", engine = \"mariadb\", wait = TRUE ) con <- aws_db_rds_con(id = \"myinstance\") library(DBI) dbListTables(con) dbWriteTable(con, \"mtcars\", mtcars) dbListTables(con) dbReadTable(con, \"mtcars\") library(dplyr) tbl(con, \"mtcars\") %>% filter(mpg == 4)"},{"path":"/articles/sixtyfour.html","id":"authentication","dir":"Articles","previous_headings":"","what":"Authentication","title":"Getting Started","text":"able use package ’ll need two AWS secrets AWS region following three environment variables: AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION can set within R current R session like: set variety ways available across R sessions. See R Startup chapter Forgot Teach R book details.","code":"Sys.setenv( AWS_ACCESS_KEY_ID = \"\", AWS_SECRET_ACCESS_KEY = \"\", AWS_REGION = \"us-west-2\" )"},{"path":"/articles/sixtyfour.html","id":"package-api-overview","dir":"Articles","previous_headings":"","what":"Package API Overview","title":"Getting Started","text":"aws_billing*: manage AWS billing details aws_bucket*: manage S3 buckets aws_file_*: manage files S3 buckets aws_user*: manage AWS users aws_group*: manage AWS groups aws_role*: manage AWS roles aws_policy*: manage AWS policies aws_db*: interact AWS database services Redshift RDS aws_secrets*: secrets manager aws_vpc_security*: VPC security groups","code":""},{"path":"/articles/sixtyfour.html","id":"working-with-s3","dir":"Articles","previous_headings":"","what":"Working with S3","title":"Getting Started","text":"vignette won’t touch parts package API - instead cover working files ’s likely common use case sixtyfour users.","code":""},{"path":"/articles/sixtyfour.html","id":"buckets","dir":"Articles","previous_headings":"Working with S3","what":"Buckets","title":"Getting Started","text":"Make random bucket name Create bucket - check exists first Create files different directories Upload newly created bucket List objects bucket Cleanup - delete bucket. ’s files bucket can delete . Delete files, delete bucket ","code":"random_bucket_name <- function() { glue::glue(\"egs-{paste0(sample(letters, size = 12), collapse = '')}\") } bucket <- random_bucket_name() exists <- aws_bucket_exists(bucket) if (!exists) { aws_bucket_create(bucket) } #> [1] \"http://egs-tnxoekbrjcdl.s3.amazonaws.com/\" library(fs) tdir <- fs::path(tempdir(), \"apples\") fs::dir_create(tdir) tfiles <- replicate(n = 10, fs::file_temp(tmp_dir = tdir, ext = \".txt\")) invisible(lapply(tfiles, function(x) write.csv(mtcars, x))) aws_bucket_upload(path = tdir, bucket = bucket) #> [1] \"s3://private/var/folders/qt/fzq1m_bj2yb_7b2jz57s9q7c0000gp/T/RtmpyTGZNW/apples\" objects <- aws_bucket_list_objects(bucket) objects #> # A tibble: 10 × 8 #> bucket_name key uri size type owner etag last_modified #> #> 1 egs-tnxoekbrjcdl file102ee… s3:/… 1.74K file \"\\\"6… 2024-03-19 23:28:06 #> 2 egs-tnxoekbrjcdl file102ee… s3:/… 1.74K file \"\\\"6… 2024-03-19 23:28:06 #> 3 egs-tnxoekbrjcdl file102ee… s3:/… 1.74K file \"\\\"6… 2024-03-19 23:28:06 #> 4 egs-tnxoekbrjcdl file102ee… s3:/… 1.74K file \"\\\"6… 2024-03-19 23:28:06 #> 5 egs-tnxoekbrjcdl file102ee… s3:/… 1.74K file \"\\\"6… 2024-03-19 23:28:06 #> 6 egs-tnxoekbrjcdl file102ee… s3:/… 1.74K file \"\\\"6… 2024-03-19 23:28:07 #> 7 egs-tnxoekbrjcdl file102ee… s3:/… 1.74K file \"\\\"6… 2024-03-19 23:28:07 #> 8 egs-tnxoekbrjcdl file102ee… s3:/… 1.74K file \"\\\"6… 2024-03-19 23:28:07 #> 9 egs-tnxoekbrjcdl file102ee… s3:/… 1.74K file \"\\\"6… 2024-03-19 23:28:07 #> 10 egs-tnxoekbrjcdl file102ee… s3:/… 1.74K file \"\\\"6… 2024-03-19 23:28:07 aws_bucket_delete(bucket) #> Error: BucketNotEmpty (HTTP 409). The bucket you tried to delete is not empty aws_file_delete(objects$uri) aws_bucket_delete(bucket)"},{"path":"/articles/sixtyfour.html","id":"files","dir":"Articles","previous_headings":"Working with S3","what":"Files","title":"Getting Started","text":"file functions built around accepting returning character vectors length one greater. includes functions take two inputs, source destination file. Rather using paws package hood functions package use, file functions use s3fs hood (built paws) ’s cleaner interface S3. First, create bucket: , upload files List files bucket Fetch file attributes Check one files exist Copy Download Rename","code":"my_bucket <- random_bucket_name() aws_bucket_create(my_bucket) #> [1] \"http://egs-fzpqkyhmtxlg.s3.amazonaws.com/\" temp_files <- replicate(n = 3, tempfile(fileext = \".txt\")) for (i in temp_files) cat(letters, \"\\n\", file = i) remote_files <- s3_path(my_bucket, basename(temp_files)) aws_file_upload(path = temp_files, remote_path = remote_files) #> [1] \"s3://egs-fzpqkyhmtxlg/file102ee45c0b74.txt\" #> [2] \"s3://egs-fzpqkyhmtxlg/file102ee36f3eee8.txt\" #> [3] \"s3://egs-fzpqkyhmtxlg/file102ee48c9dd87.txt\" obs <- aws_bucket_list_objects(my_bucket) obs #> # A tibble: 3 × 8 #> bucket_name key uri size type owner etag last_modified #> #> 1 egs-fzpqkyhmtxlg file102ee3… s3:/… 53 file \"\\\"a… 2024-03-19 23:28:10 #> 2 egs-fzpqkyhmtxlg file102ee4… s3:/… 53 file \"\\\"a… 2024-03-19 23:28:10 #> 3 egs-fzpqkyhmtxlg file102ee4… s3:/… 53 file \"\\\"a… 2024-03-19 23:28:10 aws_file_attr(remote_files) #> # A tibble: 3 × 38 #> bucket_name key uri size type etag last_modified delete_marker #> #> 1 egs-fzpqkyhmt… file… s3:/… 53 file \"\\\"a… 2024-03-19 23:28:10 NA #> 2 egs-fzpqkyhmt… file… s3:/… 53 file \"\\\"a… 2024-03-19 23:28:10 NA #> 3 egs-fzpqkyhmt… file… s3:/… 53 file \"\\\"a… 2024-03-19 23:28:10 NA #> # ℹ 30 more variables: accept_ranges , expiration , restore , #> # archive_status , checksum_crc32 , checksum_crc32_c , #> # checksum_sha1 , checksum_sha256 , missing_meta , #> # version_id , cache_control , content_disposition , #> # content_encoding , content_language , content_type , #> # expires , website_redirect_location , #> # server_side_encryption , metadata , … aws_file_exists(remote_files[1]) #> [1] TRUE aws_file_exists(remote_files) #> [1] TRUE TRUE TRUE new_bucket <- random_bucket_name() aws_bucket_create(new_bucket) #> [1] \"http://egs-gqalfwjhukzr.s3.amazonaws.com/\" # add existing files to the new bucket aws_file_copy(remote_files, new_bucket) #> [1] \"s3://egs-gqalfwjhukzr/file102ee45c0b74.txt\" #> [2] \"s3://egs-gqalfwjhukzr/file102ee36f3eee8.txt\" #> [3] \"s3://egs-gqalfwjhukzr/file102ee48c9dd87.txt\" # create bucket that doesn't exist yet # the force=TRUE makes this work non-interactively aws_file_copy(remote_files, random_bucket_name(), force = TRUE) #> [1] \"s3://egs-tsadhcfyrjmo/file102ee45c0b74.txt\" #> [2] \"s3://egs-tsadhcfyrjmo/file102ee36f3eee8.txt\" #> [3] \"s3://egs-tsadhcfyrjmo/file102ee48c9dd87.txt\" tfile <- tempfile() aws_file_download(remote_files[1], tfile) #> [1] \"/var/folders/qt/fzq1m_bj2yb_7b2jz57s9q7c0000gp/T//RtmpyTGZNW/file102ee497415cd\" readLines(tfile) #> [1] \"a b c d e f g h i j k l m n o p q r s t u v w x y z \" aws_file_exists(remote_files[1]) #> [1] TRUE aws_file_rename(remote_files[1], s3_path(dirname(remote_files[1]), \"myfile.txt\")) #> [1] \"s3://egs-fzpqkyhmtxlg/myfile.txt\" aws_file_exists(remote_files[1]) #> [1] FALSE"},{"path":"/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Sean Kross. Author. Scott Chamberlain. Author, maintainer.","code":""},{"path":"/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Kross S, Chamberlain S (2024). sixtyfour: Humane Interface AWS. R package version 0.0.0.98, https://github.com/getwilds/sixtyfour.","code":"@Manual{, title = {sixtyfour: Humane Interface to AWS}, author = {Sean Kross and Scott Chamberlain}, year = {2024}, note = {R package version 0.0.0.98}, url = {https://github.com/getwilds/sixtyfour}, }"},{"path":"/index.html","id":"sixtyfour","dir":"","previous_headings":"","what":"Humane Interface to AWS","title":"Humane Interface to AWS","text":"science-focused, humane R interface AWS.","code":""},{"path":"/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Humane Interface to AWS","text":"Development version","code":"# install.packages(\"pak\") pak::pak(\"getwilds/sixtyfour\")"},{"path":"/index.html","id":"documentation","dir":"","previous_headings":"","what":"Documentation","title":"Humane Interface to AWS","text":"Go http://getwilds.org/sixtyfour/ sixtyfour package documentation. Go Get Started vignette get started. package leans primarily packages paws s3fs.","code":""},{"path":"/index.html","id":"bugs-features","dir":"","previous_headings":"","what":"Bugs? Features?","title":"Humane Interface to AWS","text":"Open issue issue tracker.","code":""},{"path":"/index.html","id":"contributors","dir":"","previous_headings":"","what":"Contributors","title":"Humane Interface to AWS","text":"See Contributing article","code":""},{"path":"/index.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"Humane Interface to AWS","text":"Please note sixtyfour project released Contributor Code Conduct. contributing project, agree abide terms.","code":""},{"path":"/reference/account_id.html","id":null,"dir":"Reference","previous_headings":"","what":"Get account ID of current user — account_id","title":"Get account ID of current user — account_id","text":"Get account ID current user","code":""},{"path":"/reference/account_id.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get account ID of current user — account_id","text":"","code":"account_id()"},{"path":"/reference/account_id.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get account ID of current user — account_id","text":"list 3 elements: UserId: ID user Account: account ID user Arn: arn user","code":""},{"path":"/reference/account_id.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get account ID of current user — account_id","text":"env var AWS_PROFILE == \"localstack\", return \"000000000000\"","code":""},{"path":"/reference/as_policy_arn.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert a policy name to a policy ARN — as_policy_arn","title":"Convert a policy name to a policy ARN — as_policy_arn","text":"function simply constructs string, checks ARN valid using get_policy","code":""},{"path":"/reference/as_policy_arn.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert a policy name to a policy ARN — as_policy_arn","text":"","code":"as_policy_arn(name, local = FALSE, path = NULL)"},{"path":"/reference/as_policy_arn.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert a policy name to a policy ARN — as_policy_arn","text":"name (character) policy name arn local (logical) TRUE use AWS account managed policies. FALSE, AWS managed policies path (character) NULL, add path ARN name value","code":""},{"path":"/reference/as_policy_arn.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convert a policy name to a policy ARN — as_policy_arn","text":"policy ARN (character)","code":""},{"path":[]},{"path":"/reference/as_policy_arn.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Convert a policy name to a policy ARN — as_policy_arn","text":"","code":"if (FALSE) { as_policy_arn(\"ReadOnlyAccess\") as_policy_arn(\"arn:aws:iam::aws:policy/ReadOnlyAccess\") as_policy_arn(\"AmazonRDSDataFullAccess\") # as_policy_arn(\"Blarp\") # as_policy_arn(letters) # as_policy_arn(5) as_policy_arn(\"MyTestPolicy\", local = TRUE) # returns an arn - and if given an arn returns self as_policy_arn(\"MyTestPolicy\", local = TRUE) %>% as_policy_arn() # path = Job function as_policy_arn(\"Billing\", path = \"job-function\") # path = Service role as_policy_arn(\"AWSCostAndUsageReportAutomationPolicy\", path = \"service-role\" ) }"},{"path":"/reference/aws_billing.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch billing data - with some internal munging for ease of use — aws_billing","title":"Fetch billing data - with some internal munging for ease of use — aws_billing","text":"Fetch billing data - internal munging ease use","code":""},{"path":"/reference/aws_billing.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch billing data - with some internal munging for ease of use — aws_billing","text":"","code":"aws_billing(date_start, date_end = as.character(Sys.Date()))"},{"path":"/reference/aws_billing.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch billing data - with some internal munging for ease of use — aws_billing","text":"date_start, date_end Start end date get billing data . Date format expected: yyyy-MM-dd. required","code":""},{"path":"/reference/aws_billing.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch billing data - with some internal munging for ease of use — aws_billing","text":"tibble columns: id: \"blended\", \"unblended\" date: date, format yyyy-MM-dd service: AWS service name, spelled full linked_account: account number cost: cost USD acronym: short code service; none known, row value service","code":""},{"path":"/reference/aws_billing.html","id":"blended-vs-unblended","dir":"Reference","previous_headings":"","what":"Blended vs. Unblended","title":"Fetch billing data - with some internal munging for ease of use — aws_billing","text":"Unblended: Unblended costs represent usage costs day charged Blended: Blended costs calculated multiplying account’s service usage something called blended rate. blended rate average rate -demand usage, well Savings Plans- reservation-related usage, consumed member accounts organization particular service.","code":""},{"path":"/reference/aws_billing.html","id":"historical-data","dir":"Reference","previous_headings":"","what":"Historical data","title":"Fetch billing data - with some internal munging for ease of use — aws_billing","text":"supply date_start older 14 months prior today's date likely see error like \"enabled historical data beyond 14 months\". See https://docs.aws.amazon.com/cost-management/latest/userguide/ce-advanced-cost-analysis.html #nolint help","code":""},{"path":"/reference/aws_billing.html","id":"references","dir":"Reference","previous_headings":"","what":"References","title":"Fetch billing data - with some internal munging for ease of use — aws_billing","text":"https://www.paws-r-sdk.com/docs/costexplorer/","code":""},{"path":[]},{"path":"/reference/aws_billing.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch billing data - with some internal munging for ease of use — aws_billing","text":"","code":"if (FALSE) { # interactive() library(lubridate) library(dplyr) start_date <- today() - months(13) z <- aws_billing(date_start = start_date) z %>% filter(id == \"blended\") %>% group_by(service) %>% summarise(sum_cost = sum(cost)) %>% filter(sum_cost > 0) %>% arrange(desc(sum_cost)) z %>% filter(id == \"blended\") %>% filter(cost > 0) %>% arrange(service) z %>% filter(id == \"blended\") %>% group_by(service) %>% summarise(sum_cost = sum(cost)) %>% filter(service == \"Amazon Relational Database Service\") }"},{"path":"/reference/aws_billing_raw.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch billing data - rawest form — aws_billing_raw","title":"Fetch billing data - rawest form — aws_billing_raw","text":"Fetch billing data - rawest form","code":""},{"path":"/reference/aws_billing_raw.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch billing data - rawest form — aws_billing_raw","text":"","code":"aws_billing_raw( date_start, metrics, granularity = \"daily\", filter = NULL, group_by = NULL, date_end = as.character(Sys.Date()) )"},{"path":"/reference/aws_billing_raw.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch billing data - rawest form — aws_billing_raw","text":"date_start, date_end Start end date get billing data . Date format expected: yyyy-MM-dd. required metrics (character) metrics return. required. One : AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, UsageQuantity granularity (character) monthly, daily, hourly. required. filter (list) filters costs different dimensions. optional. group_by (list) group costs using two different groups, either dimensions, tag keys, cost categories, two group types. optional.","code":""},{"path":"/reference/aws_billing_raw.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch billing data - rawest form — aws_billing_raw","text":"list slots : NextPageToken GroupDefinitions ResultsByTime DimensionValueAttributes","code":""},{"path":[]},{"path":"/reference/aws_billing_raw.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch billing data - rawest form — aws_billing_raw","text":"","code":"if (FALSE) { # interactive() aws_billing_x(date_start = \"2023-02-01\", metrics = \"BlendedCost\") }"},{"path":"/reference/aws_bucket_create.html","id":null,"dir":"Reference","previous_headings":"","what":"Create an S3 bucket — aws_bucket_create","title":"Create an S3 bucket — aws_bucket_create","text":"Create S3 bucket","code":""},{"path":"/reference/aws_bucket_create.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create an S3 bucket — aws_bucket_create","text":"","code":"aws_bucket_create(bucket, ...)"},{"path":"/reference/aws_bucket_create.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create an S3 bucket — aws_bucket_create","text":"bucket (character) bucket name. required ... named parameters passed create_bucket","code":""},{"path":"/reference/aws_bucket_create.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create an S3 bucket — aws_bucket_create","text":"bucket path (character)","code":""},{"path":"/reference/aws_bucket_create.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Create an S3 bucket — aws_bucket_create","text":"Requires env var AWS_REGION","code":""},{"path":[]},{"path":"/reference/aws_bucket_create.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create an S3 bucket — aws_bucket_create","text":"","code":"if (FALSE) { aws_bucket_create(bucket = \"s64-test-2\") }"},{"path":"/reference/aws_bucket_delete.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete an S3 bucket — aws_bucket_delete","title":"Delete an S3 bucket — aws_bucket_delete","text":"Delete S3 bucket","code":""},{"path":"/reference/aws_bucket_delete.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete an S3 bucket — aws_bucket_delete","text":"","code":"aws_bucket_delete(bucket, force = FALSE, ...)"},{"path":"/reference/aws_bucket_delete.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete an S3 bucket — aws_bucket_delete","text":"bucket (character) bucket name. required force (logical) force deletion without going prompt. default: FALSE. set TRUE required non-interactive use. ... named parameters passed delete_bucket","code":""},{"path":"/reference/aws_bucket_delete.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete an S3 bucket — aws_bucket_delete","text":"NULL, invisibly","code":""},{"path":"/reference/aws_bucket_delete.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Delete an S3 bucket — aws_bucket_delete","text":"Requires env var AWS_REGION. function prompts make sure want delete bucket.","code":""},{"path":[]},{"path":"/reference/aws_bucket_delete.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Delete an S3 bucket — aws_bucket_delete","text":"","code":"if (FALSE) { # interactive() bucket_name <- \"bucket-to-delete-113\" if (!aws_bucket_exists(bucket_name)) { aws_bucket_create(bucket = bucket_name) aws_buckets() aws_bucket_delete(bucket = bucket_name) aws_buckets() } }"},{"path":"/reference/aws_bucket_download.html","id":null,"dir":"Reference","previous_headings":"","what":"Download an S3 bucket — aws_bucket_download","title":"Download an S3 bucket — aws_bucket_download","text":"Download S3 bucket","code":""},{"path":"/reference/aws_bucket_download.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Download an S3 bucket — aws_bucket_download","text":"","code":"aws_bucket_download(bucket, dest_path, ...)"},{"path":"/reference/aws_bucket_download.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Download an S3 bucket — aws_bucket_download","text":"bucket (character) bucket name. required dest_path (character) destination directory store files. required ... named parameters passed s3fs::s3_dir_download()","code":""},{"path":"/reference/aws_bucket_download.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Download an S3 bucket — aws_bucket_download","text":"Requires env var AWS_REGION. function prompts make sure want delete bucket.","code":""},{"path":[]},{"path":"/reference/aws_bucket_download.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Download an S3 bucket — aws_bucket_download","text":"","code":"if (FALSE) { # interactive() bucket <- random_string(\"bucket\") aws_bucket_create(bucket = bucket) desc_file <- file.path(system.file(), \"DESCRIPTION\") aws_file_upload(desc_file, s3_path(bucket, \"DESCRIPTION.txt\")) aws_file_upload(desc_file, s3_path(bucket, \"d_file.txt\")) temp_dir <- file.path(tempdir(), bucket) aws_bucket_download(bucket = bucket, dest_path = temp_dir) fs::dir_ls(temp_dir) # cleanup aws_bucket_delete(\"tmp-bucket-369\") }"},{"path":"/reference/aws_bucket_exists.html","id":null,"dir":"Reference","previous_headings":"","what":"Check if an S3 bucket exists — aws_bucket_exists","title":"Check if an S3 bucket exists — aws_bucket_exists","text":"Check S3 bucket exists","code":""},{"path":"/reference/aws_bucket_exists.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check if an S3 bucket exists — aws_bucket_exists","text":"","code":"aws_bucket_exists(bucket)"},{"path":"/reference/aws_bucket_exists.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check if an S3 bucket exists — aws_bucket_exists","text":"bucket (character) bucket name; must length 1. required","code":""},{"path":"/reference/aws_bucket_exists.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check if an S3 bucket exists — aws_bucket_exists","text":"single boolean (logical)","code":""},{"path":"/reference/aws_bucket_exists.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Check if an S3 bucket exists — aws_bucket_exists","text":"internally uses head_bucket","code":""},{"path":[]},{"path":"/reference/aws_bucket_exists.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Check if an S3 bucket exists — aws_bucket_exists","text":"","code":"if (FALSE) { # exists aws_bucket_exists(bucket = \"s64-test-2\") # does not exist aws_bucket_exists(bucket = \"no-bucket\") }"},{"path":"/reference/aws_bucket_list_objects.html","id":null,"dir":"Reference","previous_headings":"","what":"List objects in an S3 bucket — aws_bucket_list_objects","title":"List objects in an S3 bucket — aws_bucket_list_objects","text":"List objects S3 bucket","code":""},{"path":"/reference/aws_bucket_list_objects.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List objects in an S3 bucket — aws_bucket_list_objects","text":"","code":"aws_bucket_list_objects(bucket, ...)"},{"path":"/reference/aws_bucket_list_objects.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List objects in an S3 bucket — aws_bucket_list_objects","text":"bucket (character) bucket name. required ... named parameters passed list_objects","code":""},{"path":"/reference/aws_bucket_list_objects.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List objects in an S3 bucket — aws_bucket_list_objects","text":"objects found, empty tibble. tibble rows S3 bucket, 8 columns: bucket_name (character) key (character) uri (character) size (fs::bytes) type (character) owner (character) etag (character) last_modified (dttm)","code":""},{"path":[]},{"path":"/reference/aws_bucket_list_objects.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List objects in an S3 bucket — aws_bucket_list_objects","text":"","code":"if (FALSE) { # interactive() bucket_name <- random_string(\"bucket\") if (!aws_bucket_exists(bucket_name)) aws_bucket_create(bucket_name) links_file <- file.path(system.file(), \"Meta/links.rds\") aws_file_upload( links_file, s3_path(bucket_name, basename(links_file)) ) aws_bucket_list_objects(bucket = bucket_name) }"},{"path":"/reference/aws_bucket_tree.html","id":null,"dir":"Reference","previous_headings":"","what":"Print a tree of the objects in a bucket — aws_bucket_tree","title":"Print a tree of the objects in a bucket — aws_bucket_tree","text":"Print tree objects bucket","code":""},{"path":"/reference/aws_bucket_tree.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Print a tree of the objects in a bucket — aws_bucket_tree","text":"","code":"aws_bucket_tree(bucket, recurse = TRUE, ...)"},{"path":"/reference/aws_bucket_tree.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Print a tree of the objects in a bucket — aws_bucket_tree","text":"bucket (character) bucket name; must length 1. required recurse (logical) returns AWS S3 objects lower sub directories, default: TRUE ... Additional arguments passed s3fs::s3_dir_tree()","code":""},{"path":"/reference/aws_bucket_tree.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Print a tree of the objects in a bucket — aws_bucket_tree","text":"character vector objects/files within bucket, printed tree","code":""},{"path":[]},{"path":"/reference/aws_bucket_tree.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Print a tree of the objects in a bucket — aws_bucket_tree","text":"","code":"if (FALSE) { # interactive() bucket_name <- random_string(\"bucket\") if (!aws_bucket_exists(bucket_name)) aws_bucket_create(bucket_name) links_file <- file.path(system.file(), \"Meta/links.rds\") pkgs_file <- file.path(system.file(), \"Meta/package.rds\") demo_file <- file.path(system.file(), \"Meta/demo.rds\") aws_file_upload( c(links_file, pkgs_file, demo_file), s3_path( bucket_name, c( basename(links_file), basename(pkgs_file), basename(demo_file) ) ) ) aws_bucket_tree(bucket_name) # cleanup objs <- aws_bucket_list_objects(bucket_name) aws_file_delete(objs$uri) aws_bucket_delete(bucket_name, force = TRUE) aws_bucket_exists(bucket_name) }"},{"path":"/reference/aws_bucket_upload.html","id":null,"dir":"Reference","previous_headings":"","what":"Upload a folder of files to create an S3 bucket — aws_bucket_upload","title":"Upload a folder of files to create an S3 bucket — aws_bucket_upload","text":"Upload folder files create S3 bucket","code":""},{"path":"/reference/aws_bucket_upload.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Upload a folder of files to create an S3 bucket — aws_bucket_upload","text":"","code":"aws_bucket_upload( path, bucket, max_batch = fs::fs_bytes(\"100MB\"), force = FALSE, ... )"},{"path":"/reference/aws_bucket_upload.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Upload a folder of files to create an S3 bucket — aws_bucket_upload","text":"path (character) local path directory. required bucket (character) bucket name. required max_batch (fs_bytes) maximum batch size uploaded multipart force (logical) force deletion without going prompt. default: FALSE. set TRUE required non-interactive use. ... named parameters passed s3fs::s3_dir_upload()","code":""},{"path":"/reference/aws_bucket_upload.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Upload a folder of files to create an S3 bucket — aws_bucket_upload","text":"s3 format path bucket uploaded ","code":""},{"path":"/reference/aws_bucket_upload.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Upload a folder of files to create an S3 bucket — aws_bucket_upload","text":"upload individual files see aws_file_upload()","code":""},{"path":"/reference/aws_bucket_upload.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Upload a folder of files to create an S3 bucket — aws_bucket_upload","text":"Requires env var AWS_REGION. function prompts make sure want delete bucket.","code":""},{"path":[]},{"path":"/reference/aws_bucket_upload.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Upload a folder of files to create an S3 bucket — aws_bucket_upload","text":"","code":"if (FALSE) { # interactive() library(fs) tdir <- path(tempdir(), \"apples\") dir.create(tdir) tfiles <- replicate(n = 10, file_temp(tmp_dir = tdir, ext = \".txt\")) invisible(lapply(tfiles, function(x) write.csv(mtcars, x))) bucket_name <- random_string(\"bucket\") if (!aws_bucket_exists(bucket_name)) aws_bucket_create(bucket_name) aws_bucket_upload(path = tdir, bucket = bucket_name) aws_bucket_list_objects(bucket_name) # cleanup objs <- aws_bucket_list_objects(bucket_name) aws_file_delete(objs$uri) aws_bucket_list_objects(bucket_name) aws_bucket_delete(bucket_name, force = TRUE) aws_bucket_exists(bucket_name) }"},{"path":"/reference/aws_buckets.html","id":null,"dir":"Reference","previous_headings":"","what":"List S3 buckets — aws_buckets","title":"List S3 buckets — aws_buckets","text":"List S3 buckets","code":""},{"path":"/reference/aws_buckets.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List S3 buckets — aws_buckets","text":"","code":"aws_buckets(...)"},{"path":"/reference/aws_buckets.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List S3 buckets — aws_buckets","text":"... named parameters passed list_objects","code":""},{"path":"/reference/aws_buckets.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List S3 buckets — aws_buckets","text":"objects found, empty tibble. tibble rows S3 bucket, 8 columns: bucket_name (character) key (character) uri (character) size (fs::bytes) type (character) owner (character) etag (character) last_modified (dttm)","code":""},{"path":"/reference/aws_buckets.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"List S3 buckets — aws_buckets","text":"internally uses s3fs::s3_dir_info()","code":""},{"path":"/reference/aws_buckets.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"List S3 buckets — aws_buckets","text":"set refresh=TRUE internally make sure return date information buckets rather cached locally","code":""},{"path":[]},{"path":"/reference/aws_buckets.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List S3 buckets — aws_buckets","text":"","code":"if (FALSE) { aws_buckets() }"},{"path":"/reference/aws_db_cluster_status.html","id":null,"dir":"Reference","previous_headings":"","what":"Get cluster status — aws_db_cluster_status","title":"Get cluster status — aws_db_cluster_status","text":"Get cluster status","code":""},{"path":"/reference/aws_db_cluster_status.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get cluster status — aws_db_cluster_status","text":"","code":"aws_db_cluster_status(id)"},{"path":"/reference/aws_db_cluster_status.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get cluster status — aws_db_cluster_status","text":"id (character) Cluster identifier. Use identifier refer cluster subsequent cluster operations deleting modifying. identifier also appears Amazon Redshift console. Must unique clusters within Amazon Web Services account.","code":""},{"path":"/reference/aws_db_cluster_status.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get cluster status — aws_db_cluster_status","text":"(character) status cluster, e.g., \"creating\", \"available\", \"found\"","code":""},{"path":[]},{"path":"/reference/aws_db_cluster_status.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get cluster status — aws_db_cluster_status","text":"","code":"if (FALSE) { aws_db_cluster_status(id = \"scotts-test-cluster-456\") }"},{"path":"/reference/aws_db_instance_status.html","id":null,"dir":"Reference","previous_headings":"","what":"Get instance status — aws_db_instance_status","title":"Get instance status — aws_db_instance_status","text":"Get instance status","code":""},{"path":"/reference/aws_db_instance_status.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get instance status — aws_db_instance_status","text":"","code":"aws_db_instance_status(id)"},{"path":"/reference/aws_db_instance_status.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get instance status — aws_db_instance_status","text":"id (character) required. instance identifier. identifier DB instance. parameter stored lowercase string. Constraints: must contain 1 63 letters, numbers, hyphens; first character must letter; end hyphen contain two consecutive hyphens. required.","code":""},{"path":"/reference/aws_db_instance_status.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get instance status — aws_db_instance_status","text":"(character) status instance, e.g., \"creating\", \"available\", \"found\"","code":""},{"path":[]},{"path":"/reference/aws_db_instance_status.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get instance status — aws_db_instance_status","text":"","code":"if (FALSE) { aws_db_instance_status(id = \"thedbinstance\") }"},{"path":"/reference/aws_db_rds_con.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a database connection to Amazon RDS — aws_db_rds_con","title":"Get a database connection to Amazon RDS — aws_db_rds_con","text":"Supports: MariaDB, MySQL, Postgres","code":""},{"path":"/reference/aws_db_rds_con.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a database connection to Amazon RDS — aws_db_rds_con","text":"","code":"aws_db_rds_con( user = NULL, pwd = NULL, id = NULL, host = NULL, port = NULL, dbname = NULL, engine = NULL, ... )"},{"path":"/reference/aws_db_rds_con.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a database connection to Amazon RDS — aws_db_rds_con","text":"user, pwd, host, port, dbname, ... named parameters passed DBI::dbConnect. Note user pwd AWS IAM account; used create cluster aws_db_redshift_create() id (character) Cluster identifier. supply id, fetch host, port, dbname. id supplied. supply host, port, dbname. Refer parameter definition aws_db_redshift_create() details. engine (character) engine use. optional user, pwd, id supplied - otherwise required","code":""},{"path":"/reference/aws_db_rds_con.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get a database connection to Amazon RDS — aws_db_rds_con","text":"RDS supports many databases, provide support MariaDB, MySQL, Postgres engine chosen RDS instance supported function, can likely connect ","code":""},{"path":[]},{"path":"/reference/aws_db_rds_con.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get a database connection to Amazon RDS — aws_db_rds_con","text":"","code":"if (FALSE) { con_rds <- aws_db_rds_con(\"\") con_rds library(DBI) library(RMariaDB) dbListTables(con_rds) dbWriteTable(con_rds, \"mtcars\", mtcars) dbListTables(con_rds) dbReadTable(con_rds, \"mtcars\") library(dplyr) tbl(con_rds, \"mtcars\") }"},{"path":"/reference/aws_db_rds_create.html","id":null,"dir":"Reference","previous_headings":"","what":"Create an RDS cluster — aws_db_rds_create","title":"Create an RDS cluster — aws_db_rds_create","text":"Create RDS cluster","code":""},{"path":"/reference/aws_db_rds_create.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create an RDS cluster — aws_db_rds_create","text":"","code":"aws_db_rds_create( id, class, user = NULL, pwd = NULL, dbname = \"dev\", engine = \"mariadb\", storage = 20, storage_encrypted = TRUE, security_group_ids = NULL, wait = TRUE, verbose = TRUE, aws_secrets = TRUE, iam_database_auth = FALSE, ... )"},{"path":"/reference/aws_db_rds_create.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create an RDS cluster — aws_db_rds_create","text":"id (character) required. instance identifier. identifier DB instance. parameter stored lowercase string. Constraints: must contain 1 63 letters, numbers, hyphens; first character must letter; end hyphen contain two consecutive hyphens. required. class (character) required. compute memory capacity DB instance, example db.m5.large. user (character) User name associated admin user account cluster created. NULL, generate random user name, see random_user() pwd (character) Password associated admin user account cluster created. NULL, generate random password aws_secrets_pwd() (uses AWS Secrets Manager service) dbname (character) name first database created cluster created. default: \"dev\". additional databases can created within cluster engine (character) engine use. default: \"mariadb\". required. one : mariadb, mysql, postgres storage (character) amount storage gibibytes (GiB) allocate DB instance. default: 20 storage_encrypted (logical) Whether DB instance encrypted. default: TRUE security_group_ids (character) VPC security group identifiers; one . none supplied, go AWS Redshift dashboard add appropriate VPC security group. wait (logical) wait cluster initialize? default: TRUE. wait (FALSE) many operations can cluster available. wait=FALSE use aws_db_instance_status() check cluster status. verbose (logical) verbose informational output? default: TRUE aws_secrets (logical) manage database credentials AWS Secrets Manager? default: TRUE iam_database_auth (logical) Use IAM database authentication? default: FALSE ... named parameters passed create_db_instance","code":""},{"path":"/reference/aws_db_rds_create.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create an RDS cluster — aws_db_rds_create","text":"returns NULL, function called side effect creating RDS instance","code":""},{"path":"/reference/aws_db_rds_create.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Create an RDS cluster — aws_db_rds_create","text":"See link create_db_instance docs details requirements parameter Note even though can use option engine function, may provide ability connect chosen data source package.","code":""},{"path":"/reference/aws_db_rds_create.html","id":"waiting","dir":"Reference","previous_headings":"","what":"Waiting","title":"Create an RDS cluster — aws_db_rds_create","text":"Note wait = TRUE function waits instance available returning. wait can around 5 - 7 minutes. can instead set wait = FALSE check status instance AWS dashboard.","code":""},{"path":[]},{"path":"/reference/aws_db_rds_list.html","id":null,"dir":"Reference","previous_headings":"","what":"Get information for all RDS instances — aws_db_rds_list","title":"Get information for all RDS instances — aws_db_rds_list","text":"Get information RDS instances","code":""},{"path":"/reference/aws_db_rds_list.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get information for all RDS instances — aws_db_rds_list","text":"","code":"aws_db_rds_list()"},{"path":"/reference/aws_db_rds_list.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get information for all RDS instances — aws_db_rds_list","text":"tibble instance details; see https://www.paws-r-sdk.com/docs/describe_db_instances/ empty tibble instances found","code":""},{"path":[]},{"path":"/reference/aws_db_rds_list.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get information for all RDS instances — aws_db_rds_list","text":"","code":"if (FALSE) { # interactive() aws_db_rds_list() }"},{"path":"/reference/aws_db_redshift_con.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a database connection to Amazon Redshift — aws_db_redshift_con","title":"Get a database connection to Amazon Redshift — aws_db_redshift_con","text":"Get database connection Amazon Redshift","code":""},{"path":"/reference/aws_db_redshift_con.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a database connection to Amazon Redshift — aws_db_redshift_con","text":"","code":"aws_db_redshift_con( user, pwd, id = NULL, host = NULL, port = NULL, dbname = NULL, ... )"},{"path":"/reference/aws_db_redshift_con.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a database connection to Amazon Redshift — aws_db_redshift_con","text":"user, pwd, host, port, dbname, ... named parameters passed DBI::dbConnect. Note user pwd AWS IAM account; used create cluster aws_db_redshift_create() id (character) Cluster identifier. supply id, fetch host, port, dbname. id supplied. supply host, port, dbname. Refer parameter definition aws_db_redshift_create() details.","code":""},{"path":"/reference/aws_db_redshift_con.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a database connection to Amazon Redshift — aws_db_redshift_con","text":"object class RedshiftConnection","code":""},{"path":"/reference/aws_db_redshift_con.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get a database connection to Amazon Redshift — aws_db_redshift_con","text":"connection returned created using RPostgres can manage Redshift programatically via paws::redshift","code":""},{"path":[]},{"path":"/reference/aws_db_redshift_con.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get a database connection to Amazon Redshift — aws_db_redshift_con","text":"","code":"if (FALSE) { library(DBI) library(RPostgres) con_rshift <- aws_db_redshift_con(\"\") con_rshift library(RPostgres) dbListTables(con_rshift) dbWriteTable(con_rshift, \"mtcars\", mtcars) dbListTables(con_rshift) library(dplyr) tbl(con_rshift, \"mtcars\") }"},{"path":"/reference/aws_db_redshift_create.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a Redshift cluster — aws_db_redshift_create","title":"Create a Redshift cluster — aws_db_redshift_create","text":"Create Redshift cluster","code":""},{"path":"/reference/aws_db_redshift_create.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a Redshift cluster — aws_db_redshift_create","text":"","code":"aws_db_redshift_create( id, user, pwd, dbname = \"dev\", cluster_type = \"multi-node\", node_type = \"dc2.large\", number_nodes = 2, security_group_ids = NULL, wait = TRUE, verbose = TRUE, ... )"},{"path":"/reference/aws_db_redshift_create.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a Redshift cluster — aws_db_redshift_create","text":"id (character) Cluster identifier. Use identifier refer cluster subsequent cluster operations deleting modifying. identifier also appears Amazon Redshift console. Must unique clusters within Amazon Web Services account. user (character) User name associated admin user account cluster created. username IAM account pwd (character) Password associated admin user account cluster created. password IAM account dbname (character) name first database created cluster created. default: \"dev\". additional databases can created within cluster cluster_type (character) type cluster: \"single-node\" \"multi-node\" (default). node_type (character) node type provisioned cluster. defaul: \"dc2.large\" number_nodes (integer/numeric) number nodes; multi-node cluster type, must 2 greater. default: 2 security_group_ids (character) VPC security group identifiers; one . none supplied, go AWS Redshift dashboard add appropriate VPC security group. wait (logical) wait cluster initialize? default: TRUE. wait (FALSE) many operations can cluster available. wait=FALSE use aws_db_cluster_status() check cluster status. verbose (logical) verbose informational output? default: TRUE ... named parameters passed create_cluster","code":""},{"path":"/reference/aws_db_redshift_create.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a Redshift cluster — aws_db_redshift_create","text":"returns NULL, function called side effect creating Redshift instance","code":""},{"path":"/reference/aws_db_redshift_create.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Create a Redshift cluster — aws_db_redshift_create","text":"See link create_cluster docs details requirements parameter","code":""},{"path":"/reference/aws_db_redshift_create.html","id":"waiting","dir":"Reference","previous_headings":"","what":"Waiting","title":"Create a Redshift cluster — aws_db_redshift_create","text":"Note wait = TRUE function waits instance available returning. wait can around 5 - 7 minutes. can instead set wait = FALSE check status instance AWS dashboard.","code":""},{"path":[]},{"path":"/reference/aws_file_attr.html","id":null,"dir":"Reference","previous_headings":"","what":"File attributes — aws_file_attr","title":"File attributes — aws_file_attr","text":"File attributes","code":""},{"path":"/reference/aws_file_attr.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"File attributes — aws_file_attr","text":"","code":"aws_file_attr(remote_path)"},{"path":"/reference/aws_file_attr.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"File attributes — aws_file_attr","text":"remote_path (character) one remote S3 paths. required","code":""},{"path":"/reference/aws_file_attr.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"File attributes — aws_file_attr","text":"tibble many columns, number rows matching length remote_path","code":""},{"path":"/reference/aws_file_attr.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"File attributes — aws_file_attr","text":"uses s3fs::s3_file_info() internally","code":""},{"path":[]},{"path":"/reference/aws_file_attr.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"File attributes — aws_file_attr","text":"","code":"if (FALSE) { # files one by one aws_file_attr(s3_path(\"s64-test-2\", \"DESCRIPTION\")) aws_file_attr(s3_path(\"s64-test-2\", \"ddd\")) aws_file_attr(s3_path(\"s64-test-2\", \"doesntexist\")) # or all together aws_file_attr(s3_path(\"s64-test-2\", c(\"DESCRIPTION\", \"ddd\"))) }"},{"path":"/reference/aws_file_copy.html","id":null,"dir":"Reference","previous_headings":"","what":"Copy files between buckets — aws_file_copy","title":"Copy files between buckets — aws_file_copy","text":"Copy files buckets","code":""},{"path":"/reference/aws_file_copy.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Copy files between buckets — aws_file_copy","text":"","code":"aws_file_copy(remote_path, bucket, force = FALSE, ...)"},{"path":"/reference/aws_file_copy.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Copy files between buckets — aws_file_copy","text":"remote_path (character) one remote S3 paths. required bucket (character) bucket copy files . required. bucket exist prompt asking like bucket created force (logical) force bucket creation without going prompt. default: FALSE. set TRUE required non-interactive use. ... named parameters passed s3fs::s3_file_copy()","code":""},{"path":"/reference/aws_file_copy.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Copy files between buckets — aws_file_copy","text":"vector paths, length matches length(remote_path)","code":""},{"path":[]},{"path":"/reference/aws_file_copy.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Copy files between buckets — aws_file_copy","text":"","code":"if (FALSE) { # create files in an existing bucket tfiles <- replicate(n = 3, tempfile()) for (i in tfiles) cat(\"Hello\\nWorld\\n\", file = i) paths <- s3_path(\"s64-test-2\", c(\"aaa\", \"bbb\", \"ccc\"), ext = \"txt\") aws_file_upload(tfiles, paths) # create a new bucket new_bucket <- aws_bucket_create(bucket = \"s64-test-3\") # add existing files to the new bucket aws_file_copy(paths, path_as_s3(new_bucket)) # create bucket that doesn't exist yet aws_file_copy(paths, \"s64-test-4\") }"},{"path":"/reference/aws_file_delete.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete a file — aws_file_delete","title":"Delete a file — aws_file_delete","text":"Delete file","code":""},{"path":"/reference/aws_file_delete.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete a file — aws_file_delete","text":"","code":"aws_file_delete(remote_path, ...)"},{"path":"/reference/aws_file_delete.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete a file — aws_file_delete","text":"remote_path (character) one remote S3 paths. required ... named parameters passed delete_object","code":""},{"path":"/reference/aws_file_delete.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete a file — aws_file_delete","text":"NULL invisibly","code":""},{"path":[]},{"path":"/reference/aws_file_delete.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Delete a file — aws_file_delete","text":"","code":"if (FALSE) { # create a file tfile <- tempfile() cat(\"Hello World!\", file = tfile) aws_file_upload(remote_path = \"s3://s64-test-2\", path = tfile) # delete the file aws_file_delete(s3_path(\"s64-test-2\", basename(tfile))) # file does not exist - no error is raised aws_file_delete(s3_path(\"s64-test-2\", \"TESTING123\")) }"},{"path":"/reference/aws_file_download.html","id":null,"dir":"Reference","previous_headings":"","what":"Download a file — aws_file_download","title":"Download a file — aws_file_download","text":"Download file","code":""},{"path":"/reference/aws_file_download.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Download a file — aws_file_download","text":"","code":"aws_file_download(remote_path, path, ...)"},{"path":"/reference/aws_file_download.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Download a file — aws_file_download","text":"remote_path (character) one remote S3 paths. required path (character) one file paths write . required ... named parameters passed s3fs::s3_file_download()","code":""},{"path":"/reference/aws_file_download.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Download a file — aws_file_download","text":"(character) vector local file paths","code":""},{"path":[]},{"path":"/reference/aws_file_download.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Download a file — aws_file_download","text":"","code":"if (FALSE) { tfile <- tempfile() aws_file_download(remote_path = \"s3://s64-test-2/DESCRIPTION\", path = tfile) # many files tfiles <- replicate(n = 3, tempfile()) aws_file_download( remote_path = s3_path(\"s64-test-2\", c(\"a_file\", \"c_file\", \"d_file\")), path = tfiles ) ## length of `remote_path` and `path` must be the same tfiles <- replicate(n = 2, tempfile()) aws_file_download( remote_path = s3_path(\"s64-test-2\", c(\"a_file\", \"c_file\", \"d_file\")), path = tfiles ) # S3 file does not exist temp_path <- tempfile() aws_file_download(s3_path(\"s64-test-2\", \"TESTING123\"), temp_path) }"},{"path":"/reference/aws_file_exists.html","id":null,"dir":"Reference","previous_headings":"","what":"Check if a file exists — aws_file_exists","title":"Check if a file exists — aws_file_exists","text":"Check file exists","code":""},{"path":"/reference/aws_file_exists.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check if a file exists — aws_file_exists","text":"","code":"aws_file_exists(remote_path)"},{"path":"/reference/aws_file_exists.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check if a file exists — aws_file_exists","text":"remote_path (character) one remote S3 paths. required","code":""},{"path":"/reference/aws_file_exists.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check if a file exists — aws_file_exists","text":"vector booleans (TRUE FALSE), length matches length(remote_path)","code":""},{"path":[]},{"path":"/reference/aws_file_exists.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Check if a file exists — aws_file_exists","text":"","code":"if (FALSE) { aws_file_exists(s3_path(\"s64-test-2\", \"DESCRIPTION\")) aws_file_exists(s3_path(\"s64-test-2\", \"doesntexist\")) aws_file_exists(s3_path(\"s64-test-2\", c(\"DESCRIPTION\", \"doesntexist\"))) }"},{"path":"/reference/aws_file_rename.html","id":null,"dir":"Reference","previous_headings":"","what":"Rename a remote file — aws_file_rename","title":"Rename a remote file — aws_file_rename","text":"Rename remote file","code":""},{"path":"/reference/aws_file_rename.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Rename a remote file — aws_file_rename","text":"","code":"aws_file_rename(remote_path, new_remote_path, ...)"},{"path":"/reference/aws_file_rename.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rename a remote file — aws_file_rename","text":"remote_path (character) one remote S3 paths. required new_remote_path (character) one remote S3 paths. required. length must match remote_path ... named parameters passed s3fs::s3_file_move()","code":""},{"path":"/reference/aws_file_rename.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Rename a remote file — aws_file_rename","text":"vector paths, length matches length(remote_path)","code":""},{"path":[]},{"path":"/reference/aws_file_rename.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Rename a remote file — aws_file_rename","text":"","code":"if (FALSE) { aws_file_rename( s3_path(\"s64-test-2\", \"DESCRIPTION\"), s3_path(\"s64-test-2\", \"DESC\") ) tfiles <- replicate(n = 3, tempfile()) for (i in tfiles) cat(\"Hello\\nWorld\\n\", file = i) paths <- s3_path(\"s64-test-2\", c(\"aaa\", \"bbb\", \"ccc\"), ext = \"txt\") aws_file_upload(tfiles, paths) new_paths <- s3_path(\"s64-test-2\", c(\"new_aaa\", \"new_bbb\", \"new_ccc\"), ext = \"txt\" ) aws_file_rename(paths, new_paths) }"},{"path":"/reference/aws_file_upload.html","id":null,"dir":"Reference","previous_headings":"","what":"Upload a file — aws_file_upload","title":"Upload a file — aws_file_upload","text":"Upload file","code":""},{"path":"/reference/aws_file_upload.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Upload a file — aws_file_upload","text":"","code":"aws_file_upload(path, remote_path, ...)"},{"path":"/reference/aws_file_upload.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Upload a file — aws_file_upload","text":"path (character) file path read . required remote_path (character) remote path file go. required ... named parameters passed s3fs::s3_file_copy()","code":""},{"path":"/reference/aws_file_upload.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Upload a file — aws_file_upload","text":"(character) vector remote s3 paths","code":""},{"path":"/reference/aws_file_upload.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Upload a file — aws_file_upload","text":"upload folder files see aws_bucket_upload()","code":""},{"path":[]},{"path":"/reference/aws_file_upload.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Upload a file — aws_file_upload","text":"","code":"if (FALSE) { # interactive() bucket <- random_string(\"bucket\") aws_bucket_create(bucket) demo_rds_file <- file.path(system.file(), \"Meta/demo.rds\") aws_file_upload( demo_rds_file, s3_path(bucket, basename(demo_rds_file)) ) ## many files at once links_file <- file.path(system.file(), \"Meta/links.rds\") aws_file_upload( c(demo_rds_file, links_file), s3_path(\"s64-test-2\", c(basename(demo_rds_file), basename(links_file))) ) # set expiration, expire 1 minute from now aws_file_upload(demo_rds_file, s3_path(\"s64-test-2\", \"ddd.rds\"), Expires = Sys.time() + 60 ) # bucket doesn't exist aws_file_upload(demo_rds_file, \"s3://not-a-bucket/eee.rds\") # path doesn't exist aws_file_upload( \"file_doesnt_exist.txt\", s3_path(\"s64-test-2\", \"file_doesnt_exist.txt\") ) # Path's without file extensions behave a little weird ## With extension ## Both of these lines do the same exact thing: make a file in the ## same path in a bucket aws_file_upload(\"LICENSE.md\", s3_path(bucket, \"LICENSE.md\")) aws_file_upload(\"LICENSE.md\", s3_path(bucket)) ## Without extension ## However, it's different for a file without an extension ## This makes a file in the bucket at path DESCRIPTION aws_file_upload(\"DESCRIPTION\", s3_path(bucket)) ## Whereas this creates a directory called DESCRIPTION with ## a file DESCRIPTION within it aws_file_upload(\"DESCRIPTION\", s3_path(bucket, \"DESCRIPTION\")) }"},{"path":"/reference/aws_group.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a group — aws_group","title":"Get a group — aws_group","text":"Get group","code":""},{"path":"/reference/aws_group.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a group — aws_group","text":"","code":"aws_group(name)"},{"path":"/reference/aws_group.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a group — aws_group","text":"name (character) group name","code":""},{"path":"/reference/aws_group.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a group — aws_group","text":"named list slots : group: information group (tibble) users: users group (tibble) policies (character) attached_policies (tibble)","code":""},{"path":"/reference/aws_group.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get a group — aws_group","text":"see docs https://www.paws-r-sdk.com/docs/iam_get_group/","code":""},{"path":[]},{"path":"/reference/aws_group.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get a group — aws_group","text":"","code":"if (FALSE) { aws_group(name = \"users\") }"},{"path":"/reference/aws_group_create.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a group — aws_group_create","title":"Create a group — aws_group_create","text":"Create group","code":""},{"path":"/reference/aws_group_create.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a group — aws_group_create","text":"","code":"aws_group_create(name, path = NULL)"},{"path":"/reference/aws_group_create.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a group — aws_group_create","text":"name (character) group name. required path (character) path group name. optional. included, defaults slash (/).","code":""},{"path":"/reference/aws_group_create.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a group — aws_group_create","text":"tibble information group created","code":""},{"path":"/reference/aws_group_create.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Create a group — aws_group_create","text":"See https://www.paws-r-sdk.com/docs/iam_create_group/ docs details parameters","code":""},{"path":[]},{"path":"/reference/aws_group_create.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a group — aws_group_create","text":"","code":"if (FALSE) { aws_group_create(\"testgroup\") }"},{"path":"/reference/aws_group_delete.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete a group — aws_group_delete","title":"Delete a group — aws_group_delete","text":"Delete group","code":""},{"path":"/reference/aws_group_delete.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete a group — aws_group_delete","text":"","code":"aws_group_delete(name)"},{"path":"/reference/aws_group_delete.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete a group — aws_group_delete","text":"name (character) group name. required","code":""},{"path":"/reference/aws_group_delete.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete a group — aws_group_delete","text":"empty list","code":""},{"path":"/reference/aws_group_delete.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Delete a group — aws_group_delete","text":"See https://www.paws-r-sdk.com/docs/iam_delete_group/ docs details","code":""},{"path":[]},{"path":"/reference/aws_group_delete.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Delete a group — aws_group_delete","text":"","code":"if (FALSE) { aws_group_delete(name = \"testgroup\") }"},{"path":"/reference/aws_group_exists.html","id":null,"dir":"Reference","previous_headings":"","what":"Check if a group exists — aws_group_exists","title":"Check if a group exists — aws_group_exists","text":"Check group exists","code":""},{"path":"/reference/aws_group_exists.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check if a group exists — aws_group_exists","text":"","code":"aws_group_exists(name)"},{"path":"/reference/aws_group_exists.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check if a group exists — aws_group_exists","text":"name (character) group name","code":""},{"path":"/reference/aws_group_exists.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check if a group exists — aws_group_exists","text":"single boolean","code":""},{"path":"/reference/aws_group_exists.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Check if a group exists — aws_group_exists","text":"uses aws_group internally. see docs https://www.paws-r-sdk.com/docs/iam_get_group/","code":""},{"path":[]},{"path":"/reference/aws_group_exists.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Check if a group exists — aws_group_exists","text":"","code":"if (FALSE) { aws_group_exists(name = \"users\") aws_group_exists(name = \"apples\") }"},{"path":"/reference/aws_groups.html","id":null,"dir":"Reference","previous_headings":"","what":"List all groups or groups for a single user — aws_groups","title":"List all groups or groups for a single user — aws_groups","text":"List groups groups single user","code":""},{"path":"/reference/aws_groups.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List all groups or groups for a single user — aws_groups","text":"","code":"aws_groups(username = NULL, ...)"},{"path":"/reference/aws_groups.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List all groups or groups for a single user — aws_groups","text":"username (character) username. optional ... parameters passed paws list_groups_for_user username non-NULL, otherwise passed list_users","code":""},{"path":"/reference/aws_groups.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List all groups or groups for a single user — aws_groups","text":"tibble information groups","code":""},{"path":[]},{"path":"/reference/aws_groups.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List all groups or groups for a single user — aws_groups","text":"","code":"if (FALSE) { aws_groups() aws_groups(username = aws_user_current()) }"},{"path":"/reference/aws_policies.html","id":null,"dir":"Reference","previous_headings":"","what":"List policies — aws_policies","title":"List policies — aws_policies","text":"List policies","code":""},{"path":"/reference/aws_policies.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List policies — aws_policies","text":"","code":"aws_policies(refresh = FALSE, ...)"},{"path":"/reference/aws_policies.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List policies — aws_policies","text":"refresh (logical) refresh results? default: FALSE. invalidate cache refresh policy data, set refresh=TRUE ... named arguments passed list_policies","code":""},{"path":"/reference/aws_policies.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List policies — aws_policies","text":"tibble information policies. row policy. Columns: PolicyName PolicyId Path Arn CreateDate UpdateDate AttachmentCount PermissionsBoundaryUsageCount IsAttachable Description Tags","code":""},{"path":"/reference/aws_policies.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"List policies — aws_policies","text":"uses memoise internally cache results speed subsequent calls function","code":""},{"path":[]},{"path":"/reference/aws_policies.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List policies — aws_policies","text":"","code":"if (FALSE) { aws_policies() aws_policies() aws_policies(refresh = TRUE) }"},{"path":"/reference/aws_policy.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a policy — aws_policy","title":"Get a policy — aws_policy","text":"Get policy","code":""},{"path":"/reference/aws_policy.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a policy — aws_policy","text":"","code":"aws_policy(name, local = FALSE, path = NULL)"},{"path":"/reference/aws_policy.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a policy — aws_policy","text":"name (character) policy name arn local (logical) TRUE use AWS account managed policies. FALSE, AWS managed policies path (character) NULL, add path ARN name value","code":""},{"path":"/reference/aws_policy.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a policy — aws_policy","text":"tibble policy details","code":""},{"path":"/reference/aws_policy.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get a policy — aws_policy","text":"see docs https://www.paws-r-sdk.com/docs/iam_get_policy/","code":""},{"path":[]},{"path":"/reference/aws_policy.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get a policy — aws_policy","text":"","code":"if (FALSE) { aws_policy(\"ReadOnlyAccess\") aws_policy(\"arn:aws:iam::aws:policy/ReadOnlyAccess\") }"},{"path":"/reference/aws_policy_attach.html","id":null,"dir":"Reference","previous_headings":"","what":"Attach a policy to a user, group, or role — aws_policy_attach","title":"Attach a policy to a user, group, or role — aws_policy_attach","text":"Attach policy user, group, role","code":""},{"path":"/reference/aws_policy_attach.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Attach a policy to a user, group, or role — aws_policy_attach","text":"","code":"aws_policy_attach(.x, policy)"},{"path":"/reference/aws_policy_attach.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Attach a policy to a user, group, or role — aws_policy_attach","text":".x result call create get method user, group, role policy (character) policy name ARN","code":""},{"path":"/reference/aws_policy_attach.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Attach a policy to a user, group, or role — aws_policy_attach","text":"tibble information policies","code":""},{"path":[]},{"path":"/reference/aws_policy_attach.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Attach a policy to a user, group, or role — aws_policy_attach","text":"","code":"if (FALSE) { aws_policy(\"AmazonRDSDataFullAccess\") aws_user() %>% aws_policy_attach(\"AmazonRDSDataFullAccess\") aws_user()$attached_policies # aws_role(\"OrganizationAccountSecurityRole\") %>% # aws_policy_attach(\"ReadOnlyAccess\") }"},{"path":"/reference/aws_policy_create.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a policy — aws_policy_create","title":"Create a policy — aws_policy_create","text":"Create policy","code":""},{"path":"/reference/aws_policy_create.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a policy — aws_policy_create","text":"","code":"aws_policy_create(name, document, path = NULL, description = NULL, tags = NULL)"},{"path":"/reference/aws_policy_create.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a policy — aws_policy_create","text":"name (character) policy name. required document (character) policy document want use content new policy. required. path (character) path policy. given default \"/\". optional description (character) friendly description policy. optional. changed assigning tags (character) vector tags want attach new IAM policy. tag consists key name associated value. optional","code":""},{"path":"/reference/aws_policy_create.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a policy — aws_policy_create","text":"tibble policy details","code":""},{"path":"/reference/aws_policy_create.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Create a policy — aws_policy_create","text":"see docs https://www.paws-r-sdk.com/docs/iam_create_policy/","code":""},{"path":[]},{"path":"/reference/aws_policy_create.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a policy — aws_policy_create","text":"","code":"if (FALSE) { # interactive() doc <- aws_policy_document_create( region = \"us-east-2\", account_id = \"1234567890\", resource_id = \"*\", user = \"jane_doe\", action = \"rds-db:connect\" ) aws_policy_create(\"RdsAllow123\", document = doc) # cleanup aws_policy_delete(\"RdsAllow123\") }"},{"path":"/reference/aws_policy_delete.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete a user managed policy — aws_policy_delete","title":"Delete a user managed policy — aws_policy_delete","text":"Delete user managed policy","code":""},{"path":"/reference/aws_policy_delete.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete a user managed policy — aws_policy_delete","text":"","code":"aws_policy_delete(name)"},{"path":"/reference/aws_policy_delete.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete a user managed policy — aws_policy_delete","text":"name (character) policy name. required. within function lookup policy arn passed AWS API","code":""},{"path":"/reference/aws_policy_delete.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete a user managed policy — aws_policy_delete","text":"invisibly returns nothing","code":""},{"path":"/reference/aws_policy_delete.html","id":"aws-managed-policies","dir":"Reference","previous_headings":"","what":"AWS managed policies","title":"Delete a user managed policy — aws_policy_delete","text":"can delete AWS managed policies.","code":""},{"path":"/reference/aws_policy_delete.html","id":"deleting-process-adapted-from-paws-docs-","dir":"Reference","previous_headings":"","what":"Deleting process (adapted from paws docs)","title":"Delete a user managed policy — aws_policy_delete","text":"can delete managed policy, must first detach policy users, groups, roles attached . addition, must delete policy's versions. following steps describe process deleting managed policy: Detach policy users, groups, roles policy attached using aws_policy_attach(). list users, groups, roles policy attached use aws_policy_list_entities() Delete versions policy using aws_policy_delete_version(). list policy's versions, use aws_policy_list_versions(). use aws_policy_delete_version() delete version marked default version. delete policy's default version next step process. Delete policy using function (automatically deletes policy's default version)","code":""},{"path":"/reference/aws_policy_delete.html","id":"references","dir":"Reference","previous_headings":"","what":"References","title":"Delete a user managed policy — aws_policy_delete","text":"delete_policy","code":""},{"path":[]},{"path":"/reference/aws_policy_delete.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Delete a user managed policy — aws_policy_delete","text":"","code":"if (FALSE) { # interactive() doc <- aws_policy_document_create( region = \"us-east-2\", account_id = \"1234567890\", resource_id = \"*\", user = \"jane_doe\", action = \"rds-db:connect\" ) aws_policy_create(\"RdsAllow456\", document = doc) aws_policy_delete(\"RdsAllow456\") }"},{"path":"/reference/aws_policy_delete_version.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete a policy version — aws_policy_delete_version","title":"Delete a policy version — aws_policy_delete_version","text":"Delete policy version","code":""},{"path":"/reference/aws_policy_delete_version.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete a policy version — aws_policy_delete_version","text":"","code":"aws_policy_delete_version(name, version_id)"},{"path":"/reference/aws_policy_delete_version.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete a policy version — aws_policy_delete_version","text":"name (character) policy name. required. within function lookup policy arn passed AWS API version_id (character) policy version delete. required. Allows (via regex) string characters consists lowercase letter 'v' followed one two digits, optionally followed period '.' string letters digits.","code":""},{"path":"/reference/aws_policy_delete_version.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete a policy version — aws_policy_delete_version","text":"invisibly returns nothing","code":""},{"path":"/reference/aws_policy_delete_version.html","id":"references","dir":"Reference","previous_headings":"","what":"References","title":"Delete a policy version — aws_policy_delete_version","text":"https://www.paws-r-sdk.com/docs/iam_delete_policy_version/","code":""},{"path":[]},{"path":"/reference/aws_policy_delete_version.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Delete a policy version — aws_policy_delete_version","text":"","code":"if (FALSE) { # interactive() doc <- aws_policy_document_create( region = \"us-east-2\", account_id = \"1234567890\", resource_id = \"*\", user = \"jane_doe\", action = \"rds-db:connect\" ) aws_policy_create(\"RdsAllow456\", document = doc) aws_policy_delete_version(\"RdsAllow456\", \"v1\") }"},{"path":"/reference/aws_policy_detach.html","id":null,"dir":"Reference","previous_headings":"","what":"Detach a policy from a user, group, or role — aws_policy_detach","title":"Detach a policy from a user, group, or role — aws_policy_detach","text":"Detach policy user, group, role","code":""},{"path":"/reference/aws_policy_detach.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Detach a policy from a user, group, or role — aws_policy_detach","text":"","code":"aws_policy_detach(.x, policy)"},{"path":"/reference/aws_policy_detach.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Detach a policy from a user, group, or role — aws_policy_detach","text":".x result call create get method user, group, role policy (character) policy name ARN","code":""},{"path":"/reference/aws_policy_detach.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Detach a policy from a user, group, or role — aws_policy_detach","text":"tibble information policies","code":""},{"path":[]},{"path":"/reference/aws_policy_detach.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Detach a policy from a user, group, or role — aws_policy_detach","text":"","code":"if (FALSE) { aws_user() %>% aws_policy_detach(\"AmazonRDSDataFullAccess\") aws_user()$attached_policies # aws_role(\"OrganizationAccountSecurityRole\") %>% # aws_policy_detach(\"ReadOnlyAccess\") }"},{"path":"/reference/aws_policy_document_create.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a policy document — aws_policy_document_create","title":"Create a policy document — aws_policy_document_create","text":"Create policy document","code":""},{"path":"/reference/aws_policy_document_create.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a policy document — aws_policy_document_create","text":"","code":"aws_policy_document_create(..., .list = NULL)"},{"path":"/reference/aws_policy_document_create.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a policy document — aws_policy_document_create","text":"..., .list policy statements created aws_policy_statement() created manually. Pass 1 statements via ... like statement1, statement2 pass list like .list = list(statement1, statement2). element must named list.","code":""},{"path":"/reference/aws_policy_document_create.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a policy document — aws_policy_document_create","text":"json class string. use .character() coerce regular string","code":""},{"path":"/reference/aws_policy_document_create.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Create a policy document — aws_policy_document_create","text":"document item hard-coded: Version set 2012-10-17\"","code":""},{"path":"/reference/aws_policy_document_create.html","id":"actions","dir":"Reference","previous_headings":"","what":"Actions","title":"Create a policy document — aws_policy_document_create","text":"Actions documentation appears web. start: S3: https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazons3.html # nolint EC2: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Operations.html # nolint IAM: https://docs.aws.amazon.com/IAM/latest/APIReference/API_Operations.html # nolint","code":""},{"path":"/reference/aws_policy_document_create.html","id":"references","dir":"Reference","previous_headings":"","what":"References","title":"Create a policy document — aws_policy_document_create","text":"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html # nolint","code":""},{"path":"/reference/aws_policy_document_create.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a policy document — aws_policy_document_create","text":"","code":"if (FALSE) { # interactive() st8ment1 <- aws_policy_statement(\"iam:GetUser\", \"*\") st8ment2 <- aws_policy_statement(\"s3:ListAllMyBuckets\", \"*\") st8ment3 <- aws_policy_statement(\"s3-object-lambda:List*\", \"*\") aws_policy_document_create(st8ment1, st8ment2) aws_policy_document_create(.list = list(st8ment1, st8ment2)) aws_policy_document_create(st8ment3, .list = list(st8ment1, st8ment2)) # Policy document to give a user access to RDS resource <- \"arn:aws:rds-db:us-east-2:1234567890:dbuser:db-ABCDE1212/jane\" st8ment_rds <- aws_policy_statement( action = \"rds-db:connect\", resource = resource ) aws_policy_document_create(st8ment_rds) ### DB account = user in a database that has access to it # all DB instances & DB accounts for a AWS account and AWS Region aws_policy_document_create( aws_policy_statement( action = \"rds-db:connect\", resource = resource_rds(\"*\", \"*\") ) ) # all DB instances for a AWS account and AWS Region, single DB account aws_policy_document_create( aws_policy_statement( action = \"rds-db:connect\", resource = resource_rds(\"jane_doe\", \"*\") ) ) # single DB instasnce, single DB account aws_policy_document_create( aws_policy_statement( action = \"rds-db:connect\", resource = resource_rds(\"jane_doe\", \"db-ABCDEFGHIJKL01234\") ) ) # single DB instance, many users aws_policy_document_create( aws_policy_statement( action = \"rds-db:connect\", resource = resource_rds(c(\"jane_doe\", \"mary_roe\"), \"db-ABCDEFGHIJKL01\") ) ) }"},{"path":"/reference/aws_policy_exists.html","id":null,"dir":"Reference","previous_headings":"","what":"Check if a policy exists — aws_policy_exists","title":"Check if a policy exists — aws_policy_exists","text":"Checks customer managed AWS managed policies","code":""},{"path":"/reference/aws_policy_exists.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check if a policy exists — aws_policy_exists","text":"","code":"aws_policy_exists(name)"},{"path":"/reference/aws_policy_exists.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check if a policy exists — aws_policy_exists","text":"name (character) policy name arn","code":""},{"path":"/reference/aws_policy_exists.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check if a policy exists — aws_policy_exists","text":"single logical, TRUE FALSE","code":""},{"path":[]},{"path":"/reference/aws_policy_exists.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Check if a policy exists — aws_policy_exists","text":"","code":"if (FALSE) { # interactive() # just the policy name aws_policy_exists(\"ReadOnlyAccess\") # as an ARN aws_policy_exists(\"arn:aws:iam::aws:policy/ReadOnlyAccess\") # includes job-function in path aws_policy_exists(\"Billing\") # includes service-role in path aws_policy_exists(\"AWSCostAndUsageReportAutomationPolicy\") }"},{"path":"/reference/aws_policy_list_entities.html","id":null,"dir":"Reference","previous_headings":"","what":"List policy entities — aws_policy_list_entities","title":"List policy entities — aws_policy_list_entities","text":"List policy entities","code":""},{"path":"/reference/aws_policy_list_entities.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List policy entities — aws_policy_list_entities","text":"","code":"aws_policy_list_entities(name, ...)"},{"path":"/reference/aws_policy_list_entities.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List policy entities — aws_policy_list_entities","text":"name (character) policy name. required. within function lookup policy arn passed AWS API ... additional named arguments passed internal paws method (see link docs)","code":""},{"path":"/reference/aws_policy_list_entities.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List policy entities — aws_policy_list_entities","text":"tibble columns: type: one Users, Roles, Groups name: user, role group name id: id user, role group name Zero row tibble entities","code":""},{"path":"/reference/aws_policy_list_entities.html","id":"references","dir":"Reference","previous_headings":"","what":"References","title":"List policy entities — aws_policy_list_entities","text":"https://www.paws-r-sdk.com/docs/iam_list_entities_for_policy/","code":""},{"path":[]},{"path":"/reference/aws_policy_list_entities.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List policy entities — aws_policy_list_entities","text":"","code":"if (FALSE) { # interactive() pols <- aws_policies(Scope = \"Local\") for (policy in pols$PolicyName) { cat(\"\\n\\n\", policy, \"\\n\") print(aws_policy_list_entities(policy)) } aws_policy_list_entities(\"S3ReadOnlyAccessS64Test22\") }"},{"path":"/reference/aws_policy_list_versions.html","id":null,"dir":"Reference","previous_headings":"","what":"List policy versions — aws_policy_list_versions","title":"List policy versions — aws_policy_list_versions","text":"List policy versions","code":""},{"path":"/reference/aws_policy_list_versions.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List policy versions — aws_policy_list_versions","text":"","code":"aws_policy_list_versions(name, ...)"},{"path":"/reference/aws_policy_list_versions.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List policy versions — aws_policy_list_versions","text":"name (character) policy name. required. within function lookup policy arn passed AWS API ... additional named arguments passed internal paws method (see link docs)","code":""},{"path":"/reference/aws_policy_list_versions.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List policy versions — aws_policy_list_versions","text":"tibble columns: Document VersionId IsDefaultVersion CreateDate","code":""},{"path":"/reference/aws_policy_list_versions.html","id":"references","dir":"Reference","previous_headings":"","what":"References","title":"List policy versions — aws_policy_list_versions","text":"https://www.paws-r-sdk.com/docs/iam_list_policy_versions/","code":""},{"path":[]},{"path":"/reference/aws_policy_list_versions.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List policy versions — aws_policy_list_versions","text":"","code":"if (FALSE) { # interactive() pols <- aws_policies() aws_policy_list_versions(pols$PolicyName[1]) }"},{"path":"/reference/aws_policy_statement.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a policy statement — aws_policy_statement","title":"Create a policy statement — aws_policy_statement","text":"Create policy statement","code":""},{"path":"/reference/aws_policy_statement.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a policy statement — aws_policy_statement","text":"","code":"aws_policy_statement(action, resource, effect = \"Allow\", ...)"},{"path":"/reference/aws_policy_statement.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a policy statement — aws_policy_statement","text":"action (character) action. required. see Actions . resource (character) object objects statement covers; see link information effect (character) valid values: \"Allow\" (default), \"Deny\". length==1 ... Additional named arguments. See link Details options, examples ","code":""},{"path":"/reference/aws_policy_statement.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a policy statement — aws_policy_statement","text":"named list","code":""},{"path":"/reference/aws_policy_statement.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Create a policy statement — aws_policy_statement","text":"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html #nolint","code":""},{"path":"/reference/aws_policy_statement.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a policy statement — aws_policy_statement","text":"","code":"if (FALSE) { # interactive() aws_policy_statement(\"iam:GetUser\", \"*\") aws_policy_statement(\"iam:GetUser\", \"*\", Sid = \"MyStatementId\") aws_policy_statement(\"iam:GetUser\", \"*\", Condition = list( StringEqualsIgnoreCase = list(\"aws:username\" = \"johndoe\") ) ) aws_policy_statement(\"iam:GetUser\", \"*\", Principal = list(Service = \"s3.amazonaws.com\") ) }"},{"path":"/reference/aws_role.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a role — aws_role","title":"Get a role — aws_role","text":"Get role","code":""},{"path":"/reference/aws_role.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a role — aws_role","text":"","code":"aws_role(name)"},{"path":"/reference/aws_role.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a role — aws_role","text":"name (character) role name","code":""},{"path":"/reference/aws_role.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a role — aws_role","text":"named list slots : role (tibble) policies (character) attached_policies (tibble)","code":""},{"path":"/reference/aws_role.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get a role — aws_role","text":"see docs https://www.paws-r-sdk.com/docs/iam_get_role/; also includes policies attached policies calling list_role_policies list_attached_role_policies","code":""},{"path":[]},{"path":"/reference/aws_role.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get a role — aws_role","text":"","code":"if (FALSE) { res <- aws_role(name = \"OrganizationAccountSecurityRole\") res res$role res$policies res$attached_policies aws_role(\"AWSServiceRoleForCloudTrail\") aws_role(\"AWSServiceRoleForRedshift\") }"},{"path":"/reference/aws_role_create.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a role — aws_role_create","title":"Create a role — aws_role_create","text":"Create role","code":""},{"path":"/reference/aws_role_create.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a role — aws_role_create","text":"","code":"aws_role_create( name, assume_role_policy_document, path = NULL, description = NULL, max_session_duration = NULL, permission_boundary = NULL, tags = NULL )"},{"path":"/reference/aws_role_create.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a role — aws_role_create","text":"name (character) role name. required assume_role_policy_document (character) trust relationship policy document grants entity permission assume role. json string. required path (character) path role name. optional. included, defaults slash (/). description (character) description fo role. optional max_session_duration (character) maximum session duration (seconds) want set specified role. optional permission_boundary (character) ARN managed policy used set permissions boundary role. optional tags (list) list tags want attach new user. optional","code":""},{"path":"/reference/aws_role_create.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a role — aws_role_create","text":"tibble information role created","code":""},{"path":"/reference/aws_role_create.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Create a role — aws_role_create","text":"See https://www.paws-r-sdk.com/docs/iam_create_role/ docs details parameters","code":""},{"path":[]},{"path":"/reference/aws_role_create.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a role — aws_role_create","text":"","code":"if (FALSE) { role_name <- \"MyRole\" trust_policy <- list( Version = \"2012-10-17\", Statement = list( list( Effect = \"Allow\", Principal = list( Service = \"lambda.amazonaws.com\" ), Action = \"sts:AssumeRole\" ) ) ) doc <- jsonlite::toJSON(trust_policy, auto_unbox = TRUE) desc <- \"My test role\" z <- aws_role_create(role_name, assume_role_policy_document = doc, description = desc ) z # attach a policy z %>% aws_policy_attach(\"AWSLambdaBasicExecutionRole\") }"},{"path":"/reference/aws_role_delete.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete a role — aws_role_delete","title":"Delete a role — aws_role_delete","text":"Delete role","code":""},{"path":"/reference/aws_role_delete.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete a role — aws_role_delete","text":"","code":"aws_role_delete(name)"},{"path":"/reference/aws_role_delete.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete a role — aws_role_delete","text":"name (character) role name. required","code":""},{"path":"/reference/aws_role_delete.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete a role — aws_role_delete","text":"empty list","code":""},{"path":"/reference/aws_role_delete.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Delete a role — aws_role_delete","text":"See https://www.paws-r-sdk.com/docs/iam_delete_role/ docs details","code":""},{"path":[]},{"path":"/reference/aws_role_delete.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Delete a role — aws_role_delete","text":"","code":"if (FALSE) { aws_role_delete(name = \"MyRole\") }"},{"path":"/reference/aws_role_exists.html","id":null,"dir":"Reference","previous_headings":"","what":"Check if a role exists — aws_role_exists","title":"Check if a role exists — aws_role_exists","text":"Check role exists","code":""},{"path":"/reference/aws_role_exists.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check if a role exists — aws_role_exists","text":"","code":"aws_role_exists(name)"},{"path":"/reference/aws_role_exists.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check if a role exists — aws_role_exists","text":"name (character) role name","code":""},{"path":"/reference/aws_role_exists.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check if a role exists — aws_role_exists","text":"single boolean","code":""},{"path":[]},{"path":"/reference/aws_roles.html","id":null,"dir":"Reference","previous_headings":"","what":"List roles — aws_roles","title":"List roles — aws_roles","text":"List roles","code":""},{"path":"/reference/aws_roles.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List roles — aws_roles","text":"","code":"aws_roles(...)"},{"path":"/reference/aws_roles.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List roles — aws_roles","text":"... parameters passed paws list_users method","code":""},{"path":"/reference/aws_roles.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List roles — aws_roles","text":"tibble information roles","code":""},{"path":[]},{"path":"/reference/aws_roles.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List roles — aws_roles","text":"","code":"if (FALSE) { aws_roles() }"},{"path":"/reference/aws_s3_policy_doc_create.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a policy document for an S3 bucket — aws_s3_policy_doc_create","title":"Create a policy document for an S3 bucket — aws_s3_policy_doc_create","text":"Create policy document S3 bucket","code":""},{"path":"/reference/aws_s3_policy_doc_create.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a policy document for an S3 bucket — aws_s3_policy_doc_create","text":"","code":"aws_s3_policy_doc_create( bucket, action, resource, effect = \"Allow\", sid = NULL, ... )"},{"path":"/reference/aws_s3_policy_doc_create.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a policy document for an S3 bucket — aws_s3_policy_doc_create","text":"bucket (character) bucket name. required action (character) action. required. see Actions . resource (character) object objects statement covers; see link information effect (character) valid values: \"Allow\" (default), \"Deny\". length==1 sid (character) statement id. optional ... Additional named arguments. See link Details options, examples ","code":""},{"path":"/reference/aws_s3_policy_doc_create.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a policy document for an S3 bucket — aws_s3_policy_doc_create","text":"policy document JSON (class json)","code":""},{"path":"/reference/aws_s3_policy_doc_create.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Create a policy document for an S3 bucket — aws_s3_policy_doc_create","text":"separate function creating policy docs S3 buckets globally unique, AWS figures region account ID .","code":""},{"path":"/reference/aws_s3_policy_doc_create.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a policy document for an S3 bucket — aws_s3_policy_doc_create","text":"","code":"if (FALSE) { # interactive() bucket <- random_string(\"bucket\") aws_s3_policy_doc_create( bucket = bucket, action = s3_actions_read(), resource = c(bucket_arn(bucket), bucket_arn(bucket, objects = \"*\")) ) }"},{"path":"/reference/aws_secrets_all.html","id":null,"dir":"Reference","previous_headings":"","what":"Get all secret values — aws_secrets_all","title":"Get all secret values — aws_secrets_all","text":"Get secret values","code":""},{"path":"/reference/aws_secrets_all.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get all secret values — aws_secrets_all","text":"","code":"aws_secrets_all()"},{"path":"/reference/aws_secrets_all.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get all secret values — aws_secrets_all","text":"(tbl) secrets","code":""},{"path":"/reference/aws_secrets_all.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get all secret values — aws_secrets_all","text":"","code":"if (FALSE) { aws_secrets_all() }"},{"path":"/reference/aws_secrets_create.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a secret — aws_secrets_create","title":"Create a secret — aws_secrets_create","text":"function create database username /password. Instead, creates \"secret\", typically combination credentials (username + password + metadata)","code":""},{"path":"/reference/aws_secrets_create.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a secret — aws_secrets_create","text":"","code":"aws_secrets_create(name, secret, description = NULL, ...)"},{"path":"/reference/aws_secrets_create.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a secret — aws_secrets_create","text":"name (character) name new secret. required secret (character/raw) text raw data encrypt store new version secret. AWS recommends text use JSON structure key/value pairs secret value (see examples ). required description (character) description secret. optional ... named parameters passed create_secret https://www.paws-r-sdk.com/docs/secretsmanager_create_secret/","code":""},{"path":"/reference/aws_secrets_create.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a secret — aws_secrets_create","text":"(list) fields: ARN Name VersionId ReplicationStatus","code":""},{"path":"/reference/aws_secrets_create.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Create a secret — aws_secrets_create","text":"Note autogenerate random UUID pass ClientRequestToken parameter paws function create_secret used internally function. function creates new secret. See aws_secrets_update() update existing secret. function fails call existing secret name ARN","code":""},{"path":"/reference/aws_secrets_create.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a secret — aws_secrets_create","text":"","code":"if (FALSE) { # Text secret x <- aws_secrets_create( name = \"MyTestDatabaseSecret\", secret = '{\"username\":\"david\",\"password\":\"EXAMPLE-PASSWORD\"}', description = \"My test database secret as a string\" ) # Raw secret x <- aws_secrets_create( name = \"MyRawDatabaseSecret\", secret = charToRaw('{\"username\":\"david\",\"password\":\"EXAMPLE-PASSWORD\"}'), description = \"My test database secret as raw\" ) }"},{"path":"/reference/aws_secrets_delete.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete a secret — aws_secrets_delete","title":"Delete a secret — aws_secrets_delete","text":"Delete secret","code":""},{"path":"/reference/aws_secrets_delete.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete a secret — aws_secrets_delete","text":"","code":"aws_secrets_delete(id, ...)"},{"path":"/reference/aws_secrets_delete.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete a secret — aws_secrets_delete","text":"id (character) name ARN secret. required ... named parameters passed delete_secret https://www.paws-r-sdk.com/docs/secretsmanager_delete_secret/","code":""},{"path":"/reference/aws_secrets_delete.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete a secret — aws_secrets_delete","text":"(list) fields: ARN Name DeletionDate","code":""},{"path":"/reference/aws_secrets_delete.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Delete a secret — aws_secrets_delete","text":"","code":"if (FALSE) { # Does exist aws_secrets_delete(id = \"MyTestDatabaseSecret\") # Does not exist # aws_secrets_get(id = \"DoesntExist\") #> Error: ResourceNotFoundException (HTTP 400). Secrets Manager #> can't find the specified secret. }"},{"path":"/reference/aws_secrets_get.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a secret — aws_secrets_get","title":"Get a secret — aws_secrets_get","text":"Get secret","code":""},{"path":"/reference/aws_secrets_get.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a secret — aws_secrets_get","text":"","code":"aws_secrets_get(id, ...)"},{"path":"/reference/aws_secrets_get.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a secret — aws_secrets_get","text":"id (character) name ARN secret. required ... named parameters passed get_secret_value https://www.paws-r-sdk.com/docs/secretsmanager_get_secret_value/","code":""},{"path":"/reference/aws_secrets_get.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a secret — aws_secrets_get","text":"(list) fields: ARN Name VersionId SecretBinary SecretString VersionStages CreatedDate","code":""},{"path":"/reference/aws_secrets_get.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get a secret — aws_secrets_get","text":"","code":"if (FALSE) { # Does exist aws_secrets_get(id = \"MyTestDatabaseSecret\") # Does not exist # aws_secrets_get(id = \"DoesntExist\") #> Error: ResourceNotFoundException (HTTP 400). Secrets Manager #> can't find the specified secret. }"},{"path":"/reference/aws_secrets_list.html","id":null,"dir":"Reference","previous_headings":"","what":"List secrets — aws_secrets_list","title":"List secrets — aws_secrets_list","text":"List secrets","code":""},{"path":"/reference/aws_secrets_list.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List secrets — aws_secrets_list","text":"","code":"aws_secrets_list(...)"},{"path":"/reference/aws_secrets_list.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List secrets — aws_secrets_list","text":"... parameters passed paws method","code":""},{"path":"/reference/aws_secrets_list.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List secrets — aws_secrets_list","text":"(list) list secrets","code":""},{"path":"/reference/aws_secrets_list.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"List secrets — aws_secrets_list","text":"see https://www.paws-r-sdk.com/docs/secretsmanager_list_secrets/ available parameters","code":""},{"path":"/reference/aws_secrets_list.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List secrets — aws_secrets_list","text":"","code":"if (FALSE) { aws_secrets_list() }"},{"path":"/reference/aws_secrets_pwd.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a random password — aws_secrets_pwd","title":"Get a random password — aws_secrets_pwd","text":"Get random password","code":""},{"path":"/reference/aws_secrets_pwd.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a random password — aws_secrets_pwd","text":"","code":"aws_secrets_pwd(...)"},{"path":"/reference/aws_secrets_pwd.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a random password — aws_secrets_pwd","text":"... named parameters passed get_random_password https://www.paws-r-sdk.com/docs/secretsmanager_get_random_password/","code":""},{"path":"/reference/aws_secrets_pwd.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get a random password — aws_secrets_pwd","text":"","code":"if (FALSE) { aws_secrets_pwd() aws_secrets_pwd(ExcludeNumbers = TRUE) }"},{"path":"/reference/aws_secrets_rotate.html","id":null,"dir":"Reference","previous_headings":"","what":"Rotate a secret — aws_secrets_rotate","title":"Rotate a secret — aws_secrets_rotate","text":"Rotate secret","code":""},{"path":"/reference/aws_secrets_rotate.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Rotate a secret — aws_secrets_rotate","text":"","code":"aws_secrets_rotate(id, lambda_arn = NULL, rules = NULL, immediately = TRUE)"},{"path":"/reference/aws_secrets_rotate.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rotate a secret — aws_secrets_rotate","text":"id (character) name ARN secret. required lambda_arn (character) ARN Lambda rotation function. supply secrets use Lambda rotation function rotate rules (list) asdfadf immediately (logical) whether rotate secret immediately . default: TRUE","code":""},{"path":"/reference/aws_secrets_rotate.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Rotate a secret — aws_secrets_rotate","text":"(list) fields: ARN Name VersionId","code":""},{"path":"/reference/aws_secrets_rotate.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Rotate a secret — aws_secrets_rotate","text":"Note autogenerate random UUID pass ClientRequestToken parameter paws function used internally","code":""},{"path":"/reference/aws_secrets_rotate.html","id":"references","dir":"Reference","previous_headings":"","what":"References","title":"Rotate a secret — aws_secrets_rotate","text":"https://www.paws-r-sdk.com/docs/secretsmanager_rotate_secret/","code":""},{"path":"/reference/aws_secrets_rotate.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Rotate a secret — aws_secrets_rotate","text":"","code":"if (FALSE) { aws_secrets_rotate(id = \"MyTestDatabaseSecret\") aws_secrets_rotate(id = \"MyTestDatabaseSecret\", rules = list( Duration = \"2h\", ScheduleExpression = \"cron(0 16 1,15 * ? *)\" )) }"},{"path":"/reference/aws_secrets_update.html","id":null,"dir":"Reference","previous_headings":"","what":"Update a secret — aws_secrets_update","title":"Update a secret — aws_secrets_update","text":"Update secret","code":""},{"path":"/reference/aws_secrets_update.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Update a secret — aws_secrets_update","text":"","code":"aws_secrets_update(id, secret, ...)"},{"path":"/reference/aws_secrets_update.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Update a secret — aws_secrets_update","text":"id (character) name ARN secret. required secret (character/raw) text raw data encrypt store new version secret. AWS recommends text use JSON structure key/value pairs secret value (see examples ). required ... named parameters passed put_secret_value https://www.paws-r-sdk.com/docs/secretsmanager_put_secret_value/","code":""},{"path":"/reference/aws_secrets_update.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Update a secret — aws_secrets_update","text":"(list) fields: ARN Name VersionId VersionStages","code":""},{"path":"/reference/aws_secrets_update.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Update a secret — aws_secrets_update","text":"Note autogenerate random UUID pass ClientRequestToken parameter paws function used internally","code":""},{"path":"/reference/aws_secrets_update.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Update a secret — aws_secrets_update","text":"","code":"if (FALSE) { # Create a secret aws_secrets_create( name = \"TheSecret\", secret = '{\"username\":\"jane\",\"password\":\"cat\"}', description = \"A string\" ) aws_secrets_get(\"TheSecret\") # Update the secret aws_secrets_update( id = \"TheSecret\", secret = '{\"username\":\"jane\",\"password\":\"kitten\"}' ) aws_secrets_get(\"TheSecret\") }"},{"path":"/reference/aws_user.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a user — aws_user","title":"Get a user — aws_user","text":"Gets user information, including policies, groups, attached policies","code":""},{"path":"/reference/aws_user.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a user — aws_user","text":"","code":"aws_user(username = NULL)"},{"path":"/reference/aws_user.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a user — aws_user","text":"username (character) user name. required","code":""},{"path":"/reference/aws_user.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a user — aws_user","text":"named list slots : user (tibble) policies (list) attached_policies (list) groups (list)","code":""},{"path":"/reference/aws_user.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get a user — aws_user","text":"See following docs links details https://www.paws-r-sdk.com/docs/iam_get_user/ https://www.paws-r-sdk.com/docs/iam_list_user_policies/ https://www.paws-r-sdk.com/docs/iam_list_groups_for_user/ https://www.paws-r-sdk.com/docs/iam_list_attached_user_policies/","code":""},{"path":"/reference/aws_user.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Get a user — aws_user","text":"username supplied, gets logged user","code":""},{"path":[]},{"path":"/reference/aws_user.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get a user — aws_user","text":"","code":"if (FALSE) { # if username not supplied, gets logged in user aws_user() # supply a username to get that user's information aws_user_create(\"testBlueBird\") aws_user(username = \"testBlueBird\") aws_user_delete(\"testBlueBird\") # cleanup user }"},{"path":"/reference/aws_user_access_key.html","id":null,"dir":"Reference","previous_headings":"","what":"Get AWS Access Key for a user — aws_user_access_key","title":"Get AWS Access Key for a user — aws_user_access_key","text":"IMPORTANT: secret access key accessible key user creation","code":""},{"path":"/reference/aws_user_access_key.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get AWS Access Key for a user — aws_user_access_key","text":"","code":"aws_user_access_key(username = NULL, ...)"},{"path":"/reference/aws_user_access_key.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get AWS Access Key for a user — aws_user_access_key","text":"username (character) user name. required ... named args passed list_access_keys","code":""},{"path":"/reference/aws_user_access_key.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get AWS Access Key for a user — aws_user_access_key","text":"tibble key details","code":""},{"path":"/reference/aws_user_access_key.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get AWS Access Key for a user — aws_user_access_key","text":"See https://www.paws-r-sdk.com/docs/iam_list_access_keys/ docs details","code":""},{"path":[]},{"path":"/reference/aws_user_access_key_delete.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete current user's AWS Access Key — aws_user_access_key_delete","title":"Delete current user's AWS Access Key — aws_user_access_key_delete","text":"Delete current user's AWS Access Key","code":""},{"path":"/reference/aws_user_access_key_delete.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete current user's AWS Access Key — aws_user_access_key_delete","text":"","code":"aws_user_access_key_delete(access_key_id, username = NULL)"},{"path":"/reference/aws_user_access_key_delete.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete current user's AWS Access Key — aws_user_access_key_delete","text":"access_key_id (character) access key ID access key ID secret access key want delete. required. username (character) user name. optional. however, supply username, paws likely use current user, may user access key id associated - get error like NoSuchEntity (HTTP 404). Access Key id xx found","code":""},{"path":"/reference/aws_user_access_key_delete.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete current user's AWS Access Key — aws_user_access_key_delete","text":"NULL, invisibly","code":""},{"path":"/reference/aws_user_access_key_delete.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Delete current user's AWS Access Key — aws_user_access_key_delete","text":"See https://www.paws-r-sdk.com/docs/iam_delete_access_key/ docs details","code":""},{"path":[]},{"path":"/reference/aws_user_access_key_delete.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Delete current user's AWS Access Key — aws_user_access_key_delete","text":"","code":"if (FALSE) { # interactive() aws_user_access_key_delete(access_key_id = \"adfasdfadfadfasdf\") aws_user_access_key_delete(access_key_id = \"adfasdf\", username = \"jane\") }"},{"path":"/reference/aws_user_add_to_group.html","id":null,"dir":"Reference","previous_headings":"","what":"Add or remove a user to/from a group — aws_user_add_to_group","title":"Add or remove a user to/from a group — aws_user_add_to_group","text":"Add remove user /group","code":""},{"path":"/reference/aws_user_add_to_group.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Add or remove a user to/from a group — aws_user_add_to_group","text":"","code":"aws_user_add_to_group(username, groupname) aws_user_remove_from_group(username, groupname)"},{"path":"/reference/aws_user_add_to_group.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Add or remove a user to/from a group — aws_user_add_to_group","text":"username (character) user name. required groupname (character) group name. required","code":""},{"path":"/reference/aws_user_add_to_group.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Add or remove a user to/from a group — aws_user_add_to_group","text":"named list slots : user (tibble) policies (list) attached_policies (list) groups (list)","code":""},{"path":"/reference/aws_user_add_to_group.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Add or remove a user to/from a group — aws_user_add_to_group","text":"See https://www.paws-r-sdk.com/docs/iam_add_user_to_group/ https://www.paws-r-sdk.com/docs/iam_remove_user_from_group/ docs details","code":""},{"path":[]},{"path":"/reference/aws_user_add_to_group.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Add or remove a user to/from a group — aws_user_add_to_group","text":"","code":"if (FALSE) { if (!aws_group_exists(\"testgroup3\")) { aws_group_create(\"testgroup3\") } if (!aws_user_exists(\"testBlueBird3\")) { aws_user_create(\"testBlueBird3\") } aws_user_add_to_group(\"testBlueBird3\", \"testgroup3\") aws_user_remove_from_group(\"testBlueBird3\", \"testgroup3\") }"},{"path":"/reference/aws_user_create.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a user — aws_user_create","title":"Create a user — aws_user_create","text":"Create user","code":""},{"path":"/reference/aws_user_create.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a user — aws_user_create","text":"","code":"aws_user_create(username, path = NULL, permission_boundary = NULL, tags = NULL)"},{"path":"/reference/aws_user_create.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a user — aws_user_create","text":"username (character) user name. required path (character) path user name. optional. included, defaults slash (/). permission_boundary (character) ARN managed policy used set permissions boundary user. optional tags (list) list tags want attach new user. optional","code":""},{"path":"/reference/aws_user_create.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a user — aws_user_create","text":"tibble information user created","code":""},{"path":"/reference/aws_user_create.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Create a user — aws_user_create","text":"See https://www.paws-r-sdk.com/docs/iam_create_user/ docs details parameters","code":""},{"path":[]},{"path":"/reference/aws_user_create.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a user — aws_user_create","text":"","code":"if (FALSE) { aws_user_create(\"testBlueBird\") }"},{"path":"/reference/aws_user_current.html","id":null,"dir":"Reference","previous_headings":"","what":"Get the current logged-in username as a string — aws_user_current","title":"Get the current logged-in username as a string — aws_user_current","text":"Get current logged-username string","code":""},{"path":"/reference/aws_user_current.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get the current logged-in username as a string — aws_user_current","text":"","code":"aws_user_current()"},{"path":"/reference/aws_user_current.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get the current logged-in username as a string — aws_user_current","text":"username character","code":""},{"path":[]},{"path":"/reference/aws_user_delete.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete a user — aws_user_delete","title":"Delete a user — aws_user_delete","text":"Delete user","code":""},{"path":"/reference/aws_user_delete.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete a user — aws_user_delete","text":"","code":"aws_user_delete(username)"},{"path":"/reference/aws_user_delete.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete a user — aws_user_delete","text":"username (character) user name. required","code":""},{"path":"/reference/aws_user_delete.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete a user — aws_user_delete","text":"NULL invisibly","code":""},{"path":"/reference/aws_user_delete.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Delete a user — aws_user_delete","text":"See https://www.paws-r-sdk.com/docs/iam_delete_user/ docs details","code":""},{"path":[]},{"path":"/reference/aws_user_delete.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Delete a user — aws_user_delete","text":"","code":"if (FALSE) { aws_user_delete(username = \"testBlueBird\") }"},{"path":"/reference/aws_user_exists.html","id":null,"dir":"Reference","previous_headings":"","what":"Check if a user exists — aws_user_exists","title":"Check if a user exists — aws_user_exists","text":"Check user exists","code":""},{"path":"/reference/aws_user_exists.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check if a user exists — aws_user_exists","text":"","code":"aws_user_exists(username)"},{"path":"/reference/aws_user_exists.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check if a user exists — aws_user_exists","text":"username (character) user name","code":""},{"path":"/reference/aws_user_exists.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check if a user exists — aws_user_exists","text":"single boolean","code":""},{"path":"/reference/aws_user_exists.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Check if a user exists — aws_user_exists","text":"uses aws_user() internally. see docs https://www.paws-r-sdk.com/docs/iam_get_user/","code":""},{"path":[]},{"path":"/reference/aws_user_exists.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Check if a user exists — aws_user_exists","text":"","code":"if (FALSE) { aws_user_exists(aws_user_current()) aws_user_exists(\"blueberry\") }"},{"path":"/reference/aws_users.html","id":null,"dir":"Reference","previous_headings":"","what":"List Users — aws_users","title":"List Users — aws_users","text":"List Users","code":""},{"path":"/reference/aws_users.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List Users — aws_users","text":"","code":"aws_users(...)"},{"path":"/reference/aws_users.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List Users — aws_users","text":"... parameters passed paws list_users method","code":""},{"path":"/reference/aws_users.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List Users — aws_users","text":"tibble information user accounts, columns: UserName UserId Path Arn CreateDate PasswordLastUsed","code":""},{"path":[]},{"path":"/reference/aws_users.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List Users — aws_users","text":"","code":"if (FALSE) { aws_users() }"},{"path":"/reference/aws_vpc.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a VPC by id — aws_vpc","title":"Get a VPC by id — aws_vpc","text":"Get VPC id","code":""},{"path":"/reference/aws_vpc.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a VPC by id — aws_vpc","text":"","code":"aws_vpc(id, ...)"},{"path":"/reference/aws_vpc.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a VPC by id — aws_vpc","text":"id (character) id VPC. required ... parameters passed describe_vpcs","code":""},{"path":"/reference/aws_vpc.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a VPC by id — aws_vpc","text":"(list) fields: Vpcs (list) VPC group NextToken (character) token paginating element Vpcs list slots: CidrBlock DhcpOptionsId State VpcId OwnerId InstanceTenancy Ipv6CidrBlockAssociationSet CidrBlockAssociationSet IsDefault Tags","code":""},{"path":"/reference/aws_vpc_sec_group_rules.html","id":null,"dir":"Reference","previous_headings":"","what":"Modify security group rules — aws_vpc_sec_group_rules","title":"Modify security group rules — aws_vpc_sec_group_rules","text":"Modify security group rules","code":""},{"path":"/reference/aws_vpc_sec_group_rules.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Modify security group rules — aws_vpc_sec_group_rules","text":"","code":"aws_vpc_sec_group_rules(id, rules, ...)"},{"path":"/reference/aws_vpc_sec_group_rules.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Modify security group rules — aws_vpc_sec_group_rules","text":"id (character) security group id rules list rules add/modify security group id ... named parameters passed modify_security_group_rules","code":""},{"path":[]},{"path":"/reference/aws_vpc_sec_group_rules.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Modify security group rules — aws_vpc_sec_group_rules","text":"","code":"if (FALSE) { # interactive() aws_vpc_sec_group_rules( id = \"someid\", rules = list( SecurityGroupRuleId = \"sgr-07de36a0521f39c8b\", SecurityGroupRule = list( IpProtocol = \"tcp\", FromPort = 22, ToPort = 22, CidrIpv4 = \"3.3.3.3/32\", Description = \"added ssh port\" ) ) ) }"},{"path":"/reference/aws_vpc_security_group.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a security group by ID — aws_vpc_security_group","title":"Get a security group by ID — aws_vpc_security_group","text":"Get security group ID","code":""},{"path":"/reference/aws_vpc_security_group.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a security group by ID — aws_vpc_security_group","text":"","code":"aws_vpc_security_group(id, ...)"},{"path":"/reference/aws_vpc_security_group.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a security group by ID — aws_vpc_security_group","text":"id (character) id security group. required ... named parameters passed describe_security_groups","code":""},{"path":"/reference/aws_vpc_security_group.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a security group by ID — aws_vpc_security_group","text":"(list) fields: SecurityGroups (list) security group Description GroupName IpPermissions OwnerId GroupId IpPermissionsEgress Tags VpcId NextToken (character) token paginating","code":""},{"path":[]},{"path":"/reference/aws_vpc_security_group_create.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a security group — aws_vpc_security_group_create","title":"Create a security group — aws_vpc_security_group_create","text":"Create security group","code":""},{"path":"/reference/aws_vpc_security_group_create.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a security group — aws_vpc_security_group_create","text":"","code":"aws_vpc_security_group_create( name, engine = \"mariadb\", description = NULL, vpc_id = NULL, tags = NULL, ... )"},{"path":"/reference/aws_vpc_security_group_create.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a security group — aws_vpc_security_group_create","text":"name (character) name new secret. required engine (character) engine use. default: \"mariadb\". required. one : mariadb, mysql, postgres description (character) description secret. optional vpc_id (character) VPC id. optional. supplied default VPC used. get VPCs, see aws_vpcs() tags (character) tags assign security group. optional ... named parameters passed create_security_group","code":""},{"path":"/reference/aws_vpc_security_group_create.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a security group — aws_vpc_security_group_create","text":"(list) fields: GroupId (character) Tags (list)","code":""},{"path":[]},{"path":"/reference/aws_vpc_security_group_create.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a security group — aws_vpc_security_group_create","text":"","code":"if (FALSE) { # create security group x <- aws_vpc_security_group_create( name = \"testing1\", description = \"Testing security group creation\" ) aws_vpc_security_group_create(name = \"testing2\") aws_vpc_security_group_create( name = \"testing4\", tags = list( list( ResourceType = \"security-group\", Tags = list( list( Key = \"sky\", Value = \"blue\" ) ) ) ) ) # add ingress aws_vpc_security_group_ingress( id = x$GroupId, ip_permissions = ip_permissions_generator(\"mariadb\") ) }"},{"path":"/reference/aws_vpc_security_group_ingress.html","id":null,"dir":"Reference","previous_headings":"","what":"Authorize Security Group Ingress — aws_vpc_security_group_ingress","title":"Authorize Security Group Ingress — aws_vpc_security_group_ingress","text":"Authorize Security Group Ingress","code":""},{"path":"/reference/aws_vpc_security_group_ingress.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Authorize Security Group Ingress — aws_vpc_security_group_ingress","text":"","code":"aws_vpc_security_group_ingress(id, ip_permissions = NULL, ...)"},{"path":"/reference/aws_vpc_security_group_ingress.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Authorize Security Group Ingress — aws_vpc_security_group_ingress","text":"id (character) security group id. required ip_permissions (list) list persmissions. see link paws docs use ip_permissions_generator() generate list parameter ... named parameters passed authorize_security_group_ingress","code":""},{"path":"/reference/aws_vpc_security_group_ingress.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Authorize Security Group Ingress — aws_vpc_security_group_ingress","text":"list slots: Return (boolean) SecurityGroupRules (list) SecurityGroupRuleId GroupId GroupOwnerId IsEgress IpProtocol FromPort ToPort CidrIpv4 CidrIpv6 PrefixListId ReferencedGroupInfo Description Tags","code":""},{"path":[]},{"path":"/reference/aws_vpc_security_groups.html","id":null,"dir":"Reference","previous_headings":"","what":"List VPC security groups — aws_vpc_security_groups","title":"List VPC security groups — aws_vpc_security_groups","text":"List VPC security groups","code":""},{"path":"/reference/aws_vpc_security_groups.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List VPC security groups — aws_vpc_security_groups","text":"","code":"aws_vpc_security_groups(...)"},{"path":"/reference/aws_vpc_security_groups.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List VPC security groups — aws_vpc_security_groups","text":"... named parameters passed describe_security_groups","code":""},{"path":"/reference/aws_vpc_security_groups.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List VPC security groups — aws_vpc_security_groups","text":"(list) list security groups","code":""},{"path":[]},{"path":"/reference/aws_vpc_security_groups.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List VPC security groups — aws_vpc_security_groups","text":"","code":"if (FALSE) { # interactive() aws_vpc_security_groups() aws_vpc_security_groups(MaxResults = 6) }"},{"path":"/reference/aws_vpc_sg_with_ingresss.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a security group with one ingress rule based on the engine — aws_vpc_sg_with_ingresss","title":"Get a security group with one ingress rule based on the engine — aws_vpc_sg_with_ingresss","text":"Get security group one ingress rule based engine","code":""},{"path":"/reference/aws_vpc_sg_with_ingresss.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a security group with one ingress rule based on the engine — aws_vpc_sg_with_ingresss","text":"","code":"aws_vpc_sg_with_ingresss(engine)"},{"path":"/reference/aws_vpc_sg_with_ingresss.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a security group with one ingress rule based on the engine — aws_vpc_sg_with_ingresss","text":"engine (character) engine use. default: \"mariadb\". required. one : mariadb, mysql, postgres, redshift","code":""},{"path":"/reference/aws_vpc_sg_with_ingresss.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a security group with one ingress rule based on the engine — aws_vpc_sg_with_ingresss","text":"(character) security group ID","code":""},{"path":"/reference/aws_vpc_sg_with_ingresss.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get a security group with one ingress rule based on the engine — aws_vpc_sg_with_ingresss","text":"Adds ingress rule specific engine supplied (port changes based engine), IP address. create security group ingress rules see aws_vpc_security_group_create() aws_vpc_security_group_ingress()","code":""},{"path":[]},{"path":"/reference/aws_vpcs.html","id":null,"dir":"Reference","previous_headings":"","what":"List VPCs — aws_vpcs","title":"List VPCs — aws_vpcs","text":"List VPCs","code":""},{"path":"/reference/aws_vpcs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List VPCs — aws_vpcs","text":"","code":"aws_vpcs(...)"},{"path":"/reference/aws_vpcs.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List VPCs — aws_vpcs","text":"... parameters passed describe_vpcs","code":""},{"path":"/reference/aws_vpcs.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List VPCs — aws_vpcs","text":"(list) list VPCs","code":""},{"path":"/reference/aws_vpcs.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List VPCs — aws_vpcs","text":"","code":"if (FALSE) { # interactive() aws_vpcs() aws_vpcs(MaxResults = 6) }"},{"path":"/reference/bucket_arn.html","id":null,"dir":"Reference","previous_headings":"","what":"Get bucket ARN — bucket_arn","title":"Get bucket ARN — bucket_arn","text":"Get bucket ARN","code":""},{"path":"/reference/bucket_arn.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get bucket ARN — bucket_arn","text":"","code":"bucket_arn(bucket, objects = \"\")"},{"path":"/reference/bucket_arn.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get bucket ARN — bucket_arn","text":"bucket (character) bucket name. required. objects (character) path object(s). default: \"\"","code":""},{"path":"/reference/bucket_arn.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get bucket ARN — bucket_arn","text":"character string bucket arn","code":""},{"path":"/reference/bucket_arn.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get bucket ARN — bucket_arn","text":"","code":"bucket_arn(\"somebucket\") #> arn:aws:s3:::somebucket bucket_arn(\"somebucket\", objects = \"*\") #> arn:aws:s3:::somebucket/* bucket_arn(\"somebucket\", objects = \"data.csv\") #> arn:aws:s3:::somebucket/data.csv bucket_arn(\"somebucket\", objects = \"myfolder/subset/data.csv\") #> arn:aws:s3:::somebucket/myfolder/subset/data.csv bucket_arn(\"somebucket\", objects = \"myfolder/subset/*\") #> arn:aws:s3:::somebucket/myfolder/subset/*"},{"path":"/reference/bucket_create_if_not.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a bucket if it does not exist — bucket_create_if_not","title":"Create a bucket if it does not exist — bucket_create_if_not","text":"Create bucket exist","code":""},{"path":"/reference/bucket_create_if_not.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a bucket if it does not exist — bucket_create_if_not","text":"","code":"bucket_create_if_not(bucket, force = FALSE)"},{"path":"/reference/bucket_create_if_not.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a bucket if it does not exist — bucket_create_if_not","text":"bucket (character) bucket name. required force (logical) force deletion without going prompt. default: FALSE. set TRUE required non-interactive use.","code":""},{"path":"/reference/bucket_region.html","id":null,"dir":"Reference","previous_headings":"","what":"Get bucket region — bucket_region","title":"Get bucket region — bucket_region","text":"Get bucket region","code":""},{"path":"/reference/bucket_region.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get bucket region — bucket_region","text":"","code":"bucket_region(bucket)"},{"path":"/reference/bucket_region.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get bucket region — bucket_region","text":"character string bucket region; NULL bucket found","code":""},{"path":"/reference/cluster_con_info.html","id":null,"dir":"Reference","previous_headings":"","what":"Get connection information for all clusters — cluster_con_info","title":"Get connection information for all clusters — cluster_con_info","text":"Get connection information clusters","code":""},{"path":"/reference/cluster_con_info.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get connection information for all clusters — cluster_con_info","text":"","code":"cluster_con_info(id)"},{"path":"/reference/cluster_con_info.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get connection information for all clusters — cluster_con_info","text":"id (character) Cluster identifier. Use identifier refer cluster subsequent cluster operations deleting modifying. identifier also appears Amazon Redshift console. Must unique clusters within Amazon Web Services account.","code":""},{"path":"/reference/cluster_con_info.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get connection information for all clusters — cluster_con_info","text":"list cluster details","code":""},{"path":"/reference/cluster_details.html","id":null,"dir":"Reference","previous_headings":"","what":"Get information for all clusters — cluster_details","title":"Get information for all clusters — cluster_details","text":"Get information clusters","code":""},{"path":"/reference/cluster_details.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get information for all clusters — cluster_details","text":"","code":"cluster_details()"},{"path":"/reference/cluster_details.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get information for all clusters — cluster_details","text":"list cluster details, see link format, slots: Marker (pagination) Clusters (cluster; empty list clusters)","code":""},{"path":"/reference/cluster_details.html","id":"references","dir":"Reference","previous_headings":"","what":"References","title":"Get information for all clusters — cluster_details","text":"https://www.paws-r-sdk.com/docs/redshift_describe_clusters/","code":""},{"path":"/reference/con_factory.html","id":null,"dir":"Reference","previous_headings":"","what":"paws connection factory — con_factory","title":"paws connection factory — con_factory","text":"paws connection factory","code":""},{"path":"/reference/con_factory.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"paws connection factory — con_factory","text":"","code":"con_factory(service)"},{"path":"/reference/con_factory.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"paws connection factory — con_factory","text":"service (character) service supported paws","code":""},{"path":"/reference/con_factory.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"paws connection factory — con_factory","text":"function returning client service service parameter","code":""},{"path":"/reference/con_iam.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a paws client for a service — con_iam","title":"Get a paws client for a service — con_iam","text":"Get paws client service","code":""},{"path":"/reference/con_iam.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a paws client for a service — con_iam","text":"","code":"con_iam() con_s3() con_sm() con_ec2() con_rds() con_redshift() con_ce()"},{"path":"/reference/con_iam.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a paws client for a service — con_iam","text":"con_s3: list methods interfacing S3; https://www.paws-r-sdk.com/docs/s3/ con_iam: list methods interfacing IAM; https://www.paws-r-sdk.com/docs/iam/ con_sm: list methods interfacing Secrets Manager; https://www.paws-r-sdk.com/docs/secretsmanager/ con_ec2: list methods interfacing EC2; https://www.paws-r-sdk.com/docs/ec2/ con_rds: list methods interfacing RDS; https://www.paws-r-sdk.com/docs/rds/ con_redshift: list methods interfacing Redshift; https://www.paws-r-sdk.com/docs/redshift/ con_ce: list methods interfacing Cost Explorer; https://www.paws-r-sdk.com/docs/costexplorer/","code":""},{"path":"/reference/con_iam.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get a paws client for a service — con_iam","text":"Toggles credentials used based environment variable AWS_PROFILE one : minio, localstack, aws. AWS_PROFILE \"minio\" set following credentials connection: access_key_id uses env var MINIO_USER, default \"minioadmin\" secret_access_key uses env var MINIO_PWD, default \"minioadmin\" endpoint uses env var MINIO_ENDPOINT, default \"http://127.0.0.1:9000\" AWS_PROFILE \"localstack\" set following credentials connection: access_key_id uses env var LOCALSTACK_KEY, default string essentially ignored. need set LOCALSTACK_KEY env var. However, want set account ID Localstack can set env var used. see https://docs.localstack.cloud/references/credentials/ secret_access_key uses env var LOCALSTACK_SECRET, default string ignored; value set LOCALSTACK_SECRET ignored Localstack well. see https://docs.localstack.cloud/references/credentials/ endpoint uses env var LOCALSTACK_ENDPOINT. can set URL Localstack running . Default http://localhost.localstack.cloud:4566 AWS_PROFILE set, set \"aws\", anything else (\"localstack\") set credentials internally, paws gather credentials set via env vars, config files, etc.-","code":""},{"path":[]},{"path":"/reference/con_iam.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get a paws client for a service — con_iam","text":"","code":"if (FALSE) { # interactive() z <- con_iam() z z$get_group withr::with_envvar( c(\"AWS_PROFILE\" = \"localstack\"), con_iam() ) withr::with_envvar( c(\"AWS_PROFILE\" = \"minio\"), con_s3() ) }"},{"path":"/reference/con_s3fs.html","id":null,"dir":"Reference","previous_headings":"","what":"s3fs connection — con_s3fs","title":"s3fs connection — con_s3fs","text":"s3fs connection","code":""},{"path":"/reference/con_s3fs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"s3fs connection — con_s3fs","text":"","code":"con_s3fs()"},{"path":"/reference/con_s3fs.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"s3fs connection — con_s3fs","text":"S3 list class 'sixtyfour_client'","code":""},{"path":"/reference/con_s3fs.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"s3fs connection — con_s3fs","text":"set refresh=TRUE s3fs::s3_file_system() can change s3 interface within R session can toggle interface set one minio, localstack, aws. See connections information.","code":""},{"path":[]},{"path":"/reference/con_s3fs.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"s3fs connection — con_s3fs","text":"","code":"if (FALSE) { # interactive() con <- con_s3fs() con con_s3fs()$file_copy }"},{"path":"/reference/construct_db_secret.html","id":null,"dir":"Reference","previous_headings":"","what":"Construct a database secret string or raw version of it — construct_db_secret","title":"Construct a database secret string or raw version of it — construct_db_secret","text":"Construct database secret string raw version ","code":""},{"path":"/reference/construct_db_secret.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Construct a database secret string or raw version of it — construct_db_secret","text":"","code":"construct_db_secret( engine, host = \"\", username = \"\", password = \"\", dbname = \"\", port = \"\", as = \"string\" )"},{"path":"/reference/construct_db_secret.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Construct a database secret string or raw version of it — construct_db_secret","text":"engine, host, username, password, dbname, port supply parameters go either json string raw version json string (character) one \"string\" \"raw\"","code":""},{"path":"/reference/construct_db_secret.html","id":"references","dir":"Reference","previous_headings":"","what":"References","title":"Construct a database secret string or raw version of it — construct_db_secret","text":"https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_secret_json_structure.html # nolint","code":""},{"path":"/reference/construct_db_secret.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Construct a database secret string or raw version of it — construct_db_secret","text":"","code":"if (FALSE) { construct_db_secret(\"redshift\", dbname = \"hello\", port = 5439) construct_db_secret(\"mariadb\", dbname = \"world\", port = 3306) construct_db_secret(\"postgresql\", dbname = \"bears\", port = 5432, as = \"raw\") }"},{"path":"/reference/figure_out_policy_arn.html","id":null,"dir":"Reference","previous_headings":"","what":"Figure out policy Arn from a name — figure_out_policy_arn","title":"Figure out policy Arn from a name — figure_out_policy_arn","text":"Figure policy Arn name","code":""},{"path":"/reference/figure_out_policy_arn.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Figure out policy Arn from a name — figure_out_policy_arn","text":"","code":"figure_out_policy_arn(name)"},{"path":"/reference/figure_out_policy_arn.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Figure out policy Arn from a name — figure_out_policy_arn","text":"","code":"if (FALSE) { # interactive() # user managed, exists figure_out_policy_arn(\"MyTestPolicy\") # user managed, doesn't exist figure_out_policy_arn(\"DoesNotExist\") # aws managed figure_out_policy_arn(\"AmazonS3ReadOnlyAccess\") # aws managed, job function figure_out_policy_arn(\"Billing\") figure_out_policy_arn(\"DataScientist\") }"},{"path":"/reference/group_policies.html","id":null,"dir":"Reference","previous_headings":"","what":"Preset group policies — group_policies","title":"Preset group policies — group_policies","text":"Preset group policies","code":""},{"path":"/reference/group_policies.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Preset group policies — group_policies","text":"","code":"group_policies(group)"},{"path":"/reference/group_policies.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Preset group policies — group_policies","text":"group (character)","code":""},{"path":"/reference/group_policies.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Preset group policies — group_policies","text":"character vector policy names","code":""},{"path":"/reference/group_policies.html","id":"admin-group-policies","dir":"Reference","previous_headings":"","what":"Admin group policies","title":"Preset group policies — group_policies","text":"AdministratorAccess Billing CostOptimizationHubAdminAccess AWSBillingReadOnlyAccess AWSCostAndUsageReportAutomationPolicy","code":""},{"path":"/reference/group_policies.html","id":"user-group-policies","dir":"Reference","previous_headings":"","what":"User group policies","title":"Preset group policies — group_policies","text":"AmazonRDSReadOnlyAccess AmazonRedshiftReadOnlyAccess AmazonS3ReadOnlyAccess AWSBillingReadOnlyAccess IAMReadOnlyAccess","code":""},{"path":"/reference/group_policies.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Preset group policies — group_policies","text":"","code":"group_policies(\"admin\") #> [1] \"AdministratorAccess\" #> [2] \"Billing\" #> [3] \"CostOptimizationHubAdminAccess\" #> [4] \"AWSBillingReadOnlyAccess\" #> [5] \"AWSCostAndUsageReportAutomationPolicy\" group_policies(\"users\") #> [1] \"AmazonRDSReadOnlyAccess\" \"AmazonRedshiftReadOnlyAccess\" #> [3] \"AmazonS3ReadOnlyAccess\" \"AWSBillingReadOnlyAccess\" #> [5] \"IAMReadOnlyAccess\""},{"path":"/reference/instance_con_info.html","id":null,"dir":"Reference","previous_headings":"","what":"Get connection information for all instances — instance_con_info","title":"Get connection information for all instances — instance_con_info","text":"Get connection information instances","code":""},{"path":"/reference/instance_con_info.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get connection information for all instances — instance_con_info","text":"","code":"instance_con_info(id)"},{"path":"/reference/instance_con_info.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get connection information for all instances — instance_con_info","text":"id (character) Cluster identifier. Use identifier refer cluster subsequent cluster operations deleting modifying. identifier also appears Amazon Redshift console. Must unique clusters within Amazon Web Services account.","code":""},{"path":"/reference/instance_con_info.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get connection information for all instances — instance_con_info","text":"list cluster details","code":""},{"path":"/reference/instance_details.html","id":null,"dir":"Reference","previous_headings":"","what":"Get information for all RDS instances — instance_details","title":"Get information for all RDS instances — instance_details","text":"Get information RDS instances","code":""},{"path":"/reference/instance_details.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get information for all RDS instances — instance_details","text":"","code":"instance_details()"},{"path":"/reference/instance_details.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get information for all RDS instances — instance_details","text":"list RDS instance details, see link format, slots: Marker (pagination) DBInstances (instance; empty list instances)","code":""},{"path":"/reference/instance_details.html","id":"references","dir":"Reference","previous_headings":"","what":"References","title":"Get information for all RDS instances — instance_details","text":"https://www.paws-r-sdk.com/docs/describe_db_instances/","code":""},{"path":"/reference/ip_address.html","id":null,"dir":"Reference","previous_headings":"","what":"Get your IP address using https://ifconfig.me/ip — ip_address","title":"Get your IP address using https://ifconfig.me/ip — ip_address","text":"Get IP address using https://ifconfig./ip","code":""},{"path":"/reference/ip_address.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get your IP address using https://ifconfig.me/ip — ip_address","text":"","code":"ip_address()"},{"path":"/reference/ip_address.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get your IP address using https://ifconfig.me/ip — ip_address","text":"(character) ip address","code":""},{"path":"/reference/ip_permissions_generator.html","id":null,"dir":"Reference","previous_headings":"","what":"Ip Permissions generator — ip_permissions_generator","title":"Ip Permissions generator — ip_permissions_generator","text":"Ip Permissions generator","code":""},{"path":"/reference/ip_permissions_generator.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Ip Permissions generator — ip_permissions_generator","text":"","code":"ip_permissions_generator(engine, port = NULL, description = NULL)"},{"path":"/reference/ip_permissions_generator.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Ip Permissions generator — ip_permissions_generator","text":"engine (character) one mariadb, mysql, postgres port (character) port number. port determined engine port given. default: NULL description (character) description. given, autogenerated depending value engine","code":""},{"path":"/reference/ip_permissions_generator.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Ip Permissions generator — ip_permissions_generator","text":"list slots: FromPort, ToPort, IpProtocol, IpRanges","code":""},{"path":"/reference/last.html","id":null,"dir":"Reference","previous_headings":"","what":"Get the last element of a vector — last","title":"Get the last element of a vector — last","text":"Get last element vector","code":""},{"path":"/reference/last.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get the last element of a vector — last","text":"","code":"last(x)"},{"path":"/reference/last.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get the last element of a vector — last","text":"x vector","code":""},{"path":"/reference/last.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get the last element of a vector — last","text":"last element vector","code":""},{"path":"/reference/paginate_aws_marker.html","id":null,"dir":"Reference","previous_headings":"","what":"Paginate over list_* methods with Marker/IsTruncated — paginate_aws_marker","title":"Paginate over list_* methods with Marker/IsTruncated — paginate_aws_marker","text":"Currently works IAM - .e., IAM hard-coded internally","code":""},{"path":"/reference/paginate_aws_marker.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Paginate over list_* methods with Marker/IsTruncated — paginate_aws_marker","text":"","code":"paginate_aws_marker(fun, target, ...)"},{"path":"/reference/paginate_aws_marker.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Paginate over list_* methods with Marker/IsTruncated — paginate_aws_marker","text":"fun (character) name function call - function target (character) list element get ... named args passed fun","code":""},{"path":"/reference/paginate_aws_token.html","id":null,"dir":"Reference","previous_headings":"","what":"Paginate over list_* methods with NextToken — paginate_aws_token","title":"Paginate over list_* methods with NextToken — paginate_aws_token","text":"Paginate list_* methods NextToken","code":""},{"path":"/reference/paginate_aws_token.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Paginate over list_* methods with NextToken — paginate_aws_token","text":"","code":"paginate_aws_token(fun, target, ...)"},{"path":"/reference/paginate_aws_token.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Paginate over list_* methods with NextToken — paginate_aws_token","text":"fun (character) name function call - function target (character) list element get ... named args passed fun","code":""},{"path":"/reference/paginate_aws_token.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Paginate over list_* methods with NextToken — paginate_aws_token","text":"","code":"if (FALSE) { paginate_aws_token( fun = con_sm()$list_secrets, target = \"SecretList\" ) }"},{"path":"/reference/path_as_s3.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert a s3 like path to a single format — path_as_s3","title":"Convert a s3 like path to a single format — path_as_s3","text":"Convert s3 like path single format","code":""},{"path":"/reference/path_as_s3.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert a s3 like path to a single format — path_as_s3","text":"","code":"path_as_s3(paths)"},{"path":"/reference/path_as_s3.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert a s3 like path to a single format — path_as_s3","text":"paths (character) one s3 paths","code":""},{"path":"/reference/path_as_s3.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convert a s3 like path to a single format — path_as_s3","text":"vector s3 paths (character), form: s3:////","code":""},{"path":"/reference/path_as_s3.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Convert a s3 like path to a single format — path_as_s3","text":"","code":"if (FALSE) { # interactive() path_as_s3(\"http://s64-test-3.s3.amazonaws.com/\") path_as_s3(\"https://s64-test-3.s3.amazonaws.com/\") path_as_s3(c( \"https://s64-test-3.s3.amazonaws.com/\", \"https://mybucket.s3.amazonaws.com/\" )) path_as_s3(c(\"apple\", \"banana\", \"pear\", \"pineapple\")) }"},{"path":"/reference/path_s3_build.html","id":null,"dir":"Reference","previous_headings":"","what":"Build s3 paths — path_s3_build","title":"Build s3 paths — path_s3_build","text":"Build s3 paths","code":""},{"path":"/reference/path_s3_build.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build s3 paths — path_s3_build","text":"","code":"path_s3_build(x)"},{"path":"/reference/path_s3_build.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build s3 paths — path_s3_build","text":"x unnamed list parsed paths, path_s3_parse()","code":""},{"path":"/reference/path_s3_build.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Build s3 paths — path_s3_build","text":"","code":"if (FALSE) { # interactive() paths <- c( \"s3://s64-test-2/DESCRIPTION\", \"s3://s64-test-2/stuff.txt\", \"s3://s64-test-2/some/other/path/things.csv\" ) x <- path_s3_parse(paths) path_s3_build(x) }"},{"path":"/reference/path_s3_parse.html","id":null,"dir":"Reference","previous_headings":"","what":"Parse s3 paths — path_s3_parse","title":"Parse s3 paths — path_s3_parse","text":"Parse s3 paths","code":""},{"path":"/reference/path_s3_parse.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Parse s3 paths — path_s3_parse","text":"","code":"path_s3_parse(paths)"},{"path":"/reference/path_s3_parse.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Parse s3 paths — path_s3_parse","text":"paths (character) one s3 paths","code":""},{"path":"/reference/path_s3_parse.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Parse s3 paths — path_s3_parse","text":"unnamed list slot named list bucket, path, file","code":""},{"path":"/reference/path_s3_parse.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Parse s3 paths — path_s3_parse","text":"","code":"if (FALSE) { # interactive() path_s3_parse(\"s3://s64-test-2/DESCRIPTION\") path_s3_parse(\"s3://s64-test-2/some/other/path/things.csv\") paths <- c( \"s3://s64-test-2/DESCRIPTION\", \"s3://s64-test-2/stuff.txt\", \"s3://s64-test-2/some/other/path/things.csv\" ) path_s3_parse(paths) # if a path is not an s3 path paths <- c( \"s3://s64-test-2/DESCRIPTION\", \"s3://s64-test-2/stuff.txt\", \"s64-test-2/some/other/path/things.csv\" ) path_s3_parse(paths) }"},{"path":"/reference/random_string.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a random string with prefix — random_string","title":"Get a random string with prefix — random_string","text":"Get random string prefix","code":""},{"path":"/reference/random_string.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a random string with prefix — random_string","text":"","code":"random_string(prefix, size = 8)"},{"path":"/reference/random_string.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a random string with prefix — random_string","text":"prefix (character) string. required. size (character) length random part (including prefix)","code":""},{"path":"/reference/random_string.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a random string with prefix — random_string","text":"(character) string prefix beginning","code":""},{"path":"/reference/random_string.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get a random string with prefix — random_string","text":"","code":"random_string(\"bucket\") #> bucketmwlefoud replicate(10, random_string(\"bucket\")) #> [1] \"bucketfiexombk\" \"bucketkeulbfdp\" \"bucketbcvkgufi\" \"bucketvjubqtaf\" #> [5] \"bucketbsnaoreh\" \"bucketalspkcbj\" \"bucketcfdjagys\" \"bucketybhawgli\" #> [9] \"bucketjbfglnew\" \"bucketslqexmfa\""},{"path":"/reference/random_user.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a random user — random_user","title":"Get a random user — random_user","text":"Get random user","code":""},{"path":"/reference/random_user.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a random user — random_user","text":"","code":"random_user()"},{"path":"/reference/random_user.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a random user — random_user","text":"(character) username random adjective plus random noun combined one string, shortened longer 16 characters longer 16","code":""},{"path":"/reference/random_user.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get a random user — random_user","text":"","code":"random_user() #> [1] \"InsensibleParson\" replicate(10, random_user()) #> [1] \"FamousCountdown\" \"UnintendedMonume\" \"UnattractiveDomi\" \"SanctionedLoathi\" #> [5] \"PacedLeopard\" \"UntimelyEstimati\" \"HandheldRecurren\" \"WidowDenominatio\" #> [9] \"OrdinateTourist\" \"ConsequentialAnn\""},{"path":"/reference/reexports.html","id":null,"dir":"Reference","previous_headings":"","what":"Objects exported from other packages — reexports","title":"Objects exported from other packages — reexports","text":"objects imported packages. Follow links see documentation. s3fs s3_path","code":""},{"path":"/reference/resource_rds.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a resource string for a policy statement for RDS — resource_rds","title":"Create a resource string for a policy statement for RDS — resource_rds","text":"Create resource string policy statement RDS","code":""},{"path":"/reference/resource_rds.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a resource string for a policy statement for RDS — resource_rds","text":"","code":"resource_rds( user, resource_id, region = Sys.getenv(\"AWS_REGION\"), account = account_id() )"},{"path":"/reference/resource_rds.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a resource string for a policy statement for RDS — resource_rds","text":"user (character) user name IAM account. length>=1. required resource_id (character) identifier DB instance. length==1. required region (character) AWS Region DB instance. length==1 account (character) AWS account number DB instance. length==1. user must account account DB instance. default calls account_id()","code":""},{"path":"/reference/resource_rds.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a resource string for a policy statement for RDS — resource_rds","text":"resource ARN (character)","code":""},{"path":"/reference/s3_actions_full.html","id":null,"dir":"Reference","previous_headings":"","what":"S3 actions for full access (read and write), from the AWS\nmanaged policy AmazonS3FullAccess — s3_actions_full","title":"S3 actions for full access (read and write), from the AWS\nmanaged policy AmazonS3FullAccess — s3_actions_full","text":"S3 actions full access (read write), AWS managed policy AmazonS3FullAccess","code":""},{"path":"/reference/s3_actions_full.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"S3 actions for full access (read and write), from the AWS\nmanaged policy AmazonS3FullAccess — s3_actions_full","text":"","code":"s3_actions_full()"},{"path":"/reference/s3_actions_full.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"S3 actions for full access (read and write), from the AWS\nmanaged policy AmazonS3FullAccess — s3_actions_full","text":"character vector actions","code":""},{"path":"/reference/s3_actions_read.html","id":null,"dir":"Reference","previous_headings":"","what":"S3 actions for reading, from the AWS managed policy\nAmazonS3ReadOnlyAccess — s3_actions_read","title":"S3 actions for reading, from the AWS managed policy\nAmazonS3ReadOnlyAccess — s3_actions_read","text":"S3 actions reading, AWS managed policy AmazonS3ReadOnlyAccess","code":""},{"path":"/reference/s3_actions_read.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"S3 actions for reading, from the AWS managed policy\nAmazonS3ReadOnlyAccess — s3_actions_read","text":"","code":"s3_actions_read()"},{"path":"/reference/s3_actions_read.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"S3 actions for reading, from the AWS managed policy\nAmazonS3ReadOnlyAccess — s3_actions_read","text":"character vector actions","code":""},{"path":"/reference/service_map.html","id":null,"dir":"Reference","previous_headings":"","what":"Mapping of full names of AWS services to acronyms — service_map","title":"Mapping of full names of AWS services to acronyms — service_map","text":"Mapping full names AWS services acronyms","code":""},{"path":"/reference/service_map.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Mapping of full names of AWS services to acronyms — service_map","text":"","code":"service_map"},{"path":[]},{"path":"/reference/service_map.html","id":"service-map","dir":"Reference","previous_headings":"","what":"service_map","title":"Mapping of full names of AWS services to acronyms — service_map","text":"data frame 178 rows 2 columns: service Service name full acronym acronym, 2 5 characters length","code":""},{"path":"/reference/service_map.html","id":"source","dir":"Reference","previous_headings":"","what":"Source","title":"Mapping of full names of AWS services to acronyms — service_map","text":"https://tommymaynard.com/aws-service-acronyms/","code":""},{"path":"/reference/set_s3_interface.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the S3 compatible interface to use — set_s3_interface","title":"Set the S3 compatible interface to use — set_s3_interface","text":"Set S3 compatible interface use","code":""},{"path":"/reference/set_s3_interface.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the S3 compatible interface to use — set_s3_interface","text":"","code":"set_s3_interface(interface = \"aws\")"},{"path":"/reference/set_s3_interface.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the S3 compatible interface to use — set_s3_interface","text":"interface s3 compatible interface use. options: \"aws\" (default), \"minio\", \"localstack\"","code":""},{"path":"/reference/set_s3_interface.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set the S3 compatible interface to use — set_s3_interface","text":"paws s3 client object class list","code":""},{"path":"/reference/set_s3_interface.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Set the S3 compatible interface to use — set_s3_interface","text":"function sets connection details paws s3fs packages, returns something paws function expects access following environment variables: AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION MINIO_USER MINIO_PWD MINIO_ENDPOINT s3fs::s3_file_system() set refresh=TRUE can change s3 interface within R session.","code":""},{"path":"/reference/six_admin_setup.html","id":null,"dir":"Reference","previous_headings":"","what":"AWS account setup for administrators — six_admin_setup","title":"AWS account setup for administrators — six_admin_setup","text":"AWS account setup administrators","code":""},{"path":"/reference/six_admin_setup.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"AWS account setup for administrators — six_admin_setup","text":"","code":"six_admin_setup(users_group = \"users\", admin_group = \"admin\")"},{"path":"/reference/six_admin_setup.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"AWS account setup for administrators — six_admin_setup","text":"users_group (character) name users group. default: \"users\" admin_group (character) name admin group. default: \"admin\"","code":""},{"path":"/reference/six_admin_setup.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"AWS account setup for administrators — six_admin_setup","text":"NULL invisibly","code":""},{"path":"/reference/six_admin_setup.html","id":"what-is-magical","dir":"Reference","previous_headings":"","what":"What is magical","title":"AWS account setup for administrators — six_admin_setup","text":"Setup users IAM group: users require admin persmissions Add policies users group Setup admin IAM group: users require admin permissions Add policies admin group","code":""},{"path":[]},{"path":"/reference/six_bucket_add_user.html","id":null,"dir":"Reference","previous_headings":"","what":"Add a user to a bucket — six_bucket_add_user","title":"Add a user to a bucket — six_bucket_add_user","text":"Add user bucket","code":""},{"path":"/reference/six_bucket_add_user.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Add a user to a bucket — six_bucket_add_user","text":"","code":"six_bucket_add_user(bucket, username, permissions)"},{"path":"/reference/six_bucket_add_user.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Add a user to a bucket — six_bucket_add_user","text":"bucket (character) bucket name. required username (character) user name. required permissions (character) user permissions, one read write. write includes read","code":""},{"path":"/reference/six_bucket_add_user.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Add a user to a bucket — six_bucket_add_user","text":"invisibly returns nothing","code":""},{"path":"/reference/six_bucket_add_user.html","id":"permissions","dir":"Reference","previous_headings":"","what":"Permissions","title":"Add a user to a bucket — six_bucket_add_user","text":"read: read ; allowed write admin tasks write: write (addition read); includes deleting files; include deleting buckets admin: change user permissions (addition read write); includes deleting buckets (OPTION ACCEPTED YET!)","code":""},{"path":"/reference/six_bucket_add_user.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Add a user to a bucket — six_bucket_add_user","text":"","code":"if (FALSE) { # interactive() # create a bucket bucket <- random_string(\"bucket\") if (!aws_bucket_exists(bucket)) { aws_bucket_create(bucket) } # create a user user <- random_user() if (!aws_user_exists(user)) { aws_user_create(user) } six_bucket_add_user( bucket = bucket, username = user, permissions = \"read\" ) # cleanup six_user_delete(user) aws_bucket_delete(bucket, force = TRUE) if (FALSE) { # not a valid permissions string six_bucket_add_user( bucket = \"mybucket\", username = \"userdmgziqpt\", permissions = \"notavalidpermission\" ) } }"},{"path":"/reference/six_bucket_change_user.html","id":null,"dir":"Reference","previous_headings":"","what":"Change user permissions for a bucket — six_bucket_change_user","title":"Change user permissions for a bucket — six_bucket_change_user","text":"Change user permissions bucket","code":""},{"path":"/reference/six_bucket_change_user.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Change user permissions for a bucket — six_bucket_change_user","text":"","code":"six_bucket_change_user(bucket, username, permissions)"},{"path":"/reference/six_bucket_change_user.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Change user permissions for a bucket — six_bucket_change_user","text":"bucket (character) bucket name. required username (character) user name. required permissions (character) user permissions, one read write. write includes read","code":""},{"path":"/reference/six_bucket_change_user.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Change user permissions for a bucket — six_bucket_change_user","text":"invisibly returns nothing","code":""},{"path":"/reference/six_bucket_change_user.html","id":"important","dir":"Reference","previous_headings":"","what":"Important","title":"Change user permissions for a bucket — six_bucket_change_user","text":"function built around policies named package. use policies name function may work.","code":""},{"path":"/reference/six_bucket_change_user.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Change user permissions for a bucket — six_bucket_change_user","text":"","code":"if (FALSE) { # interactive() # create a bucket bucket <- random_string(\"bucket\") if (!aws_bucket_exists(bucket)) { aws_bucket_create(bucket) } # create user user <- random_user() if (!aws_user_exists(user)) { aws_user_create(user) } # user doesn't have any permissions for the bucket # - use six_bucket_add_user to add permissions six_bucket_change_user( bucket = bucket, username = user, permissions = \"read\" ) six_bucket_add_user( bucket = bucket, username = user, permissions = \"read\" ) # want to change to read to write, makes the change six_bucket_change_user( bucket = bucket, username = user, permissions = \"write\" ) # want to change to write - but already has write six_bucket_change_user( bucket = bucket, username = user, permissions = \"write\" ) # cleanup six_user_delete(user) aws_bucket_delete(bucket, force = TRUE) }"},{"path":"/reference/six_bucket_delete.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete an S3 bucket — six_bucket_delete","title":"Delete an S3 bucket — six_bucket_delete","text":"Takes care deleting bucket objects, bucket can deleted cleanly","code":""},{"path":"/reference/six_bucket_delete.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete an S3 bucket — six_bucket_delete","text":"","code":"six_bucket_delete(bucket, force = FALSE, ...)"},{"path":"/reference/six_bucket_delete.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete an S3 bucket — six_bucket_delete","text":"bucket (character) bucket name. required force (logical) force deletion without going prompt. default: FALSE. set TRUE required non-interactive use. ... named parameters passed delete_bucket","code":""},{"path":"/reference/six_bucket_delete.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete an S3 bucket — six_bucket_delete","text":"NULL, invisibly","code":""},{"path":"/reference/six_bucket_delete.html","id":"what-is-magical","dir":"Reference","previous_headings":"","what":"What is magical","title":"Delete an S3 bucket — six_bucket_delete","text":"Exits early bucket exist Checks objects bucket deletes present Deletes bucket deleting objects","code":""},{"path":[]},{"path":"/reference/six_bucket_delete.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Delete an S3 bucket — six_bucket_delete","text":"","code":"if (FALSE) { # interactive() # bucket does not exist six_bucket_delete(\"notabucket\") # bucket exists w/o objects bucket <- random_string(\"bucket\") aws_bucket_create(bucket) six_bucket_delete(bucket) # bucket exists w/ objects (files and directories with files) bucket <- random_string(\"bucket\") aws_bucket_create(bucket) demo_rds_file <- file.path(system.file(), \"Meta/demo.rds\") links_file <- file.path(system.file(), \"Meta/links.rds\") aws_file_upload( c(demo_rds_file, links_file), s3_path(bucket, c(basename(demo_rds_file), basename(links_file))) ) aws_file_upload( c(demo_rds_file, links_file), s3_path( bucket, \"newfolder\", c(basename(demo_rds_file), basename(links_file)) ) ) aws_bucket_list_objects(bucket) six_bucket_delete(bucket) }"},{"path":"/reference/six_bucket_permissions.html","id":null,"dir":"Reference","previous_headings":"","what":"Get permissions for a bucket — six_bucket_permissions","title":"Get permissions for a bucket — six_bucket_permissions","text":"Get permissions bucket","code":""},{"path":"/reference/six_bucket_permissions.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get permissions for a bucket — six_bucket_permissions","text":"","code":"six_bucket_permissions(bucket)"},{"path":"/reference/six_bucket_permissions.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get permissions for a bucket — six_bucket_permissions","text":"bucket (character) bucket name. required","code":""},{"path":"/reference/six_bucket_permissions.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get permissions for a bucket — six_bucket_permissions","text":"tibble row user, columns: user (always present) permissions (always present) policy_read (optionally present) policy name behind \"read\" permission (present) policy_admin (optionally present) policy name behind \"admin\" permission (present) Note users persmissions shown; see aws_users()","code":""},{"path":"/reference/six_bucket_permissions.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get permissions for a bucket — six_bucket_permissions","text":"","code":"if (FALSE) { # interactive() # create a bucket bucket <- random_string(\"bucket\") if (!aws_bucket_exists(bucket)) aws_bucket_create(bucket) # create user user <- random_user() if (!aws_user_exists(user)) aws_user_create(user) six_bucket_permissions(bucket) six_bucket_add_user(bucket, user, permissions = \"read\") six_bucket_permissions(bucket) six_bucket_remove_user(bucket, user) six_bucket_permissions(bucket) # cleanup six_user_delete(user) aws_bucket_delete(bucket, force = TRUE) }"},{"path":"/reference/six_bucket_remove_user.html","id":null,"dir":"Reference","previous_headings":"","what":"Remove a user from a bucket — six_bucket_remove_user","title":"Remove a user from a bucket — six_bucket_remove_user","text":"Remove user bucket","code":""},{"path":"/reference/six_bucket_remove_user.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Remove a user from a bucket — six_bucket_remove_user","text":"","code":"six_bucket_remove_user(bucket, username)"},{"path":"/reference/six_bucket_remove_user.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Remove a user from a bucket — six_bucket_remove_user","text":"bucket (character) bucket name. required username (character) user name. required","code":""},{"path":"/reference/six_bucket_remove_user.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Remove a user from a bucket — six_bucket_remove_user","text":"invisibly returns nothing","code":""},{"path":"/reference/six_bucket_remove_user.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Remove a user from a bucket — six_bucket_remove_user","text":"function detaches policy user accessing bucket; policy untouched","code":""},{"path":"/reference/six_bucket_remove_user.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Remove a user from a bucket — six_bucket_remove_user","text":"","code":"if (FALSE) { # interactive() # create a bucket bucket <- random_string(\"bucket\") if (!aws_bucket_exists(bucket)) aws_bucket_create(bucket) # create user user <- random_user() if (!aws_user_exists(user)) aws_user_create(user) six_bucket_add_user(bucket, user, permissions = \"read\") six_bucket_remove_user(bucket, user) # cleanup six_user_delete(user) aws_bucket_delete(bucket, force = TRUE) }"},{"path":"/reference/six_file_upload.html","id":null,"dir":"Reference","previous_headings":"","what":"Magically upload a file — six_file_upload","title":"Magically upload a file — six_file_upload","text":"Magically upload file","code":""},{"path":"/reference/six_file_upload.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Magically upload a file — six_file_upload","text":"","code":"six_file_upload(path, bucket, force = FALSE, ...)"},{"path":"/reference/six_file_upload.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Magically upload a file — six_file_upload","text":"path (character) one file paths add bucket. required. include directories bucket (character) bucket copy files . required. bucket exist prompt asking like bucket created force (logical) force bucket creation without going prompt. default: FALSE. set TRUE required non-interactive use. ... named params passed put_object","code":""},{"path":"/reference/six_file_upload.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Magically upload a file — six_file_upload","text":"(character) vector remote s3 paths files located","code":""},{"path":"/reference/six_file_upload.html","id":"what-is-magical","dir":"Reference","previous_headings":"","what":"What is magical","title":"Magically upload a file — six_file_upload","text":"Exits early files exist Exits early path values directories Creates bucket exist Adds files bucket, figuring key use supplied path Function vectoried path argument; can pass many file paths","code":""},{"path":[]},{"path":"/reference/six_file_upload.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Magically upload a file — six_file_upload","text":"","code":"if (FALSE) { # interactive() bucket <- random_string(\"bucket\") demo_rds_file <- file.path(system.file(), \"Meta/demo.rds\") six_file_upload(demo_rds_file, bucket) ## many files at once links_file <- file.path(system.file(), \"Meta/links.rds\") six_file_upload(c(demo_rds_file, links_file), bucket) # set expiration, expire 1 minute from now six_file_upload(demo_rds_file, bucket, Expires = Sys.time() + 60) # bucket doesn't exist, ask if you want to create it six_file_upload(demo_rds_file, \"not-a-buckets\") # path doesn't exist # six_file_upload(\"file_doesnt_exist.txt\", random_string(\"bucket\")) # directories not supported mydir <- tempdir() # six_file_upload(mydir, random_string(\"bucket\")) }"},{"path":"/reference/six_user_create.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a user — six_user_create","title":"Create a user — six_user_create","text":"Create user","code":""},{"path":"/reference/six_user_create.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a user — six_user_create","text":"","code":"six_user_create(username, path = NULL, permission_boundary = NULL, tags = NULL)"},{"path":"/reference/six_user_create.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a user — six_user_create","text":"username (character) user name. required path (character) path user name. optional. included, defaults slash (/). permission_boundary (character) ARN managed policy used set permissions boundary user. optional tags (list) list tags want attach new user. optional","code":""},{"path":"/reference/six_user_create.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a user — six_user_create","text":"NULL invisibly. draft email copied clipboard","code":""},{"path":"/reference/six_user_create.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Create a user — six_user_create","text":"See aws_user_create() details. function creates user, adds policies user can access account, grants access key. Add policies using aws_polic* functions","code":""},{"path":"/reference/six_user_create.html","id":"what-is-magical","dir":"Reference","previous_headings":"","what":"What is magical","title":"Create a user — six_user_create","text":"Adds GetUser policy account exist yet Attaches GetUser policy user created Grants access key","code":""},{"path":[]},{"path":"/reference/six_user_create.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a user — six_user_create","text":"","code":"if (FALSE) { # interactive() name <- random_user() six_user_create(name) }"},{"path":"/reference/six_user_creds.html","id":null,"dir":"Reference","previous_headings":"","what":"Create access keys for a user — six_user_creds","title":"Create access keys for a user — six_user_creds","text":"Creates new Amazon Web Services secret access key corresponding Amazon Web Services access key ID","code":""},{"path":"/reference/six_user_creds.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create access keys for a user — six_user_creds","text":"","code":"six_user_creds(username, copy_to_cp = FALSE)"},{"path":"/reference/six_user_creds.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create access keys for a user — six_user_creds","text":"username (character) user name. required copy_to_cp (logical) Copy clipboard. Default: FALSE. See section \"Clipboard\" details.","code":""},{"path":"/reference/six_user_creds.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create access keys for a user — six_user_creds","text":"invisibly returns named list slots: UserName (character) AccessKeyId (character) Status (character) SecretAccessKey (character) CreateDate (POSIXct)","code":""},{"path":"/reference/six_user_creds.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Create access keys for a user — six_user_creds","text":"user can one pair access keys. default user can 2 pairs access keys. Using function replace existing set keys; instead adds additional set keys. See https://rstats.wtf/r-startup.html help bringing secrets R session. Note although return AWS Region output function IAM regional resources. can however use IAM manage regions account access , etc. See https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-regions.html #nolint","code":""},{"path":"/reference/six_user_creds.html","id":"important","dir":"Reference","previous_headings":"","what":"Important","title":"Create access keys for a user — six_user_creds","text":"Save secret key running function can viewed .","code":""},{"path":"/reference/six_user_creds.html","id":"clipboard","dir":"Reference","previous_headings":"","what":"Clipboard","title":"Create access keys for a user — six_user_creds","text":"set copy_to_cp=TRUE copy clipboard email template credentials small amount instructions. Please edit email information tailored group like store secrets.","code":""},{"path":"/reference/six_user_creds.html","id":"known-error-behaviors","dir":"Reference","previous_headings":"","what":"Known error behaviors","title":"Create access keys for a user — six_user_creds","text":"LimitExceeded (HTTP 409). exceed quota AccessKeysPerUser: 2 NoSuchEntity (HTTP 404). user name xxx found.","code":""},{"path":[]},{"path":"/reference/six_user_creds.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create access keys for a user — six_user_creds","text":"","code":"if (FALSE) { # interactive() user <- random_user() if (!aws_user_exists(user)) aws_user_create(user) six_user_creds(user) aws_user_access_key(user) six_user_creds(user, copy_to_cp = TRUE) aws_user_access_key(user) # cleanup six_user_delete(user) }"},{"path":"/reference/six_user_delete.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete a user — six_user_delete","title":"Delete a user — six_user_delete","text":"Delete user","code":""},{"path":"/reference/six_user_delete.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete a user — six_user_delete","text":"","code":"six_user_delete(username)"},{"path":"/reference/six_user_delete.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete a user — six_user_delete","text":"username (character) user name. required","code":""},{"path":"/reference/six_user_delete.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete a user — six_user_delete","text":"empty list","code":""},{"path":"/reference/six_user_delete.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Delete a user — six_user_delete","text":"See https://www.paws-r-sdk.com/docs/iam_delete_user/ docs details","code":""},{"path":"/reference/six_user_delete.html","id":"what-is-magical","dir":"Reference","previous_headings":"","what":"What is magical","title":"Delete a user — six_user_delete","text":"Detaches attached policies Deletes access keys deletes user","code":""},{"path":[]},{"path":"/reference/six_user_delete.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Delete a user — six_user_delete","text":"","code":"if (FALSE) { # interactive() name <- random_user() six_user_create(name) six_user_delete(name) }"},{"path":"/reference/sixtyfour-package.html","id":null,"dir":"Reference","previous_headings":"","what":"sixtyfour: Humane Interface to AWS — sixtyfour-package","title":"sixtyfour: Humane Interface to AWS — sixtyfour-package","text":"Write things give folks sense goal package , high level entrypoints, etc.","code":""},{"path":[]},{"path":"/reference/sixtyfour-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"sixtyfour: Humane Interface to AWS — sixtyfour-package","text":"Maintainer: Scott Chamberlain sachamber@fredhutch.org (ORCID) Authors: Sean Kross","code":""},{"path":"/reference/ui_fetch_secret.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch secrets — ui_fetch_secret","title":"Fetch secrets — ui_fetch_secret","text":"Fetch secrets","code":""},{"path":"/reference/ui_fetch_secret.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch secrets — ui_fetch_secret","text":"","code":"ui_fetch_secret(user = NULL, password = NULL, engine = NULL, id = NULL)"},{"path":"/reference/ui_fetch_secret.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch secrets — ui_fetch_secret","text":"user (character) xx password (character) password engine (character) engine filter secrets . supplied (NULL) secrets considered id (character) id instance. supplied, filter secret names id","code":""},{"path":"/reference/ui_fetch_secret.html","id":"how-the-function-works","dir":"Reference","previous_headings":"","what":"How the function works","title":"Fetch secrets — ui_fetch_secret","text":"user password supplied returned immediately user password supplied, fetch secrets secrets manager service, ask one like use. choose none function returns NULL user password","code":""},{"path":"/reference/ui_fetch_secret.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch secrets — ui_fetch_secret","text":"","code":"if (FALSE) { # user,pwd supplied, return them right away at top of fxn ui_fetch_secret(engine = \"mariadb\", user = \"jane\", password = \"apple\") # user,pwd null ui_fetch_secret(engine = \"redshift\") ui_fetch_secret(engine = \"mariadb\") }"},{"path":"/reference/wait_for_cluster.html","id":null,"dir":"Reference","previous_headings":"","what":"Wait for a Redshift cluster to have a certain status — wait_for_cluster","title":"Wait for a Redshift cluster to have a certain status — wait_for_cluster","text":"Wait Redshift cluster certain status","code":""},{"path":"/reference/wait_for_cluster.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Wait for a Redshift cluster to have a certain status — wait_for_cluster","text":"","code":"wait_for_cluster(id, sleep = 2, status_target = \"available\")"},{"path":"/reference/wait_for_cluster.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Wait for a Redshift cluster to have a certain status — wait_for_cluster","text":"id (character) Cluster identifier. Use identifier refer cluster subsequent cluster operations deleting modifying. identifier also appears Amazon Redshift console. Must unique clusters within Amazon Web Services account. sleep (integer/numeric) number seconds wait checks cluster status (.e., http requests) status_target (character) status wait . default: \"available\" fun (function) function check status something; must return single boolean, e.g., aws_db_cluster_status aws_db_instance_status","code":""},{"path":"/reference/wait_for_cluster.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Wait for a Redshift cluster to have a certain status — wait_for_cluster","text":"nothing, exits error, loop completes","code":""},{"path":"/reference/wait_for_cluster.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Wait for a Redshift cluster to have a certain status — wait_for_cluster","text":"","code":"if (FALSE) { wait_for_cluster(id = \"scotts-test-cluster-456\") }"},{"path":"/reference/wait_for_instance.html","id":null,"dir":"Reference","previous_headings":"","what":"Wait for an RDS instance to have a certain status — wait_for_instance","title":"Wait for an RDS instance to have a certain status — wait_for_instance","text":"Wait RDS instance certain status","code":""},{"path":"/reference/wait_for_instance.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Wait for an RDS instance to have a certain status — wait_for_instance","text":"","code":"wait_for_instance(id, sleep = 2, status_target = \"available\")"},{"path":"/reference/wait_for_instance.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Wait for an RDS instance to have a certain status — wait_for_instance","text":"id (character) Cluster identifier. Use identifier refer cluster subsequent cluster operations deleting modifying. identifier also appears Amazon Redshift console. Must unique clusters within Amazon Web Services account. sleep (integer/numeric) number seconds wait checks cluster status (.e., http requests) status_target (character) status wait . default: \"available\"","code":""},{"path":"/reference/wait_for_instance.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Wait for an RDS instance to have a certain status — wait_for_instance","text":"nothing, exits error, loop completes","code":""},{"path":"/reference/wait_for_instance.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Wait for an RDS instance to have a certain status — wait_for_instance","text":"","code":"if (FALSE) { wait_for_instance(id = \"scotts-test-cluster-456\") }"}]