Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SSM.DescribeInstancePatchStatesForPatchGroup

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the high-level patch state for the instances in the specified patch group.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeInstancePatchStatesForPatchGroup Source #

See: newDescribeInstancePatchStatesForPatchGroup smart constructor.

Constructors

DescribeInstancePatchStatesForPatchGroup'

Fields

filters :: Maybe [InstancePatchStateFilter]
Each entry in the array is a structure containing:
- Key (string between 1 and 200 characters)
- Values (array containing a single string)
- Type (string "Equal", "NotEqual", "LessThan", "GreaterThan")
nextToken :: Maybe Text
The token for the next set of items to return. (You received this token from a previous call.)
maxResults :: Maybe Natural
The maximum number of patches to return (per page).
patchGroup :: Text
The name of the patch group for which the patch state information should be retrieved.

Instances

Instances details

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

newDescribeInstancePatchStatesForPatchGroup Source #

Arguments

:: Text	`$sel:patchGroup:DescribeInstancePatchStatesForPatchGroup'`
-> DescribeInstancePatchStatesForPatchGroup

Create a value of DescribeInstancePatchStatesForPatchGroup 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:DescribeInstancePatchStatesForPatchGroup', describeInstancePatchStatesForPatchGroup_filters - Each entry in the array is a structure containing:

Key (string between 1 and 200 characters)
Values (array containing a single string)
Type (string "Equal", "NotEqual", "LessThan", "GreaterThan")

$sel:nextToken:DescribeInstancePatchStatesForPatchGroup', describeInstancePatchStatesForPatchGroup_nextToken - The token for the next set of items to return. (You received this token from a previous call.)

$sel:maxResults:DescribeInstancePatchStatesForPatchGroup', describeInstancePatchStatesForPatchGroup_maxResults - The maximum number of patches to return (per page).

$sel:patchGroup:DescribeInstancePatchStatesForPatchGroup', describeInstancePatchStatesForPatchGroup_patchGroup - The name of the patch group for which the patch state information should be retrieved.

Request Lenses

describeInstancePatchStatesForPatchGroup_filters :: Lens' DescribeInstancePatchStatesForPatchGroup (Maybe [InstancePatchStateFilter]) Source #

Each entry in the array is a structure containing:

Key (string between 1 and 200 characters)
Values (array containing a single string)
Type (string "Equal", "NotEqual", "LessThan", "GreaterThan")

describeInstancePatchStatesForPatchGroup_nextToken :: Lens' DescribeInstancePatchStatesForPatchGroup (Maybe Text) Source #

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

describeInstancePatchStatesForPatchGroup_maxResults :: Lens' DescribeInstancePatchStatesForPatchGroup (Maybe Natural) Source #

The maximum number of patches to return (per page).

describeInstancePatchStatesForPatchGroup_patchGroup :: Lens' DescribeInstancePatchStatesForPatchGroup Text Source #

The name of the patch group for which the patch state information should be retrieved.

Destructuring the Response

data DescribeInstancePatchStatesForPatchGroupResponse Source #

See: newDescribeInstancePatchStatesForPatchGroupResponse smart constructor.

Constructors

DescribeInstancePatchStatesForPatchGroupResponse'
Fields 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. instancePatchStates :: Maybe (NonEmpty InstancePatchState) The high-level patch state for the requested instances. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeInstancePatchStatesForPatchGroupResponse Source #
Instance details Defined in Amazonka.SSM.DescribeInstancePatchStatesForPatchGroup Methods (==) :: DescribeInstancePatchStatesForPatchGroupResponse -> DescribeInstancePatchStatesForPatchGroupResponse -> Bool # (/=) :: DescribeInstancePatchStatesForPatchGroupResponse -> DescribeInstancePatchStatesForPatchGroupResponse -> Bool #
Show DescribeInstancePatchStatesForPatchGroupResponse Source #
Instance details Defined in Amazonka.SSM.DescribeInstancePatchStatesForPatchGroup Methods showsPrec :: Int -> DescribeInstancePatchStatesForPatchGroupResponse -> ShowS # show :: DescribeInstancePatchStatesForPatchGroupResponse -> String # showList :: [DescribeInstancePatchStatesForPatchGroupResponse] -> ShowS #
Generic DescribeInstancePatchStatesForPatchGroupResponse Source #
Instance details Defined in Amazonka.SSM.DescribeInstancePatchStatesForPatchGroup Associated Types type Rep DescribeInstancePatchStatesForPatchGroupResponse :: Type -> Type # Methods from :: DescribeInstancePatchStatesForPatchGroupResponse -> Rep DescribeInstancePatchStatesForPatchGroupResponse x # to :: Rep DescribeInstancePatchStatesForPatchGroupResponse x -> DescribeInstancePatchStatesForPatchGroupResponse #
NFData DescribeInstancePatchStatesForPatchGroupResponse Source #
Instance details Defined in Amazonka.SSM.DescribeInstancePatchStatesForPatchGroup Methods rnf :: DescribeInstancePatchStatesForPatchGroupResponse -> () #
type Rep DescribeInstancePatchStatesForPatchGroupResponse Source #
Instance details Defined in Amazonka.SSM.DescribeInstancePatchStatesForPatchGroup type Rep DescribeInstancePatchStatesForPatchGroupResponse = D1 ('MetaData "DescribeInstancePatchStatesForPatchGroupResponse" "Amazonka.SSM.DescribeInstancePatchStatesForPatchGroup" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "DescribeInstancePatchStatesForPatchGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "instancePatchStates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty InstancePatchState))) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeInstancePatchStatesForPatchGroupResponse Source #

Arguments

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

Create a value of DescribeInstancePatchStatesForPatchGroupResponse 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:DescribeInstancePatchStatesForPatchGroup', describeInstancePatchStatesForPatchGroupResponse_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:instancePatchStates:DescribeInstancePatchStatesForPatchGroupResponse', describeInstancePatchStatesForPatchGroupResponse_instancePatchStates - The high-level patch state for the requested instances.

$sel:httpStatus:DescribeInstancePatchStatesForPatchGroupResponse', describeInstancePatchStatesForPatchGroupResponse_httpStatus - The response's http status code.

Response Lenses

describeInstancePatchStatesForPatchGroupResponse_nextToken :: Lens' DescribeInstancePatchStatesForPatchGroupResponse (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.

describeInstancePatchStatesForPatchGroupResponse_instancePatchStates :: Lens' DescribeInstancePatchStatesForPatchGroupResponse (Maybe (NonEmpty InstancePatchState)) Source #

The high-level patch state for the requested instances.

describeInstancePatchStatesForPatchGroupResponse_httpStatus :: Lens' DescribeInstancePatchStatesForPatchGroupResponse Int Source #

The response's http status code.