Get Bucket List
AutomatR.AWS.Activities.GetBucketList
The "Get Bucket List" activity in AutomatR is part of the AWS S3 (Simple Storage Service) activities package, enabling automation processes to retrieve a list of buckets in a specific Amazon S3 region. This activity streamlines the process of obtaining the names of available buckets, enhancing the efficiency of automation workflows.
Properties
| Name | Description |
|---|---|
| Input | |
| Access Key ID | Provides the encrypted access key ID for your AWS account, enabling connection to the AWS S3 service. String variables containing the access key ID. |
| Secret Access Key | Provides the encrypted secret access key for your AWS account, enabling connection to the AWS S3 service. String variables containing the secret access key. |
| Region | Specifies the Amazon S3 region for which the list of buckets will be retrieved. Use the RegionEndpoint enumeration to set the region. |
| Misc | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variable or argument containing the desired display name. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "Get Bucket List" activity. Useful for handling synchronization issues. Integer variables containing the delay duration. Ex.: If the wait time is 1000 milliseconds or 1 sec, i.e., 1. |
| Output | |
| Bucket List | Outputs the result of the "Get Bucket List" operation, providing a list of bucket names in the specified Amazon S3 region. Variables of type List<String> to store the list of bucket names. |
How to use:
- Drag and drop the "Get Bucket List" activity onto the workflow.
- Configure the properties by providing the required inputs, such as access key ID, secret access key, and Amazon S3 region.
- Optionally, configure the delay and customize the display name.
- Execute the workflow to retrieve the list of buckets in the specified Amazon S3 region.
Example: Consider an example where the "Get Bucket List" activity is used to obtain a list of buckets in the "us-west-2" region:
Get Bucket List:
Display Name: "Get S3 Bucket List"
Access Key ID: "**************"
Secret Access Key: "**************"
Region: "us-west-2"
Bucket List: bucketList
In this example, the activity retrieves and outputs the list of bucket names in the "us-west-2" region. The result is stored in the List<String> variable "bucketList" for further handling in the workflow.