Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SSM.ListComplianceItems

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

For a specified resource ID, this API operation returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.

This operation returns paginated results.

Synopsis

data ListComplianceItems = ListComplianceItems' {
- filters :: Maybe [ComplianceStringFilter]
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- resourceIds :: Maybe (NonEmpty Text)
- resourceTypes :: Maybe (NonEmpty Text)
}
newListComplianceItems :: ListComplianceItems
listComplianceItems_filters :: Lens' ListComplianceItems (Maybe [ComplianceStringFilter])
listComplianceItems_maxResults :: Lens' ListComplianceItems (Maybe Natural)
listComplianceItems_nextToken :: Lens' ListComplianceItems (Maybe Text)
listComplianceItems_resourceIds :: Lens' ListComplianceItems (Maybe (NonEmpty Text))
listComplianceItems_resourceTypes :: Lens' ListComplianceItems (Maybe (NonEmpty Text))
data ListComplianceItemsResponse = ListComplianceItemsResponse' {
- complianceItems :: Maybe [ComplianceItem]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListComplianceItemsResponse :: Int -> ListComplianceItemsResponse
listComplianceItemsResponse_complianceItems :: Lens' ListComplianceItemsResponse (Maybe [ComplianceItem])
listComplianceItemsResponse_nextToken :: Lens' ListComplianceItemsResponse (Maybe Text)
listComplianceItemsResponse_httpStatus :: Lens' ListComplianceItemsResponse Int

Creating a Request

data ListComplianceItems Source #

See: newListComplianceItems smart constructor.

Constructors

ListComplianceItems'

Fields

filters :: Maybe [ComplianceStringFilter]
One or more compliance 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. 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.
resourceIds :: Maybe (NonEmpty Text)
The ID for the resources from which to get compliance information. Currently, you can only specify one resource ID.
resourceTypes :: Maybe (NonEmpty Text)
The type of resource from which to get compliance information. Currently, the only supported resource type is ManagedInstance.

Instances

Instances details

