を使用した Systems Manager の例 AWS CLI - AWS SDK コード例

Doc AWS SDK Examples リポジトリには、他にも SDK の例があります。 AWS GitHub

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

を使用した Systems Manager の例 AWS CLI

次のコード例は、Systems Manager AWS Command Line Interface で を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。

アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、関連するシナリオやサービス間の例ではアクションのコンテキストが確認できます。

「シナリオ」は、同じサービス内で複数の関数を呼び出して、特定のタスクを実行する方法を示すコード例です。

各例には、 へのリンクが含まれています。このリンクには GitHub、コンテキスト内でコードをセットアップして実行する方法の手順が記載されています。

トピック

アクション

次の例は、add-tags-to-resource を使用する方法を説明しています。

AWS CLI

例 1: メンテナンスウィンドウにタグを追加するには

次のadd-tags-to-resource例では、指定したメンテナンスウィンドウにタグを追加します。

aws ssm add-tags-to-resource \ --resource-type "MaintenanceWindow" \ --resource-id "mw-03eb9db428EXAMPLE" \ --tags "Key=Stack,Value=Production"

このコマンドでは何も出力されません。

例 2: パラメータにタグを追加するには

次のadd-tags-to-resource例では、指定したパラメータに 2 つのタグを追加します。

aws ssm add-tags-to-resource \ --resource-type "Parameter" \ --resource-id "My-Parameter" \ --tags '[{"Key":"Region","Value":"East"},{"Key":"Environment", "Value":"Production"}]'

このコマンドでは何も出力されません。

例 3: SSM ドキュメントにタグを追加するには

次のadd-tags-to-resource例では、指定したドキュメントにタグを に追加します。

aws ssm add-tags-to-resource \ --resource-type "Document" \ --resource-id "My-Document" \ --tags "Key=Quarter,Value=Q322"

このコマンドでは何も出力されません。

詳細については、「Systems Manager ユーザーガイド」の「Systems Manager リソースのタグ付け」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスAddTagsToResource」の「」を参照してください。 AWS CLI

次の例は、associate-ops-item-related-item を使用する方法を説明しています。

AWS CLI

関連項目を関連付けるには

次のassociate-ops-item-related-item例では、関連項目を に関連付けます OpsItem。

aws ssm associate-ops-item-related-item \ --ops-item-id "oi-649fExample" \ --association-type "RelatesTo" \ --resource-type "AWS::SSMIncidents::IncidentRecord" \ --resource-uri "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/c2bde883-f7d5-343a-b13a-bf5fe9ea689f"

出力:

{ "AssociationId": "61d7178d-a30d-4bc5-9b4e-a9e74EXAMPLE" }

詳細については、「Systems Manager ユーザーガイド」の「 での Incident Manager インシデント OpsCenterの使用」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスAssociateOpsItemRelatedItem」の「」を参照してください。 AWS CLI

次の例は、cancel-command を使用する方法を説明しています。

AWS CLI

例 1: すべてのインスタンスのコマンドをキャンセルするには

次のcancel-command例では、すべてのインスタンスで既に実行されている指定されたコマンドをキャンセルしようとします。

aws ssm cancel-command \ --command-id "662add3d-5831-4a10-b64a-f2ff3EXAMPLE"

このコマンドでは何も出力されません。

例 2: 特定のインスタンスのコマンドをキャンセルするには

次のcancel-command例では、指定したインスタンスに対してのみコマンドをキャンセルしようとします。

aws ssm cancel-command \ --command-id "662add3d-5831-4a10-b64a-f2ff3EXAMPLE" --instance-ids "i-02573cafcfEXAMPLE"

このコマンドでは何も出力されません。

詳細については、「Systems Manager ユーザーガイド」の「Systems Manager パラメータのタグ付け」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスCancelCommand」の「」を参照してください。 AWS CLI

次の例は、cancel-maintenance-window-execution を使用する方法を説明しています。

AWS CLI

メンテナンスウィンドウの実行をキャンセルするには

cancel-maintenance-window-execution この例では、既に進行中の指定されたメンテナンスウィンドウの実行を停止します。

aws ssm cancel-maintenance-window-execution \ --window-execution-id j2l8d5b5c-mw66-tk4d-r3g9-1d4d1EXAMPLE

出力:

{ "WindowExecutionId": "j2l8d5b5c-mw66-tk4d-r3g9-1d4d1EXAMPLE" }

詳細については、「Systems Manager ユーザーガイド」の「Systems Manager メンテナンスウィンドウのチュートリアル (AWS CLI)」を参照してください。 AWS

次の例は、create-activation を使用する方法を説明しています。

AWS CLI

マネージドインスタンスのアクティベーションを作成するには

次のcreate-activation例では、マネージドインスタンスのアクティベーションを作成します。

aws ssm create-activation \ --default-instance-name "HybridWebServers" \ --iam-role "HybridWebServersRole" \ --registration-limit 5

出力:

{ "ActivationId": "5743558d-563b-4457-8682-d16c3EXAMPLE", "ActivationCode": "dRmgnYaFv567vEXAMPLE" }

詳細については、AWS 「Systems Manager ユーザーガイド」の「ステップ 4: ハイブリッド環境のマネージドインスタンスのアクティベーションを作成する」を参照してください。

  • API の詳細については、「 コマンドリファレンスCreateActivation」の「」を参照してください。 AWS CLI

次の例は、create-association-batch を使用する方法を説明しています。

AWS CLI

複数の関連付けを作成するには

この例では、設定ドキュメントを複数のインスタンスに関連付けます。出力は、該当する場合、成功したオペレーションと失敗したオペレーションのリストを返します。

コマンド:

aws ssm create-association-batch --entries "Name=AWS-UpdateSSMAgent,InstanceId=i-1234567890abcdef0" "Name=AWS-UpdateSSMAgent,InstanceId=i-9876543210abcdef0"

出力:

