| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.SSM.DescribeInstanceInformation
Description
Describes one or more of your managed nodes, including information about the operating system platform, the version of SSM Agent installed on the managed node, node status, and so on.
If you specify one or more managed node IDs, it returns information for those managed nodes. If you don't specify node IDs, it returns information for all your managed nodes. If you specify a node ID that isn't valid or a node that you don't own, you receive an error.
The IamRole field for this API operation is the Identity and Access
Management (IAM) role assigned to on-premises managed nodes. This call
doesn't return the IAM role for EC2 instances.
This operation returns paginated results.
Synopsis
- data DescribeInstanceInformation = DescribeInstanceInformation' {}
- newDescribeInstanceInformation :: DescribeInstanceInformation
- describeInstanceInformation_filters :: Lens' DescribeInstanceInformation (Maybe [InstanceInformationStringFilter])
- describeInstanceInformation_instanceInformationFilterList :: Lens' DescribeInstanceInformation (Maybe [InstanceInformationFilter])
- describeInstanceInformation_maxResults :: Lens' DescribeInstanceInformation (Maybe Natural)
- describeInstanceInformation_nextToken :: Lens' DescribeInstanceInformation (Maybe Text)
- data DescribeInstanceInformationResponse = DescribeInstanceInformationResponse' {}
- newDescribeInstanceInformationResponse :: Int -> DescribeInstanceInformationResponse
- describeInstanceInformationResponse_instanceInformationList :: Lens' DescribeInstanceInformationResponse (Maybe [InstanceInformation])
- describeInstanceInformationResponse_nextToken :: Lens' DescribeInstanceInformationResponse (Maybe Text)
- describeInstanceInformationResponse_httpStatus :: Lens' DescribeInstanceInformationResponse Int
Creating a Request
data DescribeInstanceInformation Source #
See: newDescribeInstanceInformation smart constructor.
Constructors
| DescribeInstanceInformation' | |
Fields
| |
Instances
newDescribeInstanceInformation :: DescribeInstanceInformation Source #
Create a value of DescribeInstanceInformation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeInstanceInformation, describeInstanceInformation_filters - One or more filters. Use a filter to return a more specific list of
managed nodes. You can filter based on tags applied to your managed
nodes. Use this Filters data type instead of
InstanceInformationFilterList, which is deprecated.
$sel:instanceInformationFilterList:DescribeInstanceInformation', describeInstanceInformation_instanceInformationFilterList - This is a legacy method. We recommend that you don't use this method.
Instead, use the Filters data type. Filters enables you to return
node information by filtering based on tags applied to managed nodes.
Attempting to use InstanceInformationFilterList and Filters leads to
an exception error.
$sel:maxResults:DescribeInstanceInformation', describeInstanceInformation_maxResults - The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the
next set of results.
DescribeInstanceInformation, describeInstanceInformation_nextToken - The token for the next set of items to return. (You received this token
from a previous call.)
Request Lenses
describeInstanceInformation_filters :: Lens' DescribeInstanceInformation (Maybe [InstanceInformationStringFilter]) Source #
One or more filters. Use a filter to return a more specific list of
managed nodes. You can filter based on tags applied to your managed
nodes. Use this Filters data type instead of
InstanceInformationFilterList, which is deprecated.
describeInstanceInformation_instanceInformationFilterList :: Lens' DescribeInstanceInformation (Maybe [InstanceInformationFilter]) Source #
This is a legacy method. We recommend that you don't use this method.
Instead, use the Filters data type. Filters enables you to return
node information by filtering based on tags applied to managed nodes.
Attempting to use InstanceInformationFilterList and Filters leads to
an exception error.
describeInstanceInformation_maxResults :: Lens' DescribeInstanceInformation (Maybe Natural) Source #
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
describeInstanceInformation_nextToken :: Lens' DescribeInstanceInformation (Maybe Text) Source #
The token for the next set of items to return. (You received this token from a previous call.)
Destructuring the Response
data DescribeInstanceInformationResponse Source #
See: newDescribeInstanceInformationResponse smart constructor.
Constructors
| DescribeInstanceInformationResponse' | |
Fields
| |
Instances
newDescribeInstanceInformationResponse Source #
Arguments
| :: Int | |
| -> DescribeInstanceInformationResponse |
Create a value of DescribeInstanceInformationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:instanceInformationList:DescribeInstanceInformationResponse', describeInstanceInformationResponse_instanceInformationList - The managed node information list.
DescribeInstanceInformation, describeInstanceInformationResponse_nextToken - The token to use when requesting the next set of items. If there are no
additional items to return, the string is empty.
$sel:httpStatus:DescribeInstanceInformationResponse', describeInstanceInformationResponse_httpStatus - The response's http status code.
Response Lenses
describeInstanceInformationResponse_instanceInformationList :: Lens' DescribeInstanceInformationResponse (Maybe [InstanceInformation]) Source #
The managed node information list.
describeInstanceInformationResponse_nextToken :: Lens' DescribeInstanceInformationResponse (Maybe Text) Source #
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
describeInstanceInformationResponse_httpStatus :: Lens' DescribeInstanceInformationResponse Int Source #
The response's http status code.