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

This operation returns paginated results.

Creating a Request

data GetInventorySchema

See: newGetInventorySchema smart constructor.

Constructors

GetInventorySchema'

Fields

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

• 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.)

• subType :: Maybe Bool

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

• typeName :: Maybe Text

  The type of inventory item to return.

Instances

ToJSON GetInventorySchema

Defined in Amazonka.SSM.GetInventorySchema

Methods

toJSON :: GetInventorySchema -> Value

toEncoding :: GetInventorySchema -> Encoding

toJSONList :: [GetInventorySchema] -> Value

toEncodingList :: [GetInventorySchema] -> Encoding

ToHeaders GetInventorySchema

Defined in Amazonka.SSM.GetInventorySchema

Methods

toHeaders :: GetInventorySchema -> [Header]

ToPath GetInventorySchema

Defined in Amazonka.SSM.GetInventorySchema

Methods

toPath :: GetInventorySchema -> ByteString

ToQuery GetInventorySchema

Defined in Amazonka.SSM.GetInventorySchema

Methods

toQuery :: GetInventorySchema -> QueryString

AWSPager GetInventorySchema

Defined in Amazonka.SSM.GetInventorySchema

Methods

page :: GetInventorySchema -> AWSResponse GetInventorySchema -> Maybe GetInventorySchema

AWSRequest GetInventorySchema

Defined in Amazonka.SSM.GetInventorySchema

Associated Types

type AWSResponse GetInventorySchema

Methods

request :: (Service -> Service) -> GetInventorySchema -> Request GetInventorySchema

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetInventorySchema -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetInventorySchema)))

Generic GetInventorySchema

Defined in Amazonka.SSM.GetInventorySchema

Associated Types

type Rep GetInventorySchema :: Type -> Type

Methods

from :: GetInventorySchema -> Rep GetInventorySchema x

to :: Rep GetInventorySchema x -> GetInventorySchema

Read GetInventorySchema

Defined in Amazonka.SSM.GetInventorySchema

Methods

readsPrec :: Int -> ReadS GetInventorySchema

readList :: ReadS [GetInventorySchema]

readPrec :: ReadPrec GetInventorySchema

readListPrec :: ReadPrec [GetInventorySchema]

Show GetInventorySchema

Defined in Amazonka.SSM.GetInventorySchema

Methods

showsPrec :: Int -> GetInventorySchema -> ShowS

show :: GetInventorySchema -> String

showList :: [GetInventorySchema] -> ShowS

NFData GetInventorySchema

Defined in Amazonka.SSM.GetInventorySchema

Methods

rnf :: GetInventorySchema -> ()

Eq GetInventorySchema

Defined in Amazonka.SSM.GetInventorySchema

Methods

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

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

Hashable GetInventorySchema

Defined in Amazonka.SSM.GetInventorySchema

Methods

hashWithSalt :: Int -> GetInventorySchema -> Int

hash :: GetInventorySchema -> Int

type AWSResponse GetInventorySchema

Defined in Amazonka.SSM.GetInventorySchema

type AWSResponse GetInventorySchema = GetInventorySchemaResponse

type Rep GetInventorySchema

Defined in Amazonka.SSM.GetInventorySchema

type Rep GetInventorySchema = D1 ('MetaData "GetInventorySchema" "Amazonka.SSM.GetInventorySchema" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "GetInventorySchema'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "aggregator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "subType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "typeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newGetInventorySchema :: GetInventorySchema

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

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.

GetInventorySchema, getInventorySchema_typeName - The type of inventory item to return.

Request Lenses

getInventorySchema_aggregator :: 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.

getInventorySchema_maxResults :: 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.

getInventorySchema_nextToken :: Lens' GetInventorySchema (Maybe Text)

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

getInventorySchema_subType :: Lens' GetInventorySchema (Maybe Bool)

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

getInventorySchema_typeName :: Lens' GetInventorySchema (Maybe Text)

The type of inventory item to return.

Destructuring the Response

data GetInventorySchemaResponse

See: newGetInventorySchemaResponse smart constructor.

Constructors

GetInventorySchemaResponse'

Fields

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

• schemas :: Maybe [InventoryItemSchema]

  Inventory schemas returned by the request.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetInventorySchemaResponse

Defined in Amazonka.SSM.GetInventorySchema

Associated Types

type Rep GetInventorySchemaResponse :: Type -> Type

Methods

from :: GetInventorySchemaResponse -> Rep GetInventorySchemaResponse x

to :: Rep GetInventorySchemaResponse x -> GetInventorySchemaResponse

Read GetInventorySchemaResponse

Defined in Amazonka.SSM.GetInventorySchema

Methods

readsPrec :: Int -> ReadS GetInventorySchemaResponse

readList :: ReadS [GetInventorySchemaResponse]

readPrec :: ReadPrec GetInventorySchemaResponse

readListPrec :: ReadPrec [GetInventorySchemaResponse]

Show GetInventorySchemaResponse

Defined in Amazonka.SSM.GetInventorySchema

Methods

showsPrec :: Int -> GetInventorySchemaResponse -> ShowS

show :: GetInventorySchemaResponse -> String

showList :: [GetInventorySchemaResponse] -> ShowS

NFData GetInventorySchemaResponse

Defined in Amazonka.SSM.GetInventorySchema

Methods

rnf :: GetInventorySchemaResponse -> ()

Eq GetInventorySchemaResponse

Defined in Amazonka.SSM.GetInventorySchema

Methods

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

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

type Rep GetInventorySchemaResponse

Defined in Amazonka.SSM.GetInventorySchema

type Rep GetInventorySchemaResponse = D1 ('MetaData "GetInventorySchemaResponse" "Amazonka.SSM.GetInventorySchema" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "GetInventorySchemaResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "schemas") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InventoryItemSchema])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetInventorySchemaResponse

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:

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

$sel:httpStatus:GetInventorySchemaResponse', getInventorySchemaResponse_httpStatus - The response's http status code.

Response Lenses

getInventorySchemaResponse_nextToken :: 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.

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

Inventory schemas returned by the request.

getInventorySchemaResponse_httpStatus :: Lens' GetInventorySchemaResponse Int

The response's http status code.