Client - paws: 0.9.0 (original) (raw)

Amazon Simple Storage Service¶

Description¶

Amazon Simple Storage Service

Usage¶

[](#%5F%5Fcodelineno-0-1)s3(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  * access_key_id: AWS access key ID
  * secret_access_key: AWS secret access key
  * session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this totrue to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

[](#%5F%5Fcodelineno-1-1)svc <- s3( [](#%5F%5Fcodelineno-1-2) config = list( [](#%5F%5Fcodelineno-1-3) credentials = list( [](#%5F%5Fcodelineno-1-4) creds = list( [](#%5F%5Fcodelineno-1-5) access_key_id = "string", [](#%5F%5Fcodelineno-1-6) secret_access_key = "string", [](#%5F%5Fcodelineno-1-7) session_token = "string" [](#%5F%5Fcodelineno-1-8) ), [](#%5F%5Fcodelineno-1-9) profile = "string", [](#%5F%5Fcodelineno-1-10) anonymous = "logical" [](#%5F%5Fcodelineno-1-11) ), [](#%5F%5Fcodelineno-1-12) endpoint = "string", [](#%5F%5Fcodelineno-1-13) region = "string", [](#%5F%5Fcodelineno-1-14) close_connection = "logical", [](#%5F%5Fcodelineno-1-15) timeout = "numeric", [](#%5F%5Fcodelineno-1-16) s3_force_path_style = "logical", [](#%5F%5Fcodelineno-1-17) sts_regional_endpoint = "string" [](#%5F%5Fcodelineno-1-18) ), [](#%5F%5Fcodelineno-1-19) credentials = list( [](#%5F%5Fcodelineno-1-20) creds = list( [](#%5F%5Fcodelineno-1-21) access_key_id = "string", [](#%5F%5Fcodelineno-1-22) secret_access_key = "string", [](#%5F%5Fcodelineno-1-23) session_token = "string" [](#%5F%5Fcodelineno-1-24) ), [](#%5F%5Fcodelineno-1-25) profile = "string", [](#%5F%5Fcodelineno-1-26) anonymous = "logical" [](#%5F%5Fcodelineno-1-27) ), [](#%5F%5Fcodelineno-1-28) endpoint = "string", [](#%5F%5Fcodelineno-1-29) region = "string" [](#%5F%5Fcodelineno-1-30))

Operations¶

abort_multipart_upload

This operation aborts a multipart upload

complete_multipart_upload

Completes a multipart upload by assembling previously uploaded parts

copy_object

Creates a copy of an object that is already stored in Amazon S3

create_bucket

This action creates an Amazon S3 bucket

create_bucket_metadata_table_configuration

Creates a metadata table configuration for a general purpose bucket

create_multipart_upload

This action initiates a multipart upload and returns an upload ID

create_session

Creates a session that establishes temporary security credentials to support fast authentication and authorization for the Zonal endpoint API operations on directory buckets

delete_bucket

Deletes the S3 bucket

delete_bucket_analytics_configuration