Amazon S3 - Set bucket versioning

Declaration

<AMAWSS3 ACTIVITY="set_bucket_versioning" ACCESSKEY="text" SECRETKEY="text (encrypted)" PROTOCOL="text (options)" USERAGENT="text" MAXERRORRETRY="number" SERVICEURL="text" PROXYHOST="text" PROXYPORT="number" PROXYUSER="text" PROXYPWD="text (encrypted)" BUCKETNAME="text" VERSIONING="text (options)" ENABLEMFADELETE="text (options)" MFACODES="text"><HEADER NAME="text" VALUE="text" /><HEADER /></AMAWSS3>

Related Topics    

Description

Sets a bucket's versioning state. Versioning is a method of keeping multiple variations of an object in the same bucket. For example, myfile.txt (version 1111111) and myfile.txt (version 222222). You might enable versioning to prevent objects from being deleted or overwritten by mistake, or to archive objects so that you can retrieve previous versions of them.

IMPORTANT: The AWS S3 activities are performed using Amazon's Simple Storage Service engine, therefore, launching and operating Amazon S3 through Automate Desktop requires a valid Access Key ID and Secret Access Key.
NOTE: Only the bucket owner can configure the versioning state of a bucket. The versioning state applies to ALL of the objects in that bucket. The first time you enable a bucket for versioning, objects in it are thereafter always versioned and given a unique version ID.

Practical usage

Used to set the versioning state of a bucket.

Parameters

Connection

Property Type Required Default Markup Description
Connection --- --- --- --- Indicates where AWS user credentials and preferences should originate from. This is a design mode parameter used only during task construction and configuration, thus, comprises no markup. The available options are:
  • Host (default)- Specifies that user credentials and advanced preferences are configured individually for this activity. This option is normally chosen if only a single activity is required to complete an operation.
  • Session - Specifies that user credentials and advanced preferences are obtained from a pre-configured session created in an earlier step with the use of the Amazon S3 - Create session activity. This option is normally chosen if a combination of related activities are required to complete an operation. Linking several activities to a single session eliminates redundancy. Additionally, a single task supports construction and simultaneous execution of multiple sessions, improving efficiency.

Connection - Session

Property Type Required Default Markup Description
Session Text Yes, if Connection is set to Session EC2Session1 SESSION="S3Session1" The name of an existing session to attach this activity to. This parameter is active only if the Connection parameter is set to Session. The default session name is S3Session1.

Connection - Host > Credentials

Property Type Required Default Markup Description
Access key Text Yes, if Connection is set to Host (Empty) ACCESSKEY="022QF06E7MXBSH9DHM02" A 20-character alphanumeric string that uniquely identifies the owner of the AWS service account, similar to a username. This key along with a corresponding secret access key forms a secure information set that AWS uses to confirm a valid user's identity. This parameter is active only if the Connection parameter is set to Host.
Secret access key Text Yes, if Connection is set to Host (Empty) SECRETKEY="text (encrypted)" A 40-character string that serves the role as password to access the AWS service account. This along with an associated access key forms a secure information set that EC2 uses to confirm a valid user's identity. This parameter is active only if the Connection parameter is set to Host.

Connection - Host > Advanced

Property Type Required Default Markup Description
Protocol Text (options) No HTTP PROTOCOL="HTTPS" The protocol required. The available options are:
  • HTTP (default)
  • HTTPS
User agent Text No Automate USERAGENT="Automate" The name of the client or application initiating requests to AWS, which in this case, is Automate Desktop. This parameter's default value is Automate. 
Service URL Text No (Empty) SERVICEURL="https://s3.eu-west-1.amazonaws.com" The URL that provides the service endpoint. To make the service call to a different region, you can pass the region-specific endpoint URL. For example, entering https://s3.us-west-1.amazonaws.com points to US West (Northern California) region. A complete list of S3 regions, along with associated endpoints and valid protocols can be found below under Amazon S3 regions and endpoints .
Maximum number of retries on error Number No (Empty) MAXERRORRETRY="4" The total amount of times this activity should retry its request to the server before returning an error. Network components can generate errors anytime in the life of a request, thus, implementing retries can increase reliability. 
Proxy host Text No (Empty) PROXYHOST="proxy.host.com" The hostname (for example, server.domain.com) or IP address (for example, 192.168.0.100) of the proxy server to use when connecting to AWS.  
Proxy port Number No (Empty) PROXYPORT="1028" The port that should be used to connect to the proxy server.
Proxy username Text No (Empty) PROXYUSER="username" The username that should be used to authenticate connection with the proxy server (if required).
Proxy password Text No (Empty) PROXYPWD="encrypted" The password that should be used to authenticate connection with the proxy server (if required).

