Amazon EC2: Get Volumes
Description
This step retrieves a list of EBS volumes from a specified AWS region. You can filter results by volume IDs or by key-value pairs to narrow down the list. The step returns the results as XML or as selected volume properties in table format. Use this step in workflows that audit storage resources, check volume status before attaching or deleting, or generate inventory reports of your EBS volumes.
Note:
The plugin step will not work if you provide more than 9 filters at a time.
Reference
Configurations
| Field name | Description |
|---|---|
| Step Name | Specify a unique name for the step. |
| CONNECTION tab: | Connection fields |
| Region | Specify the valid AWS region. The field type is String. This field is mandatory. |
| Button: Get | Click the button, it populates the list of available regions. |
| Access Key | Specify an Access Key to authenticate EC2 instance on Amazon AWS cloud. The field type is String. This field is mandatory. |
| Secret Key | Specify a Secret Key to authenticate the Amazon AWS cloud. The field type is String. This field is mandatory. |
| Button: Test Connection | Click to verify whether the connection is available or not. Region, Access key and Secret Key are mandatory to authenticate Amazon AWS cloud. For the purpose of verification, fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed. |
| INPUT tab: | Input fields |
| Volume IDs | Specify valid volume IDs. Note: Provide a list of multiple Volume IDs using a semicolon ( ; ) as the separator. |
| Filter | Provide the key and value in tabular format to filter the response. |
| Key | Specify the key on the basis of which you want to filter the result. |
| Value | Specify the value for the respective filter key name. |
| OUTPUT tab: | Output fields |
| XML Output | Select or clear the checkbox. Note: - If the checkbox is selected, the XML output field will be enabled. - If the checkbox is clear, Table Fields will be enabled. |
| XML | This field contains the ‘XML’ output of the successful execution step. |
| Field Name | Click on a cell in the Field Name column to open the Select Fields Name pop-up window explorer and select volume properties to fetch. You may select multiple properties. The data type is String. At least one field must be selected. |
| Output Field Name | Specify an Output Field Name to hold the corresponding value of the Field Name selected above. The data type is String. This field is mandatory. |