Amazon EC2

Amazon EC2 provides resizable virtual servers in AWS. The EC2 API also covers the VPC networking around them (subnets, route tables, NAT and internet gateways, security groups, network interfaces, and Elastic IP addresses) and the EBS volumes and snapshots that back them.

With the Amazon EC2 block, you can:

  • Inventory and control instances: List instances with their state, type, IPs, and tags, read status checks and scheduled maintenance events, and start, stop, reboot, or terminate instances
  • Manage Elastic IPs: List Elastic IP addresses and what they are attached to, allocate new addresses, associate them with an instance or network interface, disassociate them, and release them
  • Inspect VPC networking: Read VPCs, subnets, route tables with their routes and associations, NAT gateways with their public IPs, internet gateways, network ACLs, VPC endpoints, VPC peering connections, security groups with their inbound and outbound rules, and network interfaces
  • Control security group ingress: Add an inbound rule, or revoke rules by rule ID or by protocol, ports, and source
  • Work with EBS: List volumes and snapshots, create a snapshot of a volume, and delete volumes and snapshots
  • Tag resources: Add, overwrite, or remove tags on any EC2 resource ID
  • Explore the account: List AMIs, key pairs, Regions, and Availability Zones

Credentials and permissions

The block authenticates with an AWS access key ID and secret access key and runs in the region you set. Grant the IAM principal only the EC2 actions the operations you use require. Each operation maps to the IAM action of the same name, for example ec2:DescribeAddresses, ec2:DescribeNatGateways, and ec2:DescribeRouteTables for a read-only egress audit, or ec2:StopInstances and ec2:StartInstances for scheduling.

List operations accept EC2 filters such as [{"Name": "vpc-id", "Values": ["vpc-0abc123"]}]. Without IDs they return up to 100 results per page, with a nextToken for the next page.

In Sim, the Amazon EC2 block lets your agents map which public IPs your subnets egress through, find idle Elastic IPs and unattached volumes, audit and close open security group rules, back up volumes and prune old snapshots on a schedule, and stop non-production instances outside working hours.

Use the block

Integrate Amazon EC2 into workflows. Describe and control instances, manage Elastic IP addresses, inspect VPCs, subnets, route tables, NAT and internet gateways, security groups, and network interfaces, add and revoke security group ingress rules, inspect network ACLs, VPC endpoints, and peering connections, work with EBS volumes and snapshots, list AMIs and key pairs, and tag resources. Requires an AWS access key with the matching ec2:* IAM permissions.

Actions

EC2 Describe Instances

List EC2 instances with their state, type, networking, and tags

Inputs and outputs

Input

ParameterTypeRequiredDescription
awsRegionstringYesAWS region (e.g., us-east-1)
awsAccessKeyIdstringYesAWS access key ID
awsSecretAccessKeystringYesAWS secret access key
instanceIdsstringNoComma-separated instance IDs (e.g., i-0abc123,i-0def456). Leave empty to list all
filtersjsonNoEC2 filters as a JSON array, e.g. [{"Name":"instance-state-name","Values":["running"]}]
maxResultsnumberNoMaximum results per page when no IDs are given (5-1000, default 100)
nextTokenstringNoPagination token from a previous response

Output

ParameterTypeDescription
nextTokenstringPagination token for the next page, or null when there are no more results
instancesarrayEC2 instances
↳ tagsjsonResource tags as key/value pairs
↳ instanceIdstringInstance ID
↳ instanceTypestringInstance type (e.g., t3.micro)
↳ statestringInstance state (pending, running, stopping, stopped, shutting-down, terminated)
↳ stateReasonstringReason for the most recent state transition
↳ launchTimestringLaunch time (ISO 8601)
↳ availabilityZonestringAvailability Zone
↳ vpcIdstringVPC ID
↳ subnetIdstringSubnet ID
↳ privateIpAddressstringPrimary private IPv4 address
↳ publicIpAddressstringPublic IPv4 address
↳ privateDnsNamestringPrivate DNS name
↳ publicDnsNamestringPublic DNS name
↳ imageIdstringAMI ID used to launch the instance
↳ keyNamestringKey pair name
↳ platformDetailsstringPlatform details (e.g., Linux/UNIX, Windows)
↳ architecturestringCPU architecture
↳ iamInstanceProfileArnstringARN of the attached IAM instance profile
↳ securityGroupsarrayAttached security groups
↳ groupIdstringSecurity group ID
↳ groupNamestringSecurity group name

EC2 Describe Instance Status

Get status checks and scheduled events for EC2 instances

Inputs and outputs

Input

ParameterTypeRequiredDescription
awsRegionstringYesAWS region (e.g., us-east-1)
awsAccessKeyIdstringYesAWS access key ID
awsSecretAccessKeystringYesAWS secret access key
instanceIdsstringNoComma-separated instance IDs (max 100). Leave empty to describe all
filtersjsonNoEC2 filters as a JSON array, e.g. [{"Name":"instance-status.status","Values":["impaired"]}]
includeAllInstancesbooleanNoInclude instances that are not running (by default only running instances are returned)
maxResultsnumberNoMaximum results per page when no IDs are given (5-1000, default 100)
nextTokenstringNoPagination token from a previous response

Output

