Get Object
AutomatR.AWS.Activities.GetObject
The "Get Object" activity in AutomatR is part of the AWS S3 (Simple Storage Service) Objects activities package, enabling automation processes to retrieve details of a specific object in an AWS S3 bucket. This activity streamlines the process of obtaining information about an object within an S3 bucket, 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 AWS region associated with the source bucket, required for getting the object. Use the RegionEndpoint enumeration to set the region. |
| Bucket Name | Specifies the name of the S3 bucket on which you want the operation to be performed. String variables containing the bucket name. |
| Object Key Name | Specifies the entire path of the object within the bucket, for example: ("Data/Object/objectkey.docx"). String variables containing the object key name. |
| 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 Object" 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 | |
| Result | Stores the result in a variable of type GetObjectMetadataResponse, providing details about the requested object. Variables of type GetObjectMetadataResponse for further activities. |
How to use:
- Drag and drop the "Get Object" activity onto the workflow.
- Configure the properties by providing the required inputs, such as access key ID, secret access key, region, bucket name, and object key name.
- Optionally, configure the delay and customize the display name.
- Execute the workflow to retrieve details about the specified object within the S3 bucket.
Example: Consider an example where the "Get Object" activity is used to retrieve details about an object named "objectkey.docx" in the S3 bucket "Data/Object":
Get Object:
Display Name: "Retrieve Object Details"
Access Key ID: "**************"
Secret Access Key: "**************"
Region: "us-east-1"
Bucket Name: "Data/Object"
Object Key Name: "objectkey.docx"
Result: objectDetails
In this example, the activity retrieves details about the object "objectkey.docx" in the S3 bucket "Data/Object." The result is stored in the variable "objectDetails" of type GetObjectMetadataResponse for further handling in the workflow.