Amazon Simple Systems Manager (SSM)
    Amazon Simple Systems Manager (SSM)
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST

      /

      The Amazon SSM multi-region endpoint
      http://ssm.{region}.amazonaws.com
      The Amazon SSM multi-region endpoint
      http://ssm.{region}.amazonaws.com
      POST
      /
      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).
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "InstanceId": "string",
    "SnapshotId": "string",
    "BaselineOverride": {
        "OperatingSystem": "WINDOWS",
        "GlobalFilters": {
            "PatchFilters": []
        },
        "ApprovalRules": {
            "PatchRules": []
        },
        "ApprovedPatches": [],
        "ApprovedPatchesComplianceLevel": "CRITICAL",
        "RejectedPatches": [],
        "RejectedPatchesAction": "ALLOW_AS_DEPENDENCY",
        "ApprovedPatchesEnableNonSecurity": true,
        "Sources": []
    }
}'
      Response Response Example
      200 - Example 1
      {
    "InstanceId": "string",
    "SnapshotId": "string",
    "SnapshotDownloadUrl": "string",
    "Product": "string"
}

      Request

      Header Params
      X-Amz-Target
      string 
      required
      Body Params application/json
      InstanceId
      string 
      required
      The ID of the managed node for which the appropriate patch snapshot should be retrieved.
      Match pattern:
      (^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)
      SnapshotId
      string 
      required
      The snapshot ID provided by the user when running AWS-RunPatchBaseline.
      >= 36 characters<= 36 characters
      Match pattern:
      ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
      BaselineOverride
      object 
      optional
      Defines the basic information about a patch baseline override.
      OperatingSystem
      enum<string> 
      optional
      The operating system rule used by the patch baseline override.
      Allowed values:
      WINDOWSAMAZON_LINUXAMAZON_LINUX_2AMAZON_LINUX_2022UBUNTUREDHAT_ENTERPRISE_LINUXSUSECENTOSORACLE_LINUXDEBIANMACOSRASPBIANROCKY_LINUXALMA_LINUXAMAZON_LINUX_2023
      GlobalFilters
      object 
      PatchFilterGroup
      optional
      A set of patch filters, typically used for approval rules.
      ApprovalRules
      object 
      PatchRuleGroup
      optional
      A set of rules defining the approval rules for a patch baseline.
      ApprovedPatches
      array[string]
      optional
      A list of explicitly approved patches for the baseline.
      For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.
      >= 0 items<= 50 items
      ApprovedPatchesComplianceLevel
      enum<string> 
      optional
      Defines the compliance level for approved patches. When an approved patch is reported as missing, this value describes the severity of the compliance violation.
      Allowed values:
      CRITICALHIGHMEDIUMLOWINFORMATIONALUNSPECIFIED
      RejectedPatches
      array[string]
      optional
      A list of explicitly rejected patches for the baseline.
      For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.
      >= 0 items<= 50 items
      RejectedPatchesAction
      enum<string> 
      optional
      The action for Patch Manager to take on patches included in the RejectedPackages list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency.
      Allowed values:
      ALLOW_AS_DEPENDENCYBLOCK
      ApprovedPatchesEnableNonSecurity
      boolean 
      optional
      Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. The default value is false. Applies to Linux managed nodes only.
      Sources
      array[object (PatchSource) {3}] 
      optional
      Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.
      >= 0 items<= 20 items
      Examples

      Responses

      🟢200Success
      application/json
      Body
      InstanceId
      string 
      optional
      The managed node ID.
      Match pattern:
      (^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)
      SnapshotId
      string 
      optional
      The user-defined snapshot ID.
      >= 36 characters<= 36 characters
      Match pattern:
      ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
      SnapshotDownloadUrl
      string 
      optional
      A pre-signed Amazon Simple Storage Service (Amazon S3) URL that can be used to download the patch snapshot.
      Product
      string 
      optional
      Returns the specific operating system (for example Windows Server 2012 or Amazon Linux 2015.09) on the managed node for the specified patch snapshot.
      🟠480InternalServerError
      🟠481UnsupportedOperatingSystem
      🟠482UnsupportedFeatureRequiredException
      Previous
      /
      Next
      /
      Built with