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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document (SSM document).

If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your local Amazon Web Services credentials and the operation fails. To avoid this, you can run the command in the Amazon Web Services Systems Manager console. Use Run Command, a capability of Amazon Web Services Systems Manager, with an SSM document that enables you to target an instance with a script or command. For example, run the command using the AWS-RunShellScript document or the AWS-RunPowerShellScript document.

Synopsis

Creating a Request

data GetDeployablePatchSnapshotForInstance Source #

See: newGetDeployablePatchSnapshotForInstance smart constructor.

Constructors

GetDeployablePatchSnapshotForInstance'
Fields baselineOverride :: Maybe BaselineOverride Defines the basic information about a patch baseline override. instanceId :: Text The ID of the instance for which the appropriate patch snapshot should be retrieved. snapshotId :: Text The snapshot ID provided by the user when running `AWS-RunPatchBaseline`.

Instances

Instances details

Eq GetDeployablePatchSnapshotForInstance Source #
Instance details Defined in Amazonka.SSM.GetDeployablePatchSnapshotForInstance Methods (==) :: GetDeployablePatchSnapshotForInstance -> GetDeployablePatchSnapshotForInstance -> Bool # (/=) :: GetDeployablePatchSnapshotForInstance -> GetDeployablePatchSnapshotForInstance -> Bool #
Show GetDeployablePatchSnapshotForInstance Source #
Instance details Defined in Amazonka.SSM.GetDeployablePatchSnapshotForInstance Methods showsPrec :: Int -> GetDeployablePatchSnapshotForInstance -> ShowS # show :: GetDeployablePatchSnapshotForInstance -> String # showList :: [GetDeployablePatchSnapshotForInstance] -> ShowS #
Generic GetDeployablePatchSnapshotForInstance Source #
Instance details Defined in Amazonka.SSM.GetDeployablePatchSnapshotForInstance Associated Types type Rep GetDeployablePatchSnapshotForInstance :: Type -> Type # Methods from :: GetDeployablePatchSnapshotForInstance -> Rep GetDeployablePatchSnapshotForInstance x # to :: Rep GetDeployablePatchSnapshotForInstance x -> GetDeployablePatchSnapshotForInstance #
NFData GetDeployablePatchSnapshotForInstance Source #
Instance details Defined in Amazonka.SSM.GetDeployablePatchSnapshotForInstance Methods rnf :: GetDeployablePatchSnapshotForInstance -> () #
Hashable GetDeployablePatchSnapshotForInstance Source #
Instance details Defined in Amazonka.SSM.GetDeployablePatchSnapshotForInstance Methods hashWithSalt :: Int -> GetDeployablePatchSnapshotForInstance -> Int # hash :: GetDeployablePatchSnapshotForInstance -> Int #
ToJSON GetDeployablePatchSnapshotForInstance Source #
Instance details Defined in Amazonka.SSM.GetDeployablePatchSnapshotForInstance Methods toJSON :: GetDeployablePatchSnapshotForInstance -> Value # toEncoding :: GetDeployablePatchSnapshotForInstance -> Encoding # toJSONList :: [GetDeployablePatchSnapshotForInstance] -> Value # toEncodingList :: [GetDeployablePatchSnapshotForInstance] -> Encoding #
AWSRequest GetDeployablePatchSnapshotForInstance Source #
Instance details Defined in Amazonka.SSM.GetDeployablePatchSnapshotForInstance Associated Types type AWSResponse GetDeployablePatchSnapshotForInstance # Methods request :: GetDeployablePatchSnapshotForInstance -> Request GetDeployablePatchSnapshotForInstance # response :: MonadResource m => Logger -> Service -> Proxy GetDeployablePatchSnapshotForInstance -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetDeployablePatchSnapshotForInstance))) #
ToHeaders GetDeployablePatchSnapshotForInstance Source #
Instance details Defined in Amazonka.SSM.GetDeployablePatchSnapshotForInstance Methods toHeaders :: GetDeployablePatchSnapshotForInstance -> [Header] #
ToPath GetDeployablePatchSnapshotForInstance Source #
Instance details Defined in Amazonka.SSM.GetDeployablePatchSnapshotForInstance Methods toPath :: GetDeployablePatchSnapshotForInstance -> ByteString #
ToQuery GetDeployablePatchSnapshotForInstance Source #
Instance details Defined in Amazonka.SSM.GetDeployablePatchSnapshotForInstance Methods toQuery :: GetDeployablePatchSnapshotForInstance -> QueryString #
type Rep GetDeployablePatchSnapshotForInstance Source #
Instance details Defined in Amazonka.SSM.GetDeployablePatchSnapshotForInstance type Rep GetDeployablePatchSnapshotForInstance = D1 ('MetaData "GetDeployablePatchSnapshotForInstance" "Amazonka.SSM.GetDeployablePatchSnapshotForInstance" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "GetDeployablePatchSnapshotForInstance'" 'PrefixI 'True) (S1 ('MetaSel ('Just "baselineOverride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BaselineOverride)) :: (S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "snapshotId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse GetDeployablePatchSnapshotForInstance Source #
Instance details Defined in Amazonka.SSM.GetDeployablePatchSnapshotForInstance type AWSResponse GetDeployablePatchSnapshotForInstance = GetDeployablePatchSnapshotForInstanceResponse

newGetDeployablePatchSnapshotForInstance Source #

Arguments

:: Text	`$sel:instanceId:GetDeployablePatchSnapshotForInstance'`
-> Text	`$sel:snapshotId:GetDeployablePatchSnapshotForInstance'`
-> GetDeployablePatchSnapshotForInstance

Create a value of GetDeployablePatchSnapshotForInstance 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:baselineOverride:GetDeployablePatchSnapshotForInstance', getDeployablePatchSnapshotForInstance_baselineOverride - Defines the basic information about a patch baseline override.

$sel:instanceId:GetDeployablePatchSnapshotForInstance', getDeployablePatchSnapshotForInstance_instanceId - The ID of the instance for which the appropriate patch snapshot should be retrieved.

$sel:snapshotId:GetDeployablePatchSnapshotForInstance', getDeployablePatchSnapshotForInstance_snapshotId - The snapshot ID provided by the user when running AWS-RunPatchBaseline.

Request Lenses

getDeployablePatchSnapshotForInstance_baselineOverride :: Lens' GetDeployablePatchSnapshotForInstance (Maybe BaselineOverride) Source #

Defines the basic information about a patch baseline override.

getDeployablePatchSnapshotForInstance_instanceId :: Lens' GetDeployablePatchSnapshotForInstance Text Source #

The ID of the instance for which the appropriate patch snapshot should be retrieved.

getDeployablePatchSnapshotForInstance_snapshotId :: Lens' GetDeployablePatchSnapshotForInstance Text Source #

The snapshot ID provided by the user when running AWS-RunPatchBaseline.

Destructuring the Response

data GetDeployablePatchSnapshotForInstanceResponse Source #

See: newGetDeployablePatchSnapshotForInstanceResponse smart constructor.

Constructors

GetDeployablePatchSnapshotForInstanceResponse'

Fields

instanceId :: Maybe Text
The instance ID.
product :: Maybe Text
Returns the specific operating system (for example Windows Server 2012 or Amazon Linux 2015.09) on the instance for the specified patch snapshot.
snapshotDownloadUrl :: Maybe Text
A pre-signed Amazon Simple Storage Service (Amazon S3) URL that can be used to download the patch snapshot.
snapshotId :: Maybe Text
The user-defined snapshot ID.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newGetDeployablePatchSnapshotForInstanceResponse Source #

Arguments

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

Create a value of GetDeployablePatchSnapshotForInstanceResponse 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:instanceId:GetDeployablePatchSnapshotForInstance', getDeployablePatchSnapshotForInstanceResponse_instanceId - The instance ID.

$sel:product:GetDeployablePatchSnapshotForInstanceResponse', getDeployablePatchSnapshotForInstanceResponse_product - Returns the specific operating system (for example Windows Server 2012 or Amazon Linux 2015.09) on the instance for the specified patch snapshot.

$sel:snapshotDownloadUrl:GetDeployablePatchSnapshotForInstanceResponse', getDeployablePatchSnapshotForInstanceResponse_snapshotDownloadUrl - A pre-signed Amazon Simple Storage Service (Amazon S3) URL that can be used to download the patch snapshot.

$sel:snapshotId:GetDeployablePatchSnapshotForInstance', getDeployablePatchSnapshotForInstanceResponse_snapshotId - The user-defined snapshot ID.

$sel:httpStatus:GetDeployablePatchSnapshotForInstanceResponse', getDeployablePatchSnapshotForInstanceResponse_httpStatus - The response's http status code.

Response Lenses

getDeployablePatchSnapshotForInstanceResponse_instanceId :: Lens' GetDeployablePatchSnapshotForInstanceResponse (Maybe Text) Source #

The instance ID.

getDeployablePatchSnapshotForInstanceResponse_product :: Lens' GetDeployablePatchSnapshotForInstanceResponse (Maybe Text) Source #

Returns the specific operating system (for example Windows Server 2012 or Amazon Linux 2015.09) on the instance for the specified patch snapshot.

getDeployablePatchSnapshotForInstanceResponse_snapshotDownloadUrl :: Lens' GetDeployablePatchSnapshotForInstanceResponse (Maybe Text) Source #

A pre-signed Amazon Simple Storage Service (Amazon S3) URL that can be used to download the patch snapshot.

getDeployablePatchSnapshotForInstanceResponse_snapshotId :: Lens' GetDeployablePatchSnapshotForInstanceResponse (Maybe Text) Source #

The user-defined snapshot ID.

getDeployablePatchSnapshotForInstanceResponse_httpStatus :: Lens' GetDeployablePatchSnapshotForInstanceResponse Int Source #

The response's http status code.