amazonka-ssm-2.0: Amazon Simple Systems Manager (SSM) SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SSM.GetInventorySchema

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

Creating a Request

data GetInventorySchema Source #

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

Instances details
ToJSON GetInventorySchema Source # 
Instance details

Defined in Amazonka.SSM.GetInventorySchema

ToHeaders GetInventorySchema Source # 
Instance details

Defined in Amazonka.SSM.GetInventorySchema

ToPath GetInventorySchema Source # 
Instance details

Defined in Amazonka.SSM.GetInventorySchema

ToQuery GetInventorySchema Source # 
Instance details

Defined in Amazonka.SSM.GetInventorySchema

AWSPager GetInventorySchema Source # 
Instance details

Defined in Amazonka.SSM.GetInventorySchema

AWSRequest GetInventorySchema Source # 
Instance details

Defined in Amazonka.SSM.GetInventorySchema

Associated Types

type AWSResponse GetInventorySchema #

Generic GetInventorySchema Source # 
Instance details

Defined in Amazonka.SSM.GetInventorySchema

Associated Types

type Rep GetInventorySchema :: Type -> Type #

Read GetInventorySchema Source # 
Instance details

Defined in Amazonka.SSM.GetInventorySchema

Show GetInventorySchema Source # 
Instance details

Defined in Amazonka.SSM.GetInventorySchema

NFData GetInventorySchema Source # 
Instance details

Defined in Amazonka.SSM.GetInventorySchema

Methods

rnf :: GetInventorySchema -> () #

Eq GetInventorySchema Source # 
Instance details

Defined in Amazonka.SSM.GetInventorySchema

Hashable GetInventorySchema Source # 
Instance details

Defined in Amazonka.SSM.GetInventorySchema

type AWSResponse GetInventorySchema Source # 
Instance details

Defined in Amazonka.SSM.GetInventorySchema

type Rep GetInventorySchema Source # 
Instance details

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

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_typeName :: Lens' GetInventorySchema (Maybe Text) Source #

The type of inventory item to return.

Destructuring the Response

data GetInventorySchemaResponse Source #

See: newGetInventorySchemaResponse smart constructor.

Constructors

GetInventorySchemaResponse' 

Fields

Instances

Instances details
Generic GetInventorySchemaResponse Source # 
Instance details

Defined in Amazonka.SSM.GetInventorySchema

Associated Types

type Rep GetInventorySchemaResponse :: Type -> Type #

Read GetInventorySchemaResponse Source # 
Instance details

Defined in Amazonka.SSM.GetInventorySchema

Show GetInventorySchemaResponse Source # 
Instance details

Defined in Amazonka.SSM.GetInventorySchema

NFData GetInventorySchemaResponse Source # 
Instance details

Defined in Amazonka.SSM.GetInventorySchema

Eq GetInventorySchemaResponse Source # 
Instance details

Defined in Amazonka.SSM.GetInventorySchema

type Rep GetInventorySchemaResponse Source # 
Instance details

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 Source #

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) Source #

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