ParameterTypeDescription
nextTokenstringPagination token for the next page, or null when there are no more results
instanceStatusesarrayStatus of each instance
↳ instanceIdstringInstance ID
↳ availabilityZonestringAvailability Zone
↳ instanceStatestringInstance state (e.g., running, stopped)
↳ instanceStatusstringInstance status check (ok, impaired, initializing, insufficient-data, not-applicable)
↳ systemStatusstringSystem status check (ok, impaired, initializing, insufficient-data, not-applicable)
↳ attachedEbsStatusstringAttached EBS status check
↳ eventsarrayScheduled events
↳ codestringEvent code (e.g., system-reboot, instance-retirement)
↳ descriptionstringEvent description
↳ notBeforestringEarliest start time (ISO 8601)
↳ notAfterstringLatest end time (ISO 8601)

EC2 Start Instances

Start one or more stopped EC2 instances

Inputs and outputs

Input

ParameterTypeRequiredDescription
awsRegionstringYesAWS region (e.g., us-east-1)
awsAccessKeyIdstringYesAWS access key ID
awsSecretAccessKeystringYesAWS secret access key
instanceIdsstringYesComma-separated instance IDs to start

Output

ParameterTypeDescription
instancesarrayState transition for each instance
↳ instanceIdstringInstance ID
↳ currentStatestringState after the request (e.g., pending, running)
↳ previousStatestringState before the request

EC2 Stop Instances

Stop one or more running EC2 instances

Inputs and outputs

Input

ParameterTypeRequiredDescription
awsRegionstringYesAWS region (e.g., us-east-1)
awsAccessKeyIdstringYesAWS access key ID
awsSecretAccessKeystringYesAWS secret access key
instanceIdsstringYesComma-separated instance IDs to stop
hibernatebooleanNoHibernate the instances instead of stopping them (hibernation must be enabled on the instance)
forcebooleanNoForce the instances to stop without flushing file system caches

Output

ParameterTypeDescription
instancesarrayState transition for each instance
↳ instanceIdstringInstance ID
↳ currentStatestringState after the request (e.g., stopping, stopped)
↳ previousStatestringState before the request

EC2 Reboot Instances

Request a reboot of one or more EC2 instances

Inputs and outputs

Input

ParameterTypeRequiredDescription
awsRegionstringYesAWS region (e.g., us-east-1)
awsAccessKeyIdstringYesAWS access key ID
awsSecretAccessKeystringYesAWS secret access key
instanceIdsstringYesComma-separated instance IDs to reboot

Output

ParameterTypeDescription
rebootedbooleanWhether the reboot request was accepted
instanceIdsarrayInstance IDs that were sent the reboot request

EC2 Terminate Instances

Permanently terminate one or more EC2 instances

Inputs and outputs

Input

ParameterTypeRequiredDescription
awsRegionstringYesAWS region (e.g., us-east-1)
awsAccessKeyIdstringYesAWS access key ID
awsSecretAccessKeystringYesAWS secret access key
instanceIdsstringYesComma-separated instance IDs to terminate

Output

ParameterTypeDescription
instancesarrayState transition for each instance
↳ instanceIdstringInstance ID
↳ currentStatestringState after the request (e.g., shutting-down, terminated)
↳ previousStatestringState before the request

EC2 Describe Addresses

List Elastic IP addresses and what they are associated with

Inputs and outputs

Input

ParameterTypeRequiredDescription
awsRegionstringYesAWS region (e.g., us-east-1)
awsAccessKeyIdstringYesAWS access key ID
awsSecretAccessKeystringYesAWS secret access key
publicIpsstringNoComma-separated Elastic IP addresses to describe
allocationIdsstringNoComma-separated allocation IDs (e.g., eipalloc-0abc123)
filtersjsonNoEC2 filters as a JSON array, e.g. [{"Name":"domain","Values":["vpc"]}]

Output

ParameterTypeDescription
addressesarrayElastic IP addresses
↳ tagsjsonResource tags as key/value pairs
↳ publicIpstringElastic IP address
↳ allocationIdstringAllocation ID
↳ associationIdstringAssociation ID when associated
↳ domainstringAddress scope (vpc or standard)
↳ instanceIdstringAssociated instance ID
↳ networkInterfaceIdstringAssociated network interface ID
↳ networkInterfaceOwnerIdstringAWS account ID that owns the network interface
↳ privateIpAddressstringAssociated private IP address
↳ publicIpv4PoolstringPublic IPv4 pool the address came from
↳ networkBorderGroupstringNetwork border group the address is advertised from
↳ serviceManagedstringAWS service managing the address, if any (e.g., alb, nlb)

EC2 Allocate Address

Allocate a new Elastic IP address for use in a VPC

Inputs and outputs

Input

ParameterTypeRequiredDescription
awsRegionstringYesAWS region (e.g., us-east-1)
awsAccessKeyIdstringYesAWS access key ID
awsSecretAccessKeystringYesAWS secret access key
networkBorderGroupstringNoNetwork border group to allocate from (defaults to the region)
publicIpv4PoolstringNoBYOIP address pool to allocate from (defaults to the Amazon pool)
tagsjsonNoTags to apply as a JSON object, e.g. {"Name":"web-eip"}

Output

ParameterTypeDescription
allocationIdstringAllocation ID of the new Elastic IP
publicIpstringAllocated Elastic IP address
domainstringAddress scope (vpc)
networkBorderGroupstringNetwork border group
publicIpv4PoolstringPublic IPv4 pool

EC2 Associate Address

Associate an Elastic IP address with an instance or network interface

Inputs and outputs

Input

ParameterTypeRequiredDescription
awsRegionstringYesAWS region (e.g., us-east-1)
awsAccessKeyIdstringYesAWS access key ID
awsSecretAccessKeystringYesAWS secret access key
allocationIdstringYesAllocation ID of the Elastic IP (e.g., eipalloc-0abc123)
instanceIdstringNoInstance ID to associate with (provide this or networkInterfaceId)
networkInterfaceIdstringNoNetwork interface ID to associate with (provide this or instanceId)
privateIpAddressstringNoPrivate IP address on the target to associate with
allowReassociationbooleanNoAllow moving an Elastic IP that is already associated

