Get Deployable Patch Snapshot For Instance

ssm_get_deployable_patch_snapshot_for_instance

R Documentation

Retrieves the current snapshot for the patch baseline the managed node uses

Description

Retrieves the current snapshot for the patch baseline the managed node 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 tool in Amazon Web Services Systems Manager, with an SSM document that enables you to target a managed node with a script or command. For example, run the command using the AWS-RunShellScript document or the AWS-RunPowerShellScript document.

Usage

ssm_get_deployable_patch_snapshot_for_instance(InstanceId, SnapshotId,
  BaselineOverride, UseS3DualStackEndpoint)

Arguments

InstanceId	[required] The ID of the managed node for which the appropriate patch snapshot should be retrieved.
SnapshotId	[required] The snapshot ID provided by the user when running AWS-RunPatchBaseline.
BaselineOverride	Defines the basic information about a patch baseline override.
UseS3DualStackEndpoint	Specifies whether to use S3 dualstack endpoints for the patch snapshot download URL. Set to true to receive a presigned URL that supports both IPv4 and IPv6 connectivity. Set to false to use standard IPv4-only endpoints. Default is false. This parameter is required for managed nodes in IPv6-only environments.

Value

A list with the following syntax:

list(
  InstanceId = "string",
  SnapshotId = "string",
  SnapshotDownloadUrl = "string",
  Product = "string"
)

Request syntax

svc$get_deployable_patch_snapshot_for_instance(
  InstanceId = "string",
  SnapshotId = "string",
  BaselineOverride = list(
    OperatingSystem = "WINDOWS"|"AMAZON_LINUX"|"AMAZON_LINUX_2"|"AMAZON_LINUX_2022"|"UBUNTU"|"REDHAT_ENTERPRISE_LINUX"|"SUSE"|"CENTOS"|"ORACLE_LINUX"|"DEBIAN"|"MACOS"|"RASPBIAN"|"ROCKY_LINUX"|"ALMA_LINUX"|"AMAZON_LINUX_2023",
    GlobalFilters = list(
      PatchFilters = list(
        list(
          Key = "ARCH"|"ADVISORY_ID"|"BUGZILLA_ID"|"PATCH_SET"|"PRODUCT"|"PRODUCT_FAMILY"|"CLASSIFICATION"|"CVE_ID"|"EPOCH"|"MSRC_SEVERITY"|"NAME"|"PATCH_ID"|"SECTION"|"PRIORITY"|"REPOSITORY"|"RELEASE"|"SEVERITY"|"SECURITY"|"VERSION",
          Values = list(
            "string"
          )
        )
      )
    ),
    ApprovalRules = list(
      PatchRules = list(
        list(
          PatchFilterGroup = list(
            PatchFilters = list(
              list(
                Key = "ARCH"|"ADVISORY_ID"|"BUGZILLA_ID"|"PATCH_SET"|"PRODUCT"|"PRODUCT_FAMILY"|"CLASSIFICATION"|"CVE_ID"|"EPOCH"|"MSRC_SEVERITY"|"NAME"|"PATCH_ID"|"SECTION"|"PRIORITY"|"REPOSITORY"|"RELEASE"|"SEVERITY"|"SECURITY"|"VERSION",
                Values = list(
                  "string"
                )
              )
            )
          ),
          ComplianceLevel = "CRITICAL"|"HIGH"|"MEDIUM"|"LOW"|"INFORMATIONAL"|"UNSPECIFIED",
          ApproveAfterDays = 123,
          ApproveUntilDate = "string",
          EnableNonSecurity = TRUE|FALSE
        )
      )
    ),
    ApprovedPatches = list(
      "string"
    ),
    ApprovedPatchesComplianceLevel = "CRITICAL"|"HIGH"|"MEDIUM"|"LOW"|"INFORMATIONAL"|"UNSPECIFIED",
    RejectedPatches = list(
      "string"
    ),
    RejectedPatchesAction = "ALLOW_AS_DEPENDENCY"|"BLOCK",
    ApprovedPatchesEnableNonSecurity = TRUE|FALSE,
    Sources = list(
      list(
        Name = "string",
        Products = list(
          "string"
        ),
        Configuration = "string"
      )
    ),
    AvailableSecurityUpdatesComplianceStatus = "COMPLIANT"|"NON_COMPLIANT"
  ),
  UseS3DualStackEndpoint = TRUE|FALSE
)