paws (version 0.3.0)

backupstorage: AWS Backup Storage

Description

The frontend service for Cryo Storage.

Usage

backupstorage(config = list())

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.

Arguments

config

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

• 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 to true to force the request to use path-style addressing, i.e., http://s3.amazonaws.com/BUCKET/KEY.

Service syntax

svc <- backupstorage(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical"
  )
)

Operations

delete_object	Delete Object from the incremental base Backup
get_chunk	Gets the specified object's chunk
get_object_metadata	Get metadata associated with an Object
list_chunks	List chunks in a given Object
list_objects	List all Objects in a given Backup
notify_object_complete	Complete upload
put_chunk	Upload chunk
put_object	Upload object that can store object metadata String and data blob in single API call using inline chunk field
start_object	Start upload containing one or many chunks

Examples

if (FALSE) {
svc <- backupstorage()
svc$delete_object(
  Foo = 123
)
}