This page provides a reference for AWS EC2 actions available in the workflow automation actions catalog. Use these actions to manage EC2 instances, EBS volumes and snapshots, Elastic IP addresses, Amazon Machine Images (AMIs), security groups, key pairs, and EC2 resource tags.
Prerequisites
Before using AWS actions in workflow automation, ensure you have:
- An AWS account with appropriate permissions.
- AWS credentials configured (IAM user credentials, IAM role ARN, or session credentials).
- The necessary IAM permissions for the specific AWS services you plan to use.
See Set up AWS credentials for information on how to create IAM users and IAM roles, and set up static and session AWS credentials for integration with workflow automation AWS actions.
Run instances
The action identifier is aws.ec2.runInstances.
Launches the specified number of instances using an AMI for which you have permissions. If you don't specify a subnet ID, the default VPC subnet is used. If any AMIs have a product code the user hasn't subscribed to, the request fails.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the instances will be launched. |
|
| String | Required. The ID of the AMI to use for the instance. |
|
| String | Required. The instance type to use for the instance. |
|
| Int | Required. Minimum number of instances to launch. |
|
| Int | Required. Maximum number of instances to launch. |
|
| Map | Optional. Additional boto3 API parameters for the run_instances call. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
Tip
The parameters map accepts any optional argument available in the boto3 API, allowing you to dynamically construct requests.
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | See the run_instances boto3 reference. |
| Boolean |
|
| String |
|
Describe an instance
The action identifier is aws.ec2.describeInstances.
Describes the specified instances or all instances.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the instances are located. |
|
| List | Optional. List of instance IDs to describe. |
|
| List | Optional. Filters to apply to the describe request. |
|
| String | Optional. Pagination token from a previous response. |
|
| Int | Optional. Maximum number of results to return. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | See the describe_instances boto3 reference. |
| Boolean |
|
| String |
|
Important
If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you specify neither, the output includes information for all instances. The instanceIds parameter cannot be used together with maxResults.
Restart instances
The action identifier is aws.ec2.startInstances.
Starts an Amazon EBS-backed instance that you previously stopped.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the instances are located. |
|
| List | Required. List of instance IDs to start. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | See the start_instances boto3 reference. |
| Boolean |
|
| String |
|
Stop instances
The action identifier is aws.ec2.stopInstances.
Stops an Amazon EBS-backed instance.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the instances are located. |
|
| List | Required. List of instance IDs to stop. |
|
| Boolean | Optional. Hibernate the instance instead of stopping it. Default: |
|
| Boolean | Optional. Force stop the instance. Default: |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | See the stop_instances boto3 reference. |
| Boolean |
|
| String |
|
Request an instance reboot
The action identifier is aws.ec2.rebootInstances.
Requests a reboot of the specified instances. This operation is asynchronous — it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored. If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a hard reboot.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the instances are located. |
|
| List | Required. List of instance IDs to reboot. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | See the reboot_instances boto3 reference. |
| Boolean |
|
| String |
|
Shut down instances
The action identifier is aws.ec2.terminateInstances.
Shuts down the specified instances. This operation is idempotent — if you terminate an instance more than once, each call succeeds. If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the instances are located. |
|
| List | Required. IDs of the instances to terminate. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | See the terminate_instances boto3 reference. |
| Boolean |
|
| String |
|
Create an EBS snapshot
The action identifier is aws.ec2.createSnapshot.
Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance. The location of the source EBS volume determines where you can create the snapshot.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the EBS volume is located. |
|
| String | Required. The ID of the EBS volume to snapshot. |
|
| String | Optional. A description for the snapshot. |
|
| String | Optional. The Amazon Resource Name (ARN) of the Outpost on which to create the snapshot. |
|
| List | Optional. Tags to apply to the snapshot at creation. |
|
| String | Optional. The location of the snapshot. Valid values: |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | See the create_snapshot boto3 reference. |
| Boolean |
|
| String |
|
Delete a snapshot
The action identifier is aws.ec2.deleteSnapshot.
Deletes the specified snapshot. You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI — you must first deregister the AMI before you can delete the snapshot.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the snapshot is located. |
|
| String | Required. The ID of the snapshot to delete. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | No response body on success. See the delete_snapshot boto3 reference. |
| Boolean |
|
| String |
|
Allocate an Elastic IP address
The action identifier is aws.ec2.allocateAddress.
Allocates a new Elastic IP address for use with EC2 instances in a VPC.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the address is allocated. |
|
| String | Optional. Scope of the address. Use |
|
| String | Optional. A specific Elastic IP address to recover that you previously released. |
|
| String | Optional. Limits the group from which the IP address is advertised. |
|
| List | Optional. Tags applied to the address at allocation time. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | See the allocate_address boto3 reference. |
| Boolean |
|
| String |
|
Associate an Elastic IP address
The action identifier is aws.ec2.associateAddress.
Associates an Elastic IP address with an EC2 instance or network interface.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the association is made. |
|
| String | Optional. The Elastic IP allocation ID to associate. Use with |
|
| String | Optional. The instance to associate the address with. |
|
| String | Optional. Alternative to |
|
| String | Optional. Target network interface instead of an instance. |
|
| String | Optional. A specific private IP on the network interface to associate with. |
|
| Boolean | Optional. Allow the address to move off an existing association. Default: |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
Important
Only certain combinations of identifiers are valid. For VPC instances, use allocationId with instanceId or networkInterfaceId. For EC2-Classic instances, use publicIp with instanceId. Do not mix the two forms.
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | See the associate_address boto3 reference. |
| Boolean |
|
| String |
|
Disassociate an Elastic IP address
The action identifier is aws.ec2.disassociateAddress.
Disassociates an Elastic IP address from its current instance or network interface.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the association exists. |
|
| String | Optional. The association ID returned by |
|
| String | Optional. Alternative to |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
Important
Use exactly one identifier matching the domain the address was associated in. For VPC addresses, use associationId. For EC2-Classic addresses, use publicIp.
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | No response body on success. See the disassociate_address boto3 reference. |
| Boolean |
|
| String |
|
Release an Elastic IP address
The action identifier is aws.ec2.releaseAddress.
Releases an Elastic IP address back to the AWS pool. The address must already be disassociated before it can be released.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the address is allocated. |
|
| String | Optional. The allocation ID of the VPC address to release. |
|
| String | Optional. Alternative to |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | No response body on success. See the release_address boto3 reference. |
| Boolean |
|
| String |
|
Describe Elastic IP addresses
The action identifier is aws.ec2.describeAddresses.
Describes Elastic IP addresses and their current associations.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region to query. |
|
| List | Optional. Restrict results to these public IP addresses. |
|
| List | Optional. Restrict results to these allocation IDs. |
|
| List | Optional. AWS filters to apply to the query. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | See the describe_addresses boto3 reference. |
| Boolean |
|
| String |
|
Create tags
The action identifier is aws.ec2.createTags.
Adds or overwrites tags on any EC2 resource — instances, volumes, snapshots, security groups, AMIs, and so on. An existing tag with the same key is overwritten.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the resources are located. |
|
| List | Required. IDs of the EC2 resources to tag. |
|
| List | Required. Tag key/value pairs to apply. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | No response body on success. See the create_tags boto3 reference. |
| Boolean |
|
| String |
|
Delete tags
The action identifier is aws.ec2.deleteTags.
Removes tags from any EC2 resource. Omit the tags field to remove all tags from the specified resources.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the resources are located. |
|
| List | Required. IDs of the EC2 resources to remove tags from. |
|
| List | Optional. Tags to remove. Omit |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | No response body on success. See the delete_tags boto3 reference. |
| Boolean |
|
| String |
|
Describe tags
The action identifier is aws.ec2.describeTags.
Describes tags across any EC2 resource type, with optional filtering by resource ID, resource type, key, or value.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region to query. |
|
| List | Optional. AWS filters applied to the query. Filter by |
|
| String | Optional. Pagination token from a previous response. |
|
| Int | Optional. Maximum number of tags to return per page. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | See the describe_tags boto3 reference. |
| Boolean |
|
| String |
|
Create a volume
The action identifier is aws.ec2.createVolume.
Creates a new EBS volume in a given availability zone. A volume can only be attached to an instance in the same availability zone.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the volume is created. |
|
| String | Required. The availability zone in which to create the volume. |
|
| Int | Optional. Volume size in GiB. Required if |
|
| String | Optional. EBS volume type. Valid values: |
|
| String | Optional. Snapshot to restore the volume from. |
|
| Int | Optional. Provisioned IOPS. Only valid for |
|
| Int | Optional. Throughput in MiB/s. Only valid for |
|
| List | Optional. Tags applied to the volume at creation time. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | See the create_volume boto3 reference. |
| Boolean |
|
| String |
|
Delete a volume
The action identifier is aws.ec2.deleteVolume.
Deletes an EBS volume. The volume must be in the available state (fully detached) before it can be deleted.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the volume is located. |
|
| String | Required. The ID of the volume to delete. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | No response body on success. See the delete_volume boto3 reference. |
| Boolean |
|
| String |
|
Attach a volume
The action identifier is aws.ec2.attachVolume.
Attaches an EBS volume to a running or stopped EC2 instance. The volume and instance must be in the same availability zone.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the volume and instance are located. |
|
| String | Required. The ID of the volume to attach. Must be in the |
|
| String | Required. The instance to attach to. Must be |
|
| String | Required. The device name the volume is exposed as on the instance. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | See the attach_volume boto3 reference. |
| Boolean |
|
| String |
|
Detach a volume
The action identifier is aws.ec2.detachVolume.
Detaches an EBS volume from an EC2 instance.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the volume is located. |
|
| String | Required. The ID of the volume to detach. |
|
| String | Optional. Narrows the detach to a specific instance. Useful when the volume is multi-attached. |
|
| String | Optional. Narrows the detach to a specific device name on the instance. |
|
| Boolean | Optional. Forces detachment without unmounting from the guest OS. Can cause data loss or filesystem corruption. Default: |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | See the detach_volume boto3 reference. |
| Boolean |
|
| String |
|
Modify a volume
The action identifier is aws.ec2.modifyVolume.
Resizes an EBS volume or changes its volume type, IOPS, or throughput. EBS volumes can only be grown, never shrunk.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the volume is located. |
|
| String | Required. The ID of the volume to modify. |
|
| Int | Optional. New size in GiB. |
|
| String | Optional. New volume type. |
|
| Int | Optional. New provisioned IOPS. Only valid for |
|
| Int | Optional. New throughput in MiB/s. Only valid for |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | See the modify_volume boto3 reference. |
| Boolean |
|
| String |
|
Describe volumes
The action identifier is aws.ec2.describeVolumes.
Describes EBS volumes and their attachment state.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region to query. |
|
| List | Optional. Restrict results to specific volume IDs. Omit to describe all volumes in the region. |
|
| List | Optional. Server-side filters, for example by |
|
| String | Optional. Pagination token from a previous response. |
|
| Int | Optional. Maximum number of volumes to return per page. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | See the describe_volumes boto3 reference. |
| Boolean |
|
| String |
|
Copy a snapshot
The action identifier is aws.ec2.copySnapshot.
Copies an EBS snapshot to another region for backup and disaster recovery. The region field specifies the destination region.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. The destination region the snapshot is copied into. |
|
| String | Required. The ID of the snapshot to copy. |
|
| String | Required. The region the source snapshot currently lives in. |
|
| String | Optional. Description applied to the new snapshot. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | See the copy_snapshot boto3 reference. |
| Boolean |
|
| String |
|
Describe snapshots
The action identifier is aws.ec2.describeSnapshots.
Describes EBS snapshots by owner, volume, or filter criteria.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region to query. |
|
| List | Optional. Restrict results to specific snapshot IDs. |
|
| List | Optional. Filter by snapshot owner. Use |
|
| List | Optional. AWS filters, for example by volume, status, or tag. |
|
| String | Optional. Pagination token from a previous response. |
|
| Int | Optional. Maximum number of snapshots to return per page. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | See the describe_snapshots boto3 reference. |
| Boolean |
|
| String |
|
Create an image
The action identifier is aws.ec2.createImage.
Creates an Amazon Machine Image (AMI) from a running or stopped EC2 instance.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the instance is located. |
|
| String | Required. The EC2 instance to capture the image from. |
|
| String | Required. Name for the new AMI. Must be unique within the region. |
|
| String | Optional. Free-form description for the AMI. |
|
| Boolean | Optional. When |
|
| List | Optional. Tags applied to the new AMI and its snapshots at creation time. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | See the create_image boto3 reference. |
| Boolean |
|
| String |
|
Copy an image
The action identifier is aws.ec2.copyImage.
Copies an Amazon Machine Image (AMI) to another region for disaster recovery or multi-region deployments. The region field specifies the destination region.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. The destination region the copy is created in. |
|
| String | Required. The AMI to copy. |
|
| String | Required. The region that currently holds the source AMI. |
|
| String | Optional. Name for the new AMI in the destination region. |
|
| String | Optional. Free-form description for the copied AMI. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | See the copy_image boto3 reference. |
| Boolean |
|
| String |
|
Deregister an image
The action identifier is aws.ec2.deregisterImage.
Deregisters an Amazon Machine Image (AMI) that you own. Deregistering an AMI does not delete its backing EBS snapshots — delete those separately to stop incurring storage costs.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the AMI is registered. |
|
| String | Required. The AMI to deregister. Must be an AMI owned by the calling account. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | See the deregister_image boto3 reference. |
| Boolean |
|
| String |
|
Describe images
The action identifier is aws.ec2.describeImages.
Describes Amazon Machine Images owned by, shared with, or public to your account.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region to query. |
|
| List | Optional. Restrict results to specific AMI IDs. |
|
| List | Optional. Scope results by owner. Accepts an AWS account ID, |
|
| List | Optional. Server-side filters, for example by |
|
| String | Optional. Pagination token from a previous response. |
|
| Int | Optional. Maximum number of AMIs to return per page. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | See the describe_images boto3 reference. |
| Boolean |
|
| String |
|
Describe instance status
The action identifier is aws.ec2.describeInstanceStatus.
Describes the status of one or more EC2 instances, including system and instance status checks and scheduled events.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region to query. |
|
| List | Optional. Instance IDs to check. If omitted, all instances are returned. |
|
| Boolean | Optional. When |
|
| List | Optional. AWS filters to apply to the query. |
|
| String | Optional. Pagination token from a previous response. |
|
| Int | Optional. Maximum number of results to return per page. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | |
| Boolean |
|
| String |
|
Describe instance types
The action identifier is aws.ec2.describeInstanceTypes.
Describes the specifications (vCPU, memory, network, storage) of EC2 instance types.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region to query. |
|
| List | Optional. Specific instance types to describe. |
|
| List | Optional. AWS filters to apply to the query. |
|
| String | Optional. Pagination token from a previous response. |
|
| Int | Optional. Maximum number of results to return per page. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | |
| Boolean |
|
| String |
|
Modify an instance attribute
The action identifier is aws.ec2.modifyInstanceAttribute.
Modifies a single attribute of an EC2 instance such as instance type, termination protection, user data, or source/dest check.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the instance is located. |
|
| String | Required. The instance whose attribute is being modified. |
|
| Map | Required. The attribute to modify in the shape the AWS API expects. Only one attribute can be modified per call. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
Important
Only one attribute can be modified per call. Each attribute has a different shape in the parameters map — for example, {"InstanceType": {"Value": "t3.large"}} to change the instance type, or {"DisableApiTermination": {"Value": true}} to enable termination protection. Most attributes require the instance to be stopped first.
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | No response body on success. See the modify_instance_attribute boto3 reference. |
| Boolean |
|
| String |
|
Enable detailed monitoring
The action identifier is aws.ec2.monitorInstances.
Enables detailed CloudWatch monitoring (1-minute metrics) for one or more EC2 instances.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the instances are located. |
|
| List | Required. IDs of the instances to enable detailed monitoring on. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | See the monitor_instances boto3 reference. |
| Boolean |
|
| String |
|
Disable detailed monitoring
The action identifier is aws.ec2.unmonitorInstances.
Disables detailed CloudWatch monitoring for one or more EC2 instances, reverting to standard 5-minute metrics.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the instances are located. |
|
| List | Required. IDs of the instances to disable detailed monitoring on. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | See the unmonitor_instances boto3 reference. |
| Boolean |
|
| String |
|
Get console output
The action identifier is aws.ec2.getConsoleOutput.
Retrieves the console output of an EC2 instance for boot and troubleshooting diagnostics. The output is base64-encoded.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the instance is located. |
|
| String | Required. The instance to retrieve console output from. |
|
| Boolean | Optional. When |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | See the get_console_output boto3 reference. |
| Boolean |
|
| String |
|
Get Windows password data
The action identifier is aws.ec2.getPasswordData.
Retrieves the encrypted administrator password for a Windows EC2 instance. Returns an empty PasswordData field for non-Windows instances.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the instance is located. |
|
| String | Required. The Windows instance to retrieve password data from. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | See the get_password_data boto3 reference. |
| Boolean |
|
| String |
|
Import a key pair
The action identifier is aws.ec2.importKeyPair.
Imports an existing public key into EC2 as a key pair. AWS stores only the public key — the private key never leaves your control.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the key pair is registered. |
|
| String | Required. Unique name to register the imported key pair under. |
|
| String | Required. The public key to import. Pass as a secret. |
|
| List | Optional. Tags applied to the key pair at import time. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | See the import_key_pair boto3 reference. |
| Boolean |
|
| String |
|
Delete a key pair
The action identifier is aws.ec2.deleteKeyPair.
Deletes an EC2 key pair. Supply either keyName or keyPairId.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the key pair exists. |
|
| String | Optional. Name of the key pair to delete. Supply either |
|
| String | Optional. ID of the key pair to delete. Supply either |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | No response body on success. See the delete_key_pair boto3 reference. |
| Boolean |
|
| String |
|
Describe key pairs
The action identifier is aws.ec2.describeKeyPairs.
Describes the EC2 key pairs in an account and region.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region to query. |
|
| List | Optional. Restrict results to these key pair names. |
|
| List | Optional. Restrict results to these key pair IDs. |
|
| List | Optional. AWS filters, for example by |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | See the describe_key_pairs boto3 reference. |
| Boolean |
|
| String |
|
Create a security group
The action identifier is aws.ec2.createSecurityGroup.
Creates a new EC2 security group in a VPC.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the security group is created. |
|
| String | Required. Name for the new security group. Must be unique within the VPC. |
|
| String | Required. Description for the security group. |
|
| String | Optional. VPC in which to create the group. Defaults to the region's default VPC. |
|
| List | Optional. Tags applied to the group at creation time. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | |
| Boolean |
|
| String |
|
Delete a security group
The action identifier is aws.ec2.deleteSecurityGroup.
Deletes an EC2 security group. Supply either groupId (preferred) or groupName.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the security group exists. |
|
| String | Optional. The security group to delete. Works for any VPC. Preferred over |
|
| String | Optional. Alternative to |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | No response body on success. See the delete_security_group boto3 reference. |
| Boolean |
|
| String |
|
Describe security groups
The action identifier is aws.ec2.describeSecurityGroups.
Describes EC2 security groups and their inbound and outbound rules.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region to query. |
|
| List | Optional. Restrict results to specific security group IDs. |
|
| List | Optional. Restrict results by group name. Only valid for groups in the default VPC. |
|
| List | Optional. AWS filters, for example by |
|
| String | Optional. Pagination token from a previous response. |
|
| Int | Optional. Maximum number of groups to return per page. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | |
| Boolean |
|
| String |
|
Add an inbound rule
The action identifier is aws.ec2.authorizeSecurityGroupIngress.
Adds an inbound rule to an EC2 security group.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the security group exists. |
|
| String | Required. The security group to add the inbound rule to. |
|
| String | Optional. Flat form. Use with |
|
| Int | Optional. Flat form. Start of the port range. |
|
| Int | Optional. Flat form. End of the port range. |
|
| String | Optional. Flat form. Source CIDR block allowed by the rule. |
|
| List | Optional. Structured form. Required for multiple rules in one call, rule descriptions, IPv6 ranges, prefix lists, or source security groups. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
Tip
This action supports two rule forms — pick one per call. The flat form (ipProtocol, fromPort, toPort, cidrIp) is a shorthand for a single IPv4 rule. Use ipPermissions for multiple rules, descriptions, IPv6 ranges, prefix lists, or source security groups.
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | No response body on success. See the authorize_security_group_ingress boto3 reference. |
| Boolean |
|
| String |
|
Remove an inbound rule
The action identifier is aws.ec2.revokeSecurityGroupIngress.
Removes an inbound rule from an EC2 security group. The rule specification must exactly match an existing rule.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the security group exists. |
|
| String | Required. The security group to remove the inbound rule from. |
|
| String | Optional. Flat form. Use with |
|
| Int | Optional. Flat form. Start of the port range. |
|
| Int | Optional. Flat form. End of the port range. |
|
| String | Optional. Flat form. Source CIDR block of the rule being removed. |
|
| List | Optional. Structured form. Required to revoke multiple rules in one call, or rules on IPv6 ranges, prefix lists, or source security groups. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | No response body on success. See the revoke_security_group_ingress boto3 reference. |
| Boolean |
|
| String |
|
Add an outbound rule
The action identifier is aws.ec2.authorizeSecurityGroupEgress.
Adds an outbound rule to an EC2 security group using the structured ipPermissions form.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the security group exists. |
|
| String | Required. The security group to add the outbound rule to. |
|
| List | Required. The outbound rules to add in the structured form. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
Important
Unlike the inbound rule actions, this action does not support the flat parameter form (cidrIp, ipProtocol, fromPort, toPort). The AWS AuthorizeSecurityGroupEgress API rejects those parameters outright. All outbound rules must use the structured ipPermissions list.
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | No response body on success. See the authorize_security_group_egress boto3 reference. |
| Boolean |
|
| String |
|
Remove an outbound rule
The action identifier is aws.ec2.revokeSecurityGroupEgress.
Removes an outbound rule from an EC2 security group. The rule specification must exactly match an existing rule. A common use is removing the default allow-all egress rule that AWS attaches to every new security group.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the security group exists. |
|
| String | Required. The security group to remove the outbound rule from. |
|
| List | Required. The outbound rules to remove in the structured form. Must exactly match existing rules. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
Important
Unlike the inbound rule actions, this action does not support the flat parameter form (cidrIp, ipProtocol, fromPort, toPort). All outbound rules must use the structured ipPermissions list.
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object | No response body on success. See the revoke_security_group_egress boto3 reference. |
| Boolean |
|
| String |
|