Copyright | (c) 2013-2017 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Requests a description of a set of instances.
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 on user permissions, see Managing User Permissions .
- describeInstances :: DescribeInstances
- data DescribeInstances
- diInstanceIds :: Lens' DescribeInstances [Text]
- diStackId :: Lens' DescribeInstances (Maybe Text)
- diLayerId :: Lens' DescribeInstances (Maybe Text)
- describeInstancesResponse :: Int -> DescribeInstancesResponse
- data DescribeInstancesResponse
- dirsInstances :: Lens' DescribeInstancesResponse [Instance]
- dirsResponseStatus :: Lens' DescribeInstancesResponse Int
Creating a Request
describeInstances :: DescribeInstances Source #
Creates a value of DescribeInstances
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
diInstanceIds
- An array of instance IDs to be described. If you use this parameter,DescribeInstances
returns a description of the specified instances. Otherwise, it returns a description of every instance.diStackId
- A stack ID. If you use this parameter,DescribeInstances
returns descriptions of the instances associated with the specified stack.diLayerId
- A layer ID. If you use this parameter,DescribeInstances
returns descriptions of the instances associated with the specified layer.
data DescribeInstances Source #
See: describeInstances
smart constructor.
Request Lenses
diInstanceIds :: Lens' DescribeInstances [Text] Source #
An array of instance IDs to be described. If you use this parameter, DescribeInstances
returns a description of the specified instances. Otherwise, it returns a description of every instance.
diStackId :: Lens' DescribeInstances (Maybe Text) Source #
A stack ID. If you use this parameter, DescribeInstances
returns descriptions of the instances associated with the specified stack.
diLayerId :: Lens' DescribeInstances (Maybe Text) Source #
A layer ID. If you use this parameter, DescribeInstances
returns descriptions of the instances associated with the specified layer.
Destructuring the Response
describeInstancesResponse Source #
Creates a value of DescribeInstancesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dirsInstances
- An array ofInstance
objects that describe the instances.dirsResponseStatus
- -- | The response status code.
data DescribeInstancesResponse Source #
Contains the response to a DescribeInstances
request.
See: describeInstancesResponse
smart constructor.
Response Lenses
dirsInstances :: Lens' DescribeInstancesResponse [Instance] Source #
An array of Instance
objects that describe the instances.
dirsResponseStatus :: Lens' DescribeInstancesResponse Int Source #
- - | The response status code.