Procedures

Automation procedures in the AWS S3 BDK Book.

to copy an item to a folder

Copy an item to a folder

Input Concepts

Concept
Description
Type
Required
Default Value

item

The item (file or folder) to copy

s3 file reference or s3 folder reference

Yes

The folder to copy the item to

s3 folder reference

Yes

conflict behavior

The behavior to use on conflict scenarios. It should be one of the following values: ('fail', 'replace', 'rename')

text

No

fail

Examples

Copy an item to new folder in AWS S3

get a folder at "bucket_name/"
use the above as the folder
get some folder's items with
    the folder is the folder
    the path prefix is "kognitos"
use the above as the references
get the first reference as the item
get a folder at "bucket_name/google"
use the above as the folder
copy item to the folder with
    the item is the item
    the folder is the folder

to create a (folder) in another folder

Create a (folder) in another folder

Input Concepts

Concept
Description
Type
Required
Default Value

The folder to create the (folder) in

s3 folder reference

Yes

folder name

The name of the (folder) to create

text

Yes

conflict behavior

The behavior to use on conflict scenarios. It should be one of the following values: ('fail', 'replace', 'rename')

text

No

fail

Output Concepts

Concept
Description
Type

a folder reference to the created folder

s3 folder reference

Examples

Create a folder in another folder in AWS S3

get a folder at "bucket_name/google"
use the above as the another_folder
the name is "data"
create a folder in another folder with
    the another folder is the another_folder
    the folder name is the name

to delete an item

Delete an item (file or folder)

Input Concepts

Concept
Description
Type
Required
Default Value

item

The item (file or folder) to delete

s3 file reference or s3 folder reference

Yes

Examples

Delete an item (file/folder) from AWS S3

create a json
use the above as the file
set the file's bucket_name to "bucket_name"
set the file's file_path to "test.txt"
delete an item with
    the item is the file

to download a file

Download a file

Input Concepts

Concept
Description
Type
Required
Default Value

The file reference to the file to download

s3 file reference

Yes

Output Concepts

Concept
Description
Type

answer

the file as an IO object

file

Examples

Download an item from AWS S3

create a json
use the above as the file
set the file's bucket_name to "bucket_name"
set the file's file_path to "test.txt"
download a file with
    the file is the file

to get (buckets) from s3

FILTER - CAPABLE

Get the list of the AWS buckets

Output Concepts

Concept
Description
Type

List of the aws buckets

s3 bucket

Examples

Get the buckets list from AWS S3

get buckets from s3

to get a (file) at a path

Gets a reference to a file.

Input Concepts

Concept
Description
Type
Required
Default Value

path

The path to the file

text

Yes

Output Concepts

Concept
Description
Type

a file reference

s3 file reference

Examples

Retrieve the file at a path

get a file at "bucket_name/abc/test.txt"

to get a (folder) at a path

Gets a reference to a folder.

Input Concepts

Concept
Description
Type
Required
Default Value

path

The path to the folder

text

Yes

Output Concepts

Concept
Description
Type

a folder reference

s3 folder reference

Examples

Retrieve the folder at a path

get a folder at "bucket_name/abc/"

to get a (root folder) from a bucket

Gets a reference to the root folder.

Input Concepts

Concept
Description
Type
Required
Default Value

The path to the folder

s3 bucket

Yes

Output Concepts

Concept
Description
Type

a folder reference

s3 folder reference

Examples

Retrieve the root folder of the AWS BUcket

get buckets from s3
use the above as the buckets
get a root folder from the first bucket's name

to get some (folder's items)

FILTER - CAPABLE

Lists items from a folder reference

Input Concepts

Concept
Description
Type
Required
Default Value

The folder reference from which to list the items

s3 folder reference

Yes

Output Concepts

Concept
Description
Type

folder's items

a list of Items (file or folder) containing the items in the folder

s3 file reference or s3 folder reference

Examples

Get the list of the folder items from AWS S3

get a folder at "bucket_name/google"
use the above as the folder
get some folder's items with
    the folder is the folder

to move an item to a folder

Move an item to a folder

Input Concepts

Concept
Description
Type
Required
Default Value

item

The item (file or folder) to move

s3 file reference or s3 folder reference

Yes

The folder to move the item to

s3 folder reference

Yes

conflict behavior

The behavior to use on conflict scenarios. It should be one of the following values: ('fail', 'replace', 'rename')

text

No

fail

Examples

Move an item (file/folder) to another folder in AWS S3

create a json
use the above as the item
set the item's bucket_name to "bucket_name"
set the item's file_path to "kognitos-data.txt"
get a folder at "bucket_name/google"
use the above as the folder
move an item to folder with
    the item is the item
    the folder is the folder

to rename an item to a name

Rename an item (file or folder) to a given name

Input Concepts

Concept
Description
Type
Required
Default Value

item

The item (file or folder) to rename

s3 file reference or s3 folder reference

Yes

name

The new name of the item

text

Yes

conflict behavior

The behavior to use on conflict scenarios. It should be one of the following values: ('fail', 'replace', 'rename')

text

No

fail

Examples

Rename an item (file/folder) in AWS S3

create a json
use the above as the file
set the file's bucket_name to "bucket_name"
set the file's file_path to "test.txt"
rename an item to "test1.txt" with
    the item is the file

to upload a (file) to a folder

Upload a file to a folder

Input Concepts

Concept
Description
Type
Required
Default Value

file

The file to upload

file

Yes

The folder to upload the file to

s3 folder reference

Yes

file name

The name of the file to upload

text

Yes

conflict behavior

The behavior to use on conflict scenarios. It should be one of the following values: ('fail', 'replace', 'rename')

text

No

fail

Output Concepts

Concept
Description
Type

a file reference to the uploaded file

s3 file reference

Examples

Upload a file to folder in AWS S3

the file
get a folder at "bucket_name/google"
use the above as the folder
the name is "new_test.txt"
upload the file to folder with
    the folder is the folder
    the file name is the name

Last updated

Was this helpful?