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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

This operation returns paginated results.

Synopsis

data GetInventorySchema = GetInventorySchema' {
- typeName :: Maybe Text
- aggregator :: Maybe Bool
- nextToken :: Maybe Text
- subType :: Maybe Bool
- maxResults :: Maybe Natural
}
newGetInventorySchema :: GetInventorySchema
getInventorySchema_typeName :: Lens' GetInventorySchema (Maybe Text)
getInventorySchema_aggregator :: Lens' GetInventorySchema (Maybe Bool)
getInventorySchema_nextToken :: Lens' GetInventorySchema (Maybe Text)
getInventorySchema_subType :: Lens' GetInventorySchema (Maybe Bool)
getInventorySchema_maxResults :: Lens' GetInventorySchema (Maybe Natural)
data GetInventorySchemaResponse = GetInventorySchemaResponse' {
- schemas :: Maybe [InventoryItemSchema]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newGetInventorySchemaResponse :: Int -> GetInventorySchemaResponse
getInventorySchemaResponse_schemas :: Lens' GetInventorySchemaResponse (Maybe [InventoryItemSchema])
getInventorySchemaResponse_nextToken :: Lens' GetInventorySchemaResponse (Maybe Text)
getInventorySchemaResponse_httpStatus :: Lens' GetInventorySchemaResponse Int

Creating a Request

data GetInventorySchema Source #

See: newGetInventorySchema smart constructor.

Constructors

GetInventorySchema'

Fields

typeName :: Maybe Text
The type of inventory item to return.
aggregator :: 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.
nextToken :: Maybe Text
The token for the next set of items to return. (You received this token from a previous call.)
subType :: Maybe Bool
Returns the sub-type schema for a specified inventory type.
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.

Instances

Instances details

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

newGetInventorySchema :: GetInventorySchema Source #

Create a value of GetInventorySchema 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:typeName:GetInventorySchema', getInventorySchema_typeName - The type of inventory item to return.

$sel:aggregator:GetInventorySchema', getInventorySchema_aggregator - 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.

$sel:nextToken:GetInventorySchema', getInventorySchema_nextToken - The token for the next set of items to return. (You received this token from a previous call.)

$sel:subType:GetInventorySchema', getInventorySchema_subType - Returns the sub-type schema for a specified inventory type.

$sel:maxResults:GetInventorySchema', getInventorySchema_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

getInventorySchema_typeName :: Lens' GetInventorySchema (Maybe Text) Source #

The type of inventory item to return.

getInventorySchema_aggregator :: Lens' GetInventorySchema (Maybe Bool) Source #

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.

getInventorySchema_nextToken :: Lens' GetInventorySchema (Maybe Text) Source #

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

getInventorySchema_subType :: Lens' GetInventorySchema (Maybe Bool) Source #

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

getInventorySchema_maxResults :: Lens' GetInventorySchema (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 GetInventorySchemaResponse Source #

See: newGetInventorySchemaResponse smart constructor.

Constructors

GetInventorySchemaResponse'
Fields schemas :: Maybe [InventoryItemSchema] Inventory schemas returned by the request. 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. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq GetInventorySchemaResponse Source #
Instance details Defined in Amazonka.SSM.GetInventorySchema Methods (==) :: GetInventorySchemaResponse -> GetInventorySchemaResponse -> Bool # (/=) :: GetInventorySchemaResponse -> GetInventorySchemaResponse -> Bool #
Read GetInventorySchemaResponse Source #
Instance details Defined in Amazonka.SSM.GetInventorySchema Methods readsPrec :: Int -> ReadS GetInventorySchemaResponse # readList :: ReadS [GetInventorySchemaResponse] # readPrec :: ReadPrec GetInventorySchemaResponse # readListPrec :: ReadPrec [GetInventorySchemaResponse] #
Show GetInventorySchemaResponse Source #
Instance details Defined in Amazonka.SSM.GetInventorySchema Methods showsPrec :: Int -> GetInventorySchemaResponse -> ShowS # show :: GetInventorySchemaResponse -> String # showList :: [GetInventorySchemaResponse] -> ShowS #
Generic GetInventorySchemaResponse Source #
Instance details Defined in Amazonka.SSM.GetInventorySchema Associated Types type Rep GetInventorySchemaResponse :: Type -> Type # Methods from :: GetInventorySchemaResponse -> Rep GetInventorySchemaResponse x # to :: Rep GetInventorySchemaResponse x -> GetInventorySchemaResponse #
NFData GetInventorySchemaResponse Source #
Instance details Defined in Amazonka.SSM.GetInventorySchema Methods rnf :: GetInventorySchemaResponse -> () #
type Rep GetInventorySchemaResponse Source #
Instance details Defined in Amazonka.SSM.GetInventorySchema type Rep GetInventorySchemaResponse = D1 ('MetaData "GetInventorySchemaResponse" "Amazonka.SSM.GetInventorySchema" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "GetInventorySchemaResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "schemas") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InventoryItemSchema])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetInventorySchemaResponse Source #

Arguments

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

Create a value of GetInventorySchemaResponse 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:schemas:GetInventorySchemaResponse', getInventorySchemaResponse_schemas - Inventory schemas returned by the request.

$sel:nextToken:GetInventorySchema', getInventorySchemaResponse_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:GetInventorySchemaResponse', getInventorySchemaResponse_httpStatus - The response's http status code.

Response Lenses

getInventorySchemaResponse_schemas :: Lens' GetInventorySchemaResponse (Maybe [InventoryItemSchema]) Source #

Inventory schemas returned by the request.

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

getInventorySchemaResponse_httpStatus :: Lens' GetInventorySchemaResponse Int Source #

The response's http status code.