Output

ParameterTypeDescription
associationIdstringID of the new association

EC2 Disassociate Address

Disassociate an Elastic IP address from its instance or network interface

Inputs and outputs

Input

ParameterTypeRequiredDescription
awsRegionstringYesAWS region (e.g., us-east-1)
awsAccessKeyIdstringYesAWS access key ID
awsSecretAccessKeystringYesAWS secret access key
associationIdstringYesAssociation ID of the Elastic IP (e.g., eipassoc-0abc123)

Output

ParameterTypeDescription
disassociatedbooleanWhether the address was disassociated
associationIdstringAssociation ID that was removed

EC2 Release Address

Release an Elastic IP address back to AWS

Inputs and outputs

Input

ParameterTypeRequiredDescription
awsRegionstringYesAWS region (e.g., us-east-1)
awsAccessKeyIdstringYesAWS access key ID
awsSecretAccessKeystringYesAWS secret access key
allocationIdstringYesAllocation ID of the Elastic IP to release
networkBorderGroupstringNoNetwork border group the address was allocated from

Output

ParameterTypeDescription
releasedbooleanWhether the address was released
allocationIdstringAllocation ID that was released

EC2 Describe NAT Gateways

List NAT gateways with their state, subnet, and IP addresses

Inputs and outputs

Input

ParameterTypeRequiredDescription
awsRegionstringYesAWS region (e.g., us-east-1)
awsAccessKeyIdstringYesAWS access key ID
awsSecretAccessKeystringYesAWS secret access key
natGatewayIdsstringNoComma-separated NAT gateway IDs (e.g., nat-0abc123)
filtersjsonNoEC2 filters as a JSON array, e.g. [{"Name":"vpc-id","Values":["vpc-0abc123"]}]
maxResultsnumberNoMaximum results per page when no IDs are given (5-1000, default 100)
nextTokenstringNoPagination token from a previous response

Output

ParameterTypeDescription
nextTokenstringPagination token for the next page, or null when there are no more results
natGatewaysarrayNAT gateways
↳ tagsjsonResource tags as key/value pairs
↳ natGatewayIdstringNAT gateway ID
↳ statestringState (pending, failed, available, deleting, deleted)
↳ connectivityTypestringConnectivity type (public or private)
↳ vpcIdstringVPC ID
↳ subnetIdstringSubnet ID
↳ createTimestringCreation time (ISO 8601)
↳ deleteTimestringDeletion time (ISO 8601)
↳ failureCodestringFailure code when state is failed
↳ failureMessagestringFailure message when state is failed
↳ addressesarrayIP addresses of the NAT gateway
↳ allocationIdstringElastic IP allocation ID
↳ networkInterfaceIdstringNetwork interface ID
↳ privateIpstringPrivate IP address
↳ publicIpstringElastic IP address
↳ associationIdstringAssociation ID
↳ isPrimarybooleanWhether this is the primary address
↳ statusstringAddress status

EC2 Describe Route Tables

List VPC route tables with their routes and subnet associations

Inputs and outputs

Input

ParameterTypeRequiredDescription
awsRegionstringYesAWS region (e.g., us-east-1)
awsAccessKeyIdstringYesAWS access key ID
awsSecretAccessKeystringYesAWS secret access key
routeTableIdsstringNoComma-separated route table IDs (e.g., rtb-0abc123)
filtersjsonNoEC2 filters as a JSON array, e.g. [{"Name":"vpc-id","Values":["vpc-0abc123"]}]
maxResultsnumberNoMaximum results per page when no IDs are given (5-100, default 100)
nextTokenstringNoPagination token from a previous response

Output

ParameterTypeDescription
nextTokenstringPagination token for the next page, or null when there are no more results
routeTablesarrayRoute tables
↳ tagsjsonResource tags as key/value pairs
↳ routeTableIdstringRoute table ID
↳ vpcIdstringVPC ID
↳ ownerIdstringOwning AWS account ID
↳ routesarrayRoutes in the table
↳ destinationCidrBlockstringIPv4 destination CIDR
↳ destinationIpv6CidrBlockstringIPv6 destination CIDR
↳ destinationPrefixListIdstringDestination prefix list ID
↳ gatewayIdstringInternet or virtual private gateway ID (local for VPC-local routes)
↳ natGatewayIdstringNAT gateway ID
↳ transitGatewayIdstringTransit gateway ID
↳ vpcPeeringConnectionIdstringVPC peering connection ID
↳ networkInterfaceIdstringNetwork interface ID
↳ instanceIdstringNAT instance ID
↳ egressOnlyInternetGatewayIdstringEgress-only internet gateway ID
↳ statestringRoute state (active or blackhole)
↳ originstringHow the route was created
↳ associationsarraySubnet and gateway associations
↳ associationIdstringAssociation ID
↳ mainbooleanWhether this is the main route table for the VPC
↳ subnetIdstringAssociated subnet ID
↳ gatewayIdstringAssociated gateway ID
↳ statestringAssociation state

EC2 Describe VPCs

List VPCs with their CIDR blocks and state

Inputs and outputs

Input

ParameterTypeRequiredDescription
awsRegionstringYesAWS region (e.g., us-east-1)
awsAccessKeyIdstringYesAWS access key ID
awsSecretAccessKeystringYesAWS secret access key
vpcIdsstringNoComma-separated VPC IDs (e.g., vpc-0abc123)
filtersjsonNoEC2 filters as a JSON array, e.g. [{"Name":"is-default","Values":["false"]}]
maxResultsnumberNoMaximum results per page when no IDs are given (5-1000, default 100)
nextTokenstringNoPagination token from a previous response

