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.ListInventoryEntries

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

A list of inventory items returned by the request.

Synopsis

data ListInventoryEntries = ListInventoryEntries' {
- filters :: Maybe (NonEmpty InventoryFilter)
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- instanceId :: Text
- typeName :: Text
}
newListInventoryEntries :: Text -> Text -> ListInventoryEntries
listInventoryEntries_filters :: Lens' ListInventoryEntries (Maybe (NonEmpty InventoryFilter))
listInventoryEntries_maxResults :: Lens' ListInventoryEntries (Maybe Natural)
listInventoryEntries_nextToken :: Lens' ListInventoryEntries (Maybe Text)
listInventoryEntries_instanceId :: Lens' ListInventoryEntries Text
listInventoryEntries_typeName :: Lens' ListInventoryEntries Text
data ListInventoryEntriesResponse = ListInventoryEntriesResponse' {
- captureTime :: Maybe Text
- entries :: Maybe [HashMap Text Text]
- instanceId :: Maybe Text
- nextToken :: Maybe Text
- schemaVersion :: Maybe Text
- typeName :: Maybe Text
- httpStatus :: Int
}
newListInventoryEntriesResponse :: Int -> ListInventoryEntriesResponse
listInventoryEntriesResponse_captureTime :: Lens' ListInventoryEntriesResponse (Maybe Text)
listInventoryEntriesResponse_entries :: Lens' ListInventoryEntriesResponse (Maybe [HashMap Text Text])
listInventoryEntriesResponse_instanceId :: Lens' ListInventoryEntriesResponse (Maybe Text)
listInventoryEntriesResponse_nextToken :: Lens' ListInventoryEntriesResponse (Maybe Text)
listInventoryEntriesResponse_schemaVersion :: Lens' ListInventoryEntriesResponse (Maybe Text)
listInventoryEntriesResponse_typeName :: Lens' ListInventoryEntriesResponse (Maybe Text)
listInventoryEntriesResponse_httpStatus :: Lens' ListInventoryEntriesResponse Int

Creating a Request

data ListInventoryEntries Source #

See: newListInventoryEntries smart constructor.

Constructors

ListInventoryEntries'

Fields

filters :: Maybe (NonEmpty InventoryFilter)
One or more filters. Use a filter to return a more specific list of results.
maxResults :: Maybe Natural
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.
nextToken :: Maybe Text
The token for the next set of items to return. (You received this token from a previous call.)
instanceId :: Text
The managed node ID for which you want inventory information.
typeName :: Text
The type of inventory item for which you want information.

Instances

Instances details

ToJSON ListInventoryEntries Source #
Instance details Defined in Amazonka.SSM.ListInventoryEntries Methods toJSON :: ListInventoryEntries -> Value # toEncoding :: ListInventoryEntries -> Encoding # toJSONList :: [ListInventoryEntries] -> Value # toEncodingList :: [ListInventoryEntries] -> Encoding #
ToHeaders ListInventoryEntries Source #
Instance details Defined in Amazonka.SSM.ListInventoryEntries Methods toHeaders :: ListInventoryEntries -> [Header] #
ToPath ListInventoryEntries Source #
Instance details Defined in Amazonka.SSM.ListInventoryEntries Methods toPath :: ListInventoryEntries -> ByteString #
ToQuery ListInventoryEntries Source #
Instance details Defined in Amazonka.SSM.ListInventoryEntries Methods toQuery :: ListInventoryEntries -> QueryString #
AWSRequest ListInventoryEntries Source #
Instance details Defined in Amazonka.SSM.ListInventoryEntries Associated Types type AWSResponse ListInventoryEntries # Methods request :: (Service -> Service) -> ListInventoryEntries -> Request ListInventoryEntries # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListInventoryEntries -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListInventoryEntries))) #
Generic ListInventoryEntries Source #
Instance details Defined in Amazonka.SSM.ListInventoryEntries Associated Types type Rep ListInventoryEntries :: Type -> Type # Methods from :: ListInventoryEntries -> Rep ListInventoryEntries x # to :: Rep ListInventoryEntries x -> ListInventoryEntries #
Read ListInventoryEntries Source #
Instance details Defined in Amazonka.SSM.ListInventoryEntries Methods readsPrec :: Int -> ReadS ListInventoryEntries # readList :: ReadS [ListInventoryEntries] # readPrec :: ReadPrec ListInventoryEntries # readListPrec :: ReadPrec [ListInventoryEntries] #
Show ListInventoryEntries Source #
Instance details Defined in Amazonka.SSM.ListInventoryEntries Methods showsPrec :: Int -> ListInventoryEntries -> ShowS # show :: ListInventoryEntries -> String # showList :: [ListInventoryEntries] -> ShowS #
NFData ListInventoryEntries Source #
Instance details Defined in Amazonka.SSM.ListInventoryEntries Methods rnf :: ListInventoryEntries -> () #
Eq ListInventoryEntries Source #
Instance details Defined in Amazonka.SSM.ListInventoryEntries Methods (==) :: ListInventoryEntries -> ListInventoryEntries -> Bool # (/=) :: ListInventoryEntries -> ListInventoryEntries -> Bool #
Hashable ListInventoryEntries Source #
Instance details Defined in Amazonka.SSM.ListInventoryEntries Methods hashWithSalt :: Int -> ListInventoryEntries -> Int # hash :: ListInventoryEntries -> Int #
type AWSResponse ListInventoryEntries Source #
Instance details Defined in Amazonka.SSM.ListInventoryEntries type AWSResponse ListInventoryEntries = ListInventoryEntriesResponse
type Rep ListInventoryEntries Source #
Instance details Defined in Amazonka.SSM.ListInventoryEntries type Rep ListInventoryEntries = D1 ('MetaData "ListInventoryEntries" "Amazonka.SSM.ListInventoryEntries" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "ListInventoryEntries'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty InventoryFilter))) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "typeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListInventoryEntries Source #

