Amazon Simple Storage Service (Amazon S3)
App Vendor: Amazon
App Category: IT Services
App Version: 1.2.0
API version: 1.0.0
About App
The AWS S3 app provides integration with the Amazon Simple Storage Service (Amazon S3) API, which is an object storage service that offers best-in-class scalability, data availability, security, and performance. Using the S3 app, you can efficiently manage the data and access control for the S3 buckets and objects.
The AWS S3 app in the Orchestrate application performs the following actions:
Action | Description |
|---|---|
Get bucket ACLs | This action retrieves the access control list for a bucket. |
List bucket objects | This action lists all the objects for the specified bucket. |
List all buckets | This action lists all the S3 buckets. |
Get object content | This action retrieves content from the specified file object. |
Upload file to bucket | This action uploads a file to an S3 bucket. |
Download file from S3 bucket | This action downloads a file from the S3 bucket. |
Get Object ACL | This action retrieves the access control list (ACL) of an object. |
Upload Bucket Lifecycle | This action creates a new lifecycle configuration or replaces an existing lifecycle configuration for the bucket. |
Get Bucket Logging | This action returns the logging status of a bucket. |
Get Bucket Location | This action returns the region location details of the bucket. |
Get Bucket Lifecycle | This action retrieves the lifecycle configuration information of a bucket. |
Create Bucket | This action creates a new bucket. |
Get Object | This action retrieves the content from the file object of S3 bucket. |
Get Bucket Policy | This action returns the policy of a specified bucket. |
Configuration Parameters
The following configuration parameters are required for the AWS S3 app to communicate with the AWS S3 enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Access Key | Enter the access key ID to access the Amazon S3 application. Example: "HKIA456UJGUP88C4JFGO" | Text | Required |
|
Secret Access Key | Enter the secret key to access the Amazon S3 resources. | Password | Required |
|
Region Name | Enter the default region name. Example: "us‑west‑1" | Text | Optional | Default value: None The default value none indicates that the region will be us-east-1. |
Action: Get bucket ACLs
This action retrieves the access control list for the specified bucket.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Bucket Name | Enter the bucket name. Example: "poc--file-uploads" | Text | Required |
Example Request
[
{
"bucket_name": "poc--file-uploads"
}
]Action: List bucket objects
This action lists all the objects for the specified bucket.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Bucket Name | Enter the bucket name. Example: "poc--file-uploads" | Text | Required |
Example Request
[
{
"bucket_name": "poc--file-uploads"
}
]Action: List all buckets
This action lists all the existing S3 buckets.
Action Input Parameters
This action does not require any input parameters.
Action: Get object content
This action retrieves content from the specified file object.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Bucket Name | Enter the bucket name. Example: "poc--file-uploads" | Text | Required | |
Object Name | Enter the object (file) name to retrieve content from. Example: "testfile101.txt" | Text | Required |
Example Request
[
{
"bucket_name": "poc--file-uploads",
"object_name": "testfile101.txt"
}
]Action: Upload File to Bucket
This action uploads a file to an S3 bucket.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Bucket Name | Enter the bucket name. Example: "poc--file-uploads" | Text | Required | |
Local File Name | Enter the local file name to upload. Example: "/tmp/61fxxe-aab8-4cbf-9a46-dfxfgefdfgcd767/sample_file.csv" | Text | Required | |
Remote File Name | Enter the file name on the remote server to store the file. Example: "Sample_file.csv" | Text | Required |
Example Request
[
{
"bucket_name": "poc--file-uploads",
"local_file_name": "/tmp/61fxxe-aab8-4cbf-9a46-dfxfgcd767/sample_file.csv,
"remote_file_name": "Sample_file.csv"
}
]Action: Download File from S3 Bucket
This action downloads a file from the S3 bucket.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Bucket Name | Enter the bucket name. Example: "poc--file-uploads" | Text | Required | |
File Name | Enter the name of the file to download from the S3 bucket. Example: "testfile101.txt" | Text | Required |
Example Request
[
{
"file_name": "testfile101.txt",
"bucket_name": "poc--file-uploads"
}
]Action: Get Object ACL
This action retrieves the access control list (ACL) of an object.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Bucket name | Enter the name of the bucket. Example: "Sample Bucket" | Text | Required | You can retrieve the bucket name using the List all buckets action. |
Object name | Enter the name of the object to get ACL information. Example: "happyface.jpg" | Text | Required |
Example Request
[
{
"bucket_name": "Sample Bucket",
"object_name": "happyface.jpg"
}
]Action: Upload Bucket Lifecycle
This action creates a new lifecycle configuration or replaces an existing lifecycle configuration for the bucket.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Bucket name | Enter the name of the bucket. Example: "Sample Name" | Text | Required | |
Rules | Specify the container for lifecycle rules. You can add as many as 1,000 rules. Example: {"ID": "Sample ID"} | Any | Required |
Example Request
[
{
"rules": [
{
"ID": "Sample ID",
"Filter": {
"Prefix": "documents"
},
"Status": "Enabled",
"Expiration": {
"Days": 365
},
"Transitions": [
{
"Days": 365,
"StorageClass": "GLACIER"
}
]
}
],
"bucket_name": "Sample Bucket"
}
]Action: Get Bucket Logging
This action returns the logging status of a bucket.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Bucket name | Enter the name of the bucket. Example: "Sample Bucket" | Text | Required | You can retrieve the bucket names using the List all Objects action. |
Example Request
[
{
"bucket_name": "Sample Bucket"
}
]Action: Get Bucket Location
This action returns the region location details of the bucket.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Bucket name | Enter the name of the bucket. Example: "Sample Bucket" | Text | Required | You can retrieve the bucket name using the List all buckets action. |
Example Request
[
{
"bucket_name": "Sample Bucket"
}
]Action: Get Bucket Lifecycle
This action retrieves the lifecycle configuration information of a bucket.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Bucket name | Enter the name of the bucket. Example: "Sample Bucket" | Text | Required |
Example Request
[
{
"bucket_name": "Sample Bucket"
}
]Action: Create Bucket
This action creates a new bucket.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Bucket name | Provide a name for the bucket. Example: "Sample Bucket" | Text | Required | |
Region | Specify the region where the bucket will be created. Example: "us-east-2" | Text | Optional | Default value:
|
Example Request
[
{
"bucket_name": "Sample Bucket",
"region": "us-east-2"
}
]Action: Get Object
This action retrieves the content from the file object of s3 bucket.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Bucket name | Enter the name of the bucket to get object. Example: "Sample Name" | Text | Required | |
Object name | Specify the object name to retrieve data. Example: "happyface.jpg" | Text | Required |
Example Request
[
{
"bucket_name": "Sample Name",
"object_name": "happyface.jpg"
}
]Action: Get Bucket Policy
This action returns the policy of a specified bucket.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Bucket name | Enter the name of the bucket. Example: "Sample Name" | Text | Required |
Example Request
[
{
"bucket_name": "Sample Name"
}
]