Output

ParameterTypeDescription
nextTokenstringPagination token for the next page, or null when there are no more results
vpcsarrayVPCs
↳ tagsjsonResource tags as key/value pairs
↳ vpcIdstringVPC ID
↳ cidrBlockstringPrimary IPv4 CIDR block
↳ cidrBlocksarrayAll associated IPv4 CIDR blocks
↳ ipv6CidrBlocksarrayAssociated IPv6 CIDR blocks
↳ statestringState (pending or available)
↳ isDefaultbooleanWhether this is the default VPC
↳ instanceTenancystringInstance tenancy
↳ dhcpOptionsIdstringDHCP options set ID
↳ ownerIdstringOwning AWS account ID

EC2 Describe Subnets

List subnets with their CIDR, Availability Zone, and free IP count

Inputs and outputs

Input

ParameterTypeRequiredDescription
awsRegionstringYesAWS region (e.g., us-east-1)
awsAccessKeyIdstringYesAWS access key ID
awsSecretAccessKeystringYesAWS secret access key
subnetIdsstringNoComma-separated subnet IDs (e.g., subnet-0abc123)
filtersjsonNoEC2 filters as a JSON array, e.g. [{"Name":"vpc-id","Values":["vpc-0abc123"]}]
maxResultsnumberNoMaximum results per page when no IDs are given (5-1000, default 100)
nextTokenstringNoPagination token from a previous response

Output

ParameterTypeDescription
nextTokenstringPagination token for the next page, or null when there are no more results
subnetsarraySubnets
↳ tagsjsonResource tags as key/value pairs
↳ subnetIdstringSubnet ID
↳ subnetArnstringSubnet ARN
↳ vpcIdstringVPC ID
↳ cidrBlockstringIPv4 CIDR block
↳ ipv6CidrBlocksarrayAssociated IPv6 CIDR blocks
↳ availabilityZonestringAvailability Zone
↳ availabilityZoneIdstringAvailability Zone ID
↳ availableIpAddressCountnumberNumber of unused private IPv4 addresses
↳ statestringState (pending, available, unavailable)
↳ defaultForAzbooleanWhether this is the default subnet for its Availability Zone
↳ mapPublicIpOnLaunchbooleanWhether instances get a public IPv4 address on launch
↳ ownerIdstringOwning AWS account ID

EC2 Describe Security Groups

List security groups with their inbound and outbound rules

Inputs and outputs

Input

ParameterTypeRequiredDescription
awsRegionstringYesAWS region (e.g., us-east-1)
awsAccessKeyIdstringYesAWS access key ID
awsSecretAccessKeystringYesAWS secret access key
groupIdsstringNoComma-separated security group IDs (e.g., sg-0abc123)
filtersjsonNoEC2 filters as a JSON array, e.g. [{"Name":"vpc-id","Values":["vpc-0abc123"]}]
maxResultsnumberNoMaximum results per page when no IDs are given (5-1000, default 100)
nextTokenstringNoPagination token from a previous response

Output

ParameterTypeDescription
nextTokenstringPagination token for the next page, or null when there are no more results
securityGroupsarraySecurity groups
↳ tagsjsonResource tags as key/value pairs
↳ groupIdstringSecurity group ID
↳ groupNamestringSecurity group name
↳ descriptionstringDescription
↳ vpcIdstringVPC ID
↳ ownerIdstringOwning AWS account ID
↳ ingressRulesarrayInbound rules
↳ ipProtocolstringIP protocol (tcp, udp, icmp, or -1 for all)
↳ fromPortnumberStart of the port range
↳ toPortnumberEnd of the port range
↳ ipv4RangesarrayIPv4 CIDR ranges
↳ cidrstringIPv4 CIDR
↳ descriptionstringRule description
↳ ipv6RangesarrayIPv6 CIDR ranges
↳ cidrstringIPv6 CIDR
↳ descriptionstringRule description
↳ referencedGroupsarrayReferenced security groups
↳ groupIdstringSecurity group ID
↳ userIdstringOwning AWS account ID
↳ descriptionstringRule description
↳ prefixListIdsarrayReferenced prefix list IDs
↳ egressRulesarrayOutbound rules
↳ ipProtocolstringIP protocol (tcp, udp, icmp, or -1 for all)
↳ fromPortnumberStart of the port range
↳ toPortnumberEnd of the port range
↳ ipv4RangesarrayIPv4 CIDR ranges
↳ cidrstringIPv4 CIDR
↳ descriptionstringRule description
↳ ipv6RangesarrayIPv6 CIDR ranges
↳ cidrstringIPv6 CIDR
↳ descriptionstringRule description
↳ referencedGroupsarrayReferenced security groups
↳ groupIdstringSecurity group ID
↳ userIdstringOwning AWS account ID
↳ descriptionstringRule description
↳ prefixListIdsarrayReferenced prefix list IDs

EC2 Describe Internet Gateways

List internet gateways and the VPCs they are attached to

Inputs and outputs

Input

ParameterTypeRequiredDescription
awsRegionstringYesAWS region (e.g., us-east-1)
awsAccessKeyIdstringYesAWS access key ID
awsSecretAccessKeystringYesAWS secret access key
internetGatewayIdsstringNoComma-separated internet gateway IDs (e.g., igw-0abc123)
filtersjsonNoEC2 filters as a JSON array, e.g. [{"Name":"attachment.vpc-id","Values":["vpc-0abc123"]}]
maxResultsnumberNoMaximum results per page when no IDs are given (5-1000, default 100)
nextTokenstringNoPagination token from a previous response

