| Copyright | (c) 2013-2021 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 |
Amazonka.SSM.GetInventory
Description
Query inventory information. This includes instance status, such as
Stopped or Terminated.
This operation returns paginated results.
Synopsis
- data GetInventory = GetInventory' {}
- newGetInventory :: GetInventory
- getInventory_aggregators :: Lens' GetInventory (Maybe (NonEmpty InventoryAggregator))
- getInventory_filters :: Lens' GetInventory (Maybe (NonEmpty InventoryFilter))
- getInventory_resultAttributes :: Lens' GetInventory (Maybe (NonEmpty ResultAttribute))
- getInventory_nextToken :: Lens' GetInventory (Maybe Text)
- getInventory_maxResults :: Lens' GetInventory (Maybe Natural)
- data GetInventoryResponse = GetInventoryResponse' {}
- newGetInventoryResponse :: Int -> GetInventoryResponse
- getInventoryResponse_entities :: Lens' GetInventoryResponse (Maybe [InventoryResultEntity])
- getInventoryResponse_nextToken :: Lens' GetInventoryResponse (Maybe Text)
- getInventoryResponse_httpStatus :: Lens' GetInventoryResponse Int
Creating a Request
data GetInventory Source #
See: newGetInventory smart constructor.
Constructors
| GetInventory' | |
Fields
| |
Instances
newGetInventory :: GetInventory Source #
Create a value of GetInventory 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:aggregators:GetInventory', getInventory_aggregators - Returns counts of inventory types based on one or more expressions. For
example, if you aggregate by using an expression that uses the
AWS:InstanceInformation.PlatformType type, you can see a count of how
many Windows and Linux instances exist in your inventoried fleet.
$sel:filters:GetInventory', getInventory_filters - One or more filters. Use a filter to return a more specific list of
results.
$sel:resultAttributes:GetInventory', getInventory_resultAttributes - The list of inventory item types to return.
$sel:nextToken:GetInventory', getInventory_nextToken - The token for the next set of items to return. (You received this token
from a previous call.)
$sel:maxResults:GetInventory', getInventory_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.
Request Lenses
getInventory_aggregators :: Lens' GetInventory (Maybe (NonEmpty InventoryAggregator)) Source #
Returns counts of inventory types based on one or more expressions. For
example, if you aggregate by using an expression that uses the
AWS:InstanceInformation.PlatformType type, you can see a count of how
many Windows and Linux instances exist in your inventoried fleet.
getInventory_filters :: Lens' GetInventory (Maybe (NonEmpty InventoryFilter)) Source #
One or more filters. Use a filter to return a more specific list of results.
getInventory_resultAttributes :: Lens' GetInventory (Maybe (NonEmpty ResultAttribute)) Source #
The list of inventory item types to return.
getInventory_nextToken :: Lens' GetInventory (Maybe Text) Source #
The token for the next set of items to return. (You received this token from a previous call.)
getInventory_maxResults :: Lens' GetInventory (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.
Destructuring the Response
data GetInventoryResponse Source #
See: newGetInventoryResponse smart constructor.
Constructors
| GetInventoryResponse' | |
Fields
| |
Instances
newGetInventoryResponse Source #
Arguments
| :: Int | |
| -> GetInventoryResponse |
Create a value of GetInventoryResponse 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:entities:GetInventoryResponse', getInventoryResponse_entities - Collection of inventory entities such as a collection of instance
inventory.
$sel:nextToken:GetInventory', getInventoryResponse_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:GetInventoryResponse', getInventoryResponse_httpStatus - The response's http status code.
Response Lenses
getInventoryResponse_entities :: Lens' GetInventoryResponse (Maybe [InventoryResultEntity]) Source #
Collection of inventory entities such as a collection of instance inventory.
getInventoryResponse_nextToken :: Lens' GetInventoryResponse (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.
getInventoryResponse_httpStatus :: Lens' GetInventoryResponse Int Source #
The response's http status code.