Network.AWS.SSM.GetInventorySchema

Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.

Creating a Request

getInventorySchema :: GetInventorySchema

Creates a value of GetInventorySchema with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gisTypeName - The type of inventory item to return.
• gisAggregator - Returns inventory schemas that support aggregation. For example, this call returns the AWS:InstanceInformation type, because it supports aggregation based on the PlatformName , PlatformType , and PlatformVersion attributes.
• gisNextToken - The token for the next set of items to return. (You received this token from a previous call.)
• gisSubType - Returns the sub-type schema for a specified inventory type.
• gisMaxResults - 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.

data GetInventorySchema

See: getInventorySchema smart constructor.

Instances

Eq GetInventorySchema

Methods

(==) :: GetInventorySchema -> GetInventorySchema -> Bool

(/=) :: GetInventorySchema -> GetInventorySchema -> Bool

Data GetInventorySchema

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetInventorySchema -> c GetInventorySchema

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetInventorySchema

toConstr :: GetInventorySchema -> Constr

dataTypeOf :: GetInventorySchema -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetInventorySchema)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetInventorySchema)

gmapT :: (forall b. Data b => b -> b) -> GetInventorySchema -> GetInventorySchema

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetInventorySchema -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetInventorySchema -> r

gmapQ :: (forall d. Data d => d -> u) -> GetInventorySchema -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetInventorySchema -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetInventorySchema -> m GetInventorySchema

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetInventorySchema -> m GetInventorySchema

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetInventorySchema -> m GetInventorySchema

Read GetInventorySchema

Methods

readsPrec :: Int -> ReadS GetInventorySchema

readList :: ReadS [GetInventorySchema]

readPrec :: ReadPrec GetInventorySchema

readListPrec :: ReadPrec [GetInventorySchema]

Show GetInventorySchema

Methods

showsPrec :: Int -> GetInventorySchema -> ShowS

show :: GetInventorySchema -> String

showList :: [GetInventorySchema] -> ShowS

Generic GetInventorySchema

Associated Types

type Rep GetInventorySchema :: * -> *

Methods

from :: GetInventorySchema -> Rep GetInventorySchema x

to :: Rep GetInventorySchema x -> GetInventorySchema

Hashable GetInventorySchema

Methods

hashWithSalt :: Int -> GetInventorySchema -> Int

hash :: GetInventorySchema -> Int

ToJSON GetInventorySchema

Methods

toJSON :: GetInventorySchema -> Value

toEncoding :: GetInventorySchema -> Encoding

toJSONList :: [GetInventorySchema] -> Value

toEncodingList :: [GetInventorySchema] -> Encoding

NFData GetInventorySchema

Methods

rnf :: GetInventorySchema -> ()

AWSRequest GetInventorySchema

Associated Types

type Rs GetInventorySchema :: *

Methods

request :: GetInventorySchema -> Request GetInventorySchema

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * GetInventorySchema -> ClientResponse -> m (Response GetInventorySchema)

ToHeaders GetInventorySchema

Methods

toHeaders :: GetInventorySchema -> [Header]

ToPath GetInventorySchema

Methods

toPath :: GetInventorySchema -> ByteString

ToQuery GetInventorySchema

Methods

toQuery :: GetInventorySchema -> QueryString

type Rep GetInventorySchema

type Rep GetInventorySchema = D1 * (MetaData "GetInventorySchema" "Network.AWS.SSM.GetInventorySchema" "amazonka-ssm-1.6.0-FkXaKF9jjpY64HF15tLQlO" False) (C1 * (MetaCons "GetInventorySchema'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_gisTypeName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gisAggregator") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gisNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gisSubType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_gisMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat)))))))

type Rs GetInventorySchema

type Rs GetInventorySchema = GetInventorySchemaResponse

Request Lenses

gisTypeName :: Lens' GetInventorySchema (Maybe Text)

The type of inventory item to return.

gisAggregator :: Lens' GetInventorySchema (Maybe Bool)

Returns inventory schemas that support aggregation. For example, this call returns the AWS:InstanceInformation type, because it supports aggregation based on the PlatformName , PlatformType , and PlatformVersion attributes.

gisNextToken :: Lens' GetInventorySchema (Maybe Text)

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

gisSubType :: Lens' GetInventorySchema (Maybe Bool)

Returns the sub-type schema for a specified inventory type.

gisMaxResults :: Lens' GetInventorySchema (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.

Destructuring the Response

getInventorySchemaResponse

Arguments

:: Int

gisrsResponseStatus

-> GetInventorySchemaResponse

Creates a value of GetInventorySchemaResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gisrsSchemas - Inventory schemas returned by the request.
• gisrsNextToken - The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
• gisrsResponseStatus - -- | The response status code.

data GetInventorySchemaResponse

See: getInventorySchemaResponse smart constructor.

Instances

Eq GetInventorySchemaResponse

Methods

(==) :: GetInventorySchemaResponse -> GetInventorySchemaResponse -> Bool

(/=) :: GetInventorySchemaResponse -> GetInventorySchemaResponse -> Bool

Data GetInventorySchemaResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetInventorySchemaResponse -> c GetInventorySchemaResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetInventorySchemaResponse

toConstr :: GetInventorySchemaResponse -> Constr

dataTypeOf :: GetInventorySchemaResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetInventorySchemaResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetInventorySchemaResponse)

gmapT :: (forall b. Data b => b -> b) -> GetInventorySchemaResponse -> GetInventorySchemaResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetInventorySchemaResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetInventorySchemaResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> GetInventorySchemaResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetInventorySchemaResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetInventorySchemaResponse -> m GetInventorySchemaResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetInventorySchemaResponse -> m GetInventorySchemaResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetInventorySchemaResponse -> m GetInventorySchemaResponse

Read GetInventorySchemaResponse

Methods

readsPrec :: Int -> ReadS GetInventorySchemaResponse

readList :: ReadS [GetInventorySchemaResponse]

readPrec :: ReadPrec GetInventorySchemaResponse

readListPrec :: ReadPrec [GetInventorySchemaResponse]

Show GetInventorySchemaResponse

Methods

showsPrec :: Int -> GetInventorySchemaResponse -> ShowS

show :: GetInventorySchemaResponse -> String

showList :: [GetInventorySchemaResponse] -> ShowS

Generic GetInventorySchemaResponse

Associated Types

type Rep GetInventorySchemaResponse :: * -> *

Methods

from :: GetInventorySchemaResponse -> Rep GetInventorySchemaResponse x

to :: Rep GetInventorySchemaResponse x -> GetInventorySchemaResponse

NFData GetInventorySchemaResponse

Methods

rnf :: GetInventorySchemaResponse -> ()

type Rep GetInventorySchemaResponse

type Rep GetInventorySchemaResponse = D1 * (MetaData "GetInventorySchemaResponse" "Network.AWS.SSM.GetInventorySchema" "amazonka-ssm-1.6.0-FkXaKF9jjpY64HF15tLQlO" False) (C1 * (MetaCons "GetInventorySchemaResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_gisrsSchemas") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [InventoryItemSchema]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gisrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gisrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

gisrsSchemas :: Lens' GetInventorySchemaResponse [InventoryItemSchema]

Inventory schemas returned by the request.

gisrsNextToken :: Lens' GetInventorySchemaResponse (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.

gisrsResponseStatus :: Lens' GetInventorySchemaResponse Int

• - | The response status code.