Output

ParameterTypeDescription
nextTokenstringPagination token for the next page, or null when there are no more results
internetGatewaysarrayInternet gateways
↳ tagsjsonResource tags as key/value pairs
↳ internetGatewayIdstringInternet gateway ID
↳ ownerIdstringOwning AWS account ID
↳ attachmentsarrayVPC attachments
↳ vpcIdstringAttached VPC ID
↳ statestringAttachment state

EC2 Describe Network Interfaces

List elastic network interfaces with their IPs, attachment, and security groups

Inputs and outputs

Input

ParameterTypeRequiredDescription
awsRegionstringYesAWS region (e.g., us-east-1)
awsAccessKeyIdstringYesAWS access key ID
awsSecretAccessKeystringYesAWS secret access key
networkInterfaceIdsstringNoComma-separated network interface IDs (e.g., eni-0abc123)
filtersjsonNoEC2 filters as a JSON array, e.g. [{"Name":"vpc-id","Values":["vpc-0abc123"]}]
maxResultsnumberNoMaximum results per page when no IDs are given (5-1000, default 100)
nextTokenstringNoPagination token from a previous response

Output

ParameterTypeDescription
nextTokenstringPagination token for the next page, or null when there are no more results
networkInterfacesarrayNetwork interfaces
↳ tagsjsonResource tags as key/value pairs
↳ networkInterfaceIdstringNetwork interface ID
↳ interfaceTypestringInterface type (e.g., interface, nat_gateway, lambda)
↳ statusstringStatus (available, in-use, attaching, detaching)
↳ descriptionstringDescription
↳ vpcIdstringVPC ID
↳ subnetIdstringSubnet ID
↳ availabilityZonestringAvailability Zone
↳ privateIpAddressstringPrimary private IPv4 address
↳ privateIpAddressesarrayAll private IPv4 addresses
↳ publicIpstringAssociated public IPv4 address
↳ macAddressstringMAC address
↳ requesterManagedbooleanWhether an AWS service manages the interface
↳ attachmentobjectInstance attachment, if attached
↳ attachmentIdstringAttachment ID
↳ instanceIdstringAttached instance ID
↳ deviceIndexnumberDevice index on the instance
↳ statusstringAttachment status
↳ deleteOnTerminationbooleanWhether the interface is deleted when the instance terminates
↳ securityGroupsarrayAttached security groups
↳ groupIdstringSecurity group ID
↳ groupNamestringSecurity group name

EC2 Describe Volumes

List EBS volumes with their size, type, state, and attachments

Inputs and outputs

Input

ParameterTypeRequiredDescription
awsRegionstringYesAWS region (e.g., us-east-1)
awsAccessKeyIdstringYesAWS access key ID
awsSecretAccessKeystringYesAWS secret access key
volumeIdsstringNoComma-separated volume IDs (e.g., vol-0abc123)
filtersjsonNoEC2 filters as a JSON array, e.g. [{"Name":"status","Values":["available"]}]
maxResultsnumberNoMaximum results per page when no IDs are given (5-1000, default 100)
nextTokenstringNoPagination token from a previous response

Output

ParameterTypeDescription
nextTokenstringPagination token for the next page, or null when there are no more results
volumesarrayEBS volumes
↳ tagsjsonResource tags as key/value pairs
↳ volumeIdstringVolume ID
↳ volumeTypestringVolume type (gp2, gp3, io1, io2, st1, sc1, standard)
↳ sizenumberSize in GiB
↳ statestringState (creating, available, in-use, deleting, deleted, error)
↳ availabilityZonestringAvailability Zone
↳ iopsnumberProvisioned IOPS
↳ throughputnumberThroughput in MiB/s (gp3)
↳ encryptedbooleanWhether the volume is encrypted
↳ kmsKeyIdstringKMS key ARN used for encryption
↳ snapshotIdstringSnapshot the volume was created from
↳ createTimestringCreation time (ISO 8601)
↳ multiAttachEnabledbooleanWhether Multi-Attach is enabled
↳ attachmentsarrayInstance attachments
↳ instanceIdstringAttached instance ID
↳ devicestringDevice name (e.g., /dev/xvda)
↳ statestringAttachment state
↳ attachTimestringAttach time (ISO 8601)
↳ deleteOnTerminationbooleanWhether the volume is deleted when the instance terminates

EC2 Describe Snapshots

List EBS snapshots owned by the account (or by the owners you specify)

Inputs and outputs

Input

ParameterTypeRequiredDescription
awsRegionstringYesAWS region (e.g., us-east-1)
awsAccessKeyIdstringYesAWS access key ID
awsSecretAccessKeystringYesAWS secret access key
snapshotIdsstringNoComma-separated snapshot IDs (e.g., snap-0abc123)
ownerIdsstringNoComma-separated owners: AWS account IDs, self, or amazon (defaults to self)
filtersjsonNoEC2 filters as a JSON array, e.g. [{"Name":"volume-id","Values":["vol-0abc123"]}]
maxResultsnumberNoMaximum results per page when no IDs are given (5-1000, default 100)
nextTokenstringNoPagination token from a previous response

Output

