ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: usr / local / jetapps / var / lib / aws / lib / python2.7 / site-packages / awscli / examples / ssm

**To get the contents of a document**

This example returns the content of a document.

Command::

aws ssm get-document --name "RunShellScript"

Output::

{
    "Content": "{\n   \"schemaVersion\":\"2.0\",\n   \"description\":\"Run a script\",\n   \"parameters\":{\n      \"commands\":{\n         \"type\":\"StringList\",\n         \"description\":\"(Required) Specify a shell script or a command to run.\",\n         \"minItems\":1,\n         \"displayType\":\"textarea\"\n      }\n   },\n   \"mainSteps\":[\n      {\n         \"action\":\"aws:runShellScript\",\n         \"name\":\"runShellScript\",\n         \"inputs\":{\n            \"commands\":\"{{ commands }}\"\n         }\n      },\n      {\n         \"action\":\"aws:runPowerShellScript\",\n         \"name\":\"runPowerShellScript\",\n         \"inputs\":{\n            \"commands\":\"{{ commands }}\"\n         }\n      }\n   ]\n}\n",
    "Name": "RunShellScript.json",
    "DocumentVersion": "1",
    "DocumentType": "Command"
  }

**To get the contents of a document in YAML format**

This example returns the content of a document in YAML format.

Command::

aws ssm get-document --name "RunShellScript" --document-format YAML

Output::

{
    "Name": "A-Document-yaml2",
    "DocumentVersion": "1",
    "Status": "Active",
    "Content": "---\nschemaVersion: '1.2'\ndescription: Run a PowerShell script or specify the paths to scripts to run.\nparameters:\n  commands:\n    type: StringList\n    description: \"(Required) Specify the commands to run or the paths to existing\n      scripts on the instance.\"\n    minItems: 1\n    displayType: textarea\n  workingDirectory:\n    type: String\n    default: ''\n    description: \"(Optional) The path to the working directory on your instance.\"\n    maxChars: 4096\n  executionTimeout:\n    type: String\n    default: '3600'\n    description: \"(Optional) The time in seconds for a command to be completed before\n      it is considered to have failed. Default is 3600 (1 hour). Maximum is 172800\n      (48 hours).\"\n    allowedPattern: \"([1-9][0-9]{0,4})|(1[0-6][0-9]{4})|(17[0-1][0-9]{3})|(172[0-7][0-9]{2})|(172800)\"\nruntimeConfig:\n  aws:runPowerShellScript:\n    properties:\n    - id: 0.aws:runPowerShellScript\n      runCommand: \"{{ commands }}\"\n      workingDirectory: \"{{ workingDirectory }}\"\n      timeoutSeconds: \"{{ executionTimeout }}\"\n",
    "DocumentType": "Command",
    "DocumentFormat": "YAML"
  }

