v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1474216311.3 KB

Requests a description of a set of instances.

This call accepts only one resource-identifying parameter.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

post/#X-Amz-Target=OpsWorks_20130218.DescribeInstances

Headers

X-Amz-Target'OpsWorks_20130218.DescribeInstances' required

Request body

StackIdstring

A stack ID. If you use this parameter, <code>DescribeInstances</code> returns descriptions of the instances associated with the specified stack.

LayerIdstring

A layer ID. If you use this parameter, <code>DescribeInstances</code> returns descriptions of the instances associated with the specified layer.

InstanceIdsString[]

An array of instance IDs to be described. If you use this parameter, <code>DescribeInstances</code> returns a description of the specified instances. Otherwise, it returns a description of every instance.

Response

Success