Amazonka.SSM.ListComplianceSummaries

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.

Creating a Request

data ListComplianceSummaries

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.

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

• nextToken :: Maybe Text

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

Instances

ToJSON ListComplianceSummaries

Defined in Amazonka.SSM.ListComplianceSummaries

Methods

toJSON :: ListComplianceSummaries -> Value

toEncoding :: ListComplianceSummaries -> Encoding

toJSONList :: [ListComplianceSummaries] -> Value

toEncodingList :: [ListComplianceSummaries] -> Encoding

ToHeaders ListComplianceSummaries

Defined in Amazonka.SSM.ListComplianceSummaries

Methods

toHeaders :: ListComplianceSummaries -> [Header]

ToPath ListComplianceSummaries

Defined in Amazonka.SSM.ListComplianceSummaries

Methods

toPath :: ListComplianceSummaries -> ByteString

ToQuery ListComplianceSummaries

Defined in Amazonka.SSM.ListComplianceSummaries

Methods

toQuery :: ListComplianceSummaries -> QueryString

AWSPager ListComplianceSummaries

Defined in Amazonka.SSM.ListComplianceSummaries

Methods

page :: ListComplianceSummaries -> AWSResponse ListComplianceSummaries -> Maybe ListComplianceSummaries

AWSRequest ListComplianceSummaries

Defined in Amazonka.SSM.ListComplianceSummaries

Associated Types

type AWSResponse ListComplianceSummaries

Methods

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

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

Generic ListComplianceSummaries

Defined in Amazonka.SSM.ListComplianceSummaries

Associated Types

type Rep ListComplianceSummaries :: Type -> Type

Methods

from :: ListComplianceSummaries -> Rep ListComplianceSummaries x

to :: Rep ListComplianceSummaries x -> ListComplianceSummaries

Read ListComplianceSummaries

Defined in Amazonka.SSM.ListComplianceSummaries

Methods

readsPrec :: Int -> ReadS ListComplianceSummaries

readList :: ReadS [ListComplianceSummaries]

readPrec :: ReadPrec ListComplianceSummaries

readListPrec :: ReadPrec [ListComplianceSummaries]

Show ListComplianceSummaries

Defined in Amazonka.SSM.ListComplianceSummaries

Methods

showsPrec :: Int -> ListComplianceSummaries -> ShowS

show :: ListComplianceSummaries -> String

showList :: [ListComplianceSummaries] -> ShowS

NFData ListComplianceSummaries

Defined in Amazonka.SSM.ListComplianceSummaries

Methods

rnf :: ListComplianceSummaries -> ()

Eq ListComplianceSummaries

Defined in Amazonka.SSM.ListComplianceSummaries

Methods

(==) :: ListComplianceSummaries -> ListComplianceSummaries -> Bool

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

Hashable ListComplianceSummaries

Defined in Amazonka.SSM.ListComplianceSummaries

Methods

hashWithSalt :: Int -> ListComplianceSummaries -> Int

hash :: ListComplianceSummaries -> Int

type AWSResponse ListComplianceSummaries

Defined in Amazonka.SSM.ListComplianceSummaries

type AWSResponse ListComplianceSummaries = ListComplianceSummariesResponse

type Rep ListComplianceSummaries

Defined in Amazonka.SSM.ListComplianceSummaries

type Rep ListComplianceSummaries = D1 ('MetaData "ListComplianceSummaries" "Amazonka.SSM.ListComplianceSummaries" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "ListComplianceSummaries'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ComplianceStringFilter])) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListComplianceSummaries :: ListComplianceSummaries

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:

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

ListComplianceSummaries, listComplianceSummaries_nextToken - A token to start the list. Use this token to get the next set of results.

Request Lenses

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

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

listComplianceSummaries_maxResults :: Lens' ListComplianceSummaries (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.

listComplianceSummaries_nextToken :: Lens' ListComplianceSummaries (Maybe Text)

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

Destructuring the Response

data ListComplianceSummariesResponse

See: newListComplianceSummariesResponse smart constructor.

Constructors

ListComplianceSummariesResponse'

Fields

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

• nextToken :: Maybe Text

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListComplianceSummariesResponse

Defined in Amazonka.SSM.ListComplianceSummaries

Associated Types

type Rep ListComplianceSummariesResponse :: Type -> Type

Methods

from :: ListComplianceSummariesResponse -> Rep ListComplianceSummariesResponse x

to :: Rep ListComplianceSummariesResponse x -> ListComplianceSummariesResponse

Read ListComplianceSummariesResponse

Defined in Amazonka.SSM.ListComplianceSummaries

Methods

readsPrec :: Int -> ReadS ListComplianceSummariesResponse

readList :: ReadS [ListComplianceSummariesResponse]

readPrec :: ReadPrec ListComplianceSummariesResponse

readListPrec :: ReadPrec [ListComplianceSummariesResponse]

Show ListComplianceSummariesResponse

Defined in Amazonka.SSM.ListComplianceSummaries

Methods

showsPrec :: Int -> ListComplianceSummariesResponse -> ShowS

show :: ListComplianceSummariesResponse -> String

showList :: [ListComplianceSummariesResponse] -> ShowS

NFData ListComplianceSummariesResponse

Defined in Amazonka.SSM.ListComplianceSummaries

Methods

rnf :: ListComplianceSummariesResponse -> ()

Eq ListComplianceSummariesResponse

Defined in Amazonka.SSM.ListComplianceSummaries

Methods

(==) :: ListComplianceSummariesResponse -> ListComplianceSummariesResponse -> Bool

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

type Rep ListComplianceSummariesResponse

Defined in Amazonka.SSM.ListComplianceSummaries

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

newListComplianceSummariesResponse

Arguments

:: Int

$sel:httpStatus:ListComplianceSummariesResponse'

-> ListComplianceSummariesResponse

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

ListComplianceSummaries, listComplianceSummariesResponse_nextToken - The token for the next set of items to return. Use this token to get the next set of results.

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

Response Lenses

listComplianceSummariesResponse_complianceSummaryItems :: Lens' ListComplianceSummariesResponse (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.

listComplianceSummariesResponse_nextToken :: Lens' ListComplianceSummariesResponse (Maybe Text)

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

listComplianceSummariesResponse_httpStatus :: Lens' ListComplianceSummariesResponse Int

The response's http status code.