[+] ..
[-] list-compliance-items.rst [edit]
[-] list-command-invocations.rst [edit]
[-] describe-automation-step-executions.rst [edit]
[-] update-service-setting.rst [edit]
[-] get-parameters.rst [edit]
[-] send-automation-signal.rst [edit]
[-] get-service-setting.rst [edit]
[-] describe-maintenance-windows.rst [edit]
[-] create-maintenance-window.rst [edit]
[-] put-parameter.rst [edit]
[-] delete-maintenance-window.rst [edit]
[-] get-maintenance-window-task.rst [edit]
[-] describe-association-execution-targets.rst [edit]
[-] delete-inventory.rst [edit]
[-] describe-patch-baselines.rst [edit]
[-] list-associations.rst [edit]
[-] get-maintenance-window-execution-task-invocation.rst [edit]
[-] get-parameters-by-path.rst [edit]
[-] get-parameter-history.rst [edit]
[-] start-session.rst [edit]
[-] update-maintenance-window-target.rst [edit]
[-] get-default-patch-baseline.rst [edit]
[-] describe-sessions.rst [edit]
[-] put-inventory.rst [edit]
[-] list-document-versions.rst [edit]
[-] describe-instance-patch-states-for-patch-group.rst [edit]
[-] describe-effective-patches-for-patch-baseline.rst [edit]
[-] describe-maintenance-window-execution-tasks.rst [edit]
[-] describe-association.rst [edit]
[-] describe-effective-instance-associations.rst [edit]
[-] describe-document-permission.rst [edit]
[-] delete-association.rst [edit]
[-] update-patch-baseline.rst [edit]
[-] describe-instance-associations-status.rst [edit]
[-] list-resource-data-sync.rst [edit]
[-] describe-maintenance-window-tasks.rst [edit]
[-] describe-document.rst [edit]
[-] register-target-with-maintenance-window.rst [edit]
[-] remove-tags-from-resource.rst [edit]
[-] get-inventory.rst [edit]
[-] delete-document.rst [edit]
[-] list-compliance-summaries.rst [edit]
[-] resume-session.rst [edit]
[-] put-compliance-items.rst [edit]
[-] create-association-batch.rst [edit]
[-] delete-parameters.rst [edit]
[-] delete-activation.rst [edit]
[-] stop-automation-execution.rst [edit]
[-] describe-maintenance-window-targets.rst [edit]
[-] create-association.rst [edit]
[-] update-maintenance-window.rst [edit]
[-] update-document-default-version.rst [edit]
[-] delete-resource-data-sync.rst [edit]
[-] list-inventory-entries.rst [edit]
[-] describe-maintenance-windows-for-target.rst [edit]
[-] describe-maintenance-window-schedule.rst [edit]
[-] create-patch-baseline.rst [edit]
[-] describe-patch-groups.rst [edit]
[-] describe-parameters.rst [edit]
[-] get-parameter.rst [edit]
[-] get-inventory-schema.rst [edit]
[-] start-automation-execution.rst [edit]
[-] cancel-command.rst [edit]
[-] list-tags-for-resource.rst [edit]
[-] get-automation-execution.rst [edit]
[-] get-patch-baseline-for-patch-group.rst [edit]
[-] create-activation.rst [edit]
[-] describe-maintenance-window-executions.rst [edit]
[-] list-documents.rst [edit]
[-] register-task-with-maintenance-window.rst [edit]
[-] deregister-target-from-maintenance-window.rst [edit]
[-] get-deployable-patch-snapshot-for-instance.rst [edit]
[-] describe-association-executions.rst [edit]
[-] describe-activations.rst [edit]
[-] update-association.rst [edit]
[-] terminate-session.rst [edit]
[-] deregister-managed-instance.rst [edit]
[-] create-resource-data-sync.rst [edit]
[-] describe-instance-information.rst [edit]
[-] update-managed-instance-role.rst [edit]
[-] get-document.rst [edit]
[-] list-resource-compliance-summaries.rst [edit]
[-] register-default-patch-baseline.rst [edit]
[-] describe-maintenance-window-execution-task-invocations.rst [edit]
[-] deregister-patch-baseline-for-patch-group.rst [edit]
[-] get-maintenance-window-execution-task.rst [edit]
[-] register-patch-baseline-for-patch-group.rst [edit]
[-] create-document.rst [edit]
[-] update-document.rst [edit]
[-] update-association-status.rst [edit]
[-] list-association-versions.rst [edit]
[-] list-commands.rst [edit]
[-] update-maintenance-window-task.rst [edit]
[-] describe-instance-patch-states.rst [edit]
[-] describe-instance-patches.rst [edit]
[-] label-parameter-version.rst [edit]
[-] describe-inventory-deletions.rst [edit]
[-] describe-automation-executions.rst [edit]
[-] get-command-invocation.rst [edit]
[-] get-maintenance-window-execution.rst [edit]
[-] deregister-task-from-maintenance-window.rst [edit]
[-] start-associations-once.rst [edit]
[-] send-command.rst [edit]
[-] get-patch-baseline.rst [edit]
[-] add-tags-to-resource.rst [edit]
[-] get-maintenance-window.rst [edit]
[-] cancel-maintenance-window-execution.rst [edit]
[-] modify-document-permission.rst [edit]
[-] get-connection-status.rst [edit]
[-] delete-patch-baseline.rst [edit]
[-] delete-parameter.rst [edit]
[-] describe-available-patches.rst [edit]
[-] describe-patch-group-state.rst [edit]