Bucket

Property Type Required Default Attributes Description
Name Text Yes (Empty) BUCKETNAME="MyBucket" Specifies the name of the bucket in which to set the versioning state.
Versioning Text(options) Yes Enabled  VERSIONING="Suspended" Indicates the versioning state to set. The available options are:
  • Enabled (default) - Enables the Amazon S3 Versioning feature, allowing you to preserve, retrieve, and restore every version of every object in an Amazon S3 bucket.
  • Suspended - Puts the Versioning feature in a suspended state.
Enable MFA delete Text (options) No Doesn't matter
  • ENABLEMFADELETE="does_not_matter"
  • ENABLEMFADELETE="yes"
  • ENABLEMFADELETE="no"
 Enables MFA (Multi-Factor Authentication) delete. By enabling MFA Delete on your Amazon S3 bucket, you can only change the versioning state of your bucket or permanently delete an object version when you provide two forms of authentication codes together; your AWS account credentials and the concatenation of a valid serial number, a space, and the six-digit code displayed on an approved authentication device (for example, "20899872 301749"). The available options are:
  • Doesn't matter (default) - Does not matter.
  • Yes - Enables MFA delete.
  • No - Do not enable MFA delete.
NOTE: Once you configure a bucket so that it is MFA Delete enabled, all future requests to change the versioning state or delete a version require the request header:[SerialNumber] [AuthenticationCode].
MFA codes Text No (Empty) MFACODES="20899872 301749" The concatenation of a valid serial number, a space, and the six-digit code displayed on an approved authentication device.

Advanced

Property Type Required Default Markup Description
Name Text No (Empty) HEADER NAME="myHeader" Specifies the "key" in a key-value pair. This is the handle that you assign to an object. In Amazon S3, details about each file and folder are stored in key value pairs called metadata or headers. System metadata is used and processed by Amazon S3, however, user metadata or custom headers can be specified by you. This adds more flexibility and enables you to better distinguish specific files by adding or editing custom headers on existing S3 objects or assigning custom headers to new objects. Press Click here to add new row... to add a key-value pair. Press the red X to remove an existing key-value pair.
Value Text No (Empty) VALUE="theValue" Specifies the "value" in a key-value pair. This is the content that you are storing for an object. In Amazon S3, details about each file and folder are stored in key value pairs called metadata or headers. System metadata is used and processed by Amazon S3, however, user metadata or custom headers can be specified by you. This adds more flexibility and enables you to better distinguish specific files by adding or editing custom headers on existing S3 objects or assigning custom headers to new objects. Press Click here to add new row... to add a key-value pair. Press the red X to remove an existing key-value pair.

Description

Error Causes

On Error

Additional notes

Amazon S3 regions and endpoints

This table contains a complete list of Amazon Simple Storage Service endpoints, along with their corresponding regions, supported protocols and location constraints.

Endpoint Region Protocol Location Constraints
s3.amazonaws.com US Standard * HTTP and HTTPS (none required)
s3.us-west-2.amazonaws.com US West (Oregon) Region HTTP and HTTPS us-west-2
s3.us-west-1.amazonaws.com US West (Northern California) Region HTTP and HTTPS us-west-1
s3.eu-west-1.amazonaws.com EU (Ireland) Region HTTP and HTTPS EU
s3.ap-southeast-1.amazonaws.com Asia Pacific (Singapore) Region HTTP and HTTPS ap-southeast-1
s3.ap-southeast-2.amazonaws.com Asia Pacific (Sydney) Region HTTP and HTTPS ap-southeast-2
s3.ap-northeast-1.amazonaws.com Asia Pacific (Tokyo) Region HTTP and HTTPS ap-northeast-1
s3.sa-east-1.amazonaws.com South America (Sao Paulo) Region HTTP and HTTPS sa-east-1

* The US Standard region automatically routes requests to facilities in Northern Virginia or the Pacific Northwest using network maps.

Example

NOTE:
  • Copy and paste the sample AML code below directly into the Task Builder Steps Panel.
  • To successfully run the sample code, update parameters containing user credentials, files, file paths, or other information specific to the task to match your environment.

Description

Set versioning to "Suspended" state for bucket "mybucket". Use "mysession" S3 session.

Copy 
<AMAWSS3 ACTIVITY="set_bucket_versioning" BUCKETNAME="mybucket" VERSIONING="Suspended" SESSION="mysession" />