ToJSON ListComplianceItems Source #
Instance details Defined in Amazonka.SSM.ListComplianceItems Methods toJSON :: ListComplianceItems -> Value # toEncoding :: ListComplianceItems -> Encoding # toJSONList :: [ListComplianceItems] -> Value # toEncodingList :: [ListComplianceItems] -> Encoding #
ToHeaders ListComplianceItems Source #
Instance details Defined in Amazonka.SSM.ListComplianceItems Methods toHeaders :: ListComplianceItems -> [Header] #
ToPath ListComplianceItems Source #
Instance details Defined in Amazonka.SSM.ListComplianceItems Methods toPath :: ListComplianceItems -> ByteString #
ToQuery ListComplianceItems Source #
Instance details Defined in Amazonka.SSM.ListComplianceItems Methods toQuery :: ListComplianceItems -> QueryString #
AWSPager ListComplianceItems Source #
Instance details Defined in Amazonka.SSM.ListComplianceItems Methods page :: ListComplianceItems -> AWSResponse ListComplianceItems -> Maybe ListComplianceItems #
AWSRequest ListComplianceItems Source #
Instance details Defined in Amazonka.SSM.ListComplianceItems Associated Types type AWSResponse ListComplianceItems # Methods request :: (Service -> Service) -> ListComplianceItems -> Request ListComplianceItems # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListComplianceItems -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListComplianceItems))) #
Generic ListComplianceItems Source #
Instance details Defined in Amazonka.SSM.ListComplianceItems Associated Types type Rep ListComplianceItems :: Type -> Type # Methods from :: ListComplianceItems -> Rep ListComplianceItems x # to :: Rep ListComplianceItems x -> ListComplianceItems #
Read ListComplianceItems Source #
Instance details Defined in Amazonka.SSM.ListComplianceItems Methods readsPrec :: Int -> ReadS ListComplianceItems # readList :: ReadS [ListComplianceItems] # readPrec :: ReadPrec ListComplianceItems # readListPrec :: ReadPrec [ListComplianceItems] #
Show ListComplianceItems Source #
Instance details Defined in Amazonka.SSM.ListComplianceItems Methods showsPrec :: Int -> ListComplianceItems -> ShowS # show :: ListComplianceItems -> String # showList :: [ListComplianceItems] -> ShowS #
NFData ListComplianceItems Source #
Instance details Defined in Amazonka.SSM.ListComplianceItems Methods rnf :: ListComplianceItems -> () #
Eq ListComplianceItems Source #
Instance details Defined in Amazonka.SSM.ListComplianceItems Methods (==) :: ListComplianceItems -> ListComplianceItems -> Bool # (/=) :: ListComplianceItems -> ListComplianceItems -> Bool #
Hashable ListComplianceItems Source #
Instance details Defined in Amazonka.SSM.ListComplianceItems Methods hashWithSalt :: Int -> ListComplianceItems -> Int # hash :: ListComplianceItems -> Int #
type AWSResponse ListComplianceItems Source #
Instance details Defined in Amazonka.SSM.ListComplianceItems type AWSResponse ListComplianceItems = ListComplianceItemsResponse
type Rep ListComplianceItems Source #
Instance details Defined in Amazonka.SSM.ListComplianceItems type Rep ListComplianceItems = D1 ('MetaData "ListComplianceItems" "Amazonka.SSM.ListComplianceItems" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "ListComplianceItems'" '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)) :: (S1 ('MetaSel ('Just "resourceIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :: S1 ('MetaSel ('Just "resourceTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text)))))))

newListComplianceItems :: ListComplianceItems Source #

Create a value of ListComplianceItems 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:

ListComplianceItems, listComplianceItems_filters - One or more compliance filters. Use a filter to return a more specific list of results.

$sel:maxResults:ListComplianceItems', listComplianceItems_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.

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

$sel:resourceIds:ListComplianceItems', listComplianceItems_resourceIds - The ID for the resources from which to get compliance information. Currently, you can only specify one resource ID.

$sel:resourceTypes:ListComplianceItems', listComplianceItems_resourceTypes - The type of resource from which to get compliance information. Currently, the only supported resource type is ManagedInstance.

Request Lenses

listComplianceItems_filters :: Lens' ListComplianceItems (Maybe [ComplianceStringFilter]) Source #

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

listComplianceItems_maxResults :: Lens' ListComplianceItems (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.

listComplianceItems_nextToken :: Lens' ListComplianceItems (Maybe Text) Source #

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

listComplianceItems_resourceIds :: Lens' ListComplianceItems (Maybe (NonEmpty Text)) Source #

The ID for the resources from which to get compliance information. Currently, you can only specify one resource ID.

listComplianceItems_resourceTypes :: Lens' ListComplianceItems (Maybe (NonEmpty Text)) Source #

The type of resource from which to get compliance information. Currently, the only supported resource type is ManagedInstance.

Destructuring the Response

data ListComplianceItemsResponse Source #

See: newListComplianceItemsResponse smart constructor.

Constructors

ListComplianceItemsResponse'
Fields complianceItems :: Maybe [ComplianceItem] A list of compliance information for the specified resource ID. 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

Instances details

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

newListComplianceItemsResponse Source #

Arguments

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

Create a value of ListComplianceItemsResponse 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:complianceItems:ListComplianceItemsResponse', listComplianceItemsResponse_complianceItems - A list of compliance information for the specified resource ID.

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

$sel:httpStatus:ListComplianceItemsResponse', listComplianceItemsResponse_httpStatus - The response's http status code.

Response Lenses

listComplianceItemsResponse_complianceItems :: Lens' ListComplianceItemsResponse (Maybe [ComplianceItem]) Source #

A list of compliance information for the specified resource ID.

listComplianceItemsResponse_nextToken :: Lens' ListComplianceItemsResponse (Maybe Text) Source #

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

listComplianceItemsResponse_httpStatus :: Lens' ListComplianceItemsResponse Int Source #

The response's http status code.