ParameterTypeDescription
nextTokenstringPagination token for the next page, or null when there are no more results
snapshotsarrayEBS snapshots
↳ tagsjsonResource tags as key/value pairs
↳ snapshotIdstringSnapshot ID
↳ volumeIdstringSource volume ID
↳ volumeSizenumberSource volume size in GiB
↳ statestringState (pending, completed, error, recoverable, recovering)
↳ progressstringCompletion progress (e.g., 100%)
↳ startTimestringStart time (ISO 8601)
↳ descriptionstringDescription
↳ ownerIdstringOwning AWS account ID
↳ encryptedbooleanWhether the snapshot is encrypted
↳ kmsKeyIdstringKMS key ARN used for encryption
↳ storageTierstringStorage tier (standard or archive)

EC2 Create Snapshot

Create a point-in-time snapshot of an EBS volume

Inputs and outputs

Input

ParameterTypeRequiredDescription
awsRegionstringYesAWS region (e.g., us-east-1)
awsAccessKeyIdstringYesAWS access key ID
awsSecretAccessKeystringYesAWS secret access key
volumeIdstringYesID of the EBS volume to snapshot (e.g., vol-0abc123)
descriptionstringNoDescription for the snapshot
tagsjsonNoTags to apply as a JSON object, e.g. {"Name":"nightly-backup"}

Output

ParameterTypeDescription
tagsjsonResource tags as key/value pairs
snapshotIdstringID of the new snapshot
volumeIdstringSource volume ID
volumeSizenumberSource volume size in GiB
statestringSnapshot state (pending until complete)
startTimestringStart time (ISO 8601)
descriptionstringDescription
encryptedbooleanWhether the snapshot is encrypted
ownerIdstringOwning AWS account ID

EC2 Create Tags

Add or overwrite tags on one or more EC2 resources

Inputs and outputs

Input

ParameterTypeRequiredDescription
awsRegionstringYesAWS region (e.g., us-east-1)
awsAccessKeyIdstringYesAWS access key ID
awsSecretAccessKeystringYesAWS secret access key
resourceIdsstringYesComma-separated resource IDs to tag (e.g., i-0abc123,vol-0def456)
tagsjsonYesTags as a JSON object, e.g. {"Environment":"prod","Owner":"platform"}

Output

ParameterTypeDescription
tagsjsonResource tags as key/value pairs
resourceIdsarrayResource IDs that were tagged

EC2 Delete Tags

Remove tags from one or more EC2 resources

Inputs and outputs

Input

ParameterTypeRequiredDescription
awsRegionstringYesAWS region (e.g., us-east-1)
awsAccessKeyIdstringYesAWS access key ID
awsSecretAccessKeystringYesAWS secret access key
resourceIdsstringYesComma-separated resource IDs to untag
tagKeysstringYesComma-separated tag keys to remove

Output

ParameterTypeDescription
resourceIdsarrayResource IDs that were untagged
tagKeysarrayTag keys that were removed

EC2 Describe Regions

List AWS Regions available to the account

Inputs and outputs

Input

ParameterTypeRequiredDescription
awsRegionstringYesAWS region (e.g., us-east-1)
awsAccessKeyIdstringYesAWS access key ID
awsSecretAccessKeystringYesAWS secret access key
regionNamesstringNoComma-separated region names to describe
allRegionsbooleanNoInclude Regions that are not enabled for the account
filtersjsonNoEC2 filters as a JSON array, e.g. [{"Name":"opt-in-status","Values":["opted-in"]}]

Output

ParameterTypeDescription
regionsarrayAWS Regions
↳ regionNamestringRegion name (e.g., us-east-1)
↳ endpointstringEC2 endpoint for the Region
↳ optInStatusstringOpt-in status (opt-in-not-required, opted-in, not-opted-in)

EC2 Describe Availability Zones

List Availability Zones, Local Zones, and Wavelength Zones in the region

Inputs and outputs

Input

ParameterTypeRequiredDescription
awsRegionstringYesAWS region (e.g., us-east-1)
awsAccessKeyIdstringYesAWS access key ID
awsSecretAccessKeystringYesAWS secret access key
zoneNamesstringNoComma-separated zone names (e.g., us-east-1a)
allAvailabilityZonesbooleanNoInclude zones that are not opted in
filtersjsonNoEC2 filters as a JSON array, e.g. [{"Name":"state","Values":["available"]}]

Output

ParameterTypeDescription
availabilityZonesarrayZones
↳ zoneNamestringZone name (e.g., us-east-1a)
↳ zoneIdstringZone ID (e.g., use1-az1)
↳ zoneTypestringZone type (availability-zone, local-zone, wavelength-zone)
↳ statestringZone state
↳ regionNamestringRegion name
↳ groupNamestringZone group name
↳ networkBorderGroupstringNetwork border group
↳ optInStatusstringOpt-in status

EC2 Authorize Security Group Ingress

Add an inbound rule to a security group

Inputs and outputs

Input

ParameterTypeRequiredDescription
awsRegionstringYesAWS region (e.g., us-east-1)
awsAccessKeyIdstringYesAWS access key ID
awsSecretAccessKeystringYesAWS secret access key
groupIdstringYesSecurity group ID (e.g., sg-0abc123)
ipProtocolstringYesIP protocol: tcp, udp, icmp, icmpv6, or -1 for all traffic
fromPortnumberNoStart of the port range (ICMP type for icmp; omit for -1)
toPortnumberNoEnd of the port range (ICMP code for icmp; omit for -1)
cidrIpstringNoIPv4 CIDR source (e.g., 203.0.113.0/24). Provide exactly one source
cidrIpv6stringNoIPv6 CIDR source (e.g., 2001:db8::/32). Provide exactly one source
sourceGroupIdstringNoSource security group ID. Provide exactly one source
descriptionstringNoDescription for the rule

Output

