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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all patch groups that have been registered with patch baselines.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribePatchGroups Source #

See: newDescribePatchGroups smart constructor.

Constructors

DescribePatchGroups'

Fields

filters :: Maybe [PatchOrchestratorFilter]
Each element in the array is a structure containing a key-value pair.
Supported keys for DescribePatchGroups include the following:
- NAME_PREFIX
  Sample values: AWS- | My-.
- OPERATING_SYSTEM
  Sample values: AMAZON_LINUX | SUSE | WINDOWS
maxResults :: Maybe Natural
The maximum number of patch groups to return (per page).
nextToken :: Maybe Text
The token for the next set of items to return. (You received this token from a previous call.)

Instances

Instances details

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

newDescribePatchGroups :: DescribePatchGroups Source #

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

DescribePatchGroups, describePatchGroups_filters - Each element in the array is a structure containing a key-value pair.

Supported keys for DescribePatchGroups include the following:

NAME_PREFIX
Sample values: AWS- | My-.
OPERATING_SYSTEM
Sample values: AMAZON_LINUX | SUSE | WINDOWS

$sel:maxResults:DescribePatchGroups', describePatchGroups_maxResults - The maximum number of patch groups to return (per page).

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

Request Lenses

describePatchGroups_filters :: Lens' DescribePatchGroups (Maybe [PatchOrchestratorFilter]) Source #

Each element in the array is a structure containing a key-value pair.

Supported keys for DescribePatchGroups include the following:

NAME_PREFIX
Sample values: AWS- | My-.
OPERATING_SYSTEM
Sample values: AMAZON_LINUX | SUSE | WINDOWS

describePatchGroups_maxResults :: Lens' DescribePatchGroups (Maybe Natural) Source #

The maximum number of patch groups to return (per page).

describePatchGroups_nextToken :: Lens' DescribePatchGroups (Maybe Text) Source #

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

Destructuring the Response

data DescribePatchGroupsResponse Source #

See: newDescribePatchGroupsResponse smart constructor.

Constructors

DescribePatchGroupsResponse'

Fields

mappings :: Maybe [PatchGroupPatchBaselineMapping]
Each entry in the array contains:
- PatchGroup: string (between 1 and 256 characters. Regex: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$)
- PatchBaselineIdentity: A PatchBaselineIdentity element.
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newDescribePatchGroupsResponse Source #

Arguments

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

Create a value of DescribePatchGroupsResponse 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:mappings:DescribePatchGroupsResponse', describePatchGroupsResponse_mappings - Each entry in the array contains:

PatchGroup: string (between 1 and 256 characters. Regex: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$)
PatchBaselineIdentity: A PatchBaselineIdentity element.

DescribePatchGroups, describePatchGroupsResponse_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:httpStatus:DescribePatchGroupsResponse', describePatchGroupsResponse_httpStatus - The response's http status code.

Response Lenses

describePatchGroupsResponse_mappings :: Lens' DescribePatchGroupsResponse (Maybe [PatchGroupPatchBaselineMapping]) Source #

Each entry in the array contains:

PatchGroup: string (between 1 and 256 characters. Regex: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$)
PatchBaselineIdentity: A PatchBaselineIdentity element.

describePatchGroupsResponse_nextToken :: Lens' DescribePatchGroupsResponse (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.

describePatchGroupsResponse_httpStatus :: Lens' DescribePatchGroupsResponse Int Source #

The response's http status code.