Arguments

:: Text	`ListInventoryEntries`
-> Text	`ListInventoryEntries`
-> ListInventoryEntries

Create a value of ListInventoryEntries 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:

ListInventoryEntries, listInventoryEntries_filters - One or more filters. Use a filter to return a more specific list of results.

$sel:maxResults:ListInventoryEntries', listInventoryEntries_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.

ListInventoryEntries, listInventoryEntries_nextToken - The token for the next set of items to return. (You received this token from a previous call.)

ListInventoryEntries, listInventoryEntries_instanceId - The managed node ID for which you want inventory information.

ListInventoryEntries, listInventoryEntries_typeName - The type of inventory item for which you want information.

Request Lenses

listInventoryEntries_filters :: Lens' ListInventoryEntries (Maybe (NonEmpty InventoryFilter)) Source #

One or more filters. Use a filter to return a more specific list of results.

listInventoryEntries_maxResults :: Lens' ListInventoryEntries (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.

listInventoryEntries_nextToken :: Lens' ListInventoryEntries (Maybe Text) Source #

The token for the next set of items to return. (You received this token from a previous call.)

listInventoryEntries_instanceId :: Lens' ListInventoryEntries Text Source #

The managed node ID for which you want inventory information.

listInventoryEntries_typeName :: Lens' ListInventoryEntries Text Source #

The type of inventory item for which you want information.

Destructuring the Response

data ListInventoryEntriesResponse Source #

See: newListInventoryEntriesResponse smart constructor.

Constructors

ListInventoryEntriesResponse'

Fields

captureTime :: Maybe Text
The time that inventory information was collected for the managed node(s).
entries :: Maybe [HashMap Text Text]
A list of inventory items on the managed node(s).
instanceId :: Maybe Text
The managed node ID targeted by the request to query inventory information.
nextToken :: Maybe Text
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
schemaVersion :: Maybe Text
The inventory schema version used by the managed node(s).
typeName :: Maybe Text
The type of inventory item returned by the request.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ListInventoryEntriesResponse Source #
Instance details Defined in Amazonka.SSM.ListInventoryEntries Associated Types type Rep ListInventoryEntriesResponse :: Type -> Type # Methods from :: ListInventoryEntriesResponse -> Rep ListInventoryEntriesResponse x # to :: Rep ListInventoryEntriesResponse x -> ListInventoryEntriesResponse #
Read ListInventoryEntriesResponse Source #
Instance details Defined in Amazonka.SSM.ListInventoryEntries Methods readsPrec :: Int -> ReadS ListInventoryEntriesResponse # readList :: ReadS [ListInventoryEntriesResponse] # readPrec :: ReadPrec ListInventoryEntriesResponse # readListPrec :: ReadPrec [ListInventoryEntriesResponse] #
Show ListInventoryEntriesResponse Source #
Instance details Defined in Amazonka.SSM.ListInventoryEntries Methods showsPrec :: Int -> ListInventoryEntriesResponse -> ShowS # show :: ListInventoryEntriesResponse -> String # showList :: [ListInventoryEntriesResponse] -> ShowS #
NFData ListInventoryEntriesResponse Source #
Instance details Defined in Amazonka.SSM.ListInventoryEntries Methods rnf :: ListInventoryEntriesResponse -> () #
Eq ListInventoryEntriesResponse Source #
Instance details Defined in Amazonka.SSM.ListInventoryEntries Methods (==) :: ListInventoryEntriesResponse -> ListInventoryEntriesResponse -> Bool # (/=) :: ListInventoryEntriesResponse -> ListInventoryEntriesResponse -> Bool #
type Rep ListInventoryEntriesResponse Source #
Instance details Defined in Amazonka.SSM.ListInventoryEntries type Rep ListInventoryEntriesResponse = D1 ('MetaData "ListInventoryEntriesResponse" "Amazonka.SSM.ListInventoryEntries" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "ListInventoryEntriesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "captureTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "entries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [HashMap Text Text])) :: S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "schemaVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "typeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newListInventoryEntriesResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListInventoryEntriesResponse'`
-> ListInventoryEntriesResponse

Create a value of ListInventoryEntriesResponse 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:

ListInventoryEntriesResponse, listInventoryEntriesResponse_captureTime - The time that inventory information was collected for the managed node(s).

$sel:entries:ListInventoryEntriesResponse', listInventoryEntriesResponse_entries - A list of inventory items on the managed node(s).

ListInventoryEntries, listInventoryEntriesResponse_instanceId - The managed node ID targeted by the request to query inventory information.

ListInventoryEntries, listInventoryEntriesResponse_nextToken - The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

ListInventoryEntriesResponse, listInventoryEntriesResponse_schemaVersion - The inventory schema version used by the managed node(s).

ListInventoryEntries, listInventoryEntriesResponse_typeName - The type of inventory item returned by the request.

$sel:httpStatus:ListInventoryEntriesResponse', listInventoryEntriesResponse_httpStatus - The response's http status code.