Component Storage access S3

Description

Performs the specified I/O operation on storage S3.

Table 1. System Characteristics

Index

116

Short title

s3

Types of scenarios

All of them

Starter module

r_script_component_s3

Mode

Asynchronous

Icon

116

Branching pattern

Branching, closing

Properties

Table 2. Properties
Specification Description

Title: The Vault
Code: bucket
Visibility: no
Default: — 

Storage name (bucket).

Title: The Storage Key
Code: key
Visibility: no
Default: — 

Storage Access Key.

Title: Action
Code: command
Visibility: no
Default: `Download'

Possible options:

  • Place (put, 0) - Places the file in storage.

  • Download (get, 1) - Returns the contents of a file, or downloads to a local directory and returns the path to it.

  • Delete (delete, 2) - Deletes the file from storage.

  • Size (size, 3) - Returns the size of the file in storage.

Title: Data type
Code: type
Visibility: yes
Default: Data file

Method of script data exchange with storage
Possible options:

  • Byte array (binary, 0) - Uses binary data via argument or variable.

  • Data file (file, 1) - Uses the path to a file in the local directory.

Title: File path
Code: filepath
Visibility: yes
Default: — 

The path to a file in the local directory, using one of filecategories.

Title: Data
Code: data
Visibility: yes
Default: — 

Argument with the content of the resource being placed in the repository.

Title: Buffer
Code: buffer
Visibility: yes
Default: — 

Variable to save the contents of a resource downloaded from storage.

Title: Titles
Code: headers
Visibility: yes
Default: — 

Additional headers for sending a request to the s3.

Title: Query Parameters (JSON)
Code: opts
Visibility: no
Default: — 

A set of parameters for a storage operation, in JSON-object format, where keys are parameter names. Possible values: query parameters

Title: Result to variable
Code: result
Visibility: yes
Default: — 

Variable to save the result of the file size query to the storage.

Title: Time, s
Code: timeout
Visibility: no
Default: — 

Response timeout, in seconds

Title: Transition
Code: transfer
Visibility: no
Default: — 

The component to which control is passed if the request is successful.

Title: Transition, Time
Code: transferTimeout
Visibility: no
Default: — 

The component to which control is passed after the set request execution time has elapsed.

Title: Transition, Error
Code: transferError
Visibility: no
Default: — 

The component to which control is passed when an error occurs.

Title: Reason for error to variable
Code: errorReason
Visibility: no
Default: — 

Variable to save the error.

Request parameters

Table 3. Request parameters
Parameter: s3_host
Default: empty
S3 storage address. For example: "s3_host": "abc.s3.com"

Parameter: s3_port
Default: empty

S3 storage port. For example: 443

Parameter: access_key_id
Default: empty

Account ID for accessing S3 (conditional "login"). For example: 1A2B3C4DFFFFFFFFFFFF

Parameter: secret_access_key
Default: empty

Secret account key to access S3 (conditional "password"). For example: 77JHKdlkljfhgkjdKFDbn43555365fhgkjdKFDbn

Parameter: acl
Default: undefined

Access Control List. Access Rights Setting.
Possible values: undefined, private, public_read, public_read_write, authenticated_read, bucket_owner_read, bucket_owner_full_control
For example: "acl":"public_read"

See also