To use this procedure, make sure your agent has learned the S3 Book (BDK).
Syntax
Below is a line-by-line overview of the automation syntax. Expand each line to learn more.
rename an item to a name
What does it do? This is the base syntax for the procedure.
Where does it go? This phrase should be written on a new line.
Is it required? ✅ Yes — This phrase is required in the syntax.
Does it require input data? ⛔ No — This phrase does not require input data.
the item is
What does it do? Specifies the item (file or folder) to rename.
Where does it go? This phrase should be indented beneath rename an item to a name with. The with keyword is added to specify additional instructions.
Is it required? ✅ Yes — This phrase is required in the syntax.
Does it require input data? ✅ Yes — An s3 file reference or s3 folder reference needs to be specified.
Example: the item is the above
the name is
What does it do? Specifies the new name of the item.
Where does it go? This phrase should be indented beneath rename an item to a name with. The with keyword is added to specify additional instructions.
Is it required? ✅ Yes — This phrase is required in the syntax.
Does it require input data? ✅ Yes — A text value needs to be specified.
Example: the name is 'some text'
the conflict behavior is
What does it do? Specifies the behavior to use on conflict scenarios. It should be one of the following values: ('fail', 'replace', 'rename').
Where does it go? This phrase should be indented beneath rename an item to a name with. The with keyword is added to specify additional instructions.
Is it required? 🌟 No — This phrase is optional in the syntax.
Does it require input data? ✅ Yes — This phrase requires input data.
Default:'fail'
Example: the conflict behavior is 'fail'
Examples
1. 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