{ "Successful": [ { "Name": "AWS-UpdateSSMAgent", "InstanceId": "i-1234567890abcdef0", "AssociationVersion": "1", "Date": 1550504725.007, "LastUpdateAssociationDate": 1550504725.007, "Status": { "Date": 1550504725.007, "Name": "Associated", "Message": "Associated with AWS-UpdateSSMAgent" }, "Overview": { "Status": "Pending", "DetailedStatus": "Creating" }, "DocumentVersion": "$DEFAULT", "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "Targets": [ { "Key": "InstanceIds", "Values": [ "i-1234567890abcdef0" ] } ] }, { "Name": "AWS-UpdateSSMAgent", "InstanceId": "i-9876543210abcdef0", "AssociationVersion": "1", "Date": 1550504725.057, "LastUpdateAssociationDate": 1550504725.057, "Status": { "Date": 1550504725.057, "Name": "Associated", "Message": "Associated with AWS-UpdateSSMAgent" }, "Overview": { "Status": "Pending", "DetailedStatus": "Creating" }, "DocumentVersion": "$DEFAULT", "AssociationId": "9c9f7f20-5154-4fed-a83e-0123456789ab", "Targets": [ { "Key": "InstanceIds", "Values": [ "i-9876543210abcdef0" ] } ] } ], "Failed": [] }
  • API の詳細については、「 コマンドリファレンスCreateAssociationBatch」の「」を参照してください。 AWS CLI

次の例は、create-association を使用する方法を説明しています。

AWS CLI

例 1: インスタンス IDs

この例では、インスタンス IDs。

aws ssm create-association \ --instance-id "i-0cb2b964d3e14fd9f" \ --name "AWS-UpdateSSMAgent"

出力:

{ "AssociationDescription": { "Status": { "Date": 1487875500.33, "Message": "Associated with AWS-UpdateSSMAgent", "Name": "Associated" }, "Name": "AWS-UpdateSSMAgent", "InstanceId": "i-0cb2b964d3e14fd9f", "Overview": { "Status": "Pending", "DetailedStatus": "Creating" }, "AssociationId": "b7c3266e-a544-44db-877e-b20d3a108189", "DocumentVersion": "$DEFAULT", "LastUpdateAssociationDate": 1487875500.33, "Date": 1487875500.33, "Targets": [ { "Values": [ "i-0cb2b964d3e14fd9f" ], "Key": "InstanceIds" } ] } }

詳細については、AWS 「Systems Manager API リファレンスCreateAssociation」の「」を参照してください。

例 2: ターゲットを使用してドキュメントを関連付けるには

この例では、ターゲットを使用して設定ドキュメントをインスタンスに関連付けます。

aws ssm create-association \ --name "AWS-UpdateSSMAgent" \ --targets "Key=instanceids,Values=i-0cb2b964d3e14fd9f"

出力:

{ "AssociationDescription": { "Status": { "Date": 1487875500.33, "Message": "Associated with AWS-UpdateSSMAgent", "Name": "Associated" }, "Name": "AWS-UpdateSSMAgent", "InstanceId": "i-0cb2b964d3e14fd9f", "Overview": { "Status": "Pending", "DetailedStatus": "Creating" }, "AssociationId": "b7c3266e-a544-44db-877e-b20d3a108189", "DocumentVersion": "$DEFAULT", "LastUpdateAssociationDate": 1487875500.33, "Date": 1487875500.33, "Targets": [ { "Values": [ "i-0cb2b964d3e14fd9f" ], "Key": "InstanceIds" } ] } }

詳細については、AWS 「Systems Manager API リファレンスCreateAssociation」の「」を参照してください。

例 3: 1 回だけ実行される関連付けを作成するには

この例では、指定した日時にのみ 1 回だけ実行される新しい関連付けを作成します。過去または現在の日付で作成された関連付け (処理されるまで日付は過去のものです) は、ただちに実行されます。

aws ssm create-association \ --name "AWS-UpdateSSMAgent" \ --targets "Key=instanceids,Values=i-0cb2b964d3e14fd9f" \ --schedule-expression "at(2020-05-14T15:55:00)" \ --apply-only-at-cron-interval

出力:

{ "AssociationDescription": { "Status": { "Date": 1487875500.33, "Message": "Associated with AWS-UpdateSSMAgent", "Name": "Associated" }, "Name": "AWS-UpdateSSMAgent", "InstanceId": "i-0cb2b964d3e14fd9f", "Overview": { "Status": "Pending", "DetailedStatus": "Creating" }, "AssociationId": "b7c3266e-a544-44db-877e-b20d3a108189", "DocumentVersion": "$DEFAULT", "LastUpdateAssociationDate": 1487875500.33, "Date": 1487875500.33, "Targets": [ { "Values": [ "i-0cb2b964d3e14fd9f" ], "Key": "InstanceIds" } ] } }

詳細については、AWS 「Systems Manager API リファレンスCreateAssociation」の「」または「Systems Manager ユーザーガイド」の「Systems Manager の cron 式と rate 式」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスCreateAssociation」の「」を参照してください。 AWS CLI

次の例は、create-document を使用する方法を説明しています。

AWS CLI

ドキュメントを作成するには

次のcreate-document例では、Systems Manager ドキュメントを作成します。

aws ssm create-document \ --content file://exampleDocument.yml \ --name "Example" \ --document-type "Automation" \ --document-format YAML

出力:

{ "DocumentDescription": { "Hash": "fc2410281f40779e694a8b95975d0f9f316da8a153daa94e3d9921102EXAMPLE", "HashType": "Sha256", "Name": "Example", "Owner": "29884EXAMPLE", "CreatedDate": 1583256349.452, "Status": "Creating", "DocumentVersion": "1", "Description": "Document Example", "Parameters": [ { "Name": "AutomationAssumeRole", "Type": "String", "Description": "(Required) The ARN of the role that allows Automation to perform the actions on your behalf. If no role is specified, Systems Manager Automation uses your IAM permissions to execute this document.", "DefaultValue": "" }, { "Name": "InstanceId", "Type": "String", "Description": "(Required) The ID of the Amazon EC2 instance.", "DefaultValue": "" } ], "PlatformTypes": [ "Windows", "Linux" ], "DocumentType": "Automation", "SchemaVersion": "0.3", "LatestVersion": "1", "DefaultVersion": "1", "DocumentFormat": "YAML", "Tags": [] } }

詳細については、「Systems Manager ユーザーガイド」の「Systems Manager ドキュメントAWS の作成」を参照してください。

  • API の詳細については、「 コマンドリファレンスCreateDocument」の「」を参照してください。 AWS CLI

次の例は、create-maintenance-window を使用する方法を説明しています。

AWS CLI

例 1: メンテナンスウィンドウを作成するには

次のcreate-maintenance-window例では、(必要に応じて) 5 分ごとに最大 2 時間、メンテナンスウィンドウの実行終了から 1 時間以内に新しいタスクが開始されないようにする新しいメンテナンスウィンドウを作成し、関連付けられていないターゲット (メンテナンスウィンドウに登録されていないインスタンス) を許可し、作成者がチュートリアルで使用するカスタムタグの使用を示します。

aws ssm create-maintenance-window \ --name "My-Tutorial-Maintenance-Window" \ --schedule "rate(5 minutes)" \ --duration 2 --cutoff 1 \ --allow-unassociated-targets \ --tags "Key=Purpose,Value=Tutorial"

出力:

{ "WindowId": "mw-0c50858d01EXAMPLE" }

例 2: 1 回だけ実行されるメンテナンスウィンドウを作成するには

次のcreate-maintenance-window例では、指定した日時で 1 回だけ実行される新しいメンテナンスウィンドウを作成します。

aws ssm create-maintenance-window \ --name My-One-Time-Maintenance-Window \ --schedule "at(2020-05-14T15:55:00)" \ --duration 5 \ --cutoff 2 \ --allow-unassociated-targets \ --tags "Key=Environment,Value=Production"

出力:

{ "WindowId": "mw-01234567890abcdef" }

詳細については、「Systems Manager ユーザーガイド」の「メンテナンスウィンドウ」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスCreateMaintenanceWindow」の「」を参照してください。 AWS CLI

次の例は、create-ops-item を使用する方法を説明しています。

AWS CLI

を作成するには OpsItems

次のcreate-ops-item例では、 で /aws/resources キーを使用して OperationalData 、Amazon DynamoDB 関連リソース OpsItem を持つ を作成します。

aws ssm create-ops-item \ --title "EC2 instance disk full" \ --description "Log clean up may have failed which caused the disk to be full" \ --priority 2 \ --source ec2 \ --operational-data '{"/aws/resources":{"Value":"[{\"arn\": \"arn:aws:dynamodb:us-west-2:12345678:table/OpsItems\"}]","Type":"SearchableString"}}' \ --notifications Arn="arn:aws:sns:us-west-2:12345678:TestUser"

出力:

{ "OpsItemId": "oi-1a2b3c4d5e6f" }

詳細については、「Systems Manager ユーザーガイド」の「 の作成 OpsItems」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスCreateOpsItem」の「」を参照してください。 AWS CLI

次の例は、create-patch-baseline を使用する方法を説明しています。

AWS CLI

例 1: 自動承認を使用してパッチベースラインを作成するには

次のcreate-patch-baseline例では、Microsoft がリリースしてから 7 日後に実稼働環境のパッチを承認する Windows Server のパッチベースラインを作成します。

aws ssm create-patch-baseline \ --name "Windows-Production-Baseline-AutoApproval" \ --operating-system "WINDOWS" \ --approval-rules "PatchRules=[{PatchFilterGroup={PatchFilters=[{Key=MSRC_SEVERITY,Values=[Critical,Important,Moderate]},{Key=CLASSIFICATION,Values=[SecurityUpdates,Updates,UpdateRollups,CriticalUpdates]}]},ApproveAfterDays=7}]" \ --description "Baseline containing all updates approved for Windows Server production systems"

出力:

{ "BaselineId": "pb-045f10b4f3EXAMPLE" }

例 2: 承認期限日を使用してパッチベースラインを作成するには

次のcreate-patch-baseline例では、2020 年 7 月 7 日以前にリリースされた実稼働環境のすべてのパッチを承認する Windows Server のパッチベースラインを作成します。

aws ssm create-patch-baseline \ --name "Windows-Production-Baseline-AutoApproval" \ --operating-system "WINDOWS" \ --approval-rules "PatchRules=[{PatchFilterGroup={PatchFilters=[{Key=MSRC_SEVERITY,Values=[Critical,Important,Moderate]},{Key=CLASSIFICATION,Values=[SecurityUpdates,Updates,UpdateRollups,CriticalUpdates]}]},ApproveUntilDate=2020-07-07}]" \ --description "Baseline containing all updates approved for Windows Server production systems"

出力:

{ "BaselineId": "pb-045f10b4f3EXAMPLE" }

例 3: 承認ルールを JSON ファイルに保存してパッチベースラインを作成するには

次のcreate-patch-baseline例では、リリースされてから 7 日後に実稼働環境のパッチを承認する Amazon Linux 2017.09 のパッチベースラインを作成し、パッチベースラインの承認ルールを指定して、パッチのカスタムリポジトリを指定します。

aws ssm create-patch-baseline \ --cli-input-json file://my-amazon-linux-approval-rules-and-repo.json

my-amazon-linux-approval-rules-and-repo.json の内容:

{ "Name": "Amazon-Linux-2017.09-Production-Baseline", "Description": "My approval rules patch baseline for Amazon Linux 2017.09 instances", "OperatingSystem": "AMAZON_LINUX", "Tags": [ { "Key": "Environment", "Value": "Production" } ], "ApprovalRules": { "PatchRules": [ { "ApproveAfterDays": 7, "EnableNonSecurity": true, "PatchFilterGroup": { "PatchFilters": [ { "Key": "SEVERITY", "Values": [ "Important", "Critical" ] }, { "Key": "CLASSIFICATION", "Values": [ "Security", "Bugfix" ] }, { "Key": "PRODUCT", "Values": [ "AmazonLinux2017.09" ] } ] } } ] }, "Sources": [ { "Name": "My-AL2017.09", "Products": [ "AmazonLinux2017.09" ], "Configuration": "[amzn-main] \nname=amzn-main-Base\nmirrorlist=http://repo./$awsregion./$awsdomain//$releasever/main/mirror.list //nmirrorlist_expire=300//nmetadata_expire=300 \npriority=10 \nfailovermethod=priority \nfastestmirror_enabled=0 \ngpgcheck=1 \ngpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-amazon-ga \nenabled=1 \nretries=3 \ntimeout=5\nreport_instanceid=yes" } ] }

例 4: 承認されたパッチと拒否されたパッチを指定するパッチベースラインを作成するには

次のcreate-patch-baseline例では、デフォルトの承認ルールの例外として承認および拒否するパッチを明示的に指定しています。

aws ssm create-patch-baseline \ --name "Amazon-Linux-2017.09-Alpha-Baseline" \ --description "My custom approve/reject patch baseline for Amazon Linux 2017.09 instances" \ --operating-system "AMAZON_LINUX" \ --approved-patches "CVE-2018-1234567,example-pkg-EE-2018*.amzn1.noarch" \ --approved-patches-compliance-level "HIGH" \ --approved-patches-enable-non-security \ --tags "Key=Environment,Value=Alpha"

詳細については、「Systems Manager ユーザーガイド」の「カスタムパッチベースラインの作成」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスCreatePatchBaseline」の「」を参照してください。 AWS CLI

次の例は、create-resource-data-sync を使用する方法を説明しています。

AWS CLI

リソースデータ同期を作成するには

この例では、リソースデータ同期を作成します。コマンドが成功した場合、出力はありません。

コマンド:

aws ssm create-resource-data-sync --sync-name "ssm-resource-data-sync" --s3-destination "BucketName=ssm-bucket,Prefix=inventory,SyncFormat=JsonSerDe,Region=us-east-1"
  • API の詳細については、「 コマンドリファレンスCreateResourceDataSync」の「」を参照してください。 AWS CLI

次の例は、delete-activation を使用する方法を説明しています。

AWS CLI

マネージドインスタンスのアクティベーションを削除するには

次のdelete-activation例では、マネージドインスタンスのアクティベーションを削除します。

aws ssm delete-activation \ --activation-id "aa673477-d926-42c1-8757-1358cEXAMPLE"

このコマンドでは何も出力されません。

詳細については、AWS 「Systems Manager ユーザーガイド」の「ハイブリッド環境用の Systems Manager のセットアップ」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスDeleteActivation」の「」を参照してください。 AWS CLI

次の例は、delete-association を使用する方法を説明しています。

AWS CLI

例 1: 関連付け ID を使用して関連付けを削除するには

次のdelete-association例では、指定した関連付け ID の関連付けを削除します。コマンドが成功した場合、出力はありません。

aws ssm delete-association \ --association-id "8dfe3659-4309-493a-8755-0123456789ab"

このコマンドでは何も出力されません。

詳細については、「Systems Manager ユーザーガイド」の「関連付けの編集と新しいバージョンの作成」を参照してください。 AWS

例 2: 関連付けを削除するには

次のdelete-association例では、インスタンスとドキュメント間の関連付けを削除します。コマンドが成功した場合、出力はありません。

aws ssm delete-association \ --instance-id "i-1234567890abcdef0" \ --name "AWS-UpdateSSMAgent"

このコマンドでは何も出力されません。

詳細については、「Systems Manager ユーザーガイド」の「Systems Manager での関連付けの使用」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスDeleteAssociation」の「」を参照してください。 AWS CLI

次の例は、delete-document を使用する方法を説明しています。

AWS CLI

ドキュメントを削除するには

次のdelete-document例では、Systems Manager ドキュメントを削除します。

aws ssm delete-document \ --name "Example"

このコマンドでは何も出力されません。

詳細については、「Systems Manager ユーザーガイド」の「Systems Manager ドキュメントAWS の作成」を参照してください。

  • API の詳細については、「 コマンドリファレンスDeleteDocument」の「」を参照してください。 AWS CLI

次の例は、delete-inventory を使用する方法を説明しています。

AWS CLI

カスタムインベントリタイプを削除するには

この例では、カスタムインベントリスキーマを削除します。

コマンド:

aws ssm delete-inventory --type-name "Custom:RackInfo" --schema-delete-option "DeleteSchema"

出力:

{ "DeletionId": "d72ac9e8-1f60-4d40-b1c6-bf8c78c68c4d", "TypeName": "Custom:RackInfo", "DeletionSummary": { "TotalCount": 1, "RemainingCount": 1, "SummaryItems": [ { "Version": "1.0", "Count": 1, "RemainingCount": 1 } ] } }

カスタムインベントリタイプを無効にするには

この例では、カスタムインベントリスキーマを無効にします。

コマンド:

aws ssm delete-inventory --type-name "Custom:RackInfo" --schema-delete-option "DisableSchema"

出力:

{ "DeletionId": "6961492a-8163-44ec-aa1e-923364dd0850", "TypeName": "Custom:RackInformation", "DeletionSummary": { "TotalCount": 0, "RemainingCount": 0, "SummaryItems": [] } }
  • API の詳細については、「 コマンドリファレンスDeleteInventory」の「」を参照してください。 AWS CLI

次の例は、delete-maintenance-window を使用する方法を説明しています。

AWS CLI

メンテナンスウィンドウを削除するには

delete-maintenance-window この例では、指定されたメンテナンスウィンドウを削除します。

aws ssm delete-maintenance-window \ --window-id "mw-1a2b3c4d5e6f7g8h9"

出力:

{ "WindowId":"mw-1a2b3c4d5e6f7g8h9" }

詳細については、「Systems Manager ユーザーガイド」の「メンテナンスウィンドウの削除 (AWS CLI)」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスDeleteMaintenanceWindow」の「」を参照してください。 AWS CLI

次の例は、delete-parameter を使用する方法を説明しています。

AWS CLI

パラメータを削除するには

次のdelete-parameter例では、指定された単一のパラメータを削除します。

aws ssm delete-parameter \ --name "MyParameter"

このコマンドでは何も出力されません。

詳細については、「Systems Manager ユーザーガイド」の「パラメータストアの使用」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスDeleteParameter」の「」を参照してください。 AWS CLI

次の例は、delete-parameters を使用する方法を説明しています。

AWS CLI

パラメータのリストを削除するには

次のdelete-parameters例では、指定されたパラメータを削除します。

aws ssm delete-parameters \ --names "MyFirstParameter" "MySecondParameter" "MyInvalidParameterName"

出力:

{ "DeletedParameters": [ "MyFirstParameter", "MySecondParameter" ], "InvalidParameters": [ "MyInvalidParameterName" ] }

詳細については、「Systems Manager ユーザーガイド」の「パラメータストアの使用」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスDeleteParameters」の「」を参照してください。 AWS CLI

次の例は、delete-patch-baseline を使用する方法を説明しています。

AWS CLI

パッチベースラインを削除するには

次のdelete-patch-baseline例では、指定されたパッチベースラインを削除します。

aws ssm delete-patch-baseline \ --baseline-id "pb-045f10b4f382baeda"

出力:

{ "BaselineId": "pb-045f10b4f382baeda" }

詳細については、「Systems Manager ユーザーガイド」の「パッチベースラインの更新または削除 (コンソール)」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスDeletePatchBaseline」の「」を参照してください。 AWS CLI

次の例は、delete-resource-data-sync を使用する方法を説明しています。

AWS CLI

リソースデータ同期を削除するには

この例では、リソースデータ同期を削除します。コマンドが成功した場合、出力はありません。

コマンド:

aws ssm delete-resource-data-sync --sync-name "ssm-resource-data-sync"
  • API の詳細については、「 コマンドリファレンスDeleteResourceDataSync」の「」を参照してください。 AWS CLI

次の例は、deregister-managed-instance を使用する方法を説明しています。

AWS CLI

マネージドインスタンスの登録を解除するには

次のderegister-managed-instance例では、指定されたマネージドインスタンスの登録を解除します。

aws ssm deregister-managed-instance --instance-id "mi-08ab247cdfEXAMPLE"

このコマンドでは何も出力されません。

詳細については、AWS 「Systems Manager ユーザーガイド」の「ハイブリッド環境でのマネージドインスタンスの登録解除」を参照してください。

  • API の詳細については、「 コマンドリファレンスDeregisterManagedInstance」の「」を参照してください。 AWS CLI

次の例は、deregister-patch-baseline-for-patch-group を使用する方法を説明しています。

AWS CLI

パッチグループをパッチベースラインから登録解除するには

次のderegister-patch-baseline-for-patch-group例では、指定したパッチグループを指定したパッチベースラインから登録解除します。

aws ssm deregister-patch-baseline-for-patch-group \ --patch-group "Production" \ --baseline-id "pb-0ca44a362fEXAMPLE"

出力:

{ "PatchGroup":"Production", "BaselineId":"pb-0ca44a362fEXAMPLE" }

詳細については、「Systems Manager ユーザーガイド」の「パッチベースラインにパッチグループを追加する」を参照してください。 AWS

次の例は、deregister-target-from-maintenance-window を使用する方法を説明しています。

AWS CLI

メンテナンスウィンドウからターゲットを削除するには

次のderegister-target-from-maintenance-window例では、指定されたメンテナンスウィンドウから指定されたターゲットを削除します。

aws ssm deregister-target-from-maintenance-window \ --window-id "mw-ab12cd34ef56gh78" \ --window-target-id "1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d-1a2"

出力:

{ "WindowId":"mw-ab12cd34ef56gh78", "WindowTargetId":"1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d-1a2" }

詳細については、「Systems Manager ユーザーガイド」の「メンテナンスウィンドウの更新 (AWS CLI)」を参照してください。 AWS

次の例は、deregister-task-from-maintenance-window を使用する方法を説明しています。

AWS CLI

メンテナンスウィンドウからタスクを削除するには

次のderegister-task-from-maintenance-window例では、指定されたメンテナンスウィンドウから指定されたタスクを削除します。

aws ssm deregister-task-from-maintenance-window \ --window-id "mw-ab12cd34ef56gh78" \ --window-task-id "1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d5e6c"

出力:

{ "WindowTaskId":"1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d5e6c", "WindowId":"mw-ab12cd34ef56gh78" }

詳細については、「Systems Manager ユーザーガイド」の「Systems Manager メンテナンスウィンドウのチュートリアル (AWS CLI)」を参照してください。 AWS

次の例は、describe-activations を使用する方法を説明しています。

AWS CLI

アクティベーションを記述するには

次のdescribe-activations例では、 AWS アカウントのアクティベーションの詳細を一覧表示します。

aws ssm describe-activations

出力:

{ "ActivationList": [ { "ActivationId": "5743558d-563b-4457-8682-d16c3EXAMPLE", "Description": "Example1", "IamRole": "HybridWebServersRole, "RegistrationLimit": 5, "RegistrationsCount": 5, "ExpirationDate": 1584316800.0, "Expired": false, "CreatedDate": 1581954699.792 }, { "ActivationId": "3ee0322b-f62d-40eb-b672-13ebfEXAMPLE", "Description": "Example2", "IamRole": "HybridDatabaseServersRole", "RegistrationLimit": 5, "RegistrationsCount": 5, "ExpirationDate": 1580515200.0, "Expired": true, "CreatedDate": 1578064132.002 }, ] }

詳細については、AWS 「Systems Manager ユーザーガイド」の「ステップ 4: ハイブリッド環境のマネージドインスタンスのアクティベーションを作成する」を参照してください。

  • API の詳細については、「 コマンドリファレンスDescribeActivations」の「」を参照してください。 AWS CLI

次の例は、describe-association-execution-targets を使用する方法を説明しています。

AWS CLI

関連付けの実行の詳細を取得するには

次のdescribe-association-execution-targets例では、指定された関連付けの実行について説明します。

aws ssm describe-association-execution-targets \ --association-id "8dfe3659-4309-493a-8755-0123456789ab" \ --execution-id "7abb6378-a4a5-4f10-8312-0123456789ab"

出力:

{ "AssociationExecutionTargets": [ { "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "AssociationVersion": "1", "ExecutionId": "7abb6378-a4a5-4f10-8312-0123456789ab", "ResourceId": "i-1234567890abcdef0", "ResourceType": "ManagedInstance", "Status": "Success", "DetailedStatus": "Success", "LastExecutionDate": 1550505538.497, "OutputSource": { "OutputSourceId": "97fff367-fc5a-4299-aed8-0123456789ab", "OutputSourceType": "RunCommand" } } ] }

詳細については、「Systems Manager ユーザーガイド」の「関連付け履歴の表示」を参照してください。 AWS

次の例は、describe-association-executions を使用する方法を説明しています。

AWS CLI

例 1: 関連付けのすべての実行の詳細を取得するには

次のdescribe-association-executions例では、指定した関連付けのすべての実行について説明します。

aws ssm describe-association-executions \ --association-id "8dfe3659-4309-493a-8755-0123456789ab"

出力:

{ "AssociationExecutions": [ { "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "AssociationVersion": "1", "ExecutionId": "474925ef-1249-45a2-b93d-0123456789ab", "Status": "Success", "DetailedStatus": "Success", "CreatedTime": 1550505827.119, "ResourceCountByStatus": "{Success=1}" }, { "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "AssociationVersion": "1", "ExecutionId": "7abb6378-a4a5-4f10-8312-0123456789ab", "Status": "Success", "DetailedStatus": "Success", "CreatedTime": 1550505536.843, "ResourceCountByStatus": "{Success=1}" }, ... ] }

詳細については、「Systems Manager ユーザーガイド」の「関連付け履歴の表示」を参照してください。 AWS

例 2: 特定の日時以降の関連付けのすべての実行の詳細を取得するには

次のdescribe-association-executions例では、指定した日時以降の関連付けのすべての実行について説明します。

aws ssm describe-association-executions \ --association-id "8dfe3659-4309-493a-8755-0123456789ab" \ --filters "Key=CreatedTime,Value=2019-02-18T16:00:00Z,Type=GREATER_THAN"

出力:

{ "AssociationExecutions": [ { "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "AssociationVersion": "1", "ExecutionId": "474925ef-1249-45a2-b93d-0123456789ab", "Status": "Success", "DetailedStatus": "Success", "CreatedTime": 1550505827.119, "ResourceCountByStatus": "{Success=1}" }, { "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "AssociationVersion": "1", "ExecutionId": "7abb6378-a4a5-4f10-8312-0123456789ab", "Status": "Success", "DetailedStatus": "Success", "CreatedTime": 1550505536.843, "ResourceCountByStatus": "{Success=1}" }, ... ] }

詳細については、「Systems Manager ユーザーガイド」の「関連付け履歴の表示」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスDescribeAssociationExecutions」の「」を参照してください。 AWS CLI

次の例は、describe-association を使用する方法を説明しています。

AWS CLI

例 1: 関連付けの詳細を取得するには

次のdescribe-association例では、指定した関連付け ID の関連付けについて説明します。

aws ssm describe-association \ --association-id "8dfe3659-4309-493a-8755-0123456789ab"

出力:

{ "AssociationDescription": { "Name": "AWS-GatherSoftwareInventory", "AssociationVersion": "1", "Date": 1534864780.995, "LastUpdateAssociationDate": 1543235759.81, "Overview": { "Status": "Success", "AssociationStatusAggregatedCount": { "Success": 2 } }, "DocumentVersion": "$DEFAULT", "Parameters": { "applications": [ "Enabled" ], "awsComponents": [ "Enabled" ], "customInventory": [ "Enabled" ], "files": [ "" ], "instanceDetailedInformation": [ "Enabled" ], "networkConfig": [ "Enabled" ], "services": [ "Enabled" ], "windowsRegistry": [ "" ], "windowsRoles": [ "Enabled" ], "windowsUpdates": [ "Enabled" ] }, "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "Targets": [ { "Key": "InstanceIds", "Values": [ "*" ] } ], "ScheduleExpression": "rate(24 hours)", "LastExecutionDate": 1550501886.0, "LastSuccessfulExecutionDate": 1550501886.0, "AssociationName": "Inventory-Association" } }

詳細については、「Systems Manager ユーザーガイド」の「関連付けの編集と新しいバージョンの作成」を参照してください。 AWS

例 2: 特定のインスタンスとドキュメントの関連付けの詳細を取得するには

次のdescribe-association例では、インスタンスとドキュメントの関連付けについて説明します。

aws ssm describe-association \ --instance-id "i-1234567890abcdef0" \ --name "AWS-UpdateSSMAgent"

出力:

{ "AssociationDescription": { "Status": { "Date": 1487876122.564, "Message": "Associated with AWS-UpdateSSMAgent", "Name": "Associated" }, "Name": "AWS-UpdateSSMAgent", "InstanceId": "i-1234567890abcdef0", "Overview": { "Status": "Pending", "DetailedStatus": "Associated", "AssociationStatusAggregatedCount": { "Pending": 1 } }, "AssociationId": "d8617c07-2079-4c18-9847-1234567890ab", "DocumentVersion": "$DEFAULT", "LastUpdateAssociationDate": 1487876122.564, "Date": 1487876122.564, "Targets": [ { "Values": [ "i-1234567890abcdef0" ], "Key": "InstanceIds" } ] } }

詳細については、「Systems Manager ユーザーガイド」の「関連付けの編集と新しいバージョンの作成」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスDescribeAssociation」の「」を参照してください。 AWS CLI

次の例は、describe-automation-executions を使用する方法を説明しています。

AWS CLI

オートメーションの実行を記述するには

次のdescribe-automation-executions例では、オートメーションの実行に関する詳細を表示します。

aws ssm describe-automation-executions \ --filters Key=ExecutionId,Values=73c8eef8-f4ee-4a05-820c-e354fEXAMPLE

出力:

{ "AutomationExecutionMetadataList": [ { "AutomationExecutionId": "73c8eef8-f4ee-4a05-820c-e354fEXAMPLE", "DocumentName": "AWS-StartEC2Instance", "DocumentVersion": "1", "AutomationExecutionStatus": "Success", "ExecutionStartTime": 1583737233.748, "ExecutionEndTime": 1583737234.719, "ExecutedBy": "arn:aws:sts::29884EXAMPLE:assumed-role/mw_service_role/OrchestrationService", "LogFile": "", "Outputs": {}, "Mode": "Auto", "Targets": [], "ResolvedTargets": { "ParameterValues": [], "Truncated": false }, "AutomationType": "Local" } ] }

詳細については、「Systems Manager ユーザーガイド」の「シンプルなオートメーションワークフローの実行」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスDescribeAutomationExecutions」の「」を参照してください。 AWS CLI

次の例は、describe-automation-step-executions を使用する方法を説明しています。

AWS CLI

例 1: オートメーション実行のすべてのステップを説明するには

次のdescribe-automation-step-executions例では、オートメーション実行のステップに関する詳細を表示します。

aws ssm describe-automation-step-executions \ --automation-execution-id 73c8eef8-f4ee-4a05-820c-e354fEXAMPLE

出力:

{ "StepExecutions": [ { "StepName": "startInstances", "Action": "aws:changeInstanceState", "ExecutionStartTime": 1583737234.134, "ExecutionEndTime": 1583737234.672, "StepStatus": "Success", "Inputs": { "DesiredState": "\"running\"", "InstanceIds": "[\"i-0cb99161f6EXAMPLE\"]" }, "Outputs": { "InstanceStates": [ "running" ] }, "StepExecutionId": "95e70479-cf20-4d80-8018-7e4e2EXAMPLE", "OverriddenParameters": {} } ] }

例 2: オートメーション実行の特定のステップを記述するには

次のdescribe-automation-step-executions例では、オートメーション実行の特定のステップに関する詳細を表示します。

aws ssm describe-automation-step-executions \ --automation-execution-id 73c8eef8-f4ee-4a05-820c-e354fEXAMPLE \ --filters Key=StepExecutionId,Values=95e70479-cf20-4d80-8018-7e4e2EXAMPLE

詳細については、「Systems Manager ユーザーガイド」の「オートメーションワークフローをステップごとに実行する (コマンドライン)」を参照してください。 AWS

次の例は、describe-available-patches を使用する方法を説明しています。

AWS CLI

利用可能なパッチを取得するには

次のdescribe-available-patches例では、MSRC 重要度が Critical の Windows Server 2019 で使用可能なすべてのパッチの詳細を取得します。

aws ssm describe-available-patches \ --filters "Key=PRODUCT,Values=WindowsServer2019" "Key=MSRC_SEVERITY,Values=Critical"

出力:

{ "Patches": [ { "Id": "fe6bd8c2-3752-4c8b-ab3e-1a7ed08767ba", "ReleaseDate": 1544047205.0, "Title": "2018-11 Update for Windows Server 2019 for x64-based Systems (KB4470788)", "Description": "Install this update to resolve issues in Windows. For a complete listing of the issues that are included in this update, see the associated Microsoft Knowledge Base article for more information. After you install this item, you may have to restart your computer.", "ContentUrl": "https://support.microsoft.com/en-us/kb/4470788", "Vendor": "Microsoft", "ProductFamily": "Windows", "Product": "WindowsServer2019", "Classification": "SecurityUpdates", "MsrcSeverity": "Critical", "KbNumber": "KB4470788", "MsrcNumber": "", "Language": "All" }, { "Id": "c96115e1-5587-4115-b851-22baa46a3f11", "ReleaseDate": 1549994410.0, "Title": "2019-02 Security Update for Adobe Flash Player for Windows Server 2019 for x64-based Systems (KB4487038)", "Description": "A security issue has been identified in a Microsoft software product that could affect your system. You can help protect your system by installing this update from Microsoft. For a complete listing of the issues that are included in this update, see the associated Microsoft Knowledge Base article. After you install this update, you may have to restart your system.", "ContentUrl": "https://support.microsoft.com/en-us/kb/4487038", "Vendor": "Microsoft", "ProductFamily": "Windows", "Product": "WindowsServer2019", "Classification": "SecurityUpdates", "MsrcSeverity": "Critical", "KbNumber": "KB4487038", "MsrcNumber": "", "Language": "All" }, ... ] }

特定のパッチの詳細を取得するには

次のdescribe-available-patches例では、指定したパッチの詳細を取得します。

aws ssm describe-available-patches \ --filters "Key=PATCH_ID,Values=KB4480979"

出力:

{ "Patches": [ { "Id": "680861e3-fb75-432e-818e-d72e5f2be719", "ReleaseDate": 1546970408.0, "Title": "2019-01 Security Update for Adobe Flash Player for Windows Server 2016 for x64-based Systems (KB4480979)", "Description": "A security issue has been identified in a Microsoft software product that could affect your system. You can help protect your system by installing this update from Microsoft. For a complete listing of the issues that are included in this update, see the associated Microsoft Knowledge Base article. After you install this update, you may have to restart your system.", "ContentUrl": "https://support.microsoft.com/en-us/kb/4480979", "Vendor": "Microsoft", "ProductFamily": "Windows", "Product": "WindowsServer2016", "Classification": "SecurityUpdates", "MsrcSeverity": "Critical", "KbNumber": "KB4480979", "MsrcNumber": "", "Language": "All" } ] }

詳細については、「Systems Manager ユーザーガイド」の「パッチマネージャーオペレーションの仕組み」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスDescribeAvailablePatches」の「」を参照してください。 AWS CLI

次の例は、describe-document-permission を使用する方法を説明しています。

AWS CLI

ドキュメントのアクセス許可を記述するには

次のdescribe-document-permission例では、パブリックに共有されている Systems Manager ドキュメントに関するアクセス許可の詳細を表示します。

aws ssm describe-document-permission \ --name "Example" \ --permission-type "Share"

出力:

{ "AccountIds": [ "all" ], "AccountSharingInfoList": [ { "AccountId": "all", "SharedDocumentVersion": "$DEFAULT" } ] }

詳細については、「Systems Manager ユーザーガイド」の「Systems Manager ドキュメントの共有AWS 」を参照してください。

  • API の詳細については、「 コマンドリファレンスDescribeDocumentPermission」の「」を参照してください。 AWS CLI

次の例は、describe-document を使用する方法を説明しています。

AWS CLI

ドキュメントの詳細を表示するには

次のdescribe-document例では、 AWS アカウントの Systems Manager ドキュメントの詳細を表示します。

aws ssm describe-document \ --name "Example"

出力:

{ "Document": { "Hash": "fc2410281f40779e694a8b95975d0f9f316da8a153daa94e3d9921102EXAMPLE", "HashType": "Sha256", "Name": "Example", "Owner": "29884EXAMPLE", "CreatedDate": 1583257938.266, "Status": "Active", "DocumentVersion": "1", "Description": "Document Example", "Parameters": [ { "Name": "AutomationAssumeRole", "Type": "String", "Description": "(Required) The ARN of the role that allows Automation to perform the actions on your behalf. If no role is specified, Systems Manager Automation uses your IAM permissions to execute this document.", "DefaultValue": "" }, { "Name": "InstanceId", "Type": "String", "Description": "(Required) The ID of the Amazon EC2 instance.", "DefaultValue": "" } ], "PlatformTypes": [ "Windows", "Linux" ], "DocumentType": "Automation", "SchemaVersion": "0.3", "LatestVersion": "1", "DefaultVersion": "1", "DocumentFormat": "YAML", "Tags": [] } }

詳細については、「Systems Manager ユーザーガイド」の「Systems Manager ドキュメントAWS の作成」を参照してください。

  • API の詳細については、「 コマンドリファレンスDescribeDocument」の「」を参照してください。 AWS CLI

次の例は、describe-effective-instance-associations を使用する方法を説明しています。

AWS CLI

インスタンスの有効な関連付けの詳細を取得するには

次のdescribe-effective-instance-associations例では、インスタンスの有効な関連付けに関する詳細を取得します。

コマンド:

aws ssm describe-effective-instance-associations --instance-id "i-1234567890abcdef0"

出力:

{ "Associations": [ { "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "InstanceId": "i-1234567890abcdef0", "Content": "{\n \"schemaVersion\": \"1.2\",\n \"description\": \"Update the Amazon SSM Agent to the latest version or specified version.\",\n \"parameters\": {\n \"version\": {\n \"default\": \"\",\n \"description\": \"(Optional) A specific version of the Amazon SSM Agent to install. If not specified, the agent will be updated to the latest version.\",\n \"type\": \"String\"\n },\n \"allowDowngrade\": {\n \"default\": \"false\",\n \"description\": \"(Optional) Allow the Amazon SSM Agent service to be downgraded to an earlier version. If set to false, the service can be upgraded to newer versions only (default). If set to true, specify the earlier version.\",\n \"type\": \"String\",\n \"allowedValues\": [\n \"true\",\n \"false\"\n ]\n }\n },\n \"runtimeConfig\": {\n \"aws:updateSsmAgent\": {\n \"properties\": [\n {\n \"agentName\": \"amazon-ssm-agent\",\n \"source\": \"https://s3.{Region}.amazonaws.com/amazon-ssm-{Region}/ssm-agent-manifest.json\",\n \"allowDowngrade\": \"{{ allowDowngrade }}\",\n \"targetVersion\": \"{{ version }}\"\n }\n ]\n }\n }\n}\n", "AssociationVersion": "1" } ] }

次の例は、describe-effective-patches-for-patch-baseline を使用する方法を説明しています。

AWS CLI

例 1: カスタムパッチベースラインで定義されているすべてのパッチを取得するには

次のdescribe-effective-patches-for-patch-baseline例では、現在の AWS アカウントのカスタムパッチベースラインで定義されているパッチを返します。カスタムベースラインの場合、 に必要なのは ID のみであることに注意してください--baseline-id

aws ssm describe-effective-patches-for-patch-baseline \ --baseline-id "pb-08b654cf9b9681f04"

出力:

{ "EffectivePatches": [ { "Patch": { "Id": "fe6bd8c2-3752-4c8b-ab3e-1a7ed08767ba", "ReleaseDate": 1544047205.0, "Title": "2018-11 Update for Windows Server 2019 for x64-based Systems (KB4470788)", "Description": "Install this update to resolve issues in Windows. For a complete listing of the issues that are included in this update, see the associated Microsoft Knowledge Base article for more information. After you install this item, you may have to restart your computer.", "ContentUrl": "https://support.microsoft.com/en-us/kb/4470788", "Vendor": "Microsoft", "ProductFamily": "Windows", "Product": "WindowsServer2019", "Classification": "SecurityUpdates", "MsrcSeverity": "Critical", "KbNumber": "KB4470788", "MsrcNumber": "", "Language": "All" }, "PatchStatus": { "DeploymentStatus": "APPROVED", "ComplianceLevel": "CRITICAL", "ApprovalDate": 1544047205.0 } }, { "Patch": { "Id": "915a6b1a-f556-4d83-8f50-b2e75a9a7e58", "ReleaseDate": 1549994400.0, "Title": "2019-02 Cumulative Update for .NET Framework 3.5 and 4.7.2 for Windows Server 2019 for x64 (KB4483452)", "Description": "A security issue has been identified in a Microsoft software product that could affect your system. You can help protect your system by installing this update from Microsoft. For a complete listing of the issues that are included in this update, see the associated Microsoft Knowledge Base article. After you install this update, you may have to restart your system.", "ContentUrl": "https://support.microsoft.com/en-us/kb/4483452", "Vendor": "Microsoft", "ProductFamily": "Windows", "Product": "WindowsServer2019", "Classification": "SecurityUpdates", "MsrcSeverity": "Important", "KbNumber": "KB4483452", "MsrcNumber": "", "Language": "All" }, "PatchStatus": { "DeploymentStatus": "APPROVED", "ComplianceLevel": "CRITICAL", "ApprovalDate": 1549994400.0 } }, ... ], "NextToken": "--token string truncated--" }

例 2: AWS マネージドパッチベースラインで定義されているすべてのパッチを取得するには

次のdescribe-effective-patches-for-patch-baseline例では、 AWS マネージドパッチベースラインで定義されているパッチを返します。 AWS マネージドベースラインの場合、 には完全なベースライン ARN が必要であることに注意してください。 --baseline-id

aws ssm describe-effective-patches-for-patch-baseline \ --baseline-id "arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-020d361a05defe4ed"

出力例については、例 1 を参照してください。

詳細については、AWS 「Systems Manager ユーザーガイド」の「セキュリティパッチの選択方法」を参照してください。

次の例は、describe-instance-associations-status を使用する方法を説明しています。

AWS CLI

インスタンスの関連付けのステータスを記述するには

この例では、インスタンスの関連付けの詳細を示します。

コマンド:

aws ssm describe-instance-associations-status --instance-id "i-1234567890abcdef0"

出力:

{ "InstanceAssociationStatusInfos": [ { "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "Name": "AWS-GatherSoftwareInventory", "DocumentVersion": "1", "AssociationVersion": "1", "InstanceId": "i-1234567890abcdef0", "ExecutionDate": 1550501886.0, "Status": "Success", "ExecutionSummary": "1 out of 1 plugin processed, 1 success, 0 failed, 0 timedout, 0 skipped. ", "AssociationName": "Inventory-Association" }, { "AssociationId": "5c5a31f6-6dae-46f9-944c-0123456789ab", "Name": "AWS-UpdateSSMAgent", "DocumentVersion": "1", "AssociationVersion": "1", "InstanceId": "i-1234567890abcdef0", "ExecutionDate": 1550505828.548, "Status": "Success", "DetailedStatus": "Success", "AssociationName": "UpdateSSMAgent" } ] }

次の例は、describe-instance-information を使用する方法を説明しています。

AWS CLI

例 1: マネージドインスタンス情報を記述するには

次のdescribe-instance-information例では、各マネージドインスタンスの詳細を取得します。

aws ssm describe-instance-information

例 2: 特定のマネージドインスタンスに関する情報を記述するには

次のdescribe-instance-information例は、マネージドインスタンス の詳細を示していますi-028ea792daEXAMPLE

aws ssm describe-instance-information \ --filters "Key=InstanceIds,Values=i-028ea792daEXAMPLE"

例 3: 特定のタグキーを持つマネージドインスタンスに関する情報を記述するには

次のdescribe-instance-information例は、タグキー を持つマネージドインスタンスの詳細を示していますDEV

aws ssm describe-instance-information \ --filters "Key=tag-key,Values=DEV"

出力:

{ "InstanceInformationList": [ { "InstanceId": "i-028ea792daEXAMPLE", "PingStatus": "Online", "LastPingDateTime": 1582221233.421, "AgentVersion": "2.3.842.0", "IsLatestVersion": true, "PlatformType": "Linux", "PlatformName": "SLES", "PlatformVersion": "15.1", "ResourceType": "EC2Instance", "IPAddress": "192.0.2.0", "ComputerName": "ip-198.51.100.0.us-east-2.compute.internal", "AssociationStatus": "Success", "LastAssociationExecutionDate": 1582220806.0, "LastSuccessfulAssociationExecutionDate": 1582220806.0, "AssociationOverview": { "DetailedStatus": "Success", "InstanceAssociationStatusAggregatedCount": { "Success": 2 } } } ] }

詳細については、AWS 「Systems Manager ユーザーガイド」の「マネージドインスタンス」を参照してください。

  • API の詳細については、「 コマンドリファレンスDescribeInstanceInformation」の「」を参照してください。 AWS CLI

次の例は、describe-instance-patch-states-for-patch-group を使用する方法を説明しています。

AWS CLI

例 1: パッチグループのインスタンス状態を取得するには

次のdescribe-instance-patch-states-for-patch-group例では、指定したパッチグループのインスタンスごとのパッチ概要の状態に関する詳細を取得します。

aws ssm describe-instance-patch-states-for-patch-group \ --patch-group "Production"

出力:

{ "InstancePatchStates": [ { "InstanceId": "i-02573cafcfEXAMPLE", "PatchGroup": "Production", "BaselineId": "pb-0c10e65780EXAMPLE", "SnapshotId": "a3f5ff34-9bc4-4d2c-a665-4d1c1EXAMPLE", "OwnerInformation": "", "InstalledCount": 32, "InstalledOtherCount": 1, "InstalledPendingRebootCount": 0, "InstalledRejectedCount": 0, "MissingCount": 2, "FailedCount": 0, "UnreportedNotApplicableCount": 2671, "NotApplicableCount": 400, "OperationStartTime": "2021-08-04T11:03:50.590000-07:00", "OperationEndTime": "2021-08-04T11:04:21.555000-07:00", "Operation": "Scan", "RebootOption": "NoReboot", "CriticalNonCompliantCount": 0, "SecurityNonCompliantCount": 1, "OtherNonCompliantCount": 0 }, { "InstanceId": "i-0471e04240EXAMPLE", "PatchGroup": "Production", "BaselineId": "pb-09ca3fb51fEXAMPLE", "SnapshotId": "05d8ffb0-1bbe-4812-ba2d-d9b7bEXAMPLE", "OwnerInformation": "", "InstalledCount": 32, "InstalledOtherCount": 1, "InstalledPendingRebootCount": 0, "InstalledRejectedCount": 0, "MissingCount": 2, "FailedCount": 0, "UnreportedNotApplicableCount": 2671, "NotApplicableCount": 400, "OperationStartTime": "2021-08-04T22:06:20.340000-07:00", "OperationEndTime": "2021-08-04T22:07:11.220000-07:00", "Operation": "Scan", "RebootOption": "NoReboot", "CriticalNonCompliantCount": 0, "SecurityNonCompliantCount": 1, "OtherNonCompliantCount": 0 } ] }

例 2: 欠落しているパッチが 5 つ以上あるパッチグループのインスタンス状態を取得するには

次のdescribe-instance-patch-states-for-patch-group例では、欠落しているパッチが 5 つ以上あるインスタンスについて、指定したパッチグループのパッチ概要の状態に関する詳細を取得します。

aws ssm describe-instance-patch-states-for-patch-group \ --filters Key=MissingCount,Type=GreaterThan,Values=5 \ --patch-group "Production"

出力:

{ "InstancePatchStates": [ { "InstanceId": "i-02573cafcfEXAMPLE", "PatchGroup": "Production", "BaselineId": "pb-0c10e65780EXAMPLE", "SnapshotId": "a3f5ff34-9bc4-4d2c-a665-4d1c1EXAMPLE", "OwnerInformation": "", "InstalledCount": 46, "InstalledOtherCount": 4, "InstalledPendingRebootCount": 1, "InstalledRejectedCount": 1, "MissingCount": 7, "FailedCount": 0, "UnreportedNotApplicableCount": 232, "NotApplicableCount": 654, "OperationStartTime": "2021-08-04T11:03:50.590000-07:00", "OperationEndTime": "2021-08-04T11:04:21.555000-07:00", "Operation": "Scan", "RebootOption": "NoReboot", "CriticalNonCompliantCount": 0, "SecurityNonCompliantCount": 1, "OtherNonCompliantCount": 1 } ] }

例 3: 再起動が必要なインスタンスが 10 個未満のパッチグループのインスタンス状態を取得するには

次のdescribe-instance-patch-states-for-patch-group例では、再起動が必要なインスタンスが 10 個未満のインスタンスについて、指定したパッチグループのパッチ概要の状態に関する詳細を取得します。

aws ssm describe-instance-patch-states-for-patch-group \ --filters Key=InstalledPendingRebootCount,Type=LessThan,Values=10 \ --patch-group "Production"

出力:

{ "InstancePatchStates": [ { "InstanceId": "i-02573cafcfEXAMPLE", "BaselineId": "pb-0c10e65780EXAMPLE", "SnapshotId": "a3f5ff34-9bc4-4d2c-a665-4d1c1EXAMPLE", "PatchGroup": "Production", "OwnerInformation": "", "InstalledCount": 32, "InstalledOtherCount": 1, "InstalledPendingRebootCount": 4, "InstalledRejectedCount": 0, "MissingCount": 2, "FailedCount": 0, "UnreportedNotApplicableCount": 846, "NotApplicableCount": 212, "OperationStartTime": "2021-08-046T11:03:50.590000-07:00", "OperationEndTime": "2021-08-06T11:04:21.555000-07:00", "Operation": "Scan", "RebootOption": "NoReboot", "CriticalNonCompliantCount": 0, "SecurityNonCompliantCount": 1, "OtherNonCompliantCount": 0 } ] }

詳細については、「Systems Manager ユーザーガイド」の「パッチコンプライアンス状態値について」を参照してください。 AWS

次の例は、describe-instance-patch-states を使用する方法を説明しています。

AWS CLI

インスタンスのパッチの概要状態を取得するには

describe-instance-patch-states この例では、インスタンスのパッチ概要の状態を取得します。

aws ssm describe-instance-patch-states \ --instance-ids "i-1234567890abcdef0"

出力:

{ "InstancePatchStates": [ { "InstanceId": "i-1234567890abcdef0", "PatchGroup": "my-patch-group", "BaselineId": "pb-0713accee01234567", "SnapshotId": "521c3536-930c-4aa9-950e-01234567abcd", "CriticalNonCompliantCount": 2, "SecurityNonCompliantCount": 2, "OtherNonCompliantCount": 1, "InstalledCount": 123, "InstalledOtherCount": 334, "InstalledPendingRebootCount": 0, "InstalledRejectedCount": 0, "MissingCount": 1, "FailedCount": 2, "UnreportedNotApplicableCount": 11, "NotApplicableCount": 2063, "OperationStartTime": "2021-05-03T11:00:56-07:00", "OperationEndTime": "2021-05-03T11:01:09-07:00", "Operation": "Scan", "LastNoRebootInstallOperationTime": "2020-06-14T12:17:41-07:00", "RebootOption": "RebootIfNeeded" } ] }

詳細については、「Systems Manager ユーザーガイド」の「パッチコンプライアンスについて」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスDescribeInstancePatchStates」の「」を参照してください。 AWS CLI

次の例は、describe-instance-patches を使用する方法を説明しています。

AWS CLI

例 1: インスタンスのパッチ状態の詳細を取得するには

次のdescribe-instance-patches例では、指定したインスタンスのパッチに関する詳細を取得します。

aws ssm describe-instance-patches \ --instance-id "i-1234567890abcdef0"

出力:

{ "Patches": [ { "Title": "2019-01 Security Update for Adobe Flash Player for Windows Server 2016 for x64-based Systems (KB4480979)", "KBId": "KB4480979", "Classification": "SecurityUpdates", "Severity": "Critical", "State": "Installed", "InstalledTime": "2019-01-09T00:00:00+00:00" }, { "Title": "", "KBId": "KB4481031", "Classification": "", "Severity": "", "State": "InstalledOther", "InstalledTime": "2019-02-08T00:00:00+00:00" }, ... ], "NextToken": "--token string truncated--" }

例 2: インスタンスの Missing 状態のパッチのリストを取得するには

次のdescribe-instance-patches例では、指定したインスタンスの Missing 状態にあるパッチに関する情報を取得します。

aws ssm describe-instance-patches \ --instance-id "i-1234567890abcdef0" \ --filters Key=State,Values=Missing

出力:

{ "Patches": [ { "Title": "Windows Malicious Software Removal Tool x64 - February 2019 (KB890830)", "KBId": "KB890830", "Classification": "UpdateRollups", "Severity": "Unspecified", "State": "Missing", "InstalledTime": "1970-01-01T00:00:00+00:00" }, ... ], "NextToken": "--token string truncated--" }

詳細については、「Systems Manager ユーザーガイド」の「パッチコンプライアンス状態について」を参照してください。 AWS

例 3: インスタンスに指定した 以降にインストールされたパッチのリストを取得する InstalledTime には

次のdescribe-instance-patches例では、 --filtersと を組み合わせて、指定したインスタンスの指定時刻以降にインストールされたパッチに関する情報を取得します--query

aws ssm describe-instance-patches \ --instance-id "i-1234567890abcdef0" \ --filters Key=State,Values=Installed \ --query "Patches[?InstalledTime >= `2023-01-01T16:00:00`]"

出力:

{ "Patches": [ { "Title": "2023-03 Cumulative Update for Windows Server 2019 (1809) for x64-based Systems (KB5023702)", "KBId": "KB5023702", "Classification": "SecurityUpdates", "Severity": "Critical", "State": "Installed", "InstalledTime": "2023-03-16T11:00:00+00:00" }, ... ], "NextToken": "--token string truncated--" }
  • API の詳細については、「 コマンドリファレンスDescribeInstancePatches」の「」を参照してください。 AWS CLI

次の例は、describe-inventory-deletions を使用する方法を説明しています。

AWS CLI

インベントリの削除を取得するには

この例では、インベントリ削除オペレーションの詳細を取得します。

コマンド:

aws ssm describe-inventory-deletions

出力:

{ "InventoryDeletions": [ { "DeletionId": "6961492a-8163-44ec-aa1e-01234567850", "TypeName": "Custom:RackInformation", "DeletionStartTime": 1550254911.0, "LastStatus": "InProgress", "LastStatusMessage": "The Delete is in progress", "DeletionSummary": { "TotalCount": 0, "RemainingCount": 0, "SummaryItems": [] }, "LastStatusUpdateTime": 1550254911.0 }, { "DeletionId": "d72ac9e8-1f60-4d40-b1c6-987654321c4d", "TypeName": "Custom:RackInfo", "DeletionStartTime": 1550254859.0, "LastStatus": "InProgress", "LastStatusMessage": "The Delete is in progress", "DeletionSummary": { "TotalCount": 1, "RemainingCount": 1, "SummaryItems": [ { "Version": "1.0", "Count": 1, "RemainingCount": 1 } ] }, "LastStatusUpdateTime": 1550254859.0 } ] }

特定のインベントリ削除の詳細を取得するには

この例では、特定のインベントリ削除オペレーションの詳細を取得します。

コマンド:

aws ssm describe-inventory-deletions --deletion-id "d72ac9e8-1f60-4d40-b1c6-987654321c4d"

出力:

{ "InventoryDeletions": [ { "DeletionId": "d72ac9e8-1f60-4d40-b1c6-987654321c4d", "TypeName": "Custom:RackInfo", "DeletionStartTime": 1550254859.0, "LastStatus": "InProgress", "LastStatusMessage": "The Delete is in progress", "DeletionSummary": { "TotalCount": 1, "RemainingCount": 1, "SummaryItems": [ { "Version": "1.0", "Count": 1, "RemainingCount": 1 } ] }, "LastStatusUpdateTime": 1550254859.0 } ] }
  • API の詳細については、「 コマンドリファレンスDescribeInventoryDeletions」の「」を参照してください。 AWS CLI

次の例は、describe-maintenance-window-execution-task-invocations を使用する方法を説明しています。

AWS CLI

メンテナンスウィンドウのタスク実行に対して実行された特定のタスク呼び出しを取得するには

次のdescribe-maintenance-window-execution-task-invocations例では、指定したメンテナンスウィンドウの実行の一部として実行された指定したタスクの呼び出しを一覧表示します。

aws ssm describe-maintenance-window-execution-task-invocations \ --window-execution-id "518d5565-5969-4cca-8f0e-da3b2a638355" \ --task-id "ac0c6ae1-daa3-4a89-832e-d384503b6586"

出力:

{ "WindowExecutionTaskInvocationIdentities": [ { "Status": "SUCCESS", "Parameters": "{\"documentName\":\"AWS-RunShellScript\",\"instanceIds\":[\"i-0000293ffd8c57862\"],\"parameters\":{\"commands\":[\"df\"]},\"maxConcurrency\":\"1\",\"maxErrors\":\"1\"}", "InvocationId": "e274b6e1-fe56-4e32-bd2a-8073c6381d8b", "StartTime": 1487692834.723, "EndTime": 1487692834.871, "WindowExecutionId": "518d5565-5969-4cca-8f0e-da3b2a638355", "TaskExecutionId": "ac0c6ae1-daa3-4a89-832e-d384503b6586" } ] }

詳細については、AWS 「Systems Manager ユーザーガイド」の「タスクとタスク実行に関する情報を表示する (AWS CLI)」を参照してください。

次の例は、describe-maintenance-window-execution-tasks を使用する方法を説明しています。

AWS CLI

メンテナンスウィンドウの実行に関連付けられているすべてのタスクを一覧表示するには

次のssm describe-maintenance-window-execution-tasks例では、指定したメンテナンスウィンドウの実行に関連付けられたタスクを一覧表示します。

aws ssm describe-maintenance-window-execution-tasks \ --window-execution-id "518d5565-5969-4cca-8f0e-da3b2EXAMPLE"

出力:

{ "WindowExecutionTaskIdentities": [ { "Status": "SUCCESS", "TaskArn": "AWS-RunShellScript", "StartTime": 1487692834.684, "TaskType": "RUN_COMMAND", "EndTime": 1487692835.005, "WindowExecutionId": "518d5565-5969-4cca-8f0e-da3b2EXAMPLE", "TaskExecutionId": "ac0c6ae1-daa3-4a89-832e-d3845EXAMPLE" } ] }

詳細については、AWS 「Systems Manager ユーザーガイド」の「タスクとタスク実行 (AWS CLI) に関する情報を表示する」を参照してください。

次の例は、describe-maintenance-window-executions を使用する方法を説明しています。

AWS CLI

例 1: メンテナンスウィンドウのすべての実行を一覧表示するには

次のdescribe-maintenance-window-executions例では、指定したメンテナンスウィンドウのすべての実行を一覧表示します。

aws ssm describe-maintenance-window-executions \ --window-id "mw-ab12cd34eEXAMPLE"

出力:

{ "WindowExecutions": [ { "WindowId": "mw-ab12cd34eEXAMPLE", "WindowExecutionId": "6027b513-64fe-4cf0-be7d-1191aEXAMPLE", "Status": "IN_PROGRESS", "StartTime": "2021-08-04T11:00:00.000000-07:00" }, { "WindowId": "mw-ab12cd34eEXAMPLE", "WindowExecutionId": "ff75b750-4834-4377-8f61-b3cadEXAMPLE", "Status": "SUCCESS", "StartTime": "2021-08-03T11:00:00.000000-07:00", "EndTime": "2021-08-03T11:37:21.450000-07:00" }, { "WindowId": "mw-ab12cd34eEXAMPLE", "WindowExecutionId": "9fac7dd9-ff21-42a5-96ad-bbc4bEXAMPLE", "Status": "FAILED", "StatusDetails": "One or more tasks in the orchestration failed.", "StartTime": "2021-08-02T11:00:00.000000-07:00", "EndTime": "2021-08-02T11:22:36.190000-07:00" } ] }

例 2: 指定した日付より前のメンテナンスウィンドウのすべての実行を一覧表示するには

次のdescribe-maintenance-window-executions例では、指定した日付より前の指定したメンテナンスウィンドウのすべての実行を一覧表示します。

aws ssm describe-maintenance-window-executions \ --window-id "mw-ab12cd34eEXAMPLE" \ --filters "Key=ExecutedBefore,Values=2021-08-03T00:00:00Z"

出力:

{ "WindowExecutions": [ { "WindowId": "mw-ab12cd34eEXAMPLE", "WindowExecutionId": "9fac7dd9-ff21-42a5-96ad-bbc4bEXAMPLE", "Status": "FAILED", "StatusDetails": "One or more tasks in the orchestration failed.", "StartTime": "2021-08-02T11:00:00.000000-07:00", "EndTime": "2021-08-02T11:22:36.190000-07:00" } ] }

例 3: 指定した日付以降のメンテナンスウィンドウのすべての実行を一覧表示するには

次のdescribe-maintenance-window-executions例では、指定した日付以降の指定したメンテナンスウィンドウのすべての実行を一覧表示します。

aws ssm describe-maintenance-window-executions \ --window-id "mw-ab12cd34eEXAMPLE" \ --filters "Key=ExecutedAfter,Values=2021-08-04T00:00:00Z"

出力:

{ "WindowExecutions": [ { "WindowId": "mw-ab12cd34eEXAMPLE", "WindowExecutionId": "6027b513-64fe-4cf0-be7d-1191aEXAMPLE", "Status": "IN_PROGRESS", "StartTime": "2021-08-04T11:00:00.000000-07:00" } ] }

詳細については、AWS 「Systems Manager ユーザーガイド」の「タスクとタスク実行 (AWS CLI) に関する情報を表示する」を参照してください。

次の例は、describe-maintenance-window-schedule を使用する方法を説明しています。

AWS CLI

例 1: メンテナンスウィンドウの今後の実行を一覧表示するには

次のdescribe-maintenance-window-schedule例では、指定したメンテナンスウィンドウのすべての今後の実行を一覧表示します。

aws ssm describe-maintenance-window-schedule \ --window-id mw-ab12cd34eEXAMPLE

出力:

{ "ScheduledWindowExecutions": [ { "WindowId": "mw-ab12cd34eEXAMPLE", "Name": "My-First-Maintenance-Window", "ExecutionTime": "2020-02-19T16:00Z" }, { "WindowId": "mw-ab12cd34eEXAMPLE", "Name": "My-First-Maintenance-Window", "ExecutionTime": "2020-02-26T16:00Z" }, ... ] }

例 2: 指定した日付より前のメンテナンスウィンドウのすべての今後の実行を一覧表示するには

次のdescribe-maintenance-window-schedule例では、指定した日付より前に実行される、指定したメンテナンスウィンドウのすべての今後の実行を一覧表示します。

aws ssm describe-maintenance-window-schedule \ --window-id mw-0ecb1226dd7b2e9a6 \ --filters "Key=ScheduledBefore,Values=2020-02-15T06:00:00Z"

例 3: 指定した日付以降のメンテナンスウィンドウのすべての今後の実行を一覧表示するには

次のdescribe-maintenance-window-schedule例では、指定した日付以降に発生する、指定したメンテナンスウィンドウのすべての今後の実行を一覧表示します。

aws ssm describe-maintenance-window-schedule \ --window-id mw-0ecb1226dd7b2e9a6 \ --filters "Key=ScheduledAfter,Values=2020-02-15T06:00:00Z"

詳細については、「Systems Manager ユーザーガイド」の「メンテナンスウィンドウ (AWS CLI) に関する情報を表示する」を参照してください。 AWS

次の例は、describe-maintenance-window-targets を使用する方法を説明しています。

AWS CLI

例 1: メンテナンスウィンドウのすべてのターゲットを一覧表示するには

次のdescribe-maintenance-window-targets例では、メンテナンスウィンドウのすべてのターゲットを一覧表示します。

aws ssm describe-maintenance-window-targets \ --window-id "mw-06cf17cbefEXAMPLE"

出力:

{ "Targets": [ { "ResourceType": "INSTANCE", "OwnerInformation": "Single instance", "WindowId": "mw-06cf17cbefEXAMPLE", "Targets": [ { "Values": [ "i-0000293ffdEXAMPLE" ], "Key": "InstanceIds" } ], "WindowTargetId": "350d44e6-28cc-44e2-951f-4b2c9EXAMPLE" }, { "ResourceType": "INSTANCE", "OwnerInformation": "Two instances in a list", "WindowId": "mw-06cf17cbefEXAMPLE", "Targets": [ { "Values": [ "i-0000293ffdEXAMPLE", "i-0cb2b964d3EXAMPLE" ], "Key": "InstanceIds" } ], "WindowTargetId": "e078a987-2866-47be-bedd-d9cf4EXAMPLE" } ] }

例 2: 特定の所有者情報値に一致するメンテナンスウィンドウのすべてのターゲットを一覧表示するには

describe-maintenance-window-targets この例では、メンテナンスウィンドウのすべてのターゲットを特定の値で一覧表示します。

aws ssm describe-maintenance-window-targets \ --window-id "mw-0ecb1226ddEXAMPLE" \ --filters "Key=OwnerInformation,Values=CostCenter1"

出力:

{ "Targets": [ { "WindowId": "mw-0ecb1226ddEXAMPLE", "WindowTargetId": "da89dcc3-7f9c-481d-ba2b-edcb7d0057f9", "ResourceType": "INSTANCE", "Targets": [ { "Key": "tag:Environment", "Values": [ "Prod" ] } ], "OwnerInformation": "CostCenter1", "Name": "ProdTarget1" } ] }

詳細については、「Systems Manager ユーザーガイド」の「メンテナンスウィンドウ (AWS CLI) に関する情報を表示する」を参照してください。 AWS

次の例は、describe-maintenance-window-tasks を使用する方法を説明しています。

AWS CLI

例 1: メンテナンスウィンドウのすべてのタスクを一覧表示するには

次のdescribe-maintenance-window-tasks例では、指定したメンテナンスウィンドウのすべてのタスクを一覧表示します。

aws ssm describe-maintenance-window-tasks \ --window-id "mw-06cf17cbefEXAMPLE"

出力:

{ "Tasks": [ { "WindowId": "mw-06cf17cbefEXAMPLE", "WindowTaskId": "018b31c3-2d77-4b9e-bd48-c91edEXAMPLE", "TaskArn": "AWS-RestartEC2Instance", "TaskParameters": {}, "Type": "AUTOMATION", "Description": "Restarting EC2 Instance for maintenance", "MaxConcurrency": "1", "MaxErrors": "1", "Name": "My-Automation-Example-Task", "Priority": 0, "ServiceRoleArn": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "Targets": [ { "Key": "WindowTargetIds", "Values": [ "da89dcc3-7f9c-481d-ba2b-edcb7EXAMPLE" ] } ] }, { "WindowId": "mw-06cf17cbefEXAMPLE", "WindowTaskId": "1943dee0-0a17-4978-9bf4-3cc2fEXAMPLE", "TaskArn": "AWS-DisableS3BucketPublicReadWrite", "TaskParameters": {}, "Type": "AUTOMATION", "Description": "Automation task to disable read/write access on public S3 buckets", "MaxConcurrency": "10", "MaxErrors": "5", "Name": "My-Disable-S3-Public-Read-Write-Access-Automation-Task", "Priority": 0, "ServiceRoleArn": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "Targets": [ { "Key": "WindowTargetIds", "Values": [ "da89dcc3-7f9c-481d-ba2b-edcb7EXAMPLE" ] } ] } ] }

例 2: AWS RunPowerShellScript コマンドドキュメントを呼び出すメンテナンスウィンドウのすべてのタスクを一覧表示するには

次のdescribe-maintenance-window-tasks例では、 AWS-RunPowerShellScript コマンドドキュメントを呼び出す指定されたメンテナンスウィンドウのすべてのタスクを一覧表示します。

aws ssm describe-maintenance-window-tasks \ --window-id "mw-ab12cd34eEXAMPLE" \ --filters "Key=TaskArn,Values=AWS-RunPowerShellScript"

出力:

{ "Tasks": [ { "WindowId": "mw-ab12cd34eEXAMPLE", "WindowTaskId": "0d36e6b4-3a4f-411e-adcb-3558eEXAMPLE", "TaskArn": "AWS-RunPowerShellScript", "Type": "RUN_COMMAND", "Targets": [ { "Key": "WindowTargetIds", "Values": [ "da89dcc3-7f9c-481d-ba2b-edcb7EXAMPLE" ] } ], "TaskParameters": {}, "Priority": 1, "ServiceRoleArn": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "MaxConcurrency": "1", "MaxErrors": "1", "Name": "MyTask" } ] }

例 3: Priority が 3 であるメンテナンスウィンドウのすべてのタスクを一覧表示するには

次のdescribe-maintenance-window-tasks例では、 が の指定されたメンテナンスウィンドウのすべてのタスクを一覧表示Priorityします3

aws ssm describe-maintenance-window-tasks \ --window-id "mw-ab12cd34eEXAMPLE" \ --filters "Key=Priority,Values=3"

出力:

{ "Tasks": [ { "WindowId": "mw-ab12cd34eEXAMPLE", "WindowTaskId": "0d36e6b4-3a4f-411e-adcb-3558eEXAMPLE", "TaskArn": "AWS-RunPowerShellScript", "Type": "RUN_COMMAND", "Targets": [ { "Key": "WindowTargetIds", "Values": [ "da89dcc3-7f9c-481d-ba2b-edcb7EXAMPLE" ] } ], "TaskParameters": {}, "Priority": 3, "ServiceRoleArn": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "MaxConcurrency": "1", "MaxErrors": "1", "Name": "MyRunCommandTask" }, { "WindowId": "mw-ab12cd34eEXAMPLE", "WindowTaskId": "ee45feff-ad65-4a6c-b478-5cab8EXAMPLE", "TaskArn": "AWS-RestartEC2Instance", "Type": "AUTOMATION", "Targets": [ { "Key": "WindowTargetIds", "Values": [ "da89dcc3-7f9c-481d-ba2b-edcb7EXAMPLE" ] } ], "TaskParameters": {}, "Priority": 3, "ServiceRoleArn": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "MaxConcurrency": "10", "MaxErrors": "5", "Name": "My-Automation-Task", "Description": "A description for my Automation task" } ] }

例 4: Priority が 1 で、Run Command を使用するメンテナンスウィンドウのすべてのタスクを一覧表示するには

describe-maintenance-window-tasks この例では、 が Priority1で、 を使用する、指定されたメンテナンスウィンドウのすべてのタスクを一覧表示しますRun Command

aws ssm describe-maintenance-window-tasks \ --window-id "mw-ab12cd34eEXAMPLE" \ --filters "Key=Priority,Values=1" "Key=TaskType,Values=RUN_COMMAND"

出力:

{ "Tasks": [ { "WindowId": "mw-ab12cd34eEXAMPLE", "WindowTaskId": "0d36e6b4-3a4f-411e-adcb-3558eEXAMPLE", "TaskArn": "AWS-RunPowerShellScript", "Type": "RUN_COMMAND", "Targets": [ { "Key": "WindowTargetIds", "Values": [ "da89dcc3-7f9c-481d-ba2b-edcb7EXAMPLE" ] } ], "TaskParameters": {}, "Priority": 1, "ServiceRoleArn": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "MaxConcurrency": "1", "MaxErrors": "1", "Name": "MyRunCommandTask" } ] }

詳細については、「Systems Manager ユーザーガイド」の「メンテナンスウィンドウ (AWS CLI) に関する情報を表示する」を参照してください。 AWS

次の例は、describe-maintenance-windows-for-target を使用する方法を説明しています。

AWS CLI

特定のインスタンスに関連付けられているすべてのメンテナンスウィンドウを一覧表示するには

次のdescribe-maintenance-windows-for-target例では、指定されたインスタンスに関連付けられたターゲットまたはタスクがあるメンテナンスウィンドウを一覧表示します。

aws ssm describe-maintenance-windows-for-target \ --targets Key=InstanceIds,Values=i-1234567890EXAMPLE \ --resource-type INSTANCE

出力:

{ "WindowIdentities": [ { "WindowId": "mw-0c5ed765acEXAMPLE", "Name": "My-First-Maintenance-Window" } ] }

詳細については、「Systems Manager ユーザーガイド」の「メンテナンスウィンドウ (AWS CLI) に関する情報を表示する」を参照してください。 AWS

次の例は、describe-maintenance-windows を使用する方法を説明しています。

AWS CLI

例 1: すべてのメンテナンスウィンドウを一覧表示するには

次のdescribe-maintenance-windows例では、現在のリージョンの AWS アカウントのすべてのメンテナンスウィンドウを一覧表示します。

aws ssm describe-maintenance-windows

出力:

{ "WindowIdentities": [ { "WindowId": "mw-0ecb1226ddEXAMPLE", "Name": "MyMaintenanceWindow-1", "Enabled": true, "Duration": 2, "Cutoff": 1, "Schedule": "rate(180 minutes)", "NextExecutionTime": "2020-02-12T23:19:20.596Z" }, { "WindowId": "mw-03eb9db428EXAMPLE", "Name": "MyMaintenanceWindow-2", "Enabled": true, "Duration": 3, "Cutoff": 1, "Schedule": "rate(7 days)", "NextExecutionTime": "2020-02-17T23:22:00.956Z" }, ] }

例 2: 有効なすべてのメンテナンスウィンドウを一覧表示するには

次のdescribe-maintenance-windows例では、有効なすべてのメンテナンスウィンドウを一覧表示します。

aws ssm describe-maintenance-windows \ --filters "Key=Enabled,Values=true"

例 3: 特定の名前に一致するメンテナンスウィンドウを一覧表示するには

describe-maintenance-windows この例では、指定した名前のすべてのメンテナンスウィンドウを一覧表示します。

aws ssm describe-maintenance-windows \ --filters "Key=Name,Values=MyMaintenanceWindow"

詳細については、「Systems Manager ユーザーガイド」の「メンテナンスウィンドウ (AWS CLI) に関する情報を表示する」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスDescribeMaintenanceWindows」の「」を参照してください。 AWS CLI

次の例は、describe-ops-items を使用する方法を説明しています。

AWS CLI

のセットを一覧表示するには OpsItems

次のdescribe-ops-items例では、 AWS アカウント OpsItems で開いているすべての のリストを表示します。

aws ssm describe-ops-items \ --ops-item-filters "Key=Status,Values=Open,Operator=Equal"

出力:

{ "OpsItemSummaries": [ { "CreatedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE", "CreatedTime": "2020-03-14T17:02:46.375000-07:00", "LastModifiedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE", "LastModifiedTime": "2020-03-14T17:02:46.375000-07:00", "Source": "SSM", "Status": "Open", "OpsItemId": "oi-7cfc5EXAMPLE", "Title": "SSM Maintenance Window execution failed", "OperationalData": { "/aws/dedup": { "Value": "{\"dedupString\":\"SSMOpsItems-SSM-maintenance-window-execution-failed\"}", "Type": "SearchableString" }, "/aws/resources": { "Value": "[{\"arn\":\"arn:aws:ssm:us-east-2:111222333444:maintenancewindow/mw-034093d322EXAMPLE\"}]", "Type": "SearchableString" } }, "Category": "Availability", "Severity": "3" }, { "CreatedBy": "arn:aws:sts::1112223233444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE", "CreatedTime": "2020-02-26T11:43:15.426000-08:00", "LastModifiedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE", "LastModifiedTime": "2020-02-26T11:43:15.426000-08:00", "Source": "EC2", "Status": "Open", "OpsItemId": "oi-6f966EXAMPLE", "Title": "EC2 instance stopped", "OperationalData": { "/aws/automations": { "Value": "[ { \"automationType\": \"AWS:SSM:Automation\", \"automationId\": \"AWS-RestartEC2Instance\" } ]", "Type": "SearchableString" }, "/aws/dedup": { "Value": "{\"dedupString\":\"SSMOpsItems-EC2-instance-stopped\"}", "Type": "SearchableString" }, "/aws/resources": { "Value": "[{\"arn\":\"arn:aws:ec2:us-east-2:111222333444:instance/i-0beccfbc02EXAMPLE\"}]", "Type": "SearchableString" } }, "Category": "Availability", "Severity": "3" } ] }

詳細については、「Systems Manager ユーザーガイド」の OpsItems「 の使用」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスDescribeOpsItems」の「」を参照してください。 AWS CLI

次の例は、describe-parameters を使用する方法を説明しています。

AWS CLI

例 1: すべてのパラメータを一覧表示するには

次のdescribe-parameters例では、現在の AWS アカウントとリージョンのすべてのパラメータを一覧表示します。

aws ssm describe-parameters

出力:

{ "Parameters": [ { "Name": "MySecureStringParameter", "Type": "SecureString", "KeyId": "alias/aws/ssm", "LastModifiedDate": 1582155479.205, "LastModifiedUser": "arn:aws:sts::111222333444:assumed-role/Admin/Richard-Roe-Managed", "Description": "This is a SecureString parameter", "Version": 2, "Tier": "Advanced", "Policies": [ { "PolicyText": "{\"Type\":\"Expiration\",\"Version\":\"1.0\",\"Attributes\":{\"Timestamp\":\"2020-07-07T22:30:00Z\"}}", "PolicyType": "Expiration", "PolicyStatus": "Pending" }, { "PolicyText": "{\"Type\":\"ExpirationNotification\",\"Version\":\"1.0\",\"Attributes\":{\"Before\":\"12\",\"Unit\":\"Hours\"}}", "PolicyType": "ExpirationNotification", "PolicyStatus": "Pending" } ] }, { "Name": "MyStringListParameter", "Type": "StringList", "LastModifiedDate": 1582154764.222, "LastModifiedUser": "arn:aws:iam::111222333444:user/Mary-Major", "Description": "This is a StringList parameter", "Version": 1, "Tier": "Standard", "Policies": [] }, { "Name": "MyStringParameter", "Type": "String", "LastModifiedDate": 1582154711.976, "LastModifiedUser": "arn:aws:iam::111222333444:user/Alejandro-Rosalez", "Description": "This is a String parameter", "Version": 1, "Tier": "Standard", "Policies": [] }, { "Name": "latestAmi", "Type": "String", "LastModifiedDate": 1580862415.521, "LastModifiedUser": "arn:aws:sts::111222333444:assumed-role/lambda-ssm-role/Automation-UpdateSSM-Param", "Version": 3, "Tier": "Standard", "Policies": [] } ] }

例 2: 特定のメタデータに一致するすべてのパラメータを一覧表示するには

この describe-parameters の例は、フィルターに一致するすべてのパラメータを一覧表示します。

aws ssm describe-parameters --filters "Key=Type,Values=StringList"

出力:

{ "Parameters": [ { "Name": "MyStringListParameter", "Type": "StringList", "LastModifiedDate": 1582154764.222, "LastModifiedUser": "arn:aws:iam::111222333444:user/Mary-Major", "Description": "This is a StringList parameter", "Version": 1, "Tier": "Standard", "Policies": [] } ] }

詳細については、「AWS Systems Manager ユーザーガイド」の「Systems Manager のパラメータを検索する」を参照してください。

  • API の詳細については、「 コマンドリファレンスDescribeParameters」の「」を参照してください。 AWS CLI

次の例は、describe-patch-baselines を使用する方法を説明しています。

AWS CLI

例 1: すべてのパッチベースラインを一覧表示するには

次のdescribe-patch-baselines例では、現在のリージョンのアカウント内のすべてのパッチベースラインの詳細を取得します。

aws ssm describe-patch-baselines

出力:

{ "BaselineIdentities": [ { "BaselineName": "AWS-SuseDefaultPatchBaseline", "DefaultBaseline": true, "BaselineDescription": "Default Patch Baseline for Suse Provided by AWS.", "BaselineId": "arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0123fdb36e334a3b2", "OperatingSystem": "SUSE" }, { "BaselineName": "AWS-DefaultPatchBaseline", "DefaultBaseline": false, "BaselineDescription": "Default Patch Baseline Provided by AWS.", "BaselineId": "arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-020d361a05defe4ed", "OperatingSystem": "WINDOWS" }, ... { "BaselineName": "MyWindowsPatchBaseline", "DefaultBaseline": true, "BaselineDescription": "My patch baseline for EC2 instances for Windows Server", "BaselineId": "pb-0ad00e0dd7EXAMPLE", "OperatingSystem": "WINDOWS" } ] }

例 2: によって提供されるすべてのパッチベースラインを一覧表示するには AWS

次のdescribe-patch-baselines例では、 が提供するすべてのパッチベースラインを一覧表示します AWS。

aws ssm describe-patch-baselines \ --filters "Key=OWNER,Values=[AWS]"

例 3: 所有しているすべてのパッチベースラインを一覧表示するには

次のdescribe-patch-baselines例では、現在のリージョンのアカウントで作成されたすべてのカスタムパッチベースラインを一覧表示します。

aws ssm describe-patch-baselines \ --filters "Key=OWNER,Values=[Self]"

詳細については、AWS 「Systems Manager ユーザーガイド」の「事前定義パッチベースラインとカスタムパッチベースラインについて」を参照してください。

  • API の詳細については、「 コマンドリファレンスDescribePatchBaselines」の「」を参照してください。 AWS CLI

次の例は、describe-patch-group-state を使用する方法を説明しています。

AWS CLI

パッチグループの状態を取得するには

次のdescribe-patch-group-state例では、パッチグループのパッチコンプライアンスの概要を取得します。

aws ssm describe-patch-group-state \ --patch-group "Production"

出力:

{ "Instances": 21, "InstancesWithCriticalNonCompliantPatches": 1, "InstancesWithFailedPatches": 2, "InstancesWithInstalledOtherPatches": 3, "InstancesWithInstalledPatches": 21, "InstancesWithInstalledPendingRebootPatches": 2, "InstancesWithInstalledRejectedPatches": 1, "InstancesWithMissingPatches": 3, "InstancesWithNotApplicablePatches": 4, "InstancesWithOtherNonCompliantPatches": 1, "InstancesWithSecurityNonCompliantPatches": 1, "InstancesWithUnreportedNotApplicablePatches": 2 }

詳細については、AWS 「Systems Manager ユーザーガイド」の「パッチグループについて <https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-patch-patchgroups.html>__」および「パッチコンプライアンス状態値について」を参照してください。

  • API の詳細については、「 コマンドリファレンスDescribePatchGroupState」の「」を参照してください。 AWS CLI

次の例は、describe-patch-groups を使用する方法を説明しています。

AWS CLI

パッチグループ登録を表示するには

次のdescribe-patch-groups例では、パッチグループの登録を一覧表示します。

aws ssm describe-patch-groups

出力:

{ "Mappings": [ { "PatchGroup": "Production", "BaselineIdentity": { "BaselineId": "pb-0123456789abcdef0", "BaselineName": "ProdPatching", "OperatingSystem": "WINDOWS", "BaselineDescription": "Patches for Production", "DefaultBaseline": false } }, { "PatchGroup": "Development", "BaselineIdentity": { "BaselineId": "pb-0713accee01234567", "BaselineName": "DevPatching", "OperatingSystem": "WINDOWS", "BaselineDescription": "Patches for Development", "DefaultBaseline": true } }, ... ] }

詳細については、AWS 「Systems Manager ユーザーガイド」の「Create a Patch Group <https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-patch-group-tagging.html>__」および「Add a Patch Group to a Patch Baseline」を参照してください。

  • API の詳細については、「 コマンドリファレンスDescribePatchGroups」の「」を参照してください。 AWS CLI

次の例は、describe-patch-properties を使用する方法を説明しています。

AWS CLI

Amazon Linux のパッチの可用性を一覧表示するには

次のdescribe-patch-properties例では、 AWS アカウントでパッチを使用できる Amazon Linux 製品のリストを表示します。

aws ssm describe-patch-properties \ --operating-system AMAZON_LINUX \ --property PRODUCT

出力:

{ "Properties": [ { "Name": "AmazonLinux2012.03" }, { "Name": "AmazonLinux2012.09" }, { "Name": "AmazonLinux2013.03" }, { "Name": "AmazonLinux2013.09" }, { "Name": "AmazonLinux2014.03" }, { "Name": "AmazonLinux2014.09" }, { "Name": "AmazonLinux2015.03" }, { "Name": "AmazonLinux2015.09" }, { "Name": "AmazonLinux2016.03" }, { "Name": "AmazonLinux2016.09" }, { "Name": "AmazonLinux2017.03" }, { "Name": "AmazonLinux2017.09" }, { "Name": "AmazonLinux2018.03" } ] }

詳細については、AWS 「Systems Manager ユーザーガイド」の「パッチベースラインについて」を参照してください。

  • API の詳細については、「 コマンドリファレンスDescribePatchProperties」の「」を参照してください。 AWS CLI

次の例は、describe-sessions を使用する方法を説明しています。

AWS CLI

例 1: すべてのアクティブな Session Manager セッションを一覧表示するには

describe-sessions この例では、指定したユーザーが過去 30 日間に最近作成したアクティブなセッション (接続されたセッションと切断されたセッションの両方) のリストを取得します。このコマンドは、Session Manager を使用して開始されたターゲットへの接続の結果のみを返します。リモートデスクトップ接続や SSH など、他の方法で行われた接続はリストされません。

aws ssm describe-sessions \ --state "Active" \ --filters "key=Owner,value=arn:aws:sts::123456789012:assumed-role/Administrator/Shirley-Rodriguez"

出力:

{ "Sessions": [ { "SessionId": "John-07a16060613c408b5", "Target": "i-1234567890abcdef0", "Status": "Connected", "StartDate": 1550676938.352, "Owner": "arn:aws:sts::123456789012:assumed-role/Administrator/Shirley-Rodriguez", "OutputUrl": {} }, { "SessionId": "John-01edf534b8b56e8eb", "Target": "i-9876543210abcdef0", "Status": "Connected", "StartDate": 1550676842.194, "Owner": "arn:aws:sts::123456789012:assumed-role/Administrator/Shirley-Rodriguez", "OutputUrl": {} } ] }

例 2: 終了したすべての Session Manager セッションを一覧表示するには

describe-sessions この例では、すべてのユーザーについて、過去 30 日間に終了したセッションのリストを取得します。

aws ssm describe-sessions \ --state "History"

出力:

{ "Sessions": [ { "SessionId": "Mary-Major-0022b1eb2b0d9e3bd", "Target": "i-1234567890abcdef0", "Status": "Terminated", "StartDate": 1550520701.256, "EndDate": 1550521931.563, "Owner": "arn:aws:sts::123456789012:assumed-role/Administrator/Mary-Major" }, { "SessionId": "Jane-Roe-0db53f487931ed9d4", "Target": "i-9876543210abcdef0", "Status": "Terminated", "StartDate": 1550161369.149, "EndDate": 1550162580.329, "Owner": "arn:aws:sts::123456789012:assumed-role/Administrator/Jane-Roe" }, ... ], "NextToken": "--token string truncated--" }

詳細については、「Systems Manager ユーザーガイド」の「セッション履歴の表示」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスDescribeSessions」の「」を参照してください。 AWS CLI

次の例は、disassociate-ops-item-related-item を使用する方法を説明しています。

AWS CLI

関連項目の関連付けを削除するには

次のdisassociate-ops-item-related-item例では、 OpsItem と関連項目間の関連付けを削除します。

aws ssm disassociate-ops-item-related-item \ --ops-item-id "oi-f99f2EXAMPLE" \ --association-id "e2036148-cccb-490e-ac2a-390e5EXAMPLE"

このコマンドでは何も出力されません。

詳細については、「Systems Manager ユーザーガイド」の「 での Incident Manager インシデント OpsCenterの使用」を参照してください。 AWS

次の例は、get-automation-execution を使用する方法を説明しています。

AWS CLI

オートメーション実行の詳細を表示するには

次のget-automation-execution例では、オートメーションの実行に関する詳細情報を表示します。

aws ssm get-automation-execution \ --automation-execution-id 73c8eef8-f4ee-4a05-820c-e354fEXAMPLE

出力:

{ "AutomationExecution": { "AutomationExecutionId": "73c8eef8-f4ee-4a05-820c-e354fEXAMPLE", "DocumentName": "AWS-StartEC2Instance", "DocumentVersion": "1", "ExecutionStartTime": 1583737233.748, "ExecutionEndTime": 1583737234.719, "AutomationExecutionStatus": "Success", "StepExecutions": [ { "StepName": "startInstances", "Action": "aws:changeInstanceState", "ExecutionStartTime": 1583737234.134, "ExecutionEndTime": 1583737234.672, "StepStatus": "Success", "Inputs": { "DesiredState": "\"running\"", "InstanceIds": "[\"i-0cb99161f6EXAMPLE\"]" }, "Outputs": { "InstanceStates": [ "running" ] }, "StepExecutionId": "95e70479-cf20-4d80-8018-7e4e2EXAMPLE", "OverriddenParameters": {} } ], "StepExecutionsTruncated": false, "Parameters": { "AutomationAssumeRole": [ "" ], "InstanceId": [ "i-0cb99161f6EXAMPLE" ] }, "Outputs": {}, "Mode": "Auto", "ExecutedBy": "arn:aws:sts::29884EXAMPLE:assumed-role/mw_service_role/OrchestrationService", "Targets": [], "ResolvedTargets": { "ParameterValues": [], "Truncated": false } } }

詳細については、「Systems Manager ユーザーガイド」の「チュートリアル: Linux AMI (AWS CLI) にパッチを適用する」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスGetAutomationExecution」の「」を参照してください。 AWS CLI

次の例は、get-calendar-state を使用する方法を説明しています。

AWS CLI

例 1: 変更カレンダーの現在の状態を取得するには

get-calendar-state この例では、現在の時刻のカレンダーの状態を返します。この例では時刻を指定していないため、カレンダーの現在の状態が報告されます。

aws ssm get-calendar-state \ --calendar-names "MyCalendar"

出力:

{ "State": "OPEN", "AtTime": "2020-02-19T22:28:51Z", "NextTransitionTime": "2020-02-24T21:15:19Z" }

例 2: 指定した時刻の変更カレンダーの状態を取得するには

get-calendar-state この例では、指定された時刻におけるカレンダーの状態を返します。

aws ssm get-calendar-state \ --calendar-names "MyCalendar" \ --at-time "2020-07-19T21:15:19Z"

出力:

{ "State": "CLOSED", "AtTime": "2020-07-19T21:15:19Z" }

詳細については、「Systems Manager ユーザーガイド」の「Change Calendar の状態を取得する」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスGetCalendarState」の「」を参照してください。 AWS CLI

次の例は、get-command-invocation を使用する方法を説明しています。

AWS CLI

コマンド呼び出しの詳細を表示するには

次のget-command-invocation例では、指定したインスタンスで指定したコマンドのすべての呼び出しを一覧表示します。

aws ssm get-command-invocation \ --command-id "ef7fdfd8-9b57-4151-a15c-db9a12345678" \ --instance-id "i-1234567890abcdef0"

出力:

{ "CommandId": "ef7fdfd8-9b57-4151-a15c-db9a12345678", "InstanceId": "i-1234567890abcdef0", "Comment": "b48291dd-ba76-43e0-b9df-13e11ddaac26:6960febb-2907-4b59-8e1a-d6ce8EXAMPLE", "DocumentName": "AWS-UpdateSSMAgent", "DocumentVersion": "", "PluginName": "aws:updateSsmAgent", "ResponseCode": 0, "ExecutionStartDateTime": "2020-02-19T18:18:03.419Z", "ExecutionElapsedTime": "PT0.091S", "ExecutionEndDateTime": "2020-02-19T18:18:03.419Z", "Status": "Success", "StatusDetails": "Success", "StandardOutputContent": "Updating amazon-ssm-agent from 2.3.842.0 to latest\nSuccessfully downloaded https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/ssm-agent-manifest.json\namazon-ssm-agent 2.3.842.0 has already been installed, update skipped\n", "StandardOutputUrl": "", "StandardErrorContent": "", "StandardErrorUrl": "", "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "", "CloudWatchOutputEnabled": false } }

詳細については、AWS 「Systems Manager ユーザーガイド」の「コマンドのステータスについて」を参照してください。

  • API の詳細については、「 コマンドリファレンスGetCommandInvocation」の「」を参照してください。 AWS CLI

次の例は、get-connection-status を使用する方法を説明しています。

AWS CLI

マネージドインスタンスの接続ステータスを表示するには

get-connection-status この例では、指定されたマネージドインスタンスの接続ステータスを返します。

aws ssm get-connection-status \ --target i-1234567890abcdef0

出力:

{ "Target": "i-1234567890abcdef0", "Status": "connected" }
  • API の詳細については、「 コマンドリファレンスGetConnectionStatus」の「」を参照してください。 AWS CLI

次の例は、get-default-patch-baseline を使用する方法を説明しています。

AWS CLI

例 1: デフォルトの Windows パッチベースラインを表示するには

次のget-default-patch-baseline例では、Windows Server のデフォルトのパッチベースラインの詳細を取得します。

aws ssm get-default-patch-baseline

出力:

{ "BaselineId": "pb-0713accee01612345", "OperatingSystem": "WINDOWS" }

例 2: Amazon Linux のデフォルトのパッチベースラインを表示するには

次のget-default-patch-baseline例では、Amazon Linux のデフォルトのパッチベースラインの詳細を取得します。

aws ssm get-default-patch-baseline \ --operating-system AMAZON_LINUX

出力:

{ "BaselineId": "pb-047c6eb9c8fc12345", "OperatingSystem": "AMAZON_LINUX" }

詳細については、AWS 「Systems Manager ユーザーガイド」の「事前定義およびカスタムパッチベースライン <https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-patch-baselines.html>__」および「既存のパッチベースラインをデフォルトとして設定する」を参照してください。

  • API の詳細については、「 コマンドリファレンスGetDefaultPatchBaseline」の「」を参照してください。 AWS CLI

次の例は、get-deployable-patch-snapshot-for-instance を使用する方法を説明しています。

AWS CLI

インスタンスが使用するパッチベースラインの現在のスナップショットを取得するには

次のget-deployable-patch-snapshot-for-instance例では、インスタンスで使用されている指定されたパッチベースラインの現在のスナップショットの詳細を取得します。このコマンドは、インスタンスの認証情報を使用してインスタンスから実行する必要があります。インスタンスの認証情報を確実に使用するには、 を実行し、インスタンスのリージョンのみaws configureを指定します。Access Key および Secret Keyフィールドは空のままにします。

ヒント: uuidgenを使用して を生成しますsnapshot-id

aws ssm get-deployable-patch-snapshot-for-instance \ --instance-id "i-1234567890abcdef0" \ --snapshot-id "521c3536-930c-4aa9-950e-01234567abcd"

出力:

{ "InstanceId": "i-1234567890abcdef0", "SnapshotId": "521c3536-930c-4aa9-950e-01234567abcd", "Product": "AmazonLinux2018.03", "SnapshotDownloadUrl": "https://patch-baseline-snapshot-us-east-1.s3.amazonaws.com/ed85194ef27214f5984f28b4d664d14f7313568fea7d4b6ac6c10ad1f729d7e7-773304212436/AMAZON_LINUX-521c3536-930c-4aa9-950e-01234567abcd?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20190215T164031Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=AKIAJ5C56P35AEBRX2QQ%2F20190215%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=efaaaf6e3878e77f48a6697e015efdbda9c426b09c5822055075c062f6ad2149" }

詳細については、AWS 「Systems Manager ユーザーガイド」の「パラメータ名: スナップショット ID」を参照してください。

次の例は、get-document を使用する方法を説明しています。

AWS CLI

ドキュメントコンテンツを取得するには

次のget-document例では、Systems Manager ドキュメントの内容を表示します。

aws ssm get-document \ --name "AWS-RunShellScript"

出力:

{ "Name": "AWS-RunShellScript", "DocumentVersion": "1", "Status": "Active", "Content": "{\n \"schemaVersion\":\"1.2\",\n \"description\":\"Run a shell script or specify the commands to run.\",\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 \"workingDirectory\":{\n \"type\":\"String\",\n \"default\":\"\",\n \"description\":\"(Optional) The path to the working directory on your instance.\",\n \"maxChars\":4096\n },\n \"executionTimeout\":{\n \"type\":\"String\",\n \"default\":\"3600\",\n \"description\":\"(Optional) The time in seconds for a command to complete before it is considered to have failed. Default is 3600 (1 hour). Maximum is 172800 (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)\"\n }\n },\n \"runtimeConfig\":{\n \"aws:runShellScript\":{\n \"properties\":[\n {\n \"id\":\"0.aws:runShellScript\",\n \"runCommand\":\"{{ commands }}\",\n \"workingDirectory\":\"{{ workingDirectory }}\",\n \"timeoutSeconds\":\"{{ executionTimeout }}\"\n }\n ]\n }\n }\n}\n", "DocumentType": "Command", "DocumentFormat": "JSON" }

詳細については、AWS 「Systems Manager ユーザーガイド」のAWS 「Systems Manager ドキュメント」を参照してください。

  • API の詳細については、「 コマンドリファレンスGetDocument」の「」を参照してください。 AWS CLI

次の例は、get-inventory-schema を使用する方法を説明しています。

AWS CLI

インベントリスキーマを表示するには

この例では、アカウントのインベントリタイプ名のリストを返します。

コマンド:

aws ssm get-inventory-schema

出力:

{ "Schemas": [ { "TypeName": "AWS:AWSComponent", "Version": "1.0", "Attributes": [ { "Name": "Name", "DataType": "STRING" }, { "Name": "ApplicationType", "DataType": "STRING" }, { "Name": "Publisher", "DataType": "STRING" }, { "Name": "Version", "DataType": "STRING" }, { "Name": "InstalledTime", "DataType": "STRING" }, { "Name": "Architecture", "DataType": "STRING" }, { "Name": "URL", "DataType": "STRING" } ] }, ... ], "NextToken": "--token string truncated--" }

特定のインベントリタイプのインベントリスキーマを表示するには

この例では、 AWS:AWS Component インベントリタイプのインベントリスキーマを返します。

コマンド:

aws ssm get-inventory-schema --type-name "AWS:AWSComponent"
  • API の詳細については、「 コマンドリファレンスGetInventorySchema」の「」を参照してください。 AWS CLI

次の例は、get-inventory を使用する方法を説明しています。

AWS CLI

インベントリを表示するには

この例では、インベントリのカスタムメタデータを取得します。

コマンド:

aws ssm get-inventory

出力:

{ "Entities": [ { "Data": { "AWS:InstanceInformation": { "Content": [ { "ComputerName": "ip-172-31-44-222.us-west-2.compute.internal", "InstanceId": "i-0cb2b964d3e14fd9f", "IpAddress": "172.31.44.222", "AgentType": "amazon-ssm-agent", "ResourceType": "EC2Instance", "AgentVersion": "2.0.672.0", "PlatformVersion": "2016.09", "PlatformName": "Amazon Linux AMI", "PlatformType": "Linux" } ], "TypeName": "AWS:InstanceInformation", "SchemaVersion": "1.0", "CaptureTime": "2017-02-20T18:03:58Z" } }, "Id": "i-0cb2b964d3e14fd9f" } ] }
  • API の詳細については、「 コマンドリファレンスGetInventory」の「」を参照してください。 AWS CLI

次の例は、get-maintenance-window-execution-task-invocation を使用する方法を説明しています。

AWS CLI

メンテナンスウィンドウのタスク呼び出しに関する情報を取得するには

次のget-maintenance-window-execution-task-invocation例では、指定されたメンテナンスウィンドウの実行の一部である指定されたタスク呼び出しに関する情報を一覧表示します。

aws ssm get-maintenance-window-execution-task-invocation \ --window-execution-id "bc494bfa-e63b-49f6-8ad1-aa9f2EXAMPLE" \ --task-id "96f2ad59-97e3-461d-a63d-40c8aEXAMPLE" \ --invocation-id "a5273e2c-d2c6-4880-b3e1-5e550EXAMPLE"

出力:

{ "Status": "SUCCESS", "Parameters": "{\"comment\":\"\",\"documentName\":\"AWS-RunPowerShellScript\",\"instanceIds\":[\"i-1234567890EXAMPLE\"],\"maxConcurrency\":\"1\",\"maxErrors\":\"1\",\"parameters\":{\"executionTimeout\":[\"3600\"],\"workingDirectory\":[\"\"],\"commands\":[\"echo Hello\"]},\"timeoutSeconds\":600}", "ExecutionId": "03b6baa0-5460-4e15-83f2-ea685EXAMPLE", "InvocationId": "a5273e2c-d2c6-4880-b3e1-5e550EXAMPLE", "StartTime": 1549998326.421, "TaskType": "RUN_COMMAND", "EndTime": 1550001931.784, "WindowExecutionId": "bc494bfa-e63b-49f6-8ad1-aa9f2EXAMPLE", "StatusDetails": "Failed", "TaskExecutionId": "96f2ad59-97e3-461d-a63d-40c8aEXAMPLE" }

詳細については、AWS 「Systems Manager ユーザーガイド」の「タスクとタスク実行 (AWS CLI) に関する情報を表示する」を参照してください。

次の例は、get-maintenance-window-execution-task を使用する方法を説明しています。

AWS CLI

メンテナンスウィンドウのタスク実行に関する情報を取得するには

次のget-maintenance-window-execution-task例では、指定されたメンテナンスウィンドウ実行の一部であるタスクに関する情報を一覧表示します。

aws ssm get-maintenance-window-execution-task \ --window-execution-id "518d5565-5969-4cca-8f0e-da3b2EXAMPLE" \ --task-id "ac0c6ae1-daa3-4a89-832e-d3845EXAMPLE"

出力:

{ "WindowExecutionId": "518d5565-5969-4cca-8f0e-da3b2EXAMPLE", "TaskExecutionId": "ac0c6ae1-daa3-4a89-832e-d3845EXAMPLE", "TaskArn": "AWS-RunPatchBaseline", "ServiceRole": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "Type": "RUN_COMMAND", "TaskParameters": [ { "BaselineOverride": { "Values": [ "" ] }, "InstallOverrideList": { "Values": [ "" ] }, "Operation": { "Values": [ "Scan" ] }, "RebootOption": { "Values": [ "RebootIfNeeded" ] }, "SnapshotId": { "Values": [ "{{ aws:ORCHESTRATION_ID }}" ] }, "aws:InstanceId": { "Values": [ "i-02573cafcfEXAMPLE", "i-0471e04240EXAMPLE", "i-07782c72faEXAMPLE" ] } } ], "Priority": 1, "MaxConcurrency": "1", "MaxErrors": "3", "Status": "SUCCESS", "StartTime": "2021-08-04T11:45:35.088000-07:00", "EndTime": "2021-08-04T11:53:09.079000-07:00" }

詳細については、AWS 「Systems Manager ユーザーガイド」の「タスクとタスク実行 (AWS CLI) に関する情報を表示する」を参照してください。

次の例は、get-maintenance-window-execution を使用する方法を説明しています。

AWS CLI

メンテナンスウィンドウのタスク実行に関する情報を取得するには

次のget-maintenance-window-execution例では、指定されたメンテナンスウィンドウ実行の一部として実行されたタスクに関する情報を一覧表示します。

aws ssm get-maintenance-window-execution \ --window-execution-id "518d5565-5969-4cca-8f0e-da3b2EXAMPLE"

出力:

{ "Status": "SUCCESS", "TaskIds": [ "ac0c6ae1-daa3-4a89-832e-d3845EXAMPLE" ], "StartTime": 1487692834.595, "EndTime": 1487692835.051, "WindowExecutionId": "518d5565-5969-4cca-8f0e-da3b2EXAMPLE", }

詳細については、AWS 「Systems Manager ユーザーガイド」の「タスクとタスク実行 (AWS CLI) に関する情報を表示する」を参照してください。

  • API の詳細については、「 コマンドリファレンスGetMaintenanceWindowExecution」の「」を参照してください。 AWS CLI

次の例は、get-maintenance-window-task を使用する方法を説明しています。

AWS CLI

メンテナンスウィンドウタスクに関する情報を取得するには

次のget-maintenance-window-task例では、指定されたメンテナンスウィンドウタスクの詳細を取得します。

aws ssm get-maintenance-window-task \ --window-id mw-0c5ed765acEXAMPLE \ --window-task-id 0e842a8d-2d44-4886-bb62-af8dcEXAMPLE

出力:

{ "ServiceRoleArn": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "MaxErrors": "1", "TaskArn": "AWS-RunPowerShellScript", "MaxConcurrency": "1", "WindowTaskId": "0e842a8d-2d44-4886-bb62-af8dcEXAMPLE", "TaskParameters": {}, "Priority": 1, "TaskInvocationParameters": { "RunCommand": { "Comment": "", "TimeoutSeconds": 600, "Parameters": { "commands": [ "echo Hello" ], "executionTimeout": [ "3600" ], "workingDirectory": [ "" ] } } }, "WindowId": "mw-0c5ed765acEXAMPLE", "TaskType": "RUN_COMMAND", "Targets": [ { "Values": [ "84c818da-b619-4d3d-9651-946f3EXAMPLE" ], "Key": "WindowTargetIds" } ], "Name": "ExampleTask" }

詳細については、「Systems Manager ユーザーガイド」の「メンテナンスウィンドウ (AWS CLI) に関する情報を表示する」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスGetMaintenanceWindowTask」の「」を参照してください。 AWS CLI

次の例は、get-maintenance-window を使用する方法を説明しています。

AWS CLI

メンテナンスウィンドウに関する情報を取得するには

次のget-maintenance-window例では、指定されたメンテナンスウィンドウの詳細を取得します。

aws ssm get-maintenance-window \ --window-id "mw-03eb9db428EXAMPLE"

出力:

{ "AllowUnassociatedTargets": true, "CreatedDate": 1515006912.957, "Cutoff": 1, "Duration": 6, "Enabled": true, "ModifiedDate": 2020-01-01T10:04:04.099Z, "Name": "My-Maintenance-Window", "Schedule": "rate(3 days)", "WindowId": "mw-03eb9db428EXAMPLE", "NextExecutionTime": "2020-02-25T00:08:15.099Z" }

詳細については、「Systems Manager ユーザーガイド」の「メンテナンスウィンドウ (AWS CLI) に関する情報を表示する」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスGetMaintenanceWindow」の「」を参照してください。 AWS CLI

次の例は、get-ops-item を使用する方法を説明しています。

AWS CLI

に関する情報を表示するには OpsItem

次のget-ops-item例では、指定した の詳細を表示します OpsItem。

aws ssm get-ops-item \ --ops-item-id oi-0b725EXAMPLE

出力:

{ "OpsItem": { "CreatedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE", "CreatedTime": "2019-12-04T15:52:16.793000-08:00", "Description": "CloudWatch Event Rule SSMOpsItems-EC2-instance-terminated was triggered. Your EC2 instance has terminated. See below for more details.", "LastModifiedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE", "LastModifiedTime": "2019-12-04T15:52:16.793000-08:00", "Notifications": [], "RelatedOpsItems": [], "Status": "Open", "OpsItemId": "oi-0b725EXAMPLE", "Title": "EC2 instance terminated", "Source": "EC2", "OperationalData": { "/aws/automations": { "Value": "[ { \"automationType\": \"AWS:SSM:Automation\", \"automationId\": \"AWS-CreateManagedWindowsInstance\" }, { \"automationType\": \"AWS:SSM:Automation\", \"automationId\": \"AWS-CreateManagedLinuxInstance\" } ]", "Type": "SearchableString" }, "/aws/dedup": { "Value": "{\"dedupString\":\"SSMOpsItems-EC2-instance-terminated\"}", "Type": "SearchableString" }, "/aws/resources": { "Value": "[{\"arn\":\"arn:aws:ec2:us-east-2:111222333444:instance/i-05adec7e97EXAMPLE\"}]", "Type": "SearchableString" }, "event-time": { "Value": "2019-12-04T23:52:16Z", "Type": "String" }, "instance-state": { "Value": "terminated", "Type": "String" } }, "Category": "Availability", "Severity": "4" } }

詳細については、「Systems Manager ユーザーガイド」の OpsItems「 の使用」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスGetOpsItem」の「」を参照してください。 AWS CLI

次の例は、get-ops-summary を使用する方法を説明しています。

AWS CLI

すべての の概要を表示するには OpsItems

次のget-ops-summary例では、 AWS アカウント OpsItems 内のすべての の概要を表示します。

aws ssm get-ops-summary

出力:

{ "Entities": [ { "Id": "oi-4309fEXAMPLE", "Data": { "AWS:OpsItem": { "CaptureTime": "2020-02-26T18:58:32.918Z", "Content": [ { "AccountId": "111222333444", "Category": "Availability", "CreatedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE", "CreatedTime": "2020-02-26T19:10:44.149Z", "Description": "CloudWatch Event Rule SSMOpsItems-EC2-instance-terminated was triggered. Your EC2 instance has terminated. See below for more details.", "LastModifiedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE", "LastModifiedTime": "2020-02-26T19:10:44.149Z", "Notifications": "", "OperationalData": "{\"/aws/automations\":{\"type\":\"SearchableString\",\"value\":\"[ { \\\"automationType\\\": \\\"AWS:SSM:Automation\\\", \\\"automationId\\\": \\\"AWS-CreateManagedWindowsInstance\\\" }, { \\\"automationType\\\": \\\"AWS:SSM:Automation\\\", \\\"automationId\\\": \\\"AWS-CreateManagedLinuxInstance\\\" } ]\"},\"/aws/resources\":{\"type\":\"SearchableString\",\"value\":\"[{\\\"arn\\\":\\\"arn:aws:ec2:us-east-2:111222333444:instance/i-0acbd0800fEXAMPLE\\\"}]\"},\"/aws/dedup\":{\"type\":\"SearchableString\",\"value\":\"{\\\"dedupString\\\":\\\"SSMOpsItems-EC2-instance-terminated\\\"}\"}}", "OpsItemId": "oi-4309fEXAMPLE", "RelatedItems": "", "Severity": "3", "Source": "EC2", "Status": "Open", "Title": "EC2 instance terminated" } ] } } }, { "Id": "oi-bb2a0e6a4541", "Data": { "AWS:OpsItem": { "CaptureTime": "2019-11-26T19:20:06.161Z", "Content": [ { "AccountId": "111222333444", "Category": "Availability", "CreatedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE", "CreatedTime": "2019-11-26T20:00:07.237Z", "Description": "CloudWatch Event Rule SSMOpsItems-SSM-maintenance-window-execution-failed was triggered. Your SSM Maintenance Window execution has failed. See below for more details.", "LastModifiedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE", "LastModifiedTime": "2019-11-26T20:00:07.237Z", "Notifications": "", "OperationalData": "{\"/aws/resources\":{\"type\":\"SearchableString\",\"value\":\"[{\\\"arn\\\":\\\"arn:aws:ssm:us-east-2:111222333444:maintenancewindow/mw-0e83ba440dEXAMPLE\\\"}]\"},\"/aws/dedup\":{\"type\":\"SearchableString\",\"value\":\"{\\\"dedupString\\\":\\\"SSMOpsItems-SSM-maintenance-window-execution-failed\\\"}\"}}", "OpsItemId": "oi-bb2a0EXAMPLE", "RelatedItems": "", "Severity": "3", "Source": "SSM", "Status": "Open", "Title": "SSM Maintenance Window execution failed" } ] } } } ] }

詳細については、「Systems Manager ユーザーガイド」の OpsItems「 の使用」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスGetOpsSummary」の「」を参照してください。 AWS CLI

次の例は、get-parameter-history を使用する方法を説明しています。

AWS CLI

パラメータの値履歴を取得するには

次のget-parameter-history例では、指定したパラメータの変更履歴を、その値を含めて一覧表示します。

aws ssm get-parameter-history \ --name "MyStringParameter"

出力:

{ "Parameters": [ { "Name": "MyStringParameter", "Type": "String", "LastModifiedDate": 1582154711.976, "LastModifiedUser": "arn:aws:iam::111222333444:user/Mary-Major", "Description": "This is the first version of my String parameter", "Value": "Veni", "Version": 1, "Labels": [], "Tier": "Standard", "Policies": [] }, { "Name": "MyStringParameter", "Type": "String", "LastModifiedDate": 1582156093.471, "LastModifiedUser": "arn:aws:iam::111222333444:user/Mary-Major", "Description": "This is the second version of my String parameter", "Value": "Vidi", "Version": 2, "Labels": [], "Tier": "Standard", "Policies": [] }, { "Name": "MyStringParameter", "Type": "String", "LastModifiedDate": 1582156117.545, "LastModifiedUser": "arn:aws:iam::111222333444:user/Mary-Major", "Description": "This is the third version of my String parameter", "Value": "Vici", "Version": 3, "Labels": [], "Tier": "Standard", "Policies": [] } ] }

詳細については、「Systems Manager ユーザーガイド」の「パラメータバージョンの使用」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスGetParameterHistory」の「」を参照してください。 AWS CLI

次の例は、get-parameter を使用する方法を説明しています。

AWS CLI

例 1: パラメータの値を表示するには

次のget-parameter例では、指定された単一パラメータの値を一覧表示します。

aws ssm get-parameter \ --name "MyStringParameter"

出力:

{ "Parameter": { "Name": "MyStringParameter", "Type": "String", "Value": "Veni", "Version": 1, "LastModifiedDate": 1530018761.888, "ARN": "arn:aws:ssm:us-east-2:111222333444:parameter/MyStringParameter" "DataType": "text" } }

詳細については、「Systems Manager ユーザーガイド」の「パラメータストアの使用」を参照してください。 AWS

例 2: SecureString パラメータの値を復号するには

次のget-parameter例では、指定されたSecureStringパラメータの値を復号します。

aws ssm get-parameter \ --name "MySecureStringParameter" \ --with-decryption

出力:

{ "Parameter": { "Name": "MySecureStringParameter", "Type": "SecureString", "Value": "16679b88-310b-4895-a943-e0764EXAMPLE", "Version": 2, "LastModifiedDate": 1582155479.205, "ARN": "arn:aws:ssm:us-east-2:111222333444:parameter/MySecureStringParameter" "DataType": "text" } }

詳細については、「Systems Manager ユーザーガイド」の「パラメータストアの使用」を参照してください。 AWS

例 3: ラベルを使用してパラメータの値を表示するには

次のget-parameter例では、指定したラベルを持つ指定した単一パラメータの値を一覧表示します。

aws ssm get-parameter \ --name "MyParameter:label"

出力:

{ "Parameter": { "Name": "MyParameter", "Type": "String", "Value": "parameter version 2", "Version": 2, "Selector": ":label", "LastModifiedDate": "2021-07-12T09:49:15.865000-07:00", "ARN": "arn:aws:ssm:us-west-2:786973925828:parameter/MyParameter", "DataType": "text" } }

詳細については、「Systems Manager ユーザーガイド」の「パラメータラベルの使用」を参照してください。 AWS

例 4: バージョンを使用してパラメータの値を表示するには

次のget-parameter例では、指定された単一パラメータバージョンの値を一覧表示します。

aws ssm get-parameter \ --name "MyParameter:2"

出力:

{ "Parameter": { "Name": "MyParameter", "Type": "String", "Value": "parameter version 2", "Version": 2, "Selector": ":2", "LastModifiedDate": "2021-07-12T09:49:15.865000-07:00", "ARN": "arn:aws:ssm:us-west-2:786973925828:parameter/MyParameter", "DataType": "text" } }

詳細については、「Systems Manager ユーザーガイド」の「パラメータラベルの使用」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスGetParameter」の「」を参照してください。 AWS CLI

次の例は、get-parameters-by-path を使用する方法を説明しています。

AWS CLI

特定のパスのパラメータを一覧表示するには

次のget-parameters-by-path例では、指定した階層内のパラメータを一覧表示します。

aws ssm get-parameters-by-path \ --path "/site/newyork/department/"

出力:

{ "Parameters": [ { "Name": "/site/newyork/department/marketing", "Type": "String", "Value": "Floor 2", "Version": 1, "LastModifiedDate": 1530018761.888, "ARN": "arn:aws:ssm:us-east-1:111222333444:parameter/site/newyork/department/marketing" }, { "Name": "/site/newyork/department/infotech", "Type": "String", "Value": "Floor 3", "Version": 1, "LastModifiedDate": 1530018823.429, "ARN": "arn:aws:ssm:us-east-1:111222333444:parameter/site/newyork/department/infotech" }, ... ] }

詳細については、AWS 「Systems Manager ユーザーガイド」の「パラメータ階層の使用」を参照してください。

  • API の詳細については、「 コマンドリファレンスGetParametersByPath」の「」を参照してください。 AWS CLI

次の例は、get-parameters を使用する方法を説明しています。

AWS CLI

例 1: パラメータの値を一覧表示するには

次のget-parameters例では、指定した 3 つのパラメータの値を一覧表示します。

aws ssm get-parameters \ --names "MyStringParameter" "MyStringListParameter" "MyInvalidParameterName"

出力:

{ "Parameters": [ { "Name": "MyStringListParameter", "Type": "StringList", "Value": "alpha,beta,gamma", "Version": 1, "LastModifiedDate": 1582154764.222, "ARN": "arn:aws:ssm:us-east-2:111222333444:parameter/MyStringListParameter" "DataType": "text" }, { "Name": "MyStringParameter", "Type": "String", "Value": "Vici", "Version": 3, "LastModifiedDate": 1582156117.545, "ARN": "arn:aws:ssm:us-east-2:111222333444:parameter/MyStringParameter" "DataType": "text" } ], "InvalidParameters": [ "MyInvalidParameterName" ] }

詳細については、「Systems Manager ユーザーガイド」の「パラメータストアの使用」を参照してください。 AWS

例 2: `-query`` オプションを使用して複数のパラメータの名前と値を一覧表示するには

次のget-parameters例では、指定したパラメータの名前と値を一覧表示します。

aws ssm get-parameters \ --names MyStringParameter MyStringListParameter \ --query "Parameters[*].{Name:Name,Value:Value}"

出力:

[ { "Name": "MyStringListParameter", "Value": "alpha,beta,gamma" }, { "Name": "MyStringParameter", "Value": "Vidi" } ]

詳細については、「Systems Manager ユーザーガイド」の「パラメータストアの使用」を参照してください。 AWS

例 3: ラベルを使用してパラメータの値を表示するには

次のget-parameter例では、指定したラベルを持つ指定した単一パラメータの値を一覧表示します。

aws ssm get-parameter \ --name "MyParameter:label"

出力:

{ "Parameters": [ { "Name": "MyLabelParameter", "Type": "String", "Value": "parameter by label", "Version": 1, "Selector": ":label", "LastModifiedDate": "2021-07-12T09:49:15.865000-07:00", "ARN": "arn:aws:ssm:us-west-2:786973925828:parameter/MyParameter", "DataType": "text" }, { "Name": "MyVersionParameter", "Type": "String", "Value": "parameter by version", "Version": 2, "Selector": ":2", "LastModifiedDate": "2021-03-24T16:20:28.236000-07:00", "ARN": "arn:aws:ssm:us-west-2:786973925828:parameter/unlabel-param", "DataType": "text" } ], "InvalidParameters": [] }

詳細については、「Systems Manager ユーザーガイド」の「パラメータラベルの使用」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスGetParameters」の「」を参照してください。 AWS CLI

次の例は、get-patch-baseline-for-patch-group を使用する方法を説明しています。

AWS CLI

パッチグループのパッチベースラインを表示するには

次のget-patch-baseline-for-patch-group例では、指定したパッチグループのパッチベースラインに関する詳細を取得します。

aws ssm get-patch-baseline-for-patch-group \ --patch-group "DEV"

出力:

{ "PatchGroup": "DEV", "BaselineId": "pb-0123456789abcdef0", "OperatingSystem": "WINDOWS" }

詳細については、AWS 「Systems Manager ユーザーガイド」の「Create a Patch Group <https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-patch-group-tagging.html>__」および「Add a Patch Group to a Patch Baseline」を参照してください。

  • API の詳細については、「 コマンドリファレンスGetPatchBaselineForPatchGroup」の「」を参照してください。 AWS CLI

次の例は、get-patch-baseline を使用する方法を説明しています。

AWS CLI

パッチベースラインを表示するには

次のget-patch-baseline例では、指定したパッチベースラインの詳細を取得します。

aws ssm get-patch-baseline \ --baseline-id "pb-0123456789abcdef0"

出力:

{ "BaselineId": "pb-0123456789abcdef0", "Name": "WindowsPatching", "OperatingSystem": "WINDOWS", "GlobalFilters": { "PatchFilters": [] }, "ApprovalRules": { "PatchRules": [ { "PatchFilterGroup": { "PatchFilters": [ { "Key": "PRODUCT", "Values": [ "WindowsServer2016" ] } ] }, "ComplianceLevel": "CRITICAL", "ApproveAfterDays": 0, "EnableNonSecurity": false } ] }, "ApprovedPatches": [], "ApprovedPatchesComplianceLevel": "UNSPECIFIED", "ApprovedPatchesEnableNonSecurity": false, "RejectedPatches": [], "RejectedPatchesAction": "ALLOW_AS_DEPENDENCY", "PatchGroups": [ "QA", "DEV" ], "CreatedDate": 1550244180.465, "ModifiedDate": 1550244180.465, "Description": "Patches for Windows Servers", "Sources": [] }

詳細については、AWS 「Systems Manager ユーザーガイド」の「パッチベースラインについて」を参照してください。

  • API の詳細については、「 コマンドリファレンスGetPatchBaseline」の「」を参照してください。 AWS CLI

次の例は、get-service-setting を使用する方法を説明しています。

AWS CLI

Parameter Store スループットのサービス設定を取得するには

次のget-service-setting例では、指定したリージョンの Parameter Store スループットの現在のサービス設定を取得します。

aws ssm get-service-setting \ --setting-id arn:aws:ssm:us-east-1:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled

出力:

{ "ServiceSetting": { "SettingId": "/ssm/parameter-store/high-throughput-enabled", "SettingValue": "false", "LastModifiedDate": 1555532818.578, "LastModifiedUser": "System", "ARN": "arn:aws:ssm:us-east-1:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled", "Status": "Default" } }

詳細については、AWS 「Systems Manager ユーザーガイド」の「パラメータストアのスループットを上げる」を参照してください。

  • API の詳細については、「 コマンドリファレンスGetServiceSetting」の「」を参照してください。 AWS CLI

次の例は、label-parameter-version を使用する方法を説明しています。

AWS CLI

例 1: パラメータの最新バージョンにラベルを追加するには

次のlabel-parameter-version例では、指定したパラメータの最新バージョンにラベルを追加します。

aws ssm label-parameter-version \ --name "MyStringParameter" \ --labels "ProductionReady"

出力:

{ "InvalidLabels": [], "ParameterVersion": 3 }

詳細については、「Systems Manager ユーザーガイド」の「パラメータラベルの使用」を参照してください。 AWS

例 2: 特定のバージョンのパラメータにラベルを追加するには

次のlabel-parameter-version例では、指定されたバージョンのパラメータにラベルを追加します。

aws ssm label-parameter-version \ --name "MyStringParameter" \ --labels "ProductionReady" \ --parameter-version "2" --labels "DevelopmentReady"

詳細については、「Systems Manager ユーザーガイド」の「パラメータラベルの使用」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスLabelParameterVersion」の「」を参照してください。 AWS CLI

次の例は、list-association-versions を使用する方法を説明しています。

AWS CLI

特定の関連付け ID の関連付けのすべてのバージョンを一覧表示するには

次のlist-association-versions例では、指定した関連付けのすべてのバージョンを一覧表示します。

aws ssm list-association-versions \ --association-id "8dfe3659-4309-493a-8755-0123456789ab"

出力:

{ "AssociationVersions": [ { "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "AssociationVersion": "1", "CreatedDate": 1550505536.726, "Name": "AWS-UpdateSSMAgent", "Parameters": { "allowDowngrade": [ "false" ], "version": [ "" ] }, "Targets": [ { "Key": "InstanceIds", "Values": [ "i-1234567890abcdef0" ] } ], "ScheduleExpression": "cron(0 00 12 ? * SUN *)", "AssociationName": "UpdateSSMAgent" } ] }

詳細については、「Systems Manager ユーザーガイド」の「Systems Manager での関連付けの使用」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスListAssociationVersions」の「」を参照してください。 AWS CLI

次の例は、list-associations を使用する方法を説明しています。

AWS CLI

例 1: 特定のインスタンスの関連付けを一覧表示するには

次の list-associations の例では AssociationName、、UpdateSSMAgent とのすべての関連付けを一覧表示します。

aws ssm list-associations / --association-filter-list "key=AssociationName,value=UpdateSSMAgent"

出力:

{ "Associations": [ { "Name": "AWS-UpdateSSMAgent", "InstanceId": "i-1234567890abcdef0", "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "AssociationVersion": "1", "Targets": [ { "Key": "InstanceIds", "Values": [ "i-016648b75dd622dab" ] } ], "Overview": { "Status": "Pending", "DetailedStatus": "Associated", "AssociationStatusAggregatedCount": { "Pending": 1 } }, "ScheduleExpression": "cron(0 00 12 ? * SUN *)", "AssociationName": "UpdateSSMAgent" } ] }

詳細については、「Systems Manager ユーザーガイド」の「Systems Manager での関連付けの使用」を参照してください。

例 2: 特定のドキュメントの関連付けを一覧表示するには

次の list-associations の例では、指定したドキュメントのすべての関連付けを一覧表示します。

aws ssm list-associations / --association-filter-list "key=Name,value=AWS-UpdateSSMAgent"

出力:

{ "Associations": [ { "Name": "AWS-UpdateSSMAgent", "InstanceId": "i-1234567890abcdef0", "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "AssociationVersion": "1", "Targets": [ { "Key": "InstanceIds", "Values": [ "i-1234567890abcdef0" ] } ], "LastExecutionDate": 1550505828.548, "Overview": { "Status": "Success", "DetailedStatus": "Success", "AssociationStatusAggregatedCount": { "Success": 1 } }, "ScheduleExpression": "cron(0 00 12 ? * SUN *)", "AssociationName": "UpdateSSMAgent" }, { "Name": "AWS-UpdateSSMAgent", "InstanceId": "i-9876543210abcdef0", "AssociationId": "fbc07ef7-b985-4684-b82b-0123456789ab", "AssociationVersion": "1", "Targets": [ { "Key": "InstanceIds", "Values": [ "i-9876543210abcdef0" ] } ], "LastExecutionDate": 1550507531.0, "Overview": { "Status": "Success", "AssociationStatusAggregatedCount": { "Success": 1 } } } ] }

詳細については、「Systems Manager ユーザーガイド」の「Systems Manager での関連付けの使用」を参照してください。

  • API の詳細については、「 コマンドリファレンスListAssociations」の「」を参照してください。 AWS CLI

次の例は、list-command-invocations を使用する方法を説明しています。

AWS CLI

特定のコマンドの呼び出しを一覧表示するには

次のlist-command-invocations例では、コマンドのすべての呼び出しを一覧表示します。

aws ssm list-command-invocations \ --command-id "ef7fdfd8-9b57-4151-a15c-db9a12345678" \ --details

出力:

{ "CommandInvocations": [ { "CommandId": "ef7fdfd8-9b57-4151-a15c-db9a12345678", "InstanceId": "i-02573cafcfEXAMPLE", "InstanceName": "", "Comment": "b48291dd-ba76-43e0-b9df-13e11ddaac26:6960febb-2907-4b59-8e1a-d6ce8EXAMPLE", "DocumentName": "AWS-UpdateSSMAgent", "DocumentVersion": "", "RequestedDateTime": 1582136283.089, "Status": "Success", "StatusDetails": "Success", "StandardOutputUrl": "", "StandardErrorUrl": "", "CommandPlugins": [ { "Name": "aws:updateSsmAgent", "Status": "Success", "StatusDetails": "Success", "ResponseCode": 0, "ResponseStartDateTime": 1582136283.419, "ResponseFinishDateTime": 1582136283.51, "Output": "Updating amazon-ssm-agent from 2.3.842.0 to latest\nSuccessfully downloaded https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/ssm-agent-manifest.json\namazon-ssm-agent 2.3.842.0 has already been installed, update skipped\n", "StandardOutputUrl": "", "StandardErrorUrl": "", "OutputS3Region": "us-east-2", "OutputS3BucketName": "", "OutputS3KeyPrefix": "" } ], "ServiceRole": "", "NotificationConfig": { "NotificationArn": "", "NotificationEvents": [], "NotificationType": "" }, "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "", "CloudWatchOutputEnabled": false } }, { "CommandId": "ef7fdfd8-9b57-4151-a15c-db9a12345678", "InstanceId": "i-0471e04240EXAMPLE", "InstanceName": "", "Comment": "b48291dd-ba76-43e0-b9df-13e11ddaac26:6960febb-2907-4b59-8e1a-d6ce8EXAMPLE", "DocumentName": "AWS-UpdateSSMAgent", "DocumentVersion": "", "RequestedDateTime": 1582136283.02, "Status": "Success", "StatusDetails": "Success", "StandardOutputUrl": "", "StandardErrorUrl": "", "CommandPlugins": [ { "Name": "aws:updateSsmAgent", "Status": "Success", "StatusDetails": "Success", "ResponseCode": 0, "ResponseStartDateTime": 1582136283.812, "ResponseFinishDateTime": 1582136295.031, "Output": "Updating amazon-ssm-agent from 2.3.672.0 to latest\nSuccessfully downloaded https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/ssm-agent-manifest.json\nSuccessfully downloaded https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/amazon-ssm-agent-updater/2.3.842.0/amazon-ssm-agent-updater-snap-amd64.tar.gz\nSuccessfully downloaded https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/amazon-ssm-agent/2.3.672.0/amazon-ssm-agent-snap-amd64.tar.gz\nSuccessfully downloaded https://s3.us-east-2.amazonaws.com/amazon-ssm-us-east-2/amazon-ssm-agent/2.3.842.0/amazon-ssm-agent-snap-amd64.tar.gz\nInitiating amazon-ssm-agent update to 2.3.842.0\namazon-ssm-agent updated successfully to 2.3.842.0", "StandardOutputUrl": "", "StandardErrorUrl": "", "OutputS3Region": "us-east-2", "OutputS3BucketName": "", "OutputS3KeyPrefix": "8bee3135-398c-4d31-99b6-e42d2EXAMPLE/i-0471e04240EXAMPLE/awsupdateSsmAgent" } ], "ServiceRole": "", "NotificationConfig": { "NotificationArn": "", "NotificationEvents": [], "NotificationType": "" }, "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "", "CloudWatchOutputEnabled": false } } ] }

詳細については、AWS 「Systems Manager ユーザーガイド」の「コマンドのステータスについて」を参照してください。

  • API の詳細については、「 コマンドリファレンスListCommandInvocations」の「」を参照してください。 AWS CLI

次の例は、list-commands を使用する方法を説明しています。

AWS CLI

例 1: 特定のコマンドのステータスを取得するには

次のlist-commands例では、指定したコマンドのステータスを取得して表示します。

aws ssm list-commands \ --command-id "0831e1a8-a1ac-4257-a1fd-c831bEXAMPLE"

例 2: 特定の日付以降にリクエストされたコマンドのステータスを取得するには

次のlist-commands例では、指定された日付以降にリクエストされたコマンドの詳細を取得します。

aws ssm list-commands \ --filter "key=InvokedAfter,value=2020-02-01T00:00:00Z"

例 3: AWS アカウントでリクエストされたすべてのコマンドを一覧表示するには

次のlist-commands例では、現在の AWS アカウントとリージョンのユーザーがリクエストしたすべてのコマンドを一覧表示します。

aws ssm list-commands

出力:

{ "Commands": [ { "CommandId": "8bee3135-398c-4d31-99b6-e42d2EXAMPLE", "DocumentName": "AWS-UpdateSSMAgent", "DocumentVersion": "", "Comment": "b48291dd-ba76-43e0-b9df-13e11ddaac26:6960febb-2907-4b59-8e1a-d6ce8EXAMPLE", "ExpiresAfter": "2020-02-19T11:28:02.500000-08:00", "Parameters": {}, "InstanceIds": [ "i-028ea792daEXAMPLE", "i-02feef8c46EXAMPLE", "i-038613f3f0EXAMPLE", "i-03a530a2d4EXAMPLE", "i-083b678d37EXAMPLE", "i-0dee81debaEXAMPLE" ], "Targets": [], "RequestedDateTime": "2020-02-19T10:18:02.500000-08:00", "Status": "Success", "StatusDetails": "Success", "OutputS3BucketName": "", "OutputS3KeyPrefix": "", "MaxConcurrency": "50", "MaxErrors": "100%", "TargetCount": 6, "CompletedCount": 6, "ErrorCount": 0, "DeliveryTimedOutCount": 0, "ServiceRole": "", "NotificationConfig": { "NotificationArn": "", "NotificationEvents": [], "NotificationType": "" }, "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "", "CloudWatchOutputEnabled": false } } { "CommandId": "e9ade581-c03d-476b-9b07-26667EXAMPLE", "DocumentName": "AWS-FindWindowsUpdates", "DocumentVersion": "1", "Comment": "", "ExpiresAfter": "2020-01-24T12:37:31.874000-08:00", "Parameters": { "KbArticleIds": [ "" ], "UpdateLevel": [ "All" ] }, "InstanceIds": [], "Targets": [ { "Key": "InstanceIds", "Values": [ "i-00ec29b21eEXAMPLE", "i-09911ddd90EXAMPLE" ] } ], "RequestedDateTime": "2020-01-24T11:27:31.874000-08:00", "Status": "Success", "StatusDetails": "Success", "OutputS3BucketName": "my-us-east-2-bucket", "OutputS3KeyPrefix": "my-rc-output", "MaxConcurrency": "50", "MaxErrors": "0", "TargetCount": 2, "CompletedCount": 2, "ErrorCount": 0, "DeliveryTimedOutCount": 0, "ServiceRole": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "NotificationConfig": { "NotificationArn": "arn:aws:sns:us-east-2:111222333444:my-us-east-2-notification-arn", "NotificationEvents": [ "All" ], "NotificationType": "Invocation" }, "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "", "CloudWatchOutputEnabled": false } } { "CommandId": "d539b6c3-70e8-4853-80e5-0ce4fEXAMPLE", "DocumentName": "AWS-RunPatchBaseline", "DocumentVersion": "1", "Comment": "", "ExpiresAfter": "2020-01-24T12:21:04.350000-08:00", "Parameters": { "InstallOverrideList": [ "" ], "Operation": [ "Install" ], "RebootOption": [ "RebootIfNeeded" ], "SnapshotId": [ "" ] }, "InstanceIds": [], "Targets": [ { "Key": "InstanceIds", "Values": [ "i-00ec29b21eEXAMPLE", "i-09911ddd90EXAMPLE" ] } ], "RequestedDateTime": "2020-01-24T11:11:04.350000-08:00", "Status": "Success", "StatusDetails": "Success", "OutputS3BucketName": "my-us-east-2-bucket", "OutputS3KeyPrefix": "my-rc-output", "MaxConcurrency": "50", "MaxErrors": "0", "TargetCount": 2, "CompletedCount": 2, "ErrorCount": 0, "DeliveryTimedOutCount": 0, "ServiceRole": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "NotificationConfig": { "NotificationArn": "arn:aws:sns:us-east-2:111222333444:my-us-east-2-notification-arn", "NotificationEvents": [ "All" ], "NotificationType": "Invocation" }, "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "", "CloudWatchOutputEnabled": false } } ] }

詳細については、「Systems Manager ユーザーガイド」の「Systems Manager Run Command を使用したコマンドの実行」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスListCommands」の「」を参照してください。 AWS CLI

次の例は、list-compliance-items を使用する方法を説明しています。

AWS CLI

特定のインスタンスのコンプライアンス項目を一覧表示するには

この例では、指定したインスタンスのすべてのコンプライアンス項目を一覧表示します。

コマンド:

aws ssm list-compliance-items --resource-ids "i-1234567890abcdef0" --resource-types "ManagedInstance"

出力:

{ "ComplianceItems": [ { "ComplianceType": "Association", "ResourceType": "ManagedInstance", "ResourceId": "i-1234567890abcdef0", "Id": "8dfe3659-4309-493a-8755-0123456789ab", "Title": "", "Status": "COMPLIANT", "Severity": "UNSPECIFIED", "ExecutionSummary": { "ExecutionTime": 1550408470.0 }, "Details": { "DocumentName": "AWS-GatherSoftwareInventory", "DocumentVersion": "1" } }, { "ComplianceType": "Association", "ResourceType": "ManagedInstance", "ResourceId": "i-1234567890abcdef0", "Id": "e4c2ed6d-516f-41aa-aa2a-0123456789ab", "Title": "", "Status": "COMPLIANT", "Severity": "UNSPECIFIED", "ExecutionSummary": { "ExecutionTime": 1550508475.0 }, "Details": { "DocumentName": "AWS-UpdateSSMAgent", "DocumentVersion": "1" } }, ... ], "NextToken": "--token string truncated--" }

特定のインスタンスおよび関連付け ID のコンプライアンス項目を一覧表示するには

この例では、指定したインスタンスと関連付け ID のすべてのコンプライアンス項目を一覧表示します。

コマンド:

aws ssm list-compliance-items --resource-ids "i-1234567890abcdef0" --resource-types "ManagedInstance" --filters "Key=ComplianceType,Values=Association,Type=EQUAL" "Key=Id,Values=e4c2ed6d-516f-41aa-aa2a-0123456789ab,Type=EQUAL"

特定の日付と時刻以降のインスタンスのコンプライアンス項目を一覧表示するには

この例では、指定した日時以降のインスタンスのすべてのコンプライアンス項目を一覧表示します。

コマンド:

aws ssm list-compliance-items --resource-ids "i-1234567890abcdef0" --resource-types "ManagedInstance" --filters "Key=ExecutionTime,Values=2019-02-18T16:00:00Z,Type=GREATER_THAN"
  • API の詳細については、「 コマンドリファレンスListComplianceItems」の「」を参照してください。 AWS CLI

次の例は、list-compliance-summaries を使用する方法を説明しています。

AWS CLI

すべてのコンプライアンスタイプのコンプライアンス概要を一覧表示するには

この例では、アカウント内のすべてのコンプライアンスタイプのコンプライアンス概要を一覧表示します。

コマンド:

aws ssm list-compliance-summaries

出力:

{ "ComplianceSummaryItems": [ { "ComplianceType": "Association", "CompliantSummary": { "CompliantCount": 2, "SeveritySummary": { "CriticalCount": 0, "HighCount": 0, "MediumCount": 0, "LowCount": 0, "InformationalCount": 0, "UnspecifiedCount": 2 } }, "NonCompliantSummary": { "NonCompliantCount": 0, "SeveritySummary": { "CriticalCount": 0, "HighCount": 0, "MediumCount": 0, "LowCount": 0, "InformationalCount": 0, "UnspecifiedCount": 0 } } }, { "ComplianceType": "Patch", "CompliantSummary": { "CompliantCount": 1, "SeveritySummary": { "CriticalCount": 0, "HighCount": 0, "MediumCount": 0, "LowCount": 0, "InformationalCount": 0, "UnspecifiedCount": 1 } }, "NonCompliantSummary": { "NonCompliantCount": 1, "SeveritySummary": { "CriticalCount": 1, "HighCount": 0, "MediumCount": 0, "LowCount": 0, "InformationalCount": 0, "UnspecifiedCount": 0 } } }, ... ], "NextToken": "eyJOZXh0VG9rZW4iOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ==" }

特定のコンプライアンスタイプのコンプライアンス概要を一覧表示するには

この例では、パッチコンプライアンスタイプのコンプライアンス概要を一覧表示します。

コマンド:

aws ssm list-compliance-summaries --filters "Key=ComplianceType,Values=Patch,Type=EQUAL"
  • API の詳細については、「 コマンドリファレンスListComplianceSummaries」の「」を参照してください。 AWS CLI

次の例は、list-document-metadata-history を使用する方法を説明しています。

AWS CLI

例: 変更テンプレートの承認履歴とステータスを表示するには

次のlist-document-metadata-history例では、指定された Change Manager 変更テンプレートの承認履歴を返します。

aws ssm list-document-metadata-history \ --name MyChangeManageTemplate \ --metadata DocumentReviews

出力:

{ "Name": "MyChangeManagerTemplate", "DocumentVersion": "1", "Author": "arn:aws:iam::111222333444;:user/JohnDoe", "Metadata": { "ReviewerResponse": [ { "CreateTime": "2021-07-30T11:58:28.025000-07:00", "UpdatedTime": "2021-07-30T12:01:19.274000-07:00", "ReviewStatus": "APPROVED", "Comment": [ { "Type": "COMMENT", "Content": "I approve this template version" } ], "Reviewer": "arn:aws:iam::111222333444;:user/ShirleyRodriguez" }, { "CreateTime": "2021-07-30T11:58:28.025000-07:00", "UpdatedTime": "2021-07-30T11:58:28.025000-07:00", "ReviewStatus": "PENDING" } ] } }

詳細については、「Systems Manager ユーザーガイド」の「変更テンプレートの確認と承認または拒否」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスListDocumentMetadataHistory」の「」を参照してください。 AWS CLI

次の例は、list-document-versions を使用する方法を説明しています。

AWS CLI

ドキュメントバージョンを一覧表示するには

次のlist-document-versions例では、Systems Manager ドキュメントのすべてのバージョンを一覧表示します。

aws ssm list-document-versions \ --name "Example"

出力:

{ "DocumentVersions": [ { "Name": "Example", "DocumentVersion": "1", "CreatedDate": 1583257938.266, "IsDefaultVersion": true, "DocumentFormat": "YAML", "Status": "Active" } ] }

詳細については、AWS 「Systems Manager ユーザーガイド」の「ドキュメントバージョンパラメータを使用するコマンドの送信」を参照してください。

  • API の詳細については、「 コマンドリファレンスListDocumentVersions」の「」を参照してください。 AWS CLI

次の例は、list-documents を使用する方法を説明しています。

AWS CLI

例 1: ドキュメントを一覧表示するには

次のlist-documents例では、カスタムタグでタグ付けされたリクエスト元のアカウントが所有するドキュメントを一覧表示します。

aws ssm list-documents \ --filters Key=Owner,Values=Self Key=tag:DocUse,Values=Testing

出力:

{ "DocumentIdentifiers": [ { "Name": "Example", "Owner": "29884EXAMPLE", "PlatformTypes": [ "Windows", "Linux" ], "DocumentVersion": "1", "DocumentType": "Automation", "SchemaVersion": "0.3", "DocumentFormat": "YAML", "Tags": [ { "Key": "DocUse", "Value": "Testing" } ] } ] }

詳細については、AWS 「Systems Manager ユーザーガイド」のAWS 「Systems Manager ドキュメント」を参照してください。

例 2: 共有 ドキュメントを一覧表示するには

次のlist-documents例では、 が所有していないプライベート共有ドキュメントを含む共有ドキュメントを一覧表示します AWS。

aws ssm list-documents \ --filters Key=Name,Values=sharedDocNamePrefix Key=Owner,Values=Private

出力:

{ "DocumentIdentifiers": [ { "Name": "Example", "Owner": "12345EXAMPLE", "PlatformTypes": [ "Windows", "Linux" ], "DocumentVersion": "1", "DocumentType": "Command", "SchemaVersion": "0.3", "DocumentFormat": "YAML", "Tags": [] } ] }

詳細については、AWS 「Systems Manager ユーザーガイド」のAWS 「Systems Manager ドキュメント」を参照してください。

  • API の詳細については、「 コマンドリファレンスListDocuments」の「」を参照してください。 AWS CLI

次の例は、list-inventory-entries を使用する方法を説明しています。

AWS CLI

例 1: インスタンスの特定のインベントリタイプのエントリを表示するには

次のlist-inventory-entries例では、特定のインスタンスの AWS:Application インベントリタイプのインベントリエントリを一覧表示します。

aws ssm list-inventory-entries \ --instance-id "i-1234567890abcdef0" \ --type-name "AWS:Application"

出力:

{ "TypeName": "AWS:Application", "InstanceId": "i-1234567890abcdef0", "SchemaVersion": "1.1", "CaptureTime": "2019-02-15T12:17:55Z", "Entries": [ { "Architecture": "i386", "Name": "Amazon SSM Agent", "PackageId": "{88a60be2-89a1-4df8-812a-80863c2a2b68}", "Publisher": "Amazon Web Services", "Version": "2.3.274.0" }, { "Architecture": "x86_64", "InstalledTime": "2018-05-03T13:42:34Z", "Name": "AmazonCloudWatchAgent", "Publisher": "", "Version": "1.200442.0" } ] }

例 2: インスタンスに割り当てられたカスタムインベントリエントリを表示するには

次のlist-inventory-entries例では、インスタンスに割り当てられたカスタムインベントリエントリを一覧表示します。

aws ssm list-inventory-entries \ --instance-id "i-1234567890abcdef0" \ --type-name "Custom:RackInfo"

出力:

{ "TypeName": "Custom:RackInfo", "InstanceId": "i-1234567890abcdef0", "SchemaVersion": "1.0", "CaptureTime": "2021-05-22T10:01:01Z", "Entries": [ { "RackLocation": "Bay B/Row C/Rack D/Shelf E" } ] }
  • API の詳細については、「 コマンドリファレンスListInventoryEntries」の「」を参照してください。 AWS CLI

次の例は、list-ops-item-related-items を使用する方法を説明しています。

AWS CLI

の関連アイテムリソースを一覧表示するには OpsItem

次のlist-ops-item-related-items例では、 の関連項目リソースを一覧表示します OpsItem。

aws ssm list-ops-item-related-items \ --ops-item-id "oi-f99f2EXAMPLE"

出力:

{ "Summaries": [ { "OpsItemId": "oi-f99f2EXAMPLE", "AssociationId": "e2036148-cccb-490e-ac2a-390e5EXAMPLE", "ResourceType": "AWS::SSMIncidents::IncidentRecord", "AssociationType": "IsParentOf", "ResourceUri": "arn:aws:ssm-incidents::111122223333:incident-record/example-response/64bd9b45-1d0e-2622-840d-03a87a1451fa", "CreatedBy": { "Arn": "arn:aws:sts::111122223333:assumed-role/AWSServiceRoleForIncidentManager/IncidentResponse" }, "CreatedTime": "2021-08-11T18:47:14.994000+00:00", "LastModifiedBy": { "Arn": "arn:aws:sts::111122223333:assumed-role/AWSServiceRoleForIncidentManager/IncidentResponse" }, "LastModifiedTime": "2021-08-11T18:47:14.994000+00:00" } ] }

詳細については、「Systems Manager ユーザーガイド」の「 での Incident Manager インシデント OpsCenterの使用」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスListOpsItemRelatedItems」の「」を参照してください。 AWS CLI

次の例は、list-resource-compliance-summaries を使用する方法を説明しています。

AWS CLI

リソースレベルのコンプライアンス概要数を一覧表示するには

この例では、リソースレベルのコンプライアンス概要数を一覧表示します。

コマンド:

aws ssm list-resource-compliance-summaries

出力:

{ "ResourceComplianceSummaryItems": [ { "ComplianceType": "Association", "ResourceType": "ManagedInstance", "ResourceId": "i-1234567890abcdef0", "Status": "COMPLIANT", "OverallSeverity": "UNSPECIFIED", "ExecutionSummary": { "ExecutionTime": 1550509273.0 }, "CompliantSummary": { "CompliantCount": 2, "SeveritySummary": { "CriticalCount": 0, "HighCount": 0, "MediumCount": 0, "LowCount": 0, "InformationalCount": 0, "UnspecifiedCount": 2 } }, "NonCompliantSummary": { "NonCompliantCount": 0, "SeveritySummary": { "CriticalCount": 0, "HighCount": 0, "MediumCount": 0, "LowCount": 0, "InformationalCount": 0, "UnspecifiedCount": 0 } } }, { "ComplianceType": "Patch", "ResourceType": "ManagedInstance", "ResourceId": "i-9876543210abcdef0", "Status": "COMPLIANT", "OverallSeverity": "UNSPECIFIED", "ExecutionSummary": { "ExecutionTime": 1550248550.0, "ExecutionId": "7abb6378-a4a5-4f10-8312-0123456789ab", "ExecutionType": "Command" }, "CompliantSummary": { "CompliantCount": 397, "SeveritySummary": { "CriticalCount": 0, "HighCount": 0, "MediumCount": 0, "LowCount": 0, "InformationalCount": 0, "UnspecifiedCount": 397 } }, "NonCompliantSummary": { "NonCompliantCount": 0, "SeveritySummary": { "CriticalCount": 0, "HighCount": 0, "MediumCount": 0, "LowCount": 0, "InformationalCount": 0, "UnspecifiedCount": 0 } } } ], "NextToken": "--token string truncated--" }

特定のコンプライアンスタイプのリソースレベルのコンプライアンス概要を一覧表示するには

この例では、パッチコンプライアンスタイプのリソースレベルのコンプライアンス概要を一覧表示します。

コマンド:

aws ssm list-resource-compliance-summaries --filters "Key=ComplianceType,Values=Patch,Type=EQUAL"

次の例は、list-resource-data-sync を使用する方法を説明しています。

AWS CLI

リソースデータ同期設定を一覧表示するには

この例では、リソースデータ同期設定に関する情報を取得します。

aws ssm list-resource-data-sync

出力:

{ "ResourceDataSyncItems": [ { "SyncName": "MyResourceDataSync", "S3Destination": { "BucketName": "ssm-resource-data-sync", "SyncFormat": "JsonSerDe", "Region": "us-east-1" }, "LastSyncTime": 1550261472.003, "LastSuccessfulSyncTime": 1550261472.003, "LastStatus": "Successful", "SyncCreatedTime": 1543235736.72, "LastSyncStatusMessage": "The sync was successfully completed" } ] }
  • API の詳細については、「 コマンドリファレンスListResourceDataSync」の「」を参照してください。 AWS CLI

次の例は、list-tags-for-resource を使用する方法を説明しています。

AWS CLI

パッチベースラインに適用されているタグを一覧表示するには

次のlist-tags-for-resource例では、パッチベースラインのタグを一覧表示します。

aws ssm list-tags-for-resource \ --resource-type "PatchBaseline" \ --resource-id "pb-0123456789abcdef0"

出力:

{ "TagList": [ { "Key": "Environment", "Value": "Production" }, { "Key": "Region", "Value": "EMEA" } ] }

詳細については、「 AWS 全般のリファレンス」の「 AWS リソースのタグ付け」を参照してください。

  • API の詳細については、「 コマンドリファレンスListTagsForResource」の「」を参照してください。 AWS CLI

次の例は、modify-document-permission を使用する方法を説明しています。

AWS CLI

ドキュメントのアクセス許可を変更するには

次のmodify-document-permission例では、Systems Manager ドキュメントをパブリックに共有します。

aws ssm modify-document-permission \ --name "Example" \ --permission-type "Share" \ --account-ids-to-add "All"

このコマンドでは何も出力されません。

詳細については、「Systems Manager ユーザーガイド」の「Systems Manager ドキュメントの共有AWS 」を参照してください。

  • API の詳細については、「 コマンドリファレンスModifyDocumentPermission」の「」を参照してください。 AWS CLI

次の例は、put-compliance-items を使用する方法を説明しています。

AWS CLI

指定されたインスタンスにコンプライアンスタイプとコンプライアンスの詳細を登録するには

この例では、指定したマネージドインスタンスCustom:AVCheckにコンプライアンスタイプを登録します。コマンドが成功した場合、出力はありません。

コマンド:

aws ssm put-compliance-items --resource-id "i-1234567890abcdef0" --resource-type "ManagedInstance" --compliance-type "Custom:AVCheck" --execution-summary "ExecutionTime=2019-02-18T16:00:00Z" --items "Id=Version2.0,Title=ScanHost,Severity=CRITICAL,Status=COMPLIANT"
  • API の詳細については、「 コマンドリファレンスPutComplianceItems」の「」を参照してください。 AWS CLI

次の例は、put-inventory を使用する方法を説明しています。

AWS CLI

顧客メタデータをインスタンスに割り当てるには

この例では、ラックの場所情報をインスタンスに割り当てます。コマンドが成功した場合、出力はありません。

コマンド (Linux):

aws ssm put-inventory --instance-id "i-016648b75dd622dab" --items '[{"TypeName": "Custom:RackInfo","SchemaVersion": "1.0","CaptureTime": "2019-01-22T10:01:01Z","Content":[{"RackLocation": "Bay B/Row C/Rack D/Shelf E"}]}]'

コマンド (Windows):

aws ssm put-inventory --instance-id "i-016648b75dd622dab" --items "TypeName=Custom:RackInfo,SchemaVersion=1.0,CaptureTime=2019-01-22T10:01:01Z,Content=[{RackLocation='Bay B/Row C/Rack D/Shelf F'}]"
  • API の詳細については、「 コマンドリファレンスPutInventory」の「」を参照してください。 AWS CLI

次の例は、put-parameter を使用する方法を説明しています。

AWS CLI

例 1: パラメータ値を変更するには

次の put-parameter の例は、指定されたパラメータの値を変更します。

aws ssm put-parameter \ --name "MyStringParameter" \ --type "String" \ --value "Vici" \ --overwrite

出力:

{ "Version": 2, "Tier": "Standard" }

詳細については、「Systems Manager ユーザーガイド」の「Systems Manager パラメータの作成 (AWS CLI)」、「パラメータ階層の管理 <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html>`__」、および「パラメータポリシーの使用」を参照してください。 AWS

例 2: アドバンストパラメータを作成するには

次の put-parameter の例は、アドバンストパラメータを作成します。

aws ssm put-parameter \ --name "MyAdvancedParameter" \ --description "This is an advanced parameter" \ --value "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat [truncated]" \ --type "String" \ --tier Advanced

出力:

{ "Version": 1, "Tier": "Advanced" }

詳細については、「Systems Manager ユーザーガイド」の「Systems Manager パラメータの作成 (AWS CLI)」、「パラメータ階層の管理 <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html>`__」、および「パラメータポリシーの使用」を参照してください。 AWS

例 3: スタンダードパラメータをアドバンストパラメータに変換するには

次の put-parameter の例は、既存のスタンダードパラメータをアドバンストパラメータに変換します。

aws ssm put-parameter \ --name "MyConvertedParameter" \ --value "abc123" \ --type "String" \ --tier Advanced \ --overwrite

出力:

{ "Version": 2, "Tier": "Advanced" }

詳細については、「Systems Manager ユーザーガイド」の「Systems Manager パラメータの作成 (AWS CLI)」、「パラメータ階層の管理 <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html>`__」、および「パラメータポリシーの使用」を参照してください。 AWS

例 4: ポリシーがアタッチされたパラメータを作成するには

次の put-parameter の例は、パラメータポリシーがアタッチされたアドバンストパラメータを作成します。

aws ssm put-parameter \ --name "/Finance/Payroll/q2accesskey" \ --value "P@sSwW)rd" \ --type "SecureString" \ --tier Advanced \ --policies "[{\"Type\":\"Expiration\",\"Version\":\"1.0\",\"Attributes\":{\"Timestamp\":\"2020-06-30T00:00:00.000Z\"}},{\"Type\":\"ExpirationNotification\",\"Version\":\"1.0\",\"Attributes\":{\"Before\":\"5\",\"Unit\":\"Days\"}},{\"Type\":\"NoChangeNotification\",\"Version\":\"1.0\",\"Attributes\":{\"After\":\"60\",\"Unit\":\"Days\"}}]"

出力:

{ "Version": 1, "Tier": "Advanced" }

詳細については、「Systems Manager ユーザーガイド」の「Systems Manager パラメータの作成 (AWS CLI)」、「パラメータ階層の管理 <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html>`__」、および「パラメータポリシーの使用」を参照してください。 AWS

例 5: 既存のパラメータにポリシーを追加するには

次の put-parameter の例は、ポリシーを既存のアドバンストパラメータにアタッチします。

aws ssm put-parameter \ --name "/Finance/Payroll/q2accesskey" \ --value "N3wP@sSwW)rd" \ --type "SecureString" \ --tier Advanced \ --policies "[{\"Type\":\"Expiration\",\"Version\":\"1.0\",\"Attributes\":{\"Timestamp\":\"2020-06-30T00:00:00.000Z\"}},{\"Type\":\"ExpirationNotification\",\"Version\":\"1.0\",\"Attributes\":{\"Before\":\"5\",\"Unit\":\"Days\"}},{\"Type\":\"NoChangeNotification\",\"Version\":\"1.0\",\"Attributes\":{\"After\":\"60\",\"Unit\":\"Days\"}}]" --overwrite

出力:

{ "Version": 2, "Tier": "Advanced" }

詳細については、「Systems Manager ユーザーガイド」の「Systems Manager パラメータの作成 (AWS CLI)」、「パラメータ階層の管理 <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html>`__」、および「パラメータポリシーの使用」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスPutParameter」の「」を参照してください。 AWS CLI

次の例は、register-default-patch-baseline を使用する方法を説明しています。

AWS CLI

デフォルトのパッチベースラインを設定するには

次のregister-default-patch-baseline例では、指定されたカスタムパッチベースラインを、サポートするオペレーティングシステムタイプのデフォルトのパッチベースラインとして登録します。

aws ssm register-default-patch-baseline \ --baseline-id "pb-abc123cf9bEXAMPLE"

出力:

{ "BaselineId":"pb-abc123cf9bEXAMPLE" }

次のregister-default-patch-baseline例では、 AWS for CentOS が提供するデフォルトのパッチベースラインをデフォルトのパッチベースラインとして登録します。

aws ssm register-default-patch-baseline \ --baseline-id "arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed"

出力:

{ "BaselineId":"pb-abc123cf9bEXAMPLE" }

詳細については、AWS 「Systems Manager ユーザーガイド」の「事前定義パッチベースラインとカスタムパッチベースラインについて」を参照してください。

  • API の詳細については、「 コマンドリファレンスRegisterDefaultPatchBaseline」の「」を参照してください。 AWS CLI

次の例は、register-patch-baseline-for-patch-group を使用する方法を説明しています。

AWS CLI

パッチグループのパッチベースラインを登録するには

次のregister-patch-baseline-for-patch-group例では、パッチグループのパッチベースラインを登録します。

aws ssm register-patch-baseline-for-patch-group \ --baseline-id "pb-045f10b4f382baeda" \ --patch-group "Production"

出力:

{ "BaselineId": "pb-045f10b4f382baeda", "PatchGroup": "Production" }

詳細については、AWS 「Systems Manager ユーザーガイド」の「Create a Patch Group <https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-patch-group-tagging.html>__」および「Add a Patch Group to a Patch Baseline」を参照してください。

次の例は、register-target-with-maintenance-window を使用する方法を説明しています。

AWS CLI

例 1: 1 つのターゲットをメンテナンスウィンドウに登録するには

次のregister-target-with-maintenance-window例では、インスタンスをメンテナンスウィンドウに登録します。

aws ssm register-target-with-maintenance-window \ --window-id "mw-ab12cd34ef56gh78" \ --target "Key=InstanceIds,Values=i-0000293ffd8c57862" \ --owner-information "Single instance" \ --resource-type "INSTANCE"

出力:

{ "WindowTargetId":"1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d-1a2" }

例 2: インスタンス IDs

次のregister-target-with-maintenance-window例では、インスタンス IDs。

aws ssm register-target-with-maintenance-window \ --window-id "mw-ab12cd34ef56gh78" \ --target "Key=InstanceIds,Values=i-0000293ffd8c57862,i-0cb2b964d3e14fd9f" \ --owner-information "Two instances in a list" \ --resource-type "INSTANCE"

出力:

{ "WindowTargetId":"1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d-1a2" }

例 3: リソースタグを使用してメンテナンスウィンドウにターゲットを登録するには

次のregister-target-with-maintenance-window例では、インスタンスに適用されているリソースタグを指定して、インスタンスをメンテナンスウィンドウに登録します。

aws ssm register-target-with-maintenance-window \ --window-id "mw-06cf17cbefcb4bf4f" \ --targets "Key=tag:Environment,Values=Prod" "Key=Role,Values=Web" \ --owner-information "Production Web Servers" \ --resource-type "INSTANCE"

出力:

{ "WindowTargetId":"1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d-1a2" }

例 4: タグキーのグループを使用してターゲットを登録するには

次のregister-target-with-maintenance-window例では、キー値に関係なく、すべての に 1 つ以上のタグキーが割り当てられているインスタンスを登録します。

aws ssm register-target-with-maintenance-window \ --window-id "mw-0c50858d01EXAMPLE" \ --resource-type "INSTANCE" \ --target "Key=tag-key,Values=Name,Instance-Type,CostCenter"

出力:

{ "WindowTargetId":"1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d-1a2" }

例 5: リソースグループ名を使用してターゲットを登録するには

次のregister-target-with-maintenance-window例では、含まれるリソースのタイプに関係なく、指定されたリソースグループを登録します。

aws ssm register-target-with-maintenance-window \ --window-id "mw-0c50858d01EXAMPLE" \ --resource-type "RESOURCE_GROUP" \ --target "Key=resource-groups:Name,Values=MyResourceGroup"

出力:

{ "WindowTargetId":"1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d-1a2" }

詳細については、「Systems Manager ユーザーガイド」の「メンテナンスウィンドウにターゲットインスタンスを登録する (AWS CLI)」を参照してください。 AWS

次の例は、register-task-with-maintenance-window を使用する方法を説明しています。

AWS CLI

例 1: オートメーションタスクをメンテナンスウィンドウに登録するには

次のregister-task-with-maintenance-window例では、インスタンスをターゲットとするメンテナンスウィンドウにオートメーションタスクを登録します。

aws ssm register-task-with-maintenance-window \ --window-id "mw-082dcd7649EXAMPLE" \ --targets Key=InstanceIds,Values=i-1234520122EXAMPLE \ --task-arn AWS-RestartEC2Instance \ --service-role-arn arn:aws:iam::111222333444:role/SSM --task-type AUTOMATION \ --task-invocation-parameters "{\"Automation\":{\"DocumentVersion\":\"\$LATEST\",\"Parameters\":{\"InstanceId\":[\"{{RESOURCE_ID}}\"]}}}" \ --priority 0 \ --max-concurrency 1 \ --max-errors 1 \ --name "AutomationExample" \ --description "Restarting EC2 Instance for maintenance"

出力:

{ "WindowTaskId":"11144444-5555-6666-7777-88888888" }

詳細については、「Systems Manager ユーザーガイド」の「メンテナンスウィンドウにタスクを登録する (AWS CLI)」を参照してください。 AWS

例 2: Lambda タスクをメンテナンスウィンドウに登録するには

次のregister-task-with-maintenance-window例では、インスタンスをターゲットとするメンテナンスウィンドウに Lambda タスクを登録します。

aws ssm register-task-with-maintenance-window \ --window-id "mw-082dcd7649dee04e4" \ --targets Key=InstanceIds,Values=i-12344d305eEXAMPLE \ --task-arn arn:aws:lambda:us-east-1:111222333444:function:SSMTestLAMBDA \ --service-role-arn arn:aws:iam::111222333444:role/SSM \ --task-type LAMBDA \ --task-invocation-parameters '{"Lambda":{"Payload":"{\"InstanceId\":\"{{RESOURCE_ID}}\",\"targetType\":\"{{TARGET_TYPE}}\"}","Qualifier":"$LATEST"}}' \ --priority 0 \ --max-concurrency 10 \ --max-errors 5 \ --name "Lambda_Example" \ --description "My Lambda Example"

出力:

{ "WindowTaskId":"22244444-5555-6666-7777-88888888" }

詳細については、「Systems Manager ユーザーガイド」の「メンテナンスウィンドウにタスクを登録する (AWS CLI)」を参照してください。 AWS

例 3: Run Command タスクをメンテナンスウィンドウに登録するには

次のregister-task-with-maintenance-window例では、インスタンスをターゲットとするメンテナンスウィンドウに Run Command タスクを登録します。

aws ssm register-task-with-maintenance-window \ --window-id "mw-082dcd7649dee04e4" \ --targets "Key=InstanceIds,Values=i-12344d305eEXAMPLE" \ --service-role-arn "arn:aws:iam::111222333444:role/SSM" \ --task-type "RUN_COMMAND" \ --name "SSMInstallPowerShellModule" \ --task-arn "AWS-InstallPowerShellModule" \ --task-invocation-parameters "{\"RunCommand\":{\"Comment\":\"\",\"OutputS3BucketName\":\"runcommandlogs\",\"Parameters\":{\"commands\":[\"Get-Module -ListAvailable\"],\"executionTimeout\":[\"3600\"],\"source\":[\"https:\/\/gallery.technet.microsoft.com\/EZOut-33ae0fb7\/file\/110351\/1\/EZOut.zip\"],\"workingDirectory\":[\"\\\\\"]},\"TimeoutSeconds\":600}}" \ --max-concurrency 1 \ --max-errors 1 \ --priority 10

出力:

{ "WindowTaskId":"33344444-5555-6666-7777-88888888" }

詳細については、「Systems Manager ユーザーガイド」の「メンテナンスウィンドウにタスクを登録する (AWS CLI)」を参照してください。 AWS

例 4: Step Functions タスクをメンテナンスウィンドウに登録するには

次のregister-task-with-maintenance-window例では、インスタンスをターゲットとするメンテナンスウィンドウに Step Functions タスクを登録します。

aws ssm register-task-with-maintenance-window \ --window-id "mw-1234d787d6EXAMPLE" \ --targets Key=WindowTargetIds,Values=12347414-69c3-49f8-95b8-ed2dcEXAMPLE \ --task-arn arn:aws:states:us-east-1:111222333444:stateMachine:SSMTestStateMachine \ --service-role-arn arn:aws:iam::111222333444:role/MaintenanceWindows \ --task-type STEP_FUNCTIONS \ --task-invocation-parameters '{"StepFunctions":{"Input":"{\"InstanceId\":\"{{RESOURCE_ID}}\"}"}}' \ --priority 0 \ --max-concurrency 10 \ --max-errors 5 \ --name "Step_Functions_Example" \ --description "My Step Functions Example"

出力:

{ "WindowTaskId":"44444444-5555-6666-7777-88888888" }

詳細については、「Systems Manager ユーザーガイド」の「メンテナンスウィンドウにタスクを登録する (AWS CLI)」を参照してください。 AWS

例 5: メンテナンスウィンドウのターゲット ID を使用してタスクを登録するには

次のregister-task-with-maintenance-window例では、メンテナンスウィンドウのターゲット ID を使用してタスクを登録します。メンテナンスウィンドウのターゲット ID は、 aws ssm register-target-with-maintenance-window コマンドの出力に含まれていました。aws ssm describe-maintenance-window-targets コマンドの出力から取得することもできます。

aws ssm register-task-with-maintenance-window \ --targets "Key=WindowTargetIds,Values=350d44e6-28cc-44e2-951f-4b2c9EXAMPLE" \ --task-arn "AWS-RunShellScript" \ --service-role-arn "arn:aws:iam::111222333444:role/MaintenanceWindowsRole" \ --window-id "mw-ab12cd34eEXAMPLE" \ --task-type "RUN_COMMAND" \ --task-parameters "{\"commands\":{\"Values\":[\"df\"]}}" \ --max-concurrency 1 \ --max-errors 1 \ --priority 10

出力:

{ "WindowTaskId":"33344444-5555-6666-7777-88888888" }

詳細については、「Systems Manager ユーザーガイド」の「メンテナンスウィンドウにタスクを登録する (AWS CLI)」を参照してください。 AWS

次の例は、remove-tags-from-resource を使用する方法を説明しています。

AWS CLI

パッチベースラインからタグを削除するには

次のremove-tags-from-resource例では、パッチベースラインからタグを削除します。

aws ssm remove-tags-from-resource \ --resource-type "PatchBaseline" \ --resource-id "pb-0123456789abcdef0" \ --tag-keys "Region"

このコマンドでは何も出力されません。

詳細については、「 AWS 全般のリファレンス」の「 AWS リソースのタグ付け」を参照してください。

  • API の詳細については、「 コマンドリファレンスRemoveTagsFromResource」の「」を参照してください。 AWS CLI

次の例は、reset-service-setting を使用する方法を説明しています。

AWS CLI

Parameter Store スループットのサービス設定をリセットするには

次のreset-service-setting例では、指定されたリージョンの Parameter Store スループットのサービス設定をリセットして、増加したスループットを使用しなくなります。

aws ssm reset-service-setting \ --setting-id arn:aws:ssm:us-east-1:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled

出力:

{ "ServiceSetting": { "SettingId": "/ssm/parameter-store/high-throughput-enabled", "SettingValue": "false", "LastModifiedDate": 1555532818.578, "LastModifiedUser": "System", "ARN": "arn:aws:ssm:us-east-1:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled", "Status": "Default" } }

詳細については、AWS 「Systems Manager ユーザーガイド」の「パラメータストアのスループットを上げる」を参照してください。

  • API の詳細については、「 コマンドリファレンスResetServiceSetting」の「」を参照してください。 AWS CLI

次の例は、resume-session を使用する方法を説明しています。

AWS CLI

Session Manager セッションを再開するには

resume-session この例では、切断されたインスタンスとの Session Manager セッションを再開します。このインタラクティブコマンドでは、呼び出しを行うクライアントマシンに Session Manager プラグインをインストールする必要があることに注意してください。

aws ssm resume-session \ --session-id Mary-Major-07a16060613c408b5

出力:

{ "SessionId": "Mary-Major-07a16060613c408b5", "TokenValue": "AAEAAVbTGsaOnyvcUoNGqifbv5r/8lgxuQljCuY8qVcvOnoBAAAAAFxtd3jIXAFUUXGTJ7zF/AWJPwDviOlF5p3dlAgrqVIVO6IEXhkHLz0/1gXKRKEME71E6TLOplLDJAMZ+kREejkZu4c5AxMkrQjMF+gtHP1bYJKTwtHQd1wjulPLexO8SHl7g5R/wekrj6WsDUpnEegFBfGftpAIz2GXQVfTJXKfkc5qepQ11C11DOIT2dozOqXgHwfQHfAKLErM5dWDZqKwyT1Z3iw7unQdm3p5qsbrugiOZ7CRANTE+ihfGa6MEJJ97Jmat/a2TspEnOjNn9Mvu5iwXIW2yCvWZrGUj+/QI5Xr7s1XJBEnSKR54o4fN0GV9RWl0RZsZm1m1ki0JJtiwwgZ", "StreamUrl": "wss://ssmmessages.us-east-2.amazonaws.com/v1/data-channel/Mary-Major-07a16060613c408b5?role=publish_subscribe" }

詳細については、「Systems Manager ユーザーガイド」の「 AWS CLI 用の Session Manager プラグインをインストールする」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスResumeSession」の「」を参照してください。 AWS CLI

次の例は、send-automation-signal を使用する方法を説明しています。

AWS CLI

オートメーション実行にシグナルを送信するには

次のsend-automation-signal例では、オートメーションの実行に承認済みシグナルを送信します。

aws ssm send-automation-signal \ --automation-execution-id 73c8eef8-f4ee-4a05-820c-e354fEXAMPLE \ --signal-type "Approve"

このコマンドでは何も出力されません。

詳細については、AWS 「Systems Manager ユーザーガイド」の「CloudWatch を使用してオートメーションワークフローを実行する」を参照してください。

  • API の詳細については、「 コマンドリファレンスSendAutomationSignal」の「」を参照してください。 AWS CLI

次の例は、send-command を使用する方法を説明しています。

AWS CLI

例 1: 1 つ以上のリモートインスタンスでコマンドを実行するには

次のsend-command例では、ターゲットインスタンスで echo コマンドを実行します。

aws ssm send-command \ --document-name "AWS-RunShellScript" \ --parameters 'commands=["echo HelloWorld"]' \ --targets "Key=instanceids,Values=i-1234567890abcdef0" \ --comment "echo HelloWorld"

出力:

{ "Command": { "CommandId": "92853adf-ba41-4cd6-9a88-142d1EXAMPLE", "DocumentName": "AWS-RunShellScript", "DocumentVersion": "", "Comment": "echo HelloWorld", "ExpiresAfter": 1550181014.717, "Parameters": { "commands": [ "echo HelloWorld" ] }, "InstanceIds": [ "i-0f00f008a2dcbefe2" ], "Targets": [], "RequestedDateTime": 1550173814.717, "Status": "Pending", "StatusDetails": "Pending", "OutputS3BucketName": "", "OutputS3KeyPrefix": "", "MaxConcurrency": "50", "MaxErrors": "0", "TargetCount": 1, "CompletedCount": 0, "ErrorCount": 0, "DeliveryTimedOutCount": 0, "ServiceRole": "", "NotificationConfig": { "NotificationArn": "", "NotificationEvents": [], "NotificationType": "" }, "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "", "CloudWatchOutputEnabled": false } } }

詳細については、「Systems Manager ユーザーガイド」の「Systems Manager Run Command を使用したコマンドの実行」を参照してください。 AWS

例 2: インスタンスに関する IP 情報を取得するには

次のsend-command例では、インスタンスに関する IP 情報を取得します。

aws ssm send-command \ --instance-ids "i-1234567890abcdef0" \ --document-name "AWS-RunShellScript" \ --comment "IP config" \ --parameters "commands=ifconfig"

出力例については、例 1 を参照してください。

詳細については、「Systems Manager ユーザーガイド」の「Systems Manager Run Command を使用したコマンドの実行」を参照してください。 AWS

例 3: 特定のタグを持つインスタンスでコマンドを実行するには

次のsend-command例では、タグキー「ENV」と値「Dev」を持つインスタンスでコマンドを実行します。

aws ssm send-command \ --targets "Key=tag:ENV,Values=Dev" \ --document-name "AWS-RunShellScript" \ --parameters "commands=ifconfig"

出力例については、例 1 を参照してください。

詳細については、「Systems Manager ユーザーガイド」の「Systems Manager Run Command を使用したコマンドの実行」を参照してください。 AWS

例 4: SNS 通知を送信するコマンドを実行するには

次のsend-command例では、すべての通知イベントと通知Commandタイプの SNS 通知を送信するコマンドを実行します。

aws ssm send-command \ --instance-ids "i-1234567890abcdef0" \ --document-name "AWS-RunShellScript" \ --comment "IP config" \ --parameters "commands=ifconfig" \ --service-role-arn "arn:aws:iam::123456789012:role/SNS_Role" \ --notification-config "NotificationArn=arn:aws:sns:us-east-1:123456789012:SNSTopicName,NotificationEvents=All,NotificationType=Command"

出力例については、例 1 を参照してください。

詳細については、「Systems Manager ユーザーガイド」の「Systems Manager Run Command を使用したコマンドの実行」を参照してください。 AWS

例 5: S3 と に出力するコマンドを実行するには CloudWatch

次のsend-command例では、コマンドの詳細を S3 バケットと CloudWatch Logs ロググループに出力するコマンドを実行します。

aws ssm send-command \ --instance-ids "i-1234567890abcdef0" \ --document-name "AWS-RunShellScript" \ --comment "IP config" \ --parameters "commands=ifconfig" \ --output-s3-bucket-name "s3-bucket-name" \ --output-s3-key-prefix "runcommand" \ --cloud-watch-output-config "CloudWatchOutputEnabled=true,CloudWatchLogGroupName=CWLGroupName"

出力例については、例 1 を参照してください。

詳細については、「Systems Manager ユーザーガイド」の「Systems Manager Run Command を使用したコマンドの実行」を参照してください。 AWS

例 6: タグが異なる複数のインスタンスでコマンドを実行するには

次のsend-command例では、2 つの異なるタグキーと値を持つインスタンスでコマンドを実行します。

aws ssm send-command \ --document-name "AWS-RunPowerShellScript" \ --parameters commands=["echo helloWorld"] \ --targets Key=tag:Env,Values=Dev Key=tag:Role,Values=WebServers

出力例については、例 1 を参照してください。

詳細については、「Systems Manager ユーザーガイド」の「Systems Manager Run Command を使用したコマンドの実行」を参照してください。 AWS

例 7: 同じタグキーを持つ複数のインスタンスをターゲットにするには

次のsend-command例では、同じタグキーを持つが異なる値を持つインスタンスでコマンドを実行します。

aws ssm send-command \ --document-name "AWS-RunPowerShellScript" \ --parameters commands=["echo helloWorld"] \ --targets Key=tag:Env,Values=Dev,Test

出力例については、例 1 を参照してください。

詳細については、「Systems Manager ユーザーガイド」の「Systems Manager Run Command を使用したコマンドの実行」を参照してください。 AWS

例 8: 共有 ドキュメントを使用するコマンドを実行するには

次のsend-command例では、ターゲットインスタンスで共有 ドキュメントを実行します。

aws ssm send-command \ --document-name "arn:aws:ssm:us-east-1:123456789012:document/ExampleDocument" \ --targets "Key=instanceids,Values=i-1234567890abcdef0"

出力例については、例 1 を参照してください。

詳細については、「Systems Manager ユーザーガイド」の「共有 SSM ドキュメントの使用」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスSendCommand」の「」を参照してください。 AWS CLI

次の例は、start-associations-once を使用する方法を説明しています。

AWS CLI

関連付けをすぐに 1 回だけ実行するには

次のstart-associations-once例では、指定された関連付けを 1 回だけすぐに実行します。コマンドが成功した場合、出力はありません。

aws ssm start-associations-once \ --association-id "8dfe3659-4309-493a-8755-0123456789ab"

このコマンドでは何も出力されません。

詳細については、「Systems Manager ユーザーガイド」の「関連付け履歴の表示」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスStartAssociationsOnce」の「」を参照してください。 AWS CLI

次の例は、start-automation-execution を使用する方法を説明しています。

AWS CLI

例 1: オートメーションドキュメントを実行するには

次のstart-automation-execution例では、オートメーションドキュメントを実行します。

aws ssm start-automation-execution \ --document-name "AWS-UpdateLinuxAmi" \ --parameters "AutomationAssumeRole=arn:aws:iam::123456789012:role/SSMAutomationRole,SourceAmiId=ami-EXAMPLE,IamInstanceProfileName=EC2InstanceRole"

出力:

{ "AutomationExecutionId": "4105a4fc-f944-11e6-9d32-0a1b2EXAMPLE" }

詳細については、AWS 「Systems Manager ユーザーガイド」の「オートメーションワークフローを手動で実行する」を参照してください。

例 2: 共有オートメーションドキュメントを実行するには

次のstart-automation-execution例では、共有オートメーションドキュメントを実行します。

aws ssm start-automation-execution \ --document-name "arn:aws:ssm:us-east-1:123456789012:document/ExampleDocument"

出力:

{ "AutomationExecutionId": "4105a4fc-f944-11e6-9d32-0a1b2EXAMPLE" }

詳細については、「Systems Manager ユーザーガイド」の「共有 SSM ドキュメントの使用」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスStartAutomationExecution」の「」を参照してください。 AWS CLI

次の例は、start-change-request-execution を使用する方法を説明しています。

AWS CLI

例 1: 変更リクエストを開始するには

次のstart-change-request-execution例では、最小限のオプションを指定して変更リクエストを開始します。

aws ssm start-change-request-execution \ --change-request-name MyChangeRequest \ --document-name AWS-HelloWorldChangeTemplate \ --runbooks '[{"DocumentName": "AWS-HelloWorld","Parameters": {"AutomationAssumeRole": ["arn:aws:iam:us-east-2:1112223233444:role/MyChangeManagerAssumeRole"]}}]' \ --parameters Approver="JohnDoe",ApproverType="IamUser",ApproverSnsTopicArn="arn:aws:sns:us-east-2:1112223233444:MyNotificationTopic"

出力:

{ "AutomationExecutionId": "9d32a4fc-f944-11e6-4105-0a1b2EXAMPLE" }

例 2: 外部 JSON ファイルを使用して変更リクエストを開始するには

次のstart-automation-execution例では、JSON ファイルに複数のオプションが指定されている変更リクエストを開始します。

aws ssm start-change-request-execution \ --cli-input-json file://MyChangeRequest.json

MyChangeRequest.json の内容:

{ "ChangeRequestName": "MyChangeRequest", "DocumentName": "AWS-HelloWorldChangeTemplate", "DocumentVersion": "$DEFAULT", "ScheduledTime": "2021-12-30T03:00:00", "ScheduledEndTime": "2021-12-30T03:05:00", "Tags": [ { "Key": "Purpose", "Value": "Testing" } ], "Parameters": { "Approver": [ "JohnDoe" ], "ApproverType": [ "IamUser" ], "ApproverSnsTopicArn": [ "arn:aws:sns:us-east-2:111222333444;:MyNotificationTopic ] }, "Runbooks": [ { "DocumentName": "AWS-HelloWorld", "DocumentVersion": "1", "MaxConcurrency": "1", "MaxErrors": "1", "Parameters": { "AutomationAssumeRole": [ "arn:aws:iam::111222333444:role/MyChangeManagerAssumeRole" ] } } ], "ChangeDetails": "### Document Name: HelloWorldChangeTemplate\n\n## What does this document do?\nThis change template demonstrates the feature set available for creating change templates for Change Manager. This template starts a Runbook workflow for the Automation document called AWS-HelloWorld.\n\n## Input Parameters\n* ApproverSnsTopicArn: (Required) Amazon Simple Notification Service ARN for approvers.\n* Approver: (Required) The name of the approver to send this request to.\n* ApproverType: (Required) The type of reviewer.\n * Allowed Values: IamUser, IamGroup, IamRole, SSOGroup, SSOUser\n\n## Output Parameters\nThis document has no outputs \n" }

出力:

{ "AutomationExecutionId": "9d32a4fc-f944-11e6-4105-0a1b2EXAMPLE" }

詳細については、「Systems Manager ユーザーガイド」の「変更リクエストの作成」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスStartChangeRequestExecution」の「」を参照してください。 AWS CLI

次の例は、start-session を使用する方法を説明しています。

AWS CLI

例 1: Session Manager セッションを開始するには

start-session この例では、Session Manager セッションのインスタンスとの接続を確立します。このインタラクティブコマンドでは、呼び出しを行うクライアントマシンに Session Manager プラグインをインストールする必要があることに注意してください。

aws ssm start-session \ --target "i-1234567890abcdef0"

出力:

Starting session with SessionId: Jane-Roe-07a16060613c408b5

例 2: SSH を使用して Session Manager セッションを開始するには

start-session この例では、SSH を使用して Session Manager セッションのインスタンスとの接続を確立します。この対話型コマンドでは、呼び出しを行うクライアントマシンに Session Manager プラグインをインストールする必要があり、コマンドは Linux 用 EC2 インスタンスec2-userの など、インスタンスのデフォルトユーザーを使用することに注意してください。

ssh -i /path/my-key-pair.pem ec2-user@i-02573cafcfEXAMPLE

出力:

Starting session with SessionId: ec2-user-07a16060613c408b5

詳細については、「Systems Manager ユーザーガイド」の「セッションの開始」および「 CLI 用の Session Manager プラグインのインストール」を参照してください。 AWS AWS

  • API の詳細については、「 コマンドリファレンスStartSession」の「」を参照してください。 AWS CLI

次の例は、stop-automation-execution を使用する方法を説明しています。

AWS CLI

オートメーションの実行を停止するには

次のstop-automation-execution例では、オートメーションドキュメントを停止します。

aws ssm stop-automation-execution --automation-execution-id "4105a4fc-f944-11e6-9d32-0a1b2EXAMPLE"

このコマンドでは何も出力されません。

詳細については、AWS 「Systems Manager ユーザーガイド」の「オートメーションワークフローを手動で実行する」を参照してください。

  • API の詳細については、「 コマンドリファレンスStopAutomationExecution」の「」を参照してください。 AWS CLI

次の例は、terminate-session を使用する方法を説明しています。

AWS CLI

Session Manager セッションを終了するには

terminate-session この例では、ユーザー「Shirley-Rodriguez」によって作成されたセッションを完全に終了し、インスタンス上の Session Manager クライアントと SSM エージェント間のデータ接続を閉じます。

aws ssm terminate-session \ --session-id "Shirley-Rodriguez-07a16060613c408b5"

出力:

{ "SessionId": "Shirley-Rodriguez-07a16060613c408b5" }

詳細については、「Systems Manager ユーザーガイド」の「セッションの終了」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスTerminateSession」の「」を参照してください。 AWS CLI

次の例は、unlabel-parameter-version を使用する方法を説明しています。

AWS CLI

パラメータラベルを削除するには

次のunlabel-parameter-version例では、指定されたパラメータバージョンから指定されたラベルを削除します。

aws ssm unlabel-parameter-version \ --name "parameterName" \ --parameter-version "version" \ --labels "label_1" "label_2" "label_3"

出力:

{ "RemovedLabels": [ "label_1" "label_2" "label_3" ], "InvalidLabels": [] }

詳細については、「Systems Manager ユーザーガイド」の「パラメータラベルの削除 (AWS CLI)」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスUnlabelParameterVersion」の「」を参照してください。 AWS CLI

次の例は、update-association-status を使用する方法を説明しています。

AWS CLI

関連付けステータスを更新するには

次のupdate-association-status例では、インスタンスとドキュメント間の関連付けの関連付けステータスを更新します。

aws ssm update-association-status \ --name "AWS-UpdateSSMAgent" \ --instance-id "i-1234567890abcdef0" \ --association-status "Date=1424421071.939,Name=Pending,Message=temp_status_change,AdditionalInfo=Additional-Config-Needed"

出力:

{ "AssociationDescription": { "Name": "AWS-UpdateSSMAgent", "InstanceId": "i-1234567890abcdef0", "AssociationVersion": "1", "Date": 1550507529.604, "LastUpdateAssociationDate": 1550507806.974, "Status": { "Date": 1424421071.0, "Name": "Pending", "Message": "temp_status_change", "AdditionalInfo": "Additional-Config-Needed" }, "Overview": { "Status": "Success", "AssociationStatusAggregatedCount": { "Success": 1 } }, "DocumentVersion": "$DEFAULT", "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "Targets": [ { "Key": "InstanceIds", "Values": [ "i-1234567890abcdef0" ] } ], "LastExecutionDate": 1550507808.0, "LastSuccessfulExecutionDate": 1550507808.0 } }

詳細については、「Systems Manager ユーザーガイド」の「Systems Manager での関連付けの使用」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスUpdateAssociationStatus」の「」を参照してください。 AWS CLI

次の例は、update-association を使用する方法を説明しています。

AWS CLI

例 1: ドキュメントの関連付けを更新するには

次のupdate-association例では、新しいドキュメントバージョンとの関連付けを更新します。

aws ssm update-association \ --association-id "8dfe3659-4309-493a-8755-0123456789ab" \ --document-version "\$LATEST"

出力:

{ "AssociationDescription": { "Name": "AWS-UpdateSSMAgent", "AssociationVersion": "2", "Date": 1550508093.293, "LastUpdateAssociationDate": 1550508106.596, "Overview": { "Status": "Pending", "DetailedStatus": "Creating" }, "DocumentVersion": "$LATEST", "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "Targets": [ { "Key": "tag:Name", "Values": [ "Linux" ] } ], "LastExecutionDate": 1550508094.879, "LastSuccessfulExecutionDate": 1550508094.879 } }

詳細については、「Systems Manager ユーザーガイド」の「関連付けの編集と新しいバージョンの作成」を参照してください。 AWS

例 2: 関連付けのスケジュール式を更新するには

次のupdate-association例では、指定した関連付けのスケジュール式を更新します。

aws ssm update-association \ --association-id "8dfe3659-4309-493a-8755-0123456789ab" \ --schedule-expression "cron(0 0 0/4 1/1 * ? *)"

出力:

{ "AssociationDescription": { "Name": "AWS-HelloWorld", "AssociationVersion": "2", "Date": "2021-02-08T13:54:19.203000-08:00", "LastUpdateAssociationDate": "2021-06-29T11:51:07.933000-07:00", "Overview": { "Status": "Pending", "DetailedStatus": "Creating" }, "DocumentVersion": "$DEFAULT", "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", "Targets": [ { "Key": "aws:NoOpAutomationTag", "Values": [ "AWS-NoOpAutomationTarget-Value" ] } ], "ScheduleExpression": "cron(0 0 0/4 1/1 * ? *)", "LastExecutionDate": "2021-06-26T19:00:48.110000-07:00", "ApplyOnlyAtCronInterval": false } }

詳細については、「Systems Manager ユーザーガイド」の「関連付けの編集と新しいバージョンの作成」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスUpdateAssociation」の「」を参照してください。 AWS CLI

次の例は、update-document-default-version を使用する方法を説明しています。

AWS CLI

ドキュメントのデフォルトバージョンを更新するには

次のupdate-document-default-version例では、Systems Manager ドキュメントのデフォルトバージョンを更新します。

aws ssm update-document-default-version \ --name "Example" \ --document-version "2"

出力:

{ "Description": { "Name": "Example", "DefaultVersion": "2" } }

詳細については、「Systems Manager ユーザーガイド」の「SSM ドキュメントコンテンツの書き込み」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスUpdateDocumentDefaultVersion」の「」を参照してください。 AWS CLI

次の例は、update-document-metadata を使用する方法を説明しています。

AWS CLI

例: 最新バージョンの変更テンプレートを承認するには

以下は、レビューのために送信された変更テンプレートの最新バージョンの承認update-document-metadataを示しています。

aws ssm update-document-metadata \ --name MyChangeManagerTemplate \ --document-reviews 'Action=Approve,Comment=[{Type=Comment,Content=Approved!}]'

このコマンドでは何も出力されません。

詳細については、「Systems Manager ユーザーガイド」の「変更テンプレートの確認と承認または拒否」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスUpdateDocumentMetadata」の「」を参照してください。 AWS CLI

次の例は、update-document を使用する方法を説明しています。

AWS CLI

ドキュメントの新しいバージョンを作成するには

次のupdate-document例では、Windows コンピュータで実行するときにドキュメントの新しいバージョンを作成します。で指定されたドキュメントは JSON 形式--documentである必要があります。は、コンテンツファイルのパスの後に参照file://する必要があります。--document-version パラメータの$先頭にある により、Windows では値を二重引用符で囲む必要があります。Linux、MacOS、または PowerShell プロンプトで、値を一重引用符で囲む必要があります。

Windows バージョン :

aws ssm update-document \ --name "RunShellScript" \ --content "file://RunShellScript.json" \ --document-version "$LATEST"

Linux/Mac バージョン :

aws ssm update-document \ --name "RunShellScript" \ --content "file://RunShellScript.json" \ --document-version '$LATEST'

出力:

{ "DocumentDescription": { "Status": "Updating", "Hash": "f775e5df4904c6fa46686c4722fae9de1950dace25cd9608ff8d622046b68d9b", "Name": "RunShellScript", "Parameters": [ { "Type": "StringList", "Name": "commands", "Description": "(Required) Specify a shell script or a command to run." } ], "DocumentType": "Command", "PlatformTypes": [ "Linux" ], "DocumentVersion": "2", "HashType": "Sha256", "CreatedDate": 1487899655.152, "Owner": "809632081692", "SchemaVersion": "2.0", "DefaultVersion": "1", "LatestVersion": "2", "Description": "Run an updated script" } }
  • API の詳細については、「 コマンドリファレンスUpdateDocument」の「」を参照してください。 AWS CLI

次の例は、update-maintenance-window-target を使用する方法を説明しています。

AWS CLI

メンテナンスウィンドウのターゲットを更新するには

次のupdate-maintenance-window-target例では、メンテナンスウィンドウターゲットの名前のみを更新します。

aws ssm update-maintenance-window-target \ --window-id "mw-0c5ed765acEXAMPLE" \ --window-target-id "57e8344e-fe64-4023-8191-6bf05EXAMPLE" \ --name "NewName" \ --no-replace

出力:

{ "Description": "", "OwnerInformation": "", "WindowTargetId": "57e8344e-fe64-4023-8191-6bf05EXAMPLE", "WindowId": "mw-0c5ed765acEXAMPLE", "Targets": [ { "Values": [ "i-1234567890EXAMPLE" ], "Key": "InstanceIds" } ], "Name": "NewName" }

詳細については、「Systems Manager ユーザーガイド」の「メンテナンスウィンドウの更新 (AWS CLI)」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスUpdateMaintenanceWindowTarget」の「」を参照してください。 AWS CLI

次の例は、update-maintenance-window-task を使用する方法を説明しています。

AWS CLI

メンテナンスウィンドウタスクを更新するには

次のupdate-maintenance-window-task例では、メンテナンスウィンドウタスクのサービスロールを更新します。

aws ssm update-maintenance-window-task \ --window-id "mw-0c5ed765acEXAMPLE" \ --window-task-id "23d3809e-9fbe-4ddf-b41a-b49d7EXAMPLE" \ --service-role-arn "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM"

出力:

{ "ServiceRoleArn": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "MaxErrors": "1", "TaskArn": "AWS-UpdateEC2Config", "MaxConcurrency": "1", "WindowTaskId": "23d3809e-9fbe-4ddf-b41a-b49d7EXAMPLE", "TaskParameters": {}, "Priority": 1, "TaskInvocationParameters": { "RunCommand": { "TimeoutSeconds": 600, "Parameters": { "allowDowngrade": [ "false" ] } } }, "WindowId": "mw-0c5ed765acEXAMPLE", "Description": "UpdateEC2Config", "Targets": [ { "Values": [ "57e8344e-fe64-4023-8191-6bf05EXAMPLE" ], "Key": "WindowTargetIds" } ], "Name": "UpdateEC2Config" }

詳細については、「Systems Manager ユーザーガイド」の「メンテナンスウィンドウの更新 (AWS CLI)」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスUpdateMaintenanceWindowTask」の「」を参照してください。 AWS CLI

次の例は、update-maintenance-window を使用する方法を説明しています。

AWS CLI

例 1: メンテナンスウィンドウを更新するには

次のupdate-maintenance-window例では、メンテナンスウィンドウの名前を更新します。

aws ssm update-maintenance-window \ --window-id "mw-1a2b3c4d5e6f7g8h9" \ --name "My-Renamed-MW"

出力:

{ "Cutoff": 1, "Name": "My-Renamed-MW", "Schedule": "cron(0 16 ? * TUE *)", "Enabled": true, "AllowUnassociatedTargets": true, "WindowId": "mw-1a2b3c4d5e6f7g8h9", "Duration": 4 }

例 2: メンテナンスウィンドウを無効にするには

次のupdate-maintenance-window例では、メンテナンスウィンドウを無効にします。

aws ssm update-maintenance-window \ --window-id "mw-1a2b3c4d5e6f7g8h9" \ --no-enabled

例 3: メンテナンスウィンドウを有効にするには

次のupdate-maintenance-window例では、メンテナンスウィンドウを有効にします。

aws ssm update-maintenance-window \ --window-id "mw-1a2b3c4d5e6f7g8h9" \ --enabled

詳細については、「Systems Manager ユーザーガイド」の「メンテナンスウィンドウの更新 (AWS CLI)」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスUpdateMaintenanceWindow」の「」を参照してください。 AWS CLI

次の例は、update-managed-instance-role を使用する方法を説明しています。

AWS CLI

マネージドインスタンスの IAM ロールを更新するには

次のupdate-managed-instance-role例では、マネージドインスタンスの IAM インスタンスプロファイルを更新します。

aws ssm update-managed-instance-role \ --instance-id "mi-08ab247cdfEXAMPLE" \ --iam-role "ExampleRole"

このコマンドでは何も出力されません。

詳細については、「Systems Manager ユーザーガイド」の「ステップ 4: Systems Manager の IAM インスタンスプロファイルを作成する」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスUpdateManagedInstanceRole」の「」を参照してください。 AWS CLI

次の例は、update-ops-item を使用する方法を説明しています。

AWS CLI

を更新するには OpsItem

次のupdate-ops-item例では、 の説明、優先度、およびカテゴリを更新します OpsItem。さらに、このコマンドは、これが編集または変更されたときに通知を送信する SNS OpsItem トピックを指定します。

aws ssm update-ops-item \ --ops-item-id "oi-287b5EXAMPLE" \ --description "Primary OpsItem for failover event 2020-01-01-fh398yf" \ --priority 2 \ --category "Security" \ --notifications "Arn=arn:aws:sns:us-east-2:111222333444:my-us-east-2-topic"

出力:

This command produces no output.

詳細については、「Systems Manager ユーザーガイド」の OpsItems「 の使用」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスUpdateOpsItem」の「」を参照してください。 AWS CLI

次の例は、update-patch-baseline を使用する方法を説明しています。

AWS CLI

例 1: パッチベースラインを更新するには

次のupdate-patch-baseline例では、指定した 2 つのパッチを拒否として追加し、承認された 1 つのパッチを指定したパッチベースラインに追加します。

aws ssm update-patch-baseline \ --baseline-id "pb-0123456789abcdef0" \ --rejected-patches "KB2032276" "MS10-048" \ --approved-patches "KB2124261"

出力:

{ "BaselineId": "pb-0123456789abcdef0", "Name": "WindowsPatching", "OperatingSystem": "WINDOWS", "GlobalFilters": { "PatchFilters": [] }, "ApprovalRules": { "PatchRules": [ { "PatchFilterGroup": { "PatchFilters": [ { "Key": "PRODUCT", "Values": [ "WindowsServer2016" ] } ] }, "ComplianceLevel": "CRITICAL", "ApproveAfterDays": 0, "EnableNonSecurity": false } ] }, "ApprovedPatches": [ "KB2124261" ], "ApprovedPatchesComplianceLevel": "UNSPECIFIED", "ApprovedPatchesEnableNonSecurity": false, "RejectedPatches": [ "KB2032276", "MS10-048" ], "RejectedPatchesAction": "ALLOW_AS_DEPENDENCY", "CreatedDate": 1550244180.465, "ModifiedDate": 1550244180.465, "Description": "Patches for Windows Servers", "Sources": [] }

例 2: パッチベースラインの名前を変更するには

次のupdate-patch-baseline例では、指定したパッチベースラインの名前を変更します。

aws ssm update-patch-baseline \ --baseline-id "pb-0713accee01234567" \ --name "Windows-Server-2012-R2-Important-and-Critical-Security-Updates"

詳細については、AWS 「Systems Manager ユーザーガイド」の「パッチベースライン <https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-baseline-update-or-delete.html>`__」を参照してください。

  • API の詳細については、「 コマンドリファレンスUpdatePatchBaseline」の「」を参照してください。 AWS CLI

次の例は、update-resource-data-sync を使用する方法を説明しています。

AWS CLI

リソースデータ同期を更新するには

次のupdate-resource-data-sync例では、 SyncFromSource リソースデータ同期を更新します。

aws ssm update-resource-data-sync \ --sync-name exampleSync \ --sync-type SyncFromSource \ --sync-source '{"SourceType":"SingleAccountMultiRegions", "SourceRegions":["us-east-1", "us-west-2"]}'

このコマンドでは何も出力されません。

詳細については、「Systems Manager ユーザーガイド」の「複数のアカウントとリージョンのデータを表示する Systems Manager Explorer のセットアップ」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスUpdateResourceDataSync」の「」を参照してください。 AWS CLI

次の例は、update-service-setting を使用する方法を説明しています。

AWS CLI

Parameter Store スループットのサービス設定を更新するには

次のupdate-service-setting例では、指定されたリージョンの Parameter Store スループットの現在のサービス設定を更新して、増加したスループットを使用します。

aws ssm update-service-setting \ --setting-id arn:aws:ssm:us-east-1:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled \ --setting-value true

このコマンドでは何も出力されません。

詳細については、「Systems Manager ユーザーガイド」の「パラメータストアのスループットを上げる」を参照してください。 AWS

  • API の詳細については、「 コマンドリファレンスUpdateServiceSetting」の「」を参照してください。 AWS CLI