Amazon S3 - Create bucket

Declaration

<AMAWSS3 ACTIVITY="create_bucket" PROVIDER="text (options)" SESSION="text" ACCESSKEY="text" SECRETKEY="text (encrypted)" PROTOCOL="https" USERAGENT="text" MAXERRORRETRY="number" SERVICEURL="text" PROXYHOST="text" PROXYPORT="number" PROXYUSER="text" PROXYPWD="text (options)" BUCKETNAME="text"><HEADER NAME="text" VALUE="text" /></AMAWSS3>

Related Topics     

Description

Creates and names a new Amazon S3 Bucket. Buckets are the primary containers in Amazon S3 used for object storage. You can store all of your objects in a single bucket or organize them across several buckets. The number of objects that can be stored in a bucket is limitless.

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

Creates a new Amazon S3 Bucket. Other Amazon S3-related steps can follow this step, such as Put object(s), Get object(s), or Copy object(s).

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 Markup Description
Name Text Yes (Empty) BUCKETNAME="mybucket" Signifies the name of the S3 bucket to be created. S3 bucket name creation must comply with the following rules:
  • Only contain lowercase letters, numbers, periods (.), and dashes (-)
  • Start with a number or letter
  • Be between 3 and 63 characters long
  • Not be in an IP address style (for example, 192.168.5.4)
  • Not end with a dash (-)
  • Not contain dashes next to periods (for example, .my-.bucket.com and my.-bucket are invalid)
Region Text Yes US
  • REGION="US"
  • REGION="EU"
  • REGION="SF"
  • REGION="USW2"
  • REGION="APS1"
  • REGION="APS2"
  • REGION="APN1"
  • REGION="SAE1"
 The geographical region where S3 will store the newly created bucket. You may want to select a region to optimize latency, minimize costs, or address regulatory requirements. The available regions are:
  • US Standard (default) - Uses Amazon S3 servers in the United States
  • Oregon - Uses Amazon S3 servers in Eugene, OR.
  • Northern California - Uses Amazon S3 servers in San Francisco, CA.
  • Ireland - Uses Amazon S3 servers in Ireland. Optimized for Europe.
  • Singapore - Uses Amazon S3 servers in Singapore. Optimized for Asia and Pacific Islands.
  • Tokyo - Uses Amazon S3 servers in Tokyo, Japan. Optimized for Asia and Pacific Islands.
  • Sydney - Uses Amazon S3 servers in Sydney, Australia.
  • San Paulo - Uses Amazon S3 servers in San Paulo, Brazil. Optimized for South America.

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. Automate Desktop lets you store your personal information as custom headers, such as Name, Address, City, State, Phone Number, etc, so that you can distinguish specific buckets. Using this parameter, you can add new custom headers to existing Amazon S3 objects, edit default S3 headers or create new objects with custom headers. 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. Automate Desktop lets you store your personal information as custom headers, such as Name, Address, City, State, Phone Number, etc, so that you can distinguish specific buckets. Using this parameter, you can add new custom headers to existing Amazon S3 objects, edit default S3 headers or created new buckets with custom headers. 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

This sample task creates a text bucket in the US region.

Copy 
<AMAWSS3 ACTIVITY="create_bucket" BUCKETNAME="text" SESSION="text" />