ParameterTypeDescription
authorizedbooleanWhether the rule was added
securityGroupRulesarrayRules that were added
↳ securityGroupRuleIdstringSecurity group rule ID
↳ groupIdstringSecurity group ID
↳ ipProtocolstringIP protocol
↳ fromPortnumberStart of the port range
↳ toPortnumberEnd of the port range
↳ cidrIpv4stringIPv4 CIDR source
↳ cidrIpv6stringIPv6 CIDR source
↳ referencedGroupIdstringSource security group ID
↳ descriptionstringRule description

EC2 Revoke Security Group Ingress

Remove inbound rules from a security group by rule ID or by matching protocol, ports, and source

Inputs and outputs

Input

ParameterTypeRequiredDescription
awsRegionstringYesAWS region (e.g., us-east-1)
awsAccessKeyIdstringYesAWS access key ID
awsSecretAccessKeystringYesAWS secret access key
groupIdstringYesSecurity group ID (e.g., sg-0abc123)
ipProtocolstringNoIP protocol: tcp, udp, icmp, icmpv6, or -1 for all traffic
fromPortnumberNoStart of the port range (ICMP type for icmp; omit for -1)
toPortnumberNoEnd of the port range (ICMP code for icmp; omit for -1)
cidrIpstringNoIPv4 CIDR source (e.g., 203.0.113.0/24). Provide exactly one source
cidrIpv6stringNoIPv6 CIDR source (e.g., 2001:db8::/32). Provide exactly one source
sourceGroupIdstringNoSource security group ID. Provide exactly one source
securityGroupRuleIdsstringNoComma-separated security group rule IDs (e.g., sgr-0abc123). Use instead of protocol, ports, and source

Output

ParameterTypeDescription
revokedbooleanWhether the request succeeded
revokedRulesarrayRules that were removed
↳ securityGroupRuleIdstringSecurity group rule ID
↳ ipProtocolstringIP protocol
↳ fromPortnumberStart of the port range
↳ toPortnumberEnd of the port range
↳ cidrIpv4stringIPv4 CIDR source
↳ cidrIpv6stringIPv6 CIDR source
↳ referencedGroupIdstringSource security group ID
↳ descriptionstringRule description
unmatchedRuleCountnumberNumber of requested rules that did not match an existing rule

EC2 Describe Network ACLs

List network ACLs with their inbound and outbound rules and subnet associations

Inputs and outputs

Input

ParameterTypeRequiredDescription
awsRegionstringYesAWS region (e.g., us-east-1)
awsAccessKeyIdstringYesAWS access key ID
awsSecretAccessKeystringYesAWS secret access key
networkAclIdsstringNoComma-separated network ACL IDs (e.g., acl-0abc123)
filtersjsonNoEC2 filters as a JSON array, e.g. [{"Name":"vpc-id","Values":["vpc-0abc123"]}]
maxResultsnumberNoMaximum results per page when no IDs are given (5-1000, default 100)
nextTokenstringNoPagination token from a previous response

Output

ParameterTypeDescription
nextTokenstringPagination token for the next page, or null when there are no more results
networkAclsarrayNetwork ACLs
↳ tagsjsonResource tags as key/value pairs
↳ networkAclIdstringNetwork ACL ID
↳ vpcIdstringVPC ID
↳ isDefaultbooleanWhether this is the default ACL for the VPC
↳ ownerIdstringOwning AWS account ID
↳ entriesarrayRules, evaluated in ascending rule number
↳ ruleNumbernumberRule number
↳ egressbooleanWhether the rule applies to outbound traffic
↳ ruleActionstringallow or deny
↳ protocolstringProtocol number (-1 for all, 6 for TCP, 17 for UDP)
↳ cidrBlockstringIPv4 CIDR
↳ ipv6CidrBlockstringIPv6 CIDR
↳ fromPortnumberStart of the port range
↳ toPortnumberEnd of the port range
↳ icmpTypenumberICMP type
↳ icmpCodenumberICMP code
↳ associationsarraySubnet associations
↳ associationIdstringAssociation ID
↳ subnetIdstringSubnet ID

EC2 Describe VPC Endpoints

List VPC endpoints with their service, type, state, and network placement

Inputs and outputs

Input

ParameterTypeRequiredDescription
awsRegionstringYesAWS region (e.g., us-east-1)
awsAccessKeyIdstringYesAWS access key ID
awsSecretAccessKeystringYesAWS secret access key
vpcEndpointIdsstringNoComma-separated VPC endpoint IDs (e.g., vpce-0abc123)
filtersjsonNoEC2 filters as a JSON array, e.g. [{"Name":"vpc-id","Values":["vpc-0abc123"]}]
maxResultsnumberNoMaximum results per page when no IDs are given (5-1000, default 100)
nextTokenstringNoPagination token from a previous response

Output

ParameterTypeDescription
nextTokenstringPagination token for the next page, or null when there are no more results
vpcEndpointsarrayVPC endpoints
↳ tagsjsonResource tags as key/value pairs
↳ vpcEndpointIdstringVPC endpoint ID
↳ vpcEndpointTypestringEndpoint type (Interface, Gateway, GatewayLoadBalancer, Resource, ServiceNetwork)
↳ vpcIdstringVPC ID
↳ serviceNamestringService name (e.g., com.amazonaws.us-east-1.s3)
↳ statestringEndpoint state
↳ privateDnsEnabledbooleanWhether private DNS is enabled
↳ routeTableIdsarrayAssociated route table IDs (gateway endpoints)
↳ subnetIdsarraySubnet IDs (interface endpoints)
↳ networkInterfaceIdsarrayEndpoint network interface IDs
↳ securityGroupIdsarrayAttached security group IDs
↳ dnsNamesarrayDNS names for the endpoint
↳ creationTimestampstringCreation time (ISO 8601)
↳ ownerIdstringOwning AWS account ID

