Amazon S3 - Delete objects
Declaration
<AMAWSS3 ACTIVITY="delete_object" 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" KEYNAME="text"><HEADER NAME="text" VALUE="text" /><HEADER /></AMAWSS3>
Description
Deletes one or more objects contained in a bucket.
IMPORTANT: The Amazon 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.
Practical usage
Used to remove unwanted or unneeded objects from a specific bucket, usually after creating copies or performing a backup. To specify more than one object, use wildcard characters (* or ?). To specify multiple objects or wildcard masks, separate them with a pipe symbol (|). Example: *.txt|*.bak
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:
|
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:
|
| 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). |
Filter Options
| Property | Type | Required | Default | Markup | Description |
|---|---|---|---|---|---|
| Match case | Yes/No | No | No | MATCHCASE="YES" | If selected, this activity becomes case sensitive. This parameter is disabled by default. |
| Exclude mMask | Text | No | (Empty) | EXCLUDE="*.txt" | Causes this activity to omit matching masks specified. Key names or wildcard masks may be used. Multiple entries may be specified by separating them with a pipe symbol (|), Example: *.txt|*.bak |
| Regular expression | Yes/No | No | No | RE="YES" | If selected, the value entered in the Exclude mask parameter will be interpreted as regular expression. If disabled, the value will be interpreted as normal readable text. |
| Only if newer than | Date | No | (Empty) | ISNEWERTHAN="%DateSerial(2001,10,12) + TimeSerial(00,00,00)%" | If
enabled, causes this activity to only act on objects that are
newer than the date/time specified. If this parameter is left
blank or disabled (default), object dates are ignored. Click the Custom button to select from a list of pre-defined date parameters. Enable the Expression option to allow entry of a date/time expression. |
| Only if older than | Date | No | (Empty) | ISOLDERTHAN="%DateSerial(2001,10,12) + TimeSerial(00,00,00)%" | If
enabled, causes this activity to only act on objects that are
older than the date/time specified. If this parameter is left
blank or disabled (default), object dates are ignored. Click the Custom button to select from a list of pre-defined date parameters. Enable the Expression option to allow entry of a date/time expression. |
Advanced
Each Amazon S3 object has a set of key-value pairs with which it is associated called Headers. Automate Desktop lets you to store your personal information as custom headers like name, address, company name, phone number, etc, so that you can distinguish specific files. Using this option, you can add new custom header/user metadata to existing S3 objects, edit default S3 metadata on a bucket or store/upload new objects with custom header or metadata.
| Property | Type | Required | Default | Markup | Description |
|---|---|---|---|---|---|
| Headers Name | Text | No | (Empty) | HEADER NAME="myHeader" | Specifies the "key" in a header 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. |
| Headers Value | Text | No | (Empty) | VALUE="headerValue" | Specifies the "value" in a header 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. |
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
This sample task deletes an object from a bucket.
Copy
<AMAWSS3 ACTIVITY="delete_object" BUCKETNAME="myBucket" KEYNAME="the_key_name" SESSION="mySession" />