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 information about a patch baseline.
      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 '{
    "BaselineId": "string"
}'
      Response Response Example
      200 - Example 1
      {
    "BaselineId": "string",
    "Name": "string",
    "OperatingSystem": "WINDOWS",
    "GlobalFilters": {
        "PatchFilters": []
    },
    "ApprovalRules": {
        "PatchRules": []
    },
    "ApprovedPatches": [],
    "ApprovedPatchesComplianceLevel": "CRITICAL",
    "ApprovedPatchesEnableNonSecurity": true,
    "RejectedPatches": [],
    "RejectedPatchesAction": "ALLOW_AS_DEPENDENCY",
    "PatchGroups": [],
    "CreatedDate": "string",
    "ModifiedDate": "string",
    "Description": "string",
    "Sources": []
}

      Request

      Header Params
      X-Amz-Target
      string 
      required
      Body Params application/json
      BaselineId
      string 
      required
      The ID of the patch baseline to retrieve.
      >= 20 characters<= 128 characters
      Match pattern:
      ^[a-zA-Z0-9_\-:/]{20,128}$
      Examples

      Responses

      🟢200Success
      application/json
      Body
      BaselineId
      string 
      optional
      The ID of the retrieved patch baseline.
      >= 20 characters<= 128 characters
      Match pattern:
      ^[a-zA-Z0-9_\-:/]{20,128}$
      Name
      string 
      optional
      The name of the patch baseline.
      >= 3 characters<= 128 characters
      Match pattern:
      ^[a-zA-Z0-9_\-.]{3,128}$
      OperatingSystem
      enum<string> 
      optional
      Returns the operating system specified for the patch baseline.
      Allowed values:
      WINDOWSAMAZON_LINUXAMAZON_LINUX_2AMAZON_LINUX_2022UBUNTUREDHAT_ENTERPRISE_LINUXSUSECENTOSORACLE_LINUXDEBIANMACOSRASPBIANROCKY_LINUXALMA_LINUXAMAZON_LINUX_2023
      GlobalFilters
      object 
      optional
      A set of global filters used to exclude patches from the baseline.
      PatchFilters
      array [object] 
      required
      The set of patch filters that make up the group.
      >= 0 items<= 4 items
      ApprovalRules
      object 
      optional
      A set of rules used to include patches in the baseline.
      PatchRules
      array[object (PatchRule) {5}] 
      required
      The rules that make up the rule group.
      >= 0 items<= 10 items
      ApprovedPatches
      array[string]
      optional
      A list of explicitly approved patches for the baseline.
      >= 0 items<= 50 items
      ApprovedPatchesComplianceLevel
      enum<string> 
      optional
      Returns the specified compliance severity level for approved patches in the patch baseline.
      Allowed values:
      CRITICALHIGHMEDIUMLOWINFORMATIONALUNSPECIFIED
      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.
      RejectedPatches
      array[string]
      optional
      A list of explicitly rejected patches for the baseline.
      >= 0 items<= 50 items
      RejectedPatchesAction
      enum<string> 
      optional
      The action specified to take on patches included in the RejectedPatches 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
      PatchGroups
      array[string]
      optional
      Patch groups included in the patch baseline.
      CreatedDate
      string <date-time>
      optional
      The date the patch baseline was created.
      ModifiedDate
      string <date-time>
      optional
      The date the patch baseline was last modified.
      Description
      string 
      optional
      A description of the patch baseline.
      >= 1 characters<= 1024 characters
      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
      Name
      string 
      required
      The name specified to identify the patch source.
      Match pattern:
      ^[a-zA-Z0-9_\-.]{3,50}$
      Products
      array[string]
      required
      The specific operating system versions a patch repository applies to, such as "Ubuntu16.04", "AmazonLinux2016.09", "RedhatEnterpriseLinux7.2" or "Suse12.7". For lists of supported product values, see PatchFilter.
      >= 1 items<= 20 items
      Configuration
      string <password>
      required
      The value of the yum repo configuration. For example:
      [main]
      name=MyCustomRepository
      baseurl=https://my-custom-repository
      enabled=1
      >= 1 characters<= 1024 characters
      🟠480DoesNotExistException
      🟠481InvalidResourceId
      🟠482InternalServerError
      Previous
      /
      Next
      /
      Built with