Skip to main content

Cyware Orchestrate

Amazon Simple Storage Service (Amazon S3)

App Vendor: Amazon

App Category: IT Services

App Version: 1.3.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

Create Bucket

This action creates a new bucket.

Download File

This action downloads a file from the S3 bucket.

Get Bucket ACL

This action retrieves the access control list for a bucket.

Get Bucket Lifecycle

This action retrieves the lifecycle configuration information of a bucket.

Get Bucket Location

This action returns the region location details of the bucket.

Get Bucket Logging

This action returns the logging status of a bucket.

Get Bucket Policy

This action returns the policy of a specified bucket.

Get Object

This action retrieves the content from the file object of S3 bucket.

Get Object ACL

This action retrieves the access control list (ACL) of an object.

List Bucket Objects

This action lists all the objects for the specified bucket.

List Buckets

This action lists all the S3 buckets.

Set Object ACL

This action sets the access control list (ACL) permissions for an existing object in an S3 bucket.

Upload Bucket Lifecycle

This action creates a new lifecycle configuration or replaces an existing lifecycle configuration for the bucket.

Upload File to Bucket

This action uploads a file to an S3 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: 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:

  • us-east-1

Example Request

[
    {
        "bucket_name": "Sample Bucket",
        "region": "us-east-2"
    }
]
Action: Download File

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 Bucket ACL

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: 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: 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 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 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"
    }
]
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 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: 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 Buckets

This action lists all the existing S3 buckets.

Action Input Parameters

This action does not require any input parameters.

Action: Set Object ACL

This action sets the access control list (ACL) permissions for an existing object in an S3 bucket.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Bucket Name 

Enter the name of the bucket that contains the object for which you want to set the ACL.

Example:

Sample Bucket Name

Text

Required

Object Name 

Enter the name of the object for which you want to set the ACL.

Example:

SampleObjectName.jpg

Text

Required

ID 

Enter the ID of the bucket owner.

Note

You must either enter both the ID and Grants, or include one or more of the following extra parameters to set ACL: GrantFullControl, GrantRead, GrantReadACP, GrantWrite, or GrantWriteACP.

Text

Optional

You can retrieve this using the action List Buckets.

Grants 

Specify the list of grants.

Note

You must either enter both the ID and Grants, or include one or more of the following extra parameters to set ACL: GrantFullControl, GrantRead, GrantReadACP, GrantWrite, or GrantWriteACP.

Example:

$JSON[[{'Grantee':'value','Permission':'value'}]]

Any

Optional

Allowed keys:

Grantee and Permission

Extra Params 

Enter the extra parameters to set the ACL.

Note

You must either enter both the ID and Grants, or include one or more of the following extra parameters to set ACL: GrantFullControl, GrantRead, GrantReadACP, GrantWrite, or GrantWriteACP.

Any

Optional

Allowed keys:

ChecksumAlgorithm, GrantFullControl, GrantRead, GrantReadACP, GrantWrite, GrantWriteACP

Example Requests 

Using ID and Grants:

[
  {
    "grants": [
      {
        "Grantee": {
          "ID": "062daf2b8c91179781886f7ebcd97b7da655e1c66a90ec3462f3a94d1dfe6283",
          "Type": "CanonicalUser"
        },
        "Permission": "READ"
      }
    ],
    "bucket_name": "Sample Bucket Name",
    "object_name": "SampleObjectName.jpg",
    "canonical_id": "062daf2b8c91179781886f7ebcd97b7da655e1c66a90ec3462f3a94d1dfe6283"
  }
]

Using Extra Params:

[
  {
    "bucket_name": "Sample Bucket Name",
    "object_name": "SampleObjectName.jpg",
    "extra_params": {
      "GrantReadACP": "id=062daf2b8c91179781886f7ebcd97b7da655e1c66a90ec3462f3a94d1dfe6283"
    }
  }
]
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: 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"
    }
]