EC2 Describe VPC Peering Connections

List VPC peering connections with their status and both VPCs

Inputs and outputs

Input

ParameterTypeRequiredDescription
awsRegionstringYesAWS region (e.g., us-east-1)
awsAccessKeyIdstringYesAWS access key ID
awsSecretAccessKeystringYesAWS secret access key
vpcPeeringConnectionIdsstringNoComma-separated VPC peering connection IDs (e.g., pcx-0abc123)
filtersjsonNoEC2 filters as a JSON array, e.g. [{"Name":"status-code","Values":["active"]}]
maxResultsnumberNoMaximum results per page when no IDs are given (5-1000, default 100)
nextTokenstringNoPagination token from a previous response

Output

ParameterTypeDescription
nextTokenstringPagination token for the next page, or null when there are no more results
vpcPeeringConnectionsarrayVPC peering connections
↳ tagsjsonResource tags as key/value pairs
↳ vpcPeeringConnectionIdstringVPC peering connection ID
↳ statusstringStatus code (e.g., pending-acceptance, active, rejected, deleted)
↳ statusMessagestringStatus message
↳ requesterVpcobjectRequester VPC
↳ vpcIdstringVPC ID
↳ ownerIdstringOwning AWS account ID
↳ regionstringRegion
↳ cidrBlockstringIPv4 CIDR block
↳ accepterVpcobjectAccepter VPC
↳ vpcIdstringVPC ID
↳ ownerIdstringOwning AWS account ID
↳ regionstringRegion
↳ cidrBlockstringIPv4 CIDR block
↳ expirationTimestringTime an unaccepted request expires (ISO 8601)

EC2 Delete Volume

Permanently delete an EBS volume that is not attached to an instance

Inputs and outputs

Input

ParameterTypeRequiredDescription
awsRegionstringYesAWS region (e.g., us-east-1)
awsAccessKeyIdstringYesAWS access key ID
awsSecretAccessKeystringYesAWS secret access key
volumeIdstringYesID of the EBS volume to delete (e.g., vol-0abc123)

Output

ParameterTypeDescription
deletedbooleanWhether the volume deletion was accepted
volumeIdstringVolume ID that was deleted

EC2 Delete Snapshot

Permanently delete an EBS snapshot

Inputs and outputs

Input

ParameterTypeRequiredDescription
awsRegionstringYesAWS region (e.g., us-east-1)
awsAccessKeyIdstringYesAWS access key ID
awsSecretAccessKeystringYesAWS secret access key
snapshotIdstringYesID of the EBS snapshot to delete (e.g., snap-0abc123)

Output

ParameterTypeDescription
deletedbooleanWhether the snapshot was deleted
snapshotIdstringSnapshot ID that was deleted

EC2 Describe Images

List AMIs owned by the account (or by the owners you specify)

Inputs and outputs

Input

ParameterTypeRequiredDescription
awsRegionstringYesAWS region (e.g., us-east-1)
awsAccessKeyIdstringYesAWS access key ID
awsSecretAccessKeystringYesAWS secret access key
imageIdsstringNoComma-separated AMI IDs (e.g., ami-0abc123)
ownersstringNoComma-separated owners: AWS account IDs, self, amazon, or aws-marketplace (defaults to self)
filtersjsonNoEC2 filters as a JSON array, e.g. [{"Name":"name","Values":["my-app-*"]}]
maxResultsnumberNoMaximum results per page when no IDs are given (5-1000, default 100)
nextTokenstringNoPagination token from a previous response

Output

ParameterTypeDescription
nextTokenstringPagination token for the next page, or null when there are no more results
imagesarrayAMIs
↳ tagsjsonResource tags as key/value pairs
↳ imageIdstringAMI ID
↳ namestringAMI name
↳ descriptionstringDescription
↳ statestringState (pending, available, invalid, deregistered, transient, failed, error, disabled)
↳ ownerIdstringOwning AWS account ID
↳ ownerAliasstringOwner alias (e.g., amazon)
↳ publicbooleanWhether the AMI is public
↳ architecturestringCPU architecture
↳ platformDetailsstringPlatform details (e.g., Linux/UNIX)
↳ rootDeviceTypestringRoot device type (ebs or instance-store)
↳ virtualizationTypestringVirtualization type (hvm or paravirtual)
↳ creationDatestringCreation date (ISO 8601)
↳ deprecationTimestringDeprecation time (ISO 8601)
↳ lastLaunchedTimestringLast time an instance was launched from the AMI (ISO 8601)

EC2 Describe Key Pairs

List EC2 key pairs with their type, fingerprint, and creation time

Inputs and outputs

Input

ParameterTypeRequiredDescription
awsRegionstringYesAWS region (e.g., us-east-1)
awsAccessKeyIdstringYesAWS access key ID
awsSecretAccessKeystringYesAWS secret access key
keyNamesstringNoComma-separated key pair names
keyPairIdsstringNoComma-separated key pair IDs (e.g., key-0abc123)
filtersjsonNoEC2 filters as a JSON array, e.g. [{"Name":"key-name","Values":["deploy-*"]}]

Output

ParameterTypeDescription
keyPairsarrayKey pairs
↳ tagsjsonResource tags as key/value pairs
↳ keyPairIdstringKey pair ID
↳ keyNamestringKey pair name
↳ keyTypestringKey type (rsa or ed25519)
↳ keyFingerprintstringKey fingerprint
↳ createTimestringCreation time (ISO 8601)