s3: Amazon Simple Storage Service

Description Usage Arguments Value Service syntax Operations Examples

View source: R/s3_service.R

Description

Amazon Simple Storage Service

Usage

1
s3(config = list())

Arguments

config

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

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
svc <- s3(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

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 Creates a new S3 bucket
create_multipart_upload This operation initiates a multipart upload and returns an upload ID
delete_bucket Deletes the S3 bucket
delete_bucket_analytics_configuration Deletes an analytics configuration for the bucket (specified by the analytics configuration ID)
delete_bucket_cors Deletes the cors configuration information set for the bucket
delete_bucket_encryption This implementation of the DELETE operation removes default encryption from the bucket
delete_bucket_intelligent_tiering_configuration Deletes the S3 Intelligent-Tiering configuration from the specified bucket
delete_bucket_inventory_configuration Deletes an inventory configuration (identified by the inventory ID) from the bucket
delete_bucket_lifecycle Deletes the lifecycle configuration from the specified bucket
delete_bucket_metrics_configuration Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the metrics configuration ID) from the bucket
delete_bucket_ownership_controls Removes OwnershipControls for an Amazon S3 bucket
delete_bucket_policy This implementation of the DELETE operation uses the policy subresource to delete the policy of a specified bucket
delete_bucket_replication Deletes the replication configuration from the bucket
delete_bucket_tagging Deletes the tags from the bucket
delete_bucket_website This operation removes the website configuration for a bucket
delete_object Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object
delete_objects This operation enables you to delete multiple objects from a bucket using a single HTTP request
delete_object_tagging Removes the entire tag set from the specified object
delete_public_access_block Removes the PublicAccessBlock configuration for an Amazon S3 bucket
download_file Download a file from S3 and store it at a specified file location
get_bucket_accelerate_configuration This implementation of the GET operation uses the accelerate subresource to return the Transfer Acceleration state of a bucket, which is either Enabled or Suspended
get_bucket_acl This implementation of the GET operation uses the acl subresource to return the access control list (ACL) of a bucket
get_bucket_analytics_configuration This implementation of the GET operation returns an analytics configuration (identified by the analytics configuration ID) from the bucket
get_bucket_cors Returns the cors configuration information set for the bucket
get_bucket_encryption Returns the default encryption configuration for an Amazon S3 bucket
get_bucket_intelligent_tiering_configuration Gets the S3 Intelligent-Tiering configuration from the specified bucket
get_bucket_inventory_configuration Returns an inventory configuration (identified by the inventory configuration ID) from the bucket
get_bucket_lifecycle For an updated version of this API, see GetBucketLifecycleConfiguration
get_bucket_lifecycle_configuration Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both
get_bucket_location Returns the Region the bucket resides in
get_bucket_logging Returns the logging status of a bucket and the permissions users have to view and modify that status
get_bucket_metrics_configuration Gets a metrics configuration (specified by the metrics configuration ID) from the bucket
get_bucket_notification No longer used, see GetBucketNotificationConfiguration
get_bucket_notification_configuration Returns the notification configuration of a bucket
get_bucket_ownership_controls Retrieves OwnershipControls for an Amazon S3 bucket
get_bucket_policy Returns the policy of a specified bucket
get_bucket_policy_status Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public
get_bucket_replication Returns the replication configuration of a bucket
get_bucket_request_payment Returns the request payment configuration of a bucket
get_bucket_tagging Returns the tag set associated with the bucket
get_bucket_versioning Returns the versioning state of a bucket
get_bucket_website Returns the website configuration for a bucket
get_object Retrieves objects from Amazon S3
get_object_acl Returns the access control list (ACL) of an object
get_object_legal_hold Gets an object's current Legal Hold status
get_object_lock_configuration Gets the Object Lock configuration for a bucket
get_object_retention Retrieves an object's retention settings
get_object_tagging Returns the tag-set of an object
get_object_torrent Returns torrent files from a bucket
get_public_access_block Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket
head_bucket This operation is useful to determine if a bucket exists and you have permission to access it
head_object The HEAD operation retrieves metadata from an object without returning the object itself
list_bucket_analytics_configurations Lists the analytics configurations for the bucket
list_bucket_intelligent_tiering_configurations Lists the S3 Intelligent-Tiering configuration from the specified bucket
list_bucket_inventory_configurations Returns a list of inventory configurations for the bucket
list_bucket_metrics_configurations Lists the metrics configurations for the bucket
list_buckets Returns a list of all buckets owned by the authenticated sender of the request
list_multipart_uploads This operation lists in-progress multipart uploads
list_objects Returns some or all (up to 1,000) of the objects in a bucket
list_objects_v2 Returns some or all (up to 1,000) of the objects in a bucket
list_object_versions Returns metadata about all versions of the objects in a bucket
list_parts Lists the parts that have been uploaded for a specific multipart upload
put_bucket_accelerate_configuration Sets the accelerate configuration of an existing bucket
put_bucket_acl Sets the permissions on an existing bucket using access control lists (ACL)
put_bucket_analytics_configuration Sets an analytics configuration for the bucket (specified by the analytics configuration ID)
put_bucket_cors Sets the cors configuration for your bucket
put_bucket_encryption This operation uses the encryption subresource to configure default encryption and Amazon S3 Bucket Key for an existing bucket
put_bucket_intelligent_tiering_configuration Puts a S3 Intelligent-Tiering configuration to the specified bucket
put_bucket_inventory_configuration This implementation of the PUT operation adds an inventory configuration (identified by the inventory ID) to the bucket
put_bucket_lifecycle For an updated version of this API, see PutBucketLifecycleConfiguration
put_bucket_lifecycle_configuration Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration
put_bucket_logging Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters
put_bucket_metrics_configuration Sets a metrics configuration (specified by the metrics configuration ID) for the bucket
put_bucket_notification No longer used, see the PutBucketNotificationConfiguration operation
put_bucket_notification_configuration Enables notifications of specified events for a bucket
put_bucket_ownership_controls Creates or modifies OwnershipControls for an Amazon S3 bucket
put_bucket_policy Applies an Amazon S3 bucket policy to an Amazon S3 bucket
put_bucket_replication Creates a replication configuration or replaces an existing one
put_bucket_request_payment Sets the request payment configuration for a bucket
put_bucket_tagging Sets the tags for a bucket
put_bucket_versioning Sets the versioning state of an existing bucket
put_bucket_website Sets the configuration of the website that is specified in the website subresource
put_object Adds an object to a bucket
put_object_acl Uses the acl subresource to set the access control list (ACL) permissions for a new or existing object in an S3 bucket
put_object_legal_hold Applies a Legal Hold configuration to the specified object
put_object_lock_configuration Places an Object Lock configuration on the specified bucket
put_object_retention Places an Object Retention configuration on an object
put_object_tagging Sets the supplied tag-set to an object that already exists in a bucket
put_public_access_block Creates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket
restore_object Restores an archived copy of an object back into Amazon S3
select_object_content This operation filters the contents of an Amazon S3 object based on a simple structured query language (SQL) statement
upload_part Uploads a part in a multipart upload
upload_part_copy Uploads a part by copying data from an existing object as data source

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## Not run: 
svc <- s3()
# The following example aborts a multipart upload.
svc$abort_multipart_upload(
  Bucket = "examplebucket",
  Key = "bigobject",
  UploadId = "xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LA..."
)

## End(Not run)

paws.storage documentation built on Aug. 23, 2021, 1:06 a.m.