IntegrationsAwsActions
Describe EC2 instances
Describe EC2 instances by explicit IDs or reviewed filters. Instance IDs cannot be combined with filters or pagination. Requires ec2:DescribeInstances.
ec2.instances.describe · AWS · v1
Details
Scopes
ec2:DescribeInstances
Input
| Name | Type | Required | Constraints |
|---|---|---|---|
(root) | object | Yes | additionalProperties false |
region | string | No | enum us-east-1 | us-east-2 | us-west-1 | us-west-2 | af-south-1 | ap-east-1 | ap-east-2 | ap-south-1 | ap-south-2 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ap-southeast-4 | ap-southeast-5 | ap-southeast-6 | ap-southeast-7 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | ca-central-1 | ca-west-1 | eu-central-1 | eu-central-2 | eu-west-1 | eu-west-2 | eu-west-3 | eu-north-1 | eu-south-1 | eu-south-2 | il-central-1 | me-central-1 | me-south-1 | mx-central-1 | sa-east-1 |
instance_ids | array<string> | No | minItems 1; maxItems 100 |
instance_ids[] | string | Yes | minLength 10; maxLength 32; pattern ^i-[0-9a-fA-F]{8,17}$ |
filters | array<object> | No | minItems 1; maxItems 10 |
filters[] | object | Yes | additionalProperties false |
filters[].name | string | Yes | enum instance-state-name | tag-key | tag-value | vpc-id | subnet-id | availability-zone | architecture | instance-type | private-ip-address | ip-address |
filters[].values | array<string> | Yes | minItems 1; maxItems 20 |
filters[].values[] | string | Yes | minLength 1; maxLength 256 |
page_size | integer | No | minimum 5; maximum 1000 |
cursor | string | No | minLength 1; maxLength 16384; pattern ^(?!.*://)[^\x00-\x1f\x7f]+$ |
Output
| Name | Type | Required | Constraints |
|---|---|---|---|
(root) | object | Yes | additionalProperties false |
instances | array<object> | Yes | maxItems 1000 |
instances[] | object | Yes | additionalProperties false |
instances[].instance_id | string | Yes | minLength 10; maxLength 32; pattern ^i-[0-9a-fA-F]{8,17}$ |
instances[].state | string | Yes | minLength 1; maxLength 64 |
instances[].instance_type | string | No | minLength 1; maxLength 64 |
instances[].image_id | string | No | minLength 1; maxLength 128 |
instances[].architecture | string | No | minLength 1; maxLength 64 |
instances[].availability_zone | string | No | minLength 1; maxLength 64 |
instances[].vpc_id | string | No | minLength 1; maxLength 64 |
instances[].subnet_id | string | No | minLength 1; maxLength 64 |
instances[].private_ip_address | string | No | minLength 1; maxLength 64 |
instances[].public_ip_address | string | No | minLength 1; maxLength 64 |
instances[].launch_time | string | No | minLength 1; maxLength 64 |
instances[].tags | array<object> | Yes | maxItems 50 |
instances[].tags[] | object | Yes | additionalProperties false |
instances[].tags[].key | string | Yes | minLength 1; maxLength 128 |
instances[].tags[].value | string | Yes | maxLength 256 |
next_cursor | string | No | minLength 1; maxLength 16384; pattern ^(?!.*://)[^\x00-\x1f\x7f]+$ |
Raw schema
Input
{
"type": "object",
"additionalProperties": false,
"properties": {
"region": {
"type": "string",
"enum": [
"us-east-1",
"us-east-2",
"us-west-1",
"us-west-2",
"af-south-1",
"ap-east-1",
"ap-east-2",
"ap-south-1",
"ap-south-2",
"ap-southeast-1",
"ap-southeast-2",
"ap-southeast-3",
"ap-southeast-4",
"ap-southeast-5",
"ap-southeast-6",
"ap-southeast-7",
"ap-northeast-1",
"ap-northeast-2",
"ap-northeast-3",
"ca-central-1",
"ca-west-1",
"eu-central-1",
"eu-central-2",
"eu-west-1",
"eu-west-2",
"eu-west-3",
"eu-north-1",
"eu-south-1",
"eu-south-2",
"il-central-1",
"me-central-1",
"me-south-1",
"mx-central-1",
"sa-east-1"
]
},
"instance_ids": {
"type": "array",
"items": {
"type": "string",
"minLength": 10,
"maxLength": 32,
"pattern": "^i-[0-9a-fA-F]{8,17}$"
},
"minItems": 1,
"maxItems": 100
},
"filters": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"enum": [
"instance-state-name",
"tag-key",
"tag-value",
"vpc-id",
"subnet-id",
"availability-zone",
"architecture",
"instance-type",
"private-ip-address",
"ip-address"
]
},
"values": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"minItems": 1,
"maxItems": 20
}
},
"required": [
"name",
"values"
]
},
"minItems": 1,
"maxItems": 10
},
"page_size": {
"type": "integer",
"minimum": 5,
"maximum": 1000
},
"cursor": {
"type": "string",
"minLength": 1,
"maxLength": 16384,
"pattern": "^(?!.*://)[^\\x00-\\x1f\\x7f]+$"
}
}
}Output
{
"type": "object",
"additionalProperties": false,
"properties": {
"instances": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"instance_id": {
"type": "string",
"minLength": 10,
"maxLength": 32,
"pattern": "^i-[0-9a-fA-F]{8,17}$"
},
"state": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"instance_type": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"image_id": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"architecture": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"availability_zone": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"vpc_id": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"subnet_id": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"private_ip_address": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"public_ip_address": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"launch_time": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"tags": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"key": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"value": {
"type": "string",
"maxLength": 256
}
},
"required": [
"key",
"value"
]
},
"maxItems": 50
}
},
"required": [
"instance_id",
"state",
"tags"
]
},
"maxItems": 1000
},
"next_cursor": {
"type": "string",
"minLength": 1,
"maxLength": 16384,
"pattern": "^(?!.*://)[^\\x00-\\x1f\\x7f]+$"
}
},
"required": [
"instances"
]
}