libZSservicesZSamazonka-ssmZSamazonka-ssm
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SSM.ListComplianceSummaries

Description

Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.

This operation returns paginated results.

Synopsis

Creating a Request

data ListComplianceSummaries Source #

See: newListComplianceSummaries smart constructor.

Constructors

ListComplianceSummaries' 

Fields

  • filters :: Maybe [ComplianceStringFilter]

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

  • nextToken :: Maybe Text

    A token to start the list. Use this token to get the next set of results.

  • maxResults :: Maybe Natural

    The maximum number of items to return for this call. Currently, you can specify null or 50. 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 ListComplianceSummaries Source # 
Instance details

Defined in Amazonka.SSM.ListComplianceSummaries

Read ListComplianceSummaries Source # 
Instance details

Defined in Amazonka.SSM.ListComplianceSummaries

Show ListComplianceSummaries Source # 
Instance details

Defined in Amazonka.SSM.ListComplianceSummaries

Generic ListComplianceSummaries Source # 
Instance details

Defined in Amazonka.SSM.ListComplianceSummaries

Associated Types

type Rep ListComplianceSummaries :: Type -> Type #

NFData ListComplianceSummaries Source # 
Instance details

Defined in Amazonka.SSM.ListComplianceSummaries

Methods

rnf :: ListComplianceSummaries -> () #

Hashable ListComplianceSummaries Source # 
Instance details

Defined in Amazonka.SSM.ListComplianceSummaries

ToJSON ListComplianceSummaries Source # 
Instance details

Defined in Amazonka.SSM.ListComplianceSummaries

AWSPager ListComplianceSummaries Source # 
Instance details

Defined in Amazonka.SSM.ListComplianceSummaries

AWSRequest ListComplianceSummaries Source # 
Instance details

Defined in Amazonka.SSM.ListComplianceSummaries

ToHeaders ListComplianceSummaries Source # 
Instance details

Defined in Amazonka.SSM.ListComplianceSummaries

ToPath ListComplianceSummaries Source # 
Instance details

Defined in Amazonka.SSM.ListComplianceSummaries

ToQuery ListComplianceSummaries Source # 
Instance details

Defined in Amazonka.SSM.ListComplianceSummaries

type Rep ListComplianceSummaries Source # 
Instance details

Defined in Amazonka.SSM.ListComplianceSummaries

type Rep ListComplianceSummaries = D1 ('MetaData "ListComplianceSummaries" "Amazonka.SSM.ListComplianceSummaries" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "ListComplianceSummaries'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ComplianceStringFilter])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListComplianceSummaries Source # 
Instance details

Defined in Amazonka.SSM.ListComplianceSummaries

newListComplianceSummaries :: ListComplianceSummaries Source #

Create a value of ListComplianceSummaries 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:filters:ListComplianceSummaries', listComplianceSummaries_filters - One or more compliance or inventory filters. Use a filter to return a more specific list of results.

$sel:nextToken:ListComplianceSummaries', listComplianceSummaries_nextToken - A token to start the list. Use this token to get the next set of results.

$sel:maxResults:ListComplianceSummaries', listComplianceSummaries_maxResults - The maximum number of items to return for this call. Currently, you can specify null or 50. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Request Lenses

listComplianceSummaries_filters :: Lens' ListComplianceSummaries (Maybe [ComplianceStringFilter]) Source #

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

listComplianceSummaries_nextToken :: Lens' ListComplianceSummaries (Maybe Text) Source #

A token to start the list. Use this token to get the next set of results.

listComplianceSummaries_maxResults :: Lens' ListComplianceSummaries (Maybe Natural) Source #

The maximum number of items to return for this call. Currently, you can specify null or 50. 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 ListComplianceSummariesResponse Source #

See: newListComplianceSummariesResponse smart constructor.

Constructors

ListComplianceSummariesResponse' 

Fields

  • nextToken :: Maybe Text

    The token for the next set of items to return. Use this token to get the next set of results.

  • complianceSummaryItems :: Maybe [ComplianceSummaryItem]

    A list of compliant and non-compliant summary counts based on compliance types. For example, this call returns State Manager associations, patches, or custom compliance types according to the filter criteria that you specified.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListComplianceSummariesResponse Source # 
Instance details

Defined in Amazonka.SSM.ListComplianceSummaries

Read ListComplianceSummariesResponse Source # 
Instance details

Defined in Amazonka.SSM.ListComplianceSummaries

Show ListComplianceSummariesResponse Source # 
Instance details

Defined in Amazonka.SSM.ListComplianceSummaries

Generic ListComplianceSummariesResponse Source # 
Instance details

Defined in Amazonka.SSM.ListComplianceSummaries

Associated Types

type Rep ListComplianceSummariesResponse :: Type -> Type #

NFData ListComplianceSummariesResponse Source # 
Instance details

Defined in Amazonka.SSM.ListComplianceSummaries

type Rep ListComplianceSummariesResponse Source # 
Instance details

Defined in Amazonka.SSM.ListComplianceSummaries

type Rep ListComplianceSummariesResponse = D1 ('MetaData "ListComplianceSummariesResponse" "Amazonka.SSM.ListComplianceSummaries" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "ListComplianceSummariesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "complianceSummaryItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ComplianceSummaryItem])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListComplianceSummariesResponse Source #

Create a value of ListComplianceSummariesResponse 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:nextToken:ListComplianceSummaries', listComplianceSummariesResponse_nextToken - The token for the next set of items to return. Use this token to get the next set of results.

$sel:complianceSummaryItems:ListComplianceSummariesResponse', listComplianceSummariesResponse_complianceSummaryItems - A list of compliant and non-compliant summary counts based on compliance types. For example, this call returns State Manager associations, patches, or custom compliance types according to the filter criteria that you specified.

$sel:httpStatus:ListComplianceSummariesResponse', listComplianceSummariesResponse_httpStatus - The response's http status code.

Response Lenses

listComplianceSummariesResponse_nextToken :: Lens' ListComplianceSummariesResponse (Maybe Text) Source #

The token for the next set of items to return. Use this token to get the next set of results.

listComplianceSummariesResponse_complianceSummaryItems :: Lens' ListComplianceSummariesResponse (Maybe [ComplianceSummaryItem]) Source #

A list of compliant and non-compliant summary counts based on compliance types. For example, this call returns State Manager associations, patches, or custom compliance types according to the filter criteria that you specified.