文件 AWS 開發套件範例 GitHub 儲存庫中有更多可用的 [AWS SDK 範例](https://github.com/awsdocs/aws-doc-sdk-examples)。
本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
# Systems Manager AWS SDKs的程式碼範例
下列程式碼範例示範如何使用 AWS Systems Manager 搭配 AWS 軟體開發套件 (SDK)。
*基本概念*是程式碼範例，這些範例說明如何在服務內執行基本操作。
*Actions* 是大型程式的程式碼摘錄，必須在內容中執行。雖然動作會告訴您如何呼叫個別服務函數，但您可以在其相關情境中查看內容中的動作。
**其他資源**
+ **[Systems Manager 使用者指南](https://docs.aws.amazon.com/systems-manager/latest/userguide/what-is-systems-manager.html)** – Systems Manager 的詳細資訊。
+ **[Systems Manager API 參考](https://docs.aws.amazon.com/systems-manager/latest/APIReference/Welcome.html)** – 所有可用 Systems Manager 動作的詳細資訊。
+ **[AWS 開發人員中心](https://aws.amazon.com/developer/code-examples/?awsf.sdk-code-examples-product=product%23systems-mgr)** – 您可以依類別或全文搜尋篩選的程式碼範例。
+ **[AWS SDK 範例](https://github.com/awsdocs/aws-doc-sdk-examples)** – GitHub 儲存庫使用慣用語言的完整程式碼。包含設定和執行程式碼的指示。
**Contents**
+ [基本概念](ssm_code_examples_basics.md)
+ [嗨，Systems Manager](ssm_example_ssm_Hello_section.md)
+ [了解基本概念](ssm_example_ssm_Scenario_section.md)
+ [動作](ssm_code_examples_actions.md)
+ [`AddTagsToResource`](ssm_example_ssm_AddTagsToResource_section.md)
+ [`CancelCommand`](ssm_example_ssm_CancelCommand_section.md)
+ [`CreateActivation`](ssm_example_ssm_CreateActivation_section.md)
+ [`CreateAssociation`](ssm_example_ssm_CreateAssociation_section.md)
+ [`CreateAssociationBatch`](ssm_example_ssm_CreateAssociationBatch_section.md)
+ [`CreateDocument`](ssm_example_ssm_CreateDocument_section.md)
+ [`CreateMaintenanceWindow`](ssm_example_ssm_CreateMaintenanceWindow_section.md)
+ [`CreateOpsItem`](ssm_example_ssm_CreateOpsItem_section.md)
+ [`CreatePatchBaseline`](ssm_example_ssm_CreatePatchBaseline_section.md)
+ [`DeleteActivation`](ssm_example_ssm_DeleteActivation_section.md)
+ [`DeleteAssociation`](ssm_example_ssm_DeleteAssociation_section.md)
+ [`DeleteDocument`](ssm_example_ssm_DeleteDocument_section.md)
+ [`DeleteMaintenanceWindow`](ssm_example_ssm_DeleteMaintenanceWindow_section.md)
+ [`DeleteOpsItem`](ssm_example_ssm_DeleteOpsItem_section.md)
+ [`DeleteParameter`](ssm_example_ssm_DeleteParameter_section.md)
+ [`DeletePatchBaseline`](ssm_example_ssm_DeletePatchBaseline_section.md)
+ [`DeregisterManagedInstance`](ssm_example_ssm_DeregisterManagedInstance_section.md)
+ [`DeregisterPatchBaselineForPatchGroup`](ssm_example_ssm_DeregisterPatchBaselineForPatchGroup_section.md)
+ [`DeregisterTargetFromMaintenanceWindow`](ssm_example_ssm_DeregisterTargetFromMaintenanceWindow_section.md)
+ [`DeregisterTaskFromMaintenanceWindow`](ssm_example_ssm_DeregisterTaskFromMaintenanceWindow_section.md)
+ [`DescribeActivations`](ssm_example_ssm_DescribeActivations_section.md)
+ [`DescribeAssociation`](ssm_example_ssm_DescribeAssociation_section.md)
+ [`DescribeAssociationExecutionTargets`](ssm_example_ssm_DescribeAssociationExecutionTargets_section.md)
+ [`DescribeAssociationExecutions`](ssm_example_ssm_DescribeAssociationExecutions_section.md)
+ [`DescribeAutomationExecutions`](ssm_example_ssm_DescribeAutomationExecutions_section.md)
+ [`DescribeAutomationStepExecutions`](ssm_example_ssm_DescribeAutomationStepExecutions_section.md)
+ [`DescribeAvailablePatches`](ssm_example_ssm_DescribeAvailablePatches_section.md)
+ [`DescribeDocument`](ssm_example_ssm_DescribeDocument_section.md)
+ [`DescribeDocumentPermission`](ssm_example_ssm_DescribeDocumentPermission_section.md)
+ [`DescribeEffectiveInstanceAssociations`](ssm_example_ssm_DescribeEffectiveInstanceAssociations_section.md)
+ [`DescribeEffectivePatchesForPatchBaseline`](ssm_example_ssm_DescribeEffectivePatchesForPatchBaseline_section.md)
+ [`DescribeInstanceAssociationsStatus`](ssm_example_ssm_DescribeInstanceAssociationsStatus_section.md)
+ [`DescribeInstanceInformation`](ssm_example_ssm_DescribeInstanceInformation_section.md)
+ [`DescribeInstancePatchStates`](ssm_example_ssm_DescribeInstancePatchStates_section.md)
+ [`DescribeInstancePatchStatesForPatchGroup`](ssm_example_ssm_DescribeInstancePatchStatesForPatchGroup_section.md)
+ [`DescribeInstancePatches`](ssm_example_ssm_DescribeInstancePatches_section.md)
+ [`DescribeMaintenanceWindowExecutionTaskInvocations`](ssm_example_ssm_DescribeMaintenanceWindowExecutionTaskInvocations_section.md)
+ [`DescribeMaintenanceWindowExecutionTasks`](ssm_example_ssm_DescribeMaintenanceWindowExecutionTasks_section.md)
+ [`DescribeMaintenanceWindowExecutions`](ssm_example_ssm_DescribeMaintenanceWindowExecutions_section.md)
+ [`DescribeMaintenanceWindowTargets`](ssm_example_ssm_DescribeMaintenanceWindowTargets_section.md)
+ [`DescribeMaintenanceWindowTasks`](ssm_example_ssm_DescribeMaintenanceWindowTasks_section.md)
+ [`DescribeMaintenanceWindows`](ssm_example_ssm_DescribeMaintenanceWindows_section.md)
+ [`DescribeOpsItems`](ssm_example_ssm_DescribeOpsItems_section.md)
+ [`DescribeParameters`](ssm_example_ssm_DescribeParameters_section.md)
+ [`DescribePatchBaselines`](ssm_example_ssm_DescribePatchBaselines_section.md)
+ [`DescribePatchGroupState`](ssm_example_ssm_DescribePatchGroupState_section.md)
+ [`DescribePatchGroups`](ssm_example_ssm_DescribePatchGroups_section.md)
+ [`GetAutomationExecution`](ssm_example_ssm_GetAutomationExecution_section.md)
+ [`GetCommandInvocation`](ssm_example_ssm_GetCommandInvocation_section.md)
+ [`GetConnectionStatus`](ssm_example_ssm_GetConnectionStatus_section.md)
+ [`GetDefaultPatchBaseline`](ssm_example_ssm_GetDefaultPatchBaseline_section.md)
+ [`GetDeployablePatchSnapshotForInstance`](ssm_example_ssm_GetDeployablePatchSnapshotForInstance_section.md)
+ [`GetDocument`](ssm_example_ssm_GetDocument_section.md)
+ [`GetInventory`](ssm_example_ssm_GetInventory_section.md)
+ [`GetInventorySchema`](ssm_example_ssm_GetInventorySchema_section.md)
+ [`GetMaintenanceWindow`](ssm_example_ssm_GetMaintenanceWindow_section.md)
+ [`GetMaintenanceWindowExecution`](ssm_example_ssm_GetMaintenanceWindowExecution_section.md)
+ [`GetMaintenanceWindowExecutionTask`](ssm_example_ssm_GetMaintenanceWindowExecutionTask_section.md)
+ [`GetParameter`](ssm_example_ssm_GetParameter_section.md)
+ [`GetParameterHistory`](ssm_example_ssm_GetParameterHistory_section.md)
+ [`GetParameters`](ssm_example_ssm_GetParameters_section.md)
+ [`GetPatchBaseline`](ssm_example_ssm_GetPatchBaseline_section.md)
+ [`GetPatchBaselineForPatchGroup`](ssm_example_ssm_GetPatchBaselineForPatchGroup_section.md)
+ [`ListAssociationVersions`](ssm_example_ssm_ListAssociationVersions_section.md)
+ [`ListAssociations`](ssm_example_ssm_ListAssociations_section.md)
+ [`ListCommandInvocations`](ssm_example_ssm_ListCommandInvocations_section.md)
+ [`ListCommands`](ssm_example_ssm_ListCommands_section.md)
+ [`ListComplianceItems`](ssm_example_ssm_ListComplianceItems_section.md)
+ [`ListComplianceSummaries`](ssm_example_ssm_ListComplianceSummaries_section.md)
+ [`ListDocumentVersions`](ssm_example_ssm_ListDocumentVersions_section.md)
+ [`ListDocuments`](ssm_example_ssm_ListDocuments_section.md)
+ [`ListInventoryEntries`](ssm_example_ssm_ListInventoryEntries_section.md)
+ [`ListResourceComplianceSummaries`](ssm_example_ssm_ListResourceComplianceSummaries_section.md)
+ [`ListTagsForResource`](ssm_example_ssm_ListTagsForResource_section.md)
+ [`ModifyDocumentPermission`](ssm_example_ssm_ModifyDocumentPermission_section.md)
+ [`PutComplianceItems`](ssm_example_ssm_PutComplianceItems_section.md)
+ [`PutInventory`](ssm_example_ssm_PutInventory_section.md)
+ [`PutParameter`](ssm_example_ssm_PutParameter_section.md)
+ [`RegisterDefaultPatchBaseline`](ssm_example_ssm_RegisterDefaultPatchBaseline_section.md)
+ [`RegisterPatchBaselineForPatchGroup`](ssm_example_ssm_RegisterPatchBaselineForPatchGroup_section.md)
+ [`RegisterTargetWithMaintenanceWindow`](ssm_example_ssm_RegisterTargetWithMaintenanceWindow_section.md)
+ [`RegisterTaskWithMaintenanceWindow`](ssm_example_ssm_RegisterTaskWithMaintenanceWindow_section.md)
+ [`RemoveTagsFromResource`](ssm_example_ssm_RemoveTagsFromResource_section.md)
+ [`SendCommand`](ssm_example_ssm_SendCommand_section.md)
+ [`StartAutomationExecution`](ssm_example_ssm_StartAutomationExecution_section.md)
+ [`StartSession`](ssm_example_ssm_StartSession_section.md)
+ [`StopAutomationExecution`](ssm_example_ssm_StopAutomationExecution_section.md)
+ [`UpdateAssociation`](ssm_example_ssm_UpdateAssociation_section.md)
+ [`UpdateAssociationStatus`](ssm_example_ssm_UpdateAssociationStatus_section.md)
+ [`UpdateDocument`](ssm_example_ssm_UpdateDocument_section.md)
+ [`UpdateDocumentDefaultVersion`](ssm_example_ssm_UpdateDocumentDefaultVersion_section.md)
+ [`UpdateMaintenanceWindow`](ssm_example_ssm_UpdateMaintenanceWindow_section.md)
+ [`UpdateManagedInstanceRole`](ssm_example_ssm_UpdateManagedInstanceRole_section.md)
+ [`UpdateOpsItem`](ssm_example_ssm_UpdateOpsItem_section.md)
+ [`UpdatePatchBaseline`](ssm_example_ssm_UpdatePatchBaseline_section.md)
# Systems Manager AWS SDKs的基本範例
下列程式碼範例示範如何 AWS Systems Manager 搭配 AWS SDKs 使用 的基本概念。
**Contents**
+ [嗨，Systems Manager](ssm_example_ssm_Hello_section.md)
+ [了解基本概念](ssm_example_ssm_Scenario_section.md)
+ [動作](ssm_code_examples_actions.md)
+ [`AddTagsToResource`](ssm_example_ssm_AddTagsToResource_section.md)
+ [`CancelCommand`](ssm_example_ssm_CancelCommand_section.md)
+ [`CreateActivation`](ssm_example_ssm_CreateActivation_section.md)
+ [`CreateAssociation`](ssm_example_ssm_CreateAssociation_section.md)
+ [`CreateAssociationBatch`](ssm_example_ssm_CreateAssociationBatch_section.md)
+ [`CreateDocument`](ssm_example_ssm_CreateDocument_section.md)
+ [`CreateMaintenanceWindow`](ssm_example_ssm_CreateMaintenanceWindow_section.md)
+ [`CreateOpsItem`](ssm_example_ssm_CreateOpsItem_section.md)
+ [`CreatePatchBaseline`](ssm_example_ssm_CreatePatchBaseline_section.md)
+ [`DeleteActivation`](ssm_example_ssm_DeleteActivation_section.md)
+ [`DeleteAssociation`](ssm_example_ssm_DeleteAssociation_section.md)
+ [`DeleteDocument`](ssm_example_ssm_DeleteDocument_section.md)
+ [`DeleteMaintenanceWindow`](ssm_example_ssm_DeleteMaintenanceWindow_section.md)
+ [`DeleteOpsItem`](ssm_example_ssm_DeleteOpsItem_section.md)
+ [`DeleteParameter`](ssm_example_ssm_DeleteParameter_section.md)
+ [`DeletePatchBaseline`](ssm_example_ssm_DeletePatchBaseline_section.md)
+ [`DeregisterManagedInstance`](ssm_example_ssm_DeregisterManagedInstance_section.md)
+ [`DeregisterPatchBaselineForPatchGroup`](ssm_example_ssm_DeregisterPatchBaselineForPatchGroup_section.md)
+ [`DeregisterTargetFromMaintenanceWindow`](ssm_example_ssm_DeregisterTargetFromMaintenanceWindow_section.md)
+ [`DeregisterTaskFromMaintenanceWindow`](ssm_example_ssm_DeregisterTaskFromMaintenanceWindow_section.md)
+ [`DescribeActivations`](ssm_example_ssm_DescribeActivations_section.md)
+ [`DescribeAssociation`](ssm_example_ssm_DescribeAssociation_section.md)
+ [`DescribeAssociationExecutionTargets`](ssm_example_ssm_DescribeAssociationExecutionTargets_section.md)
+ [`DescribeAssociationExecutions`](ssm_example_ssm_DescribeAssociationExecutions_section.md)
+ [`DescribeAutomationExecutions`](ssm_example_ssm_DescribeAutomationExecutions_section.md)
+ [`DescribeAutomationStepExecutions`](ssm_example_ssm_DescribeAutomationStepExecutions_section.md)
+ [`DescribeAvailablePatches`](ssm_example_ssm_DescribeAvailablePatches_section.md)
+ [`DescribeDocument`](ssm_example_ssm_DescribeDocument_section.md)
+ [`DescribeDocumentPermission`](ssm_example_ssm_DescribeDocumentPermission_section.md)
+ [`DescribeEffectiveInstanceAssociations`](ssm_example_ssm_DescribeEffectiveInstanceAssociations_section.md)
+ [`DescribeEffectivePatchesForPatchBaseline`](ssm_example_ssm_DescribeEffectivePatchesForPatchBaseline_section.md)
+ [`DescribeInstanceAssociationsStatus`](ssm_example_ssm_DescribeInstanceAssociationsStatus_section.md)
+ [`DescribeInstanceInformation`](ssm_example_ssm_DescribeInstanceInformation_section.md)
+ [`DescribeInstancePatchStates`](ssm_example_ssm_DescribeInstancePatchStates_section.md)
+ [`DescribeInstancePatchStatesForPatchGroup`](ssm_example_ssm_DescribeInstancePatchStatesForPatchGroup_section.md)
+ [`DescribeInstancePatches`](ssm_example_ssm_DescribeInstancePatches_section.md)
+ [`DescribeMaintenanceWindowExecutionTaskInvocations`](ssm_example_ssm_DescribeMaintenanceWindowExecutionTaskInvocations_section.md)
+ [`DescribeMaintenanceWindowExecutionTasks`](ssm_example_ssm_DescribeMaintenanceWindowExecutionTasks_section.md)
+ [`DescribeMaintenanceWindowExecutions`](ssm_example_ssm_DescribeMaintenanceWindowExecutions_section.md)
+ [`DescribeMaintenanceWindowTargets`](ssm_example_ssm_DescribeMaintenanceWindowTargets_section.md)
+ [`DescribeMaintenanceWindowTasks`](ssm_example_ssm_DescribeMaintenanceWindowTasks_section.md)
+ [`DescribeMaintenanceWindows`](ssm_example_ssm_DescribeMaintenanceWindows_section.md)
+ [`DescribeOpsItems`](ssm_example_ssm_DescribeOpsItems_section.md)
+ [`DescribeParameters`](ssm_example_ssm_DescribeParameters_section.md)
+ [`DescribePatchBaselines`](ssm_example_ssm_DescribePatchBaselines_section.md)
+ [`DescribePatchGroupState`](ssm_example_ssm_DescribePatchGroupState_section.md)
+ [`DescribePatchGroups`](ssm_example_ssm_DescribePatchGroups_section.md)
+ [`GetAutomationExecution`](ssm_example_ssm_GetAutomationExecution_section.md)
+ [`GetCommandInvocation`](ssm_example_ssm_GetCommandInvocation_section.md)
+ [`GetConnectionStatus`](ssm_example_ssm_GetConnectionStatus_section.md)
+ [`GetDefaultPatchBaseline`](ssm_example_ssm_GetDefaultPatchBaseline_section.md)
+ [`GetDeployablePatchSnapshotForInstance`](ssm_example_ssm_GetDeployablePatchSnapshotForInstance_section.md)
+ [`GetDocument`](ssm_example_ssm_GetDocument_section.md)
+ [`GetInventory`](ssm_example_ssm_GetInventory_section.md)
+ [`GetInventorySchema`](ssm_example_ssm_GetInventorySchema_section.md)
+ [`GetMaintenanceWindow`](ssm_example_ssm_GetMaintenanceWindow_section.md)
+ [`GetMaintenanceWindowExecution`](ssm_example_ssm_GetMaintenanceWindowExecution_section.md)
+ [`GetMaintenanceWindowExecutionTask`](ssm_example_ssm_GetMaintenanceWindowExecutionTask_section.md)
+ [`GetParameter`](ssm_example_ssm_GetParameter_section.md)
+ [`GetParameterHistory`](ssm_example_ssm_GetParameterHistory_section.md)
+ [`GetParameters`](ssm_example_ssm_GetParameters_section.md)
+ [`GetPatchBaseline`](ssm_example_ssm_GetPatchBaseline_section.md)
+ [`GetPatchBaselineForPatchGroup`](ssm_example_ssm_GetPatchBaselineForPatchGroup_section.md)
+ [`ListAssociationVersions`](ssm_example_ssm_ListAssociationVersions_section.md)
+ [`ListAssociations`](ssm_example_ssm_ListAssociations_section.md)
+ [`ListCommandInvocations`](ssm_example_ssm_ListCommandInvocations_section.md)
+ [`ListCommands`](ssm_example_ssm_ListCommands_section.md)
+ [`ListComplianceItems`](ssm_example_ssm_ListComplianceItems_section.md)
+ [`ListComplianceSummaries`](ssm_example_ssm_ListComplianceSummaries_section.md)
+ [`ListDocumentVersions`](ssm_example_ssm_ListDocumentVersions_section.md)
+ [`ListDocuments`](ssm_example_ssm_ListDocuments_section.md)
+ [`ListInventoryEntries`](ssm_example_ssm_ListInventoryEntries_section.md)
+ [`ListResourceComplianceSummaries`](ssm_example_ssm_ListResourceComplianceSummaries_section.md)
+ [`ListTagsForResource`](ssm_example_ssm_ListTagsForResource_section.md)
+ [`ModifyDocumentPermission`](ssm_example_ssm_ModifyDocumentPermission_section.md)
+ [`PutComplianceItems`](ssm_example_ssm_PutComplianceItems_section.md)
+ [`PutInventory`](ssm_example_ssm_PutInventory_section.md)
+ [`PutParameter`](ssm_example_ssm_PutParameter_section.md)
+ [`RegisterDefaultPatchBaseline`](ssm_example_ssm_RegisterDefaultPatchBaseline_section.md)
+ [`RegisterPatchBaselineForPatchGroup`](ssm_example_ssm_RegisterPatchBaselineForPatchGroup_section.md)
+ [`RegisterTargetWithMaintenanceWindow`](ssm_example_ssm_RegisterTargetWithMaintenanceWindow_section.md)
+ [`RegisterTaskWithMaintenanceWindow`](ssm_example_ssm_RegisterTaskWithMaintenanceWindow_section.md)
+ [`RemoveTagsFromResource`](ssm_example_ssm_RemoveTagsFromResource_section.md)
+ [`SendCommand`](ssm_example_ssm_SendCommand_section.md)
+ [`StartAutomationExecution`](ssm_example_ssm_StartAutomationExecution_section.md)
+ [`StartSession`](ssm_example_ssm_StartSession_section.md)
+ [`StopAutomationExecution`](ssm_example_ssm_StopAutomationExecution_section.md)
+ [`UpdateAssociation`](ssm_example_ssm_UpdateAssociation_section.md)
+ [`UpdateAssociationStatus`](ssm_example_ssm_UpdateAssociationStatus_section.md)
+ [`UpdateDocument`](ssm_example_ssm_UpdateDocument_section.md)
+ [`UpdateDocumentDefaultVersion`](ssm_example_ssm_UpdateDocumentDefaultVersion_section.md)
+ [`UpdateMaintenanceWindow`](ssm_example_ssm_UpdateMaintenanceWindow_section.md)
+ [`UpdateManagedInstanceRole`](ssm_example_ssm_UpdateManagedInstanceRole_section.md)
+ [`UpdateOpsItem`](ssm_example_ssm_UpdateOpsItem_section.md)
+ [`UpdatePatchBaseline`](ssm_example_ssm_UpdatePatchBaseline_section.md)
# 嗨，Systems Manager
下列程式碼範例示範如何開始使用 Systems Manager。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/ssm#code-examples)中設定和執行。
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.ssm.SsmClient;
import software.amazon.awssdk.services.ssm.model.DocumentFilter;
import software.amazon.awssdk.services.ssm.model.ListDocumentsRequest;
import software.amazon.awssdk.services.ssm.model.ListDocumentsResponse;
public class HelloSSM {
public static void main(String[] args) {
final String usage = """
Usage:
Where:
awsAccount - Your AWS Account number.
""";
if (args.length != 1) {
System.out.println(usage);
System.exit(1);
}
String awsAccount = args[0] ;
Region region = Region.US_EAST_1;
SsmClient ssmClient = SsmClient.builder()
.region(region)
.build();
listDocuments(ssmClient, awsAccount);
}
/*
This code automatically fetches the next set of results using the `nextToken` and
stops once the desired maxResults (20 in this case) have been reached.
*/
public static void listDocuments(SsmClient ssmClient, String awsAccount) {
String nextToken = null;
int totalDocumentsReturned = 0;
int maxResults = 20;
do {
ListDocumentsRequest request = ListDocumentsRequest.builder()
.documentFilterList(
DocumentFilter.builder()
.key("Owner")
.value(awsAccount)
.build()
)
.maxResults(maxResults)
.nextToken(nextToken)
.build();
ListDocumentsResponse response = ssmClient.listDocuments(request);
response.documentIdentifiers().forEach(identifier -> System.out.println("Document Name: " + identifier.name()));
nextToken = response.nextToken();
totalDocumentsReturned += response.documentIdentifiers().size();
} while (nextToken != null && totalDocumentsReturned < maxResults);
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [ListDocuments](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/ListDocuments)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ssm#code-examples)中設定和執行。
```
import { paginateListDocuments, SSMClient } from "@aws-sdk/client-ssm";
// Call ListDocuments and display the result.
export const main = async () => {
const client = new SSMClient();
const listDocumentsPaginated = [];
console.log(
"Hello, AWS Systems Manager! Let's list some of your documents:\n",
);
try {
// The paginate function is a wrapper around the base command.
const paginator = paginateListDocuments({ client }, { MaxResults: 5 });
for await (const page of paginator) {
listDocumentsPaginated.push(...page.DocumentIdentifiers);
}
} catch (caught) {
console.error(`There was a problem saying hello: ${caught.message}`);
throw caught;
}
for (const { Name, DocumentFormat, CreatedDate } of listDocumentsPaginated) {
console.log(`${Name} - ${DocumentFormat} - ${CreatedDate}`);
}
};
// Call function if run directly.
import { fileURLToPath } from "node:url";
if (process.argv[1] === fileURLToPath(import.meta.url)) {
main();
}
```
+ 如需 API 詳細資訊，請參閱《適用於 JavaScript 的 AWS SDK API 參考》**中的 [ListDocuments](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/ListDocumentsCommand)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/ssm#code-examples)中設定和執行。
```
import boto3
from botocore.exceptions import ClientError
def hello_systems_manager(ssm_client):
"""
Use the AWS SDK for Python (Boto3) to create an AWS Systems Manager
client and list the first 5 documents in your account.
This example uses the default settings specified in your shared credentials
and config files.
:param ssm_client: A Boto3 AWS Systems Manager Client object. This object wraps
the low-level AWS Systems Manager service API.
"""
print("Hello, AWS Systems Manager! Let's list some of your documents:\n")
paginator = ssm_client.get_paginator("list_documents")
page_iterator = paginator.paginate(PaginationConfig={"MaxItems": 5})
for page in page_iterator:
for document in page["DocumentIdentifiers"]:
print(f" {document['Name']}")
if __name__ == "__main__":
try:
hello_systems_manager(boto3.client("ssm"))
except ClientError as err:
print("Hello systems manager had an error.")
print(err.response["Error"]["Code"])
print(err.response["Error"]["Message"])
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [ListDocuments](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/ListDocuments)。
------
# 使用 AWS SDK 了解 Systems Manager 的基本概念
下列程式碼範例示範如何：
+ 建立維護時段。
+ 修改維護時段排程。
+ 建立文件。
+ 將命令傳送至指定的 EC2 執行個體。
+ 建立 OpsItem。
+ 更新與解析 OpsItem。
+ 刪除維護時段、OpsItem 與文件。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/ssm#code-examples)中設定和執行。
```
import software.amazon.awssdk.services.ssm.model.DocumentAlreadyExistsException;
import software.amazon.awssdk.services.ssm.model.SsmException;
import java.util.Map;
import java.util.Scanner;
public class SSMScenario {
public static final String DASHES = new String(new char[80]).replace("\0", "-");
private static final String ROLES_STACK = "SsmStack3`1";
public static void main(String[] args) {
String usage = """
Usage:
<source> <category> <severity>
Where:
title - The title of the parameter (default is Disk Space Alert).
source - The source of the parameter (default is EC2).
category - The category of the parameter. Valid values are 'Availability', 'Cost', 'Performance', 'Recovery', 'Security' (default is Performance).
severity - The severity of the parameter. Severity should be a number from 1 to 4 (default is 2).
""";
Scanner scanner = new Scanner(System.in);
SSMActions actions = new SSMActions();
String documentName;
String windowName;
System.out.println("Use AWS CloudFormation to create the EC2 instance that is required for this scenario.");
CloudFormationHelper.deployCloudFormationStack(ROLES_STACK);
Map<String, String> stackOutputs = CloudFormationHelper.getStackOutputsAsync(ROLES_STACK).join();
String instanceId = stackOutputs.get("InstanceId");
System.out.println("The Instance ID: " + instanceId +" was created.");
String title = "Disk Space Alert" ;
String source = "EC2" ;
String category = "Availability" ;
String severity = "2" ;
System.out.println(DASHES);
System.out.println("""
Welcome to the AWS Systems Manager SDK Basics scenario.
This Java program demonstrates how to interact with AWS Systems Manager using the AWS SDK for Java (v2).
AWS Systems Manager is the operations hub for your AWS applications and resources and a secure end-to-end management solution.
The program's primary functionalities include creating a maintenance window, creating a document, sending a command to a document,
listing documents, listing commands, creating an OpsItem, modifying an OpsItem, and deleting AWS SSM resources.
Upon completion of the program, all AWS resources are cleaned up.
Let's get started...
""");
waitForInputToContinue(scanner);
System.out.println(DASHES);
System.out.println("1. Create an SSM maintenance window.");
System.out.println("Please enter the maintenance window name (default is ssm-maintenance-window):");
String win = scanner.nextLine();
windowName = win.isEmpty() ? "ssm-maintenance-window" : win;
String winId = null;
try {
winId = actions.createMaintenanceWindow(windowName);
waitForInputToContinue(scanner);
System.out.println("The maintenance window ID is: " + winId);
} catch (DocumentAlreadyExistsException e) {
System.err.println("The SSM maintenance window already exists. Retrieving existing window ID...");
String existingWinId = actions.createMaintenanceWindow(windowName);
System.out.println("Existing window ID: " + existingWinId);
} catch (SsmException e) {
System.err.println("SSM error: " + e.getMessage());
return;
} catch (RuntimeException e) {
System.err.println("Unexpected error: " + e.getMessage());
return;
}
waitForInputToContinue(scanner);
System.out.println(DASHES);
System.out.println("2. Modify the maintenance window by changing the schedule");
waitForInputToContinue(scanner);
try {
actions.updateSSMMaintenanceWindow(winId, windowName);
waitForInputToContinue(scanner);
System.out.println("The SSM maintenance window was successfully updated");
} catch (SsmException e) {
System.err.println("SSM error: " + e.getMessage());
return;
} catch (RuntimeException e) {
System.err.println("Unexpected error: " + e.getMessage());
return;
}
waitForInputToContinue(scanner);
System.out.println(DASHES);
System.out.println("3. Create an SSM document that defines the actions that Systems Manager performs on your managed nodes.");
System.out.println("Please enter the document name (default is ssmdocument):");
String doc = scanner.nextLine();
documentName = doc.isEmpty() ? "ssmdocument" : doc;
try {
actions.createSSMDoc(documentName);
waitForInputToContinue(scanner);
System.out.println("The SSM document was successfully created");
} catch (DocumentAlreadyExistsException e) {
System.err.println("The SSM document already exists. Moving on");
} catch (SsmException e) {
System.err.println("SSM error: " + e.getMessage());
return;
} catch (RuntimeException e) {
System.err.println("Unexpected error: " + e.getMessage());
}
waitForInputToContinue(scanner);
System.out.println(DASHES);
System.out.println("4. Now we are going to run a command on an EC2 instance");
waitForInputToContinue(scanner);
String commandId="";
try {
commandId = actions.sendSSMCommand(documentName, instanceId);
waitForInputToContinue(scanner);
System.out.println("The command was successfully sent. Command ID: " + commandId);
} catch (SsmException e) {
System.err.println("SSM error: " + e.getMessage());
} catch (InterruptedException e) {
System.err.println("Thread was interrupted: " + e.getMessage());
} catch (RuntimeException e) {
System.err.println("Unexpected error: " + e.getMessage());
}
waitForInputToContinue(scanner);
System.out.println(DASHES);
System.out.println("5. Lets get the time when the specific command was sent to the specific managed node");
waitForInputToContinue(scanner);
try {
actions.displayCommands(commandId);
System.out.println("The command invocations were successfully displayed.");
} catch (SsmException e) {
System.err.println("SSM error: " + e.getMessage());
return;
} catch (RuntimeException e) {
System.err.println("Unexpected error: " + e.getMessage());
return;
}
waitForInputToContinue(scanner);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("""
6. Now we will create an SSM OpsItem.
A SSM OpsItem is a feature provided by Amazon's Systems Manager (SSM) service.
It is a type of operational data item that allows you to manage and track various operational issues,
events, or tasks within your AWS environment.
You can create OpsItems to track and manage operational issues as they arise.
For example, you could create an OpsItem whenever your application detects a critical error
or an anomaly in your infrastructure.
""");
waitForInputToContinue(scanner);
String opsItemId;
try {
opsItemId = actions.createSSMOpsItem(title, source, category, severity);
System.out.println(opsItemId + " was created");
} catch (SsmException e) {
System.err.println("SSM error: " + e.getMessage());
return;
} catch (RuntimeException e) {
System.err.println("Unexpected error: " + e.getMessage());
return;
}
waitForInputToContinue(scanner);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("7. Now we will update the SSM OpsItem "+opsItemId);
waitForInputToContinue(scanner);
String description = "An update to "+opsItemId ;
try {
actions.updateOpsItem(opsItemId, title, description);
} catch (SsmException e) {
System.err.println("SSM error: " + e.getMessage());
return;
} catch (RuntimeException e) {
System.err.println("Unexpected error: " + e.getMessage());
return;
}
System.out.println(DASHES);
System.out.println("8. Now we will get the status of the SSM OpsItem "+opsItemId);
waitForInputToContinue(scanner);
try {
actions.describeOpsItems(opsItemId);
} catch (SsmException e) {
System.err.println("SSM error: " + e.getMessage());
return;
} catch (RuntimeException e) {
System.err.println("Unexpected error: " + e.getMessage());
return;
}
System.out.println(DASHES);
System.out.println("9. Now we will resolve the SSM OpsItem "+opsItemId);
waitForInputToContinue(scanner);
try {
actions.resolveOpsItem(opsItemId);
} catch (SsmException e) {
System.err.println("SSM error: " + e.getMessage());
return;
} catch (RuntimeException e) {
System.err.println("Unexpected error: " + e.getMessage());
return;
}
System.out.println(DASHES);
System.out.println("10. Would you like to delete the AWS Systems Manager resources? (y/n)");
String delAns = scanner.nextLine().trim();
if (delAns.equalsIgnoreCase("y")) {
System.out.println("You selected to delete the resources.");
waitForInputToContinue(scanner);
try {
actions.deleteMaintenanceWindow(winId);
actions.deleteDoc(documentName);
} catch (SsmException e) {
System.err.println("SSM error: " + e.getMessage());
return;
} catch (RuntimeException e) {
System.err.println("Unexpected error: " + e.getMessage());
return;
}
} else {
System.out.println("The AWS Systems Manager resources will not be deleted");
}
System.out.println(DASHES);
CloudFormationHelper.destroyCloudFormationStack(ROLES_STACK);
System.out.println("This concludes the AWS Systems Manager SDK Basics scenario.");
System.out.println(DASHES);
}
private static void waitForInputToContinue(Scanner scanner) {
while (true) {
System.out.println("");
System.out.println("Enter 'c' followed by <ENTER> to continue:");
String input = scanner.nextLine();
if (input.trim().equalsIgnoreCase("c")) {
System.out.println("Continuing with the program...");
System.out.println("");
break;
} else {
// Handle invalid input.
System.out.println("Invalid input. Please try again.");
}
}
}
}
```
Systems Manager SDK 方法的包裝函式類別。
```
public class SSMActions {
private static SsmAsyncClient ssmAsyncClient;
private static SsmAsyncClient getAsyncClient() {
if (ssmAsyncClient == null) {
SdkAsyncHttpClient httpClient = NettyNioAsyncHttpClient.builder()
.maxConcurrency(100)
.connectionTimeout(Duration.ofSeconds(60))
.readTimeout(Duration.ofSeconds(60))
.writeTimeout(Duration.ofSeconds(60))
.build();
ClientOverrideConfiguration overrideConfig = ClientOverrideConfiguration.builder()
.apiCallTimeout(Duration.ofMinutes(2))
.apiCallAttemptTimeout(Duration.ofSeconds(90))
.retryPolicy(RetryPolicy.builder()
.numRetries(3)
.build())
.build();
ssmAsyncClient = SsmAsyncClient.builder()
.region(Region.US_WEST_2)
.httpClient(httpClient)
.overrideConfiguration(overrideConfig)
.build();
}
return ssmAsyncClient;
}
/**
* Deletes an AWS SSM document asynchronously.
*
* @param documentName The name of the document to delete.
* <p>
* This method initiates an asynchronous request to delete an SSM document.
* If an exception occurs, it handles the error appropriately.
*/
public void deleteDoc(String documentName) {
DeleteDocumentRequest documentRequest = DeleteDocumentRequest.builder()
.name(documentName)
.build();
CompletableFuture<Void> future = CompletableFuture.runAsync(() -> {
getAsyncClient().deleteDocument(documentRequest)
.thenAccept(response -> {
System.out.println("The SSM document was successfully deleted.");
})
.exceptionally(ex -> {
throw new CompletionException(ex);
}).join();
}).exceptionally(ex -> {
Throwable cause = (ex instanceof CompletionException) ? ex.getCause() : ex;
if (cause instanceof SsmException) {
throw new RuntimeException("SSM error: " + cause.getMessage(), cause);
} else {
throw new RuntimeException("Unexpected error: " + cause.getMessage(), cause);
}
});
try {
future.join();
} catch (CompletionException ex) {
throw ex.getCause() instanceof RuntimeException ? (RuntimeException) ex.getCause() : ex;
}
}
/**
* Deletes an AWS SSM Maintenance Window asynchronously.
*
* @param winId The ID of the Maintenance Window to delete.
* <p>
* This method initiates an asynchronous request to delete an SSM Maintenance Window.
* If an exception occurs, it handles the error appropriately.
*/
public void deleteMaintenanceWindow(String winId) {
DeleteMaintenanceWindowRequest windowRequest = DeleteMaintenanceWindowRequest.builder()
.windowId(winId)
.build();
CompletableFuture<Void> future = CompletableFuture.runAsync(() -> {
getAsyncClient().deleteMaintenanceWindow(windowRequest)
.thenAccept(response -> {
System.out.println("The maintenance window was successfully deleted.");
})
.exceptionally(ex -> {
throw new CompletionException(ex);
}).join();
}).exceptionally(ex -> {
Throwable cause = (ex instanceof CompletionException) ? ex.getCause() : ex;
if (cause instanceof SsmException) {
throw new RuntimeException("SSM error: " + cause.getMessage(), cause);
} else {
throw new RuntimeException("Unexpected error: " + cause.getMessage(), cause);
}
});
try {
future.join();
} catch (CompletionException ex) {
throw ex.getCause() instanceof RuntimeException ? (RuntimeException) ex.getCause() : ex;
}
}
/**
* Resolves an AWS SSM OpsItem asynchronously.
*
* @param opsID The ID of the OpsItem to resolve.
* <p>
* This method initiates an asynchronous request to resolve an SSM OpsItem.
* If an exception occurs, it handles the error appropriately.
*/
public void resolveOpsItem(String opsID) {
UpdateOpsItemRequest opsItemRequest = UpdateOpsItemRequest.builder()
.opsItemId(opsID)
.status(OpsItemStatus.RESOLVED)
.build();
CompletableFuture<Void> future = CompletableFuture.runAsync(() -> {
getAsyncClient().updateOpsItem(opsItemRequest)
.thenAccept(response -> {
System.out.println("OpsItem resolved successfully.");
})
.exceptionally(ex -> {
throw new CompletionException(ex);
}).join();
}).exceptionally(ex -> {
Throwable cause = (ex instanceof CompletionException) ? ex.getCause() : ex;
if (cause instanceof SsmException) {
throw new RuntimeException("SSM error: " + cause.getMessage(), cause);
} else {
throw new RuntimeException("Unexpected error: " + cause.getMessage(), cause);
}
});
try {
future.join();
} catch (CompletionException ex) {
throw ex.getCause() instanceof RuntimeException ? (RuntimeException) ex.getCause() : ex;
}
}
/**
* Describes AWS SSM OpsItems asynchronously.
*
* @param key The key to filter OpsItems by (e.g., OPS_ITEM_ID).
*
* This method initiates an asynchronous request to describe SSM OpsItems.
* If the request is successful, it prints the title and status of each OpsItem.
* If an exception occurs, it handles the error appropriately.
*/
public void describeOpsItems(String key) {
OpsItemFilter filter = OpsItemFilter.builder()
.key(OpsItemFilterKey.OPS_ITEM_ID)
.values(key)
.operator(OpsItemFilterOperator.EQUAL)
.build();
DescribeOpsItemsRequest itemsRequest = DescribeOpsItemsRequest.builder()
.maxResults(10)
.opsItemFilters(filter)
.build();
CompletableFuture<Void> future = CompletableFuture.runAsync(() -> {
getAsyncClient().describeOpsItems(itemsRequest)
.thenAccept(itemsResponse -> {
List<OpsItemSummary> items = itemsResponse.opsItemSummaries();
for (OpsItemSummary item : items) {
System.out.println("The item title is " + item.title() + " and the status is " + item.status().toString());
}
})
.exceptionally(ex -> {
throw new CompletionException(ex);
}).join();
}).exceptionally(ex -> {
Throwable cause = (ex instanceof CompletionException) ? ex.getCause() : ex;
if (cause instanceof SsmException) {
throw new RuntimeException("SSM error: " + cause.getMessage(), cause);
} else {
throw new RuntimeException("Unexpected error: " + cause.getMessage(), cause);
}
});
try {
future.join();
} catch (CompletionException ex) {
throw ex.getCause() instanceof RuntimeException ? (RuntimeException) ex.getCause() : ex;
}
}
/**
* Updates the AWS SSM OpsItem asynchronously.
*
* @param opsItemId The ID of the OpsItem to update.
* @param title The new title of the OpsItem.
* @param description The new description of the OpsItem.
* <p>
* This method initiates an asynchronous request to update an SSM OpsItem.
* If the request is successful, it completes without returning a value.
* If an exception occurs, it handles the error appropriately.
*/
public void updateOpsItem(String opsItemId, String title, String description) {
Map<String, OpsItemDataValue> operationalData = new HashMap<>();
operationalData.put("key1", OpsItemDataValue.builder().value("value1").build());
operationalData.put("key2", OpsItemDataValue.builder().value("value2").build());
CompletableFuture<Void> future = getOpsItem(opsItemId).thenCompose(opsItem -> {
UpdateOpsItemRequest request = UpdateOpsItemRequest.builder()
.opsItemId(opsItemId)
.title(title)
.operationalData(operationalData)
.status(opsItem.statusAsString())
.description(description)
.build();
return getAsyncClient().updateOpsItem(request).thenAccept(response -> {
System.out.println(opsItemId + " updated successfully.");
}).exceptionally(ex -> {
throw new CompletionException(ex);
});
}).exceptionally(ex -> {
Throwable cause = (ex instanceof CompletionException) ? ex.getCause() : ex;
if (cause instanceof SsmException) {
throw new RuntimeException("SSM error: " + cause.getMessage(), cause);
} else {
throw new RuntimeException("Unexpected error: " + cause.getMessage(), cause);
}
});
try {
future.join();
} catch (CompletionException ex) {
throw ex.getCause() instanceof RuntimeException ? (RuntimeException) ex.getCause() : ex;
}
}
private static CompletableFuture<OpsItem> getOpsItem(String opsItemId) {
GetOpsItemRequest request = GetOpsItemRequest.builder().opsItemId(opsItemId).build();
return getAsyncClient().getOpsItem(request).thenApply(GetOpsItemResponse::opsItem);
}
/**
* Creates an SSM OpsItem asynchronously.
*
* @param title The title of the OpsItem.
* @param source The source of the OpsItem.
* @param category The category of the OpsItem.
* @param severity The severity of the OpsItem.
* @return The ID of the created OpsItem.
* <p>
* This method initiates an asynchronous request to create an SSM OpsItem.
* If the request is successful, it returns the OpsItem ID.
* If an exception occurs, it handles the error appropriately.
*/
public String createSSMOpsItem(String title, String source, String category, String severity) {
CreateOpsItemRequest opsItemRequest = CreateOpsItemRequest.builder()
.description("Created by the SSM Java API")
.title(title)
.source(source)
.category(category)
.severity(severity)
.build();
CompletableFuture<CreateOpsItemResponse> future = getAsyncClient().createOpsItem(opsItemRequest);
try {
CreateOpsItemResponse response = future.join();
return response.opsItemId();
} catch (CompletionException e) {
Throwable cause = e.getCause();
if (cause instanceof SsmException) {
throw (SsmException) cause;
} else {
throw new RuntimeException(cause);
}
}
}
/**
* Displays the date and time when the specific command was invoked.
*
* @param commandId The ID of the command to describe.
* <p>
* This method initiates an asynchronous request to list command invocations and prints the date and time of each command invocation.
* If an exception occurs, it handles the error appropriately.
*/
public void displayCommands(String commandId) {
ListCommandInvocationsRequest commandInvocationsRequest = ListCommandInvocationsRequest.builder()
.commandId(commandId)
.build();
CompletableFuture<ListCommandInvocationsResponse> future = getAsyncClient().listCommandInvocations(commandInvocationsRequest);
future.thenAccept(response -> {
List<CommandInvocation> commandList = response.commandInvocations();
DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss").withZone(ZoneId.systemDefault());
for (CommandInvocation invocation : commandList) {
System.out.println("The time of the command invocation is " + formatter.format(invocation.requestedDateTime()));
}
}).exceptionally(ex -> {
Throwable cause = (ex instanceof CompletionException) ? ex.getCause() : ex;
if (cause instanceof SsmException) {
throw (SsmException) cause;
} else {
throw new RuntimeException(cause);
}
}).join();
}
/**
* Sends a SSM command to a managed node asynchronously.
*
* @param documentName The name of the document to use.
* @param instanceId The ID of the instance to send the command to.
* @return The command ID.
* <p>
* This method initiates asynchronous requests to send a SSM command to a managed node.
* It waits until the document is active, sends the command, and checks the command execution status.
*/
public String sendSSMCommand(String documentName, String instanceId) throws InterruptedException, SsmException {
// Before we use Document to send a command - make sure it is active.
CompletableFuture<Void> documentActiveFuture = CompletableFuture.runAsync(() -> {
boolean isDocumentActive = false;
DescribeDocumentRequest request = DescribeDocumentRequest.builder()
.name(documentName)
.build();
while (!isDocumentActive) {
CompletableFuture<DescribeDocumentResponse> response = getAsyncClient().describeDocument(request);
String documentStatus = response.join().document().statusAsString();
if (documentStatus.equals("Active")) {
System.out.println("The SSM document is active and ready to use.");
isDocumentActive = true;
} else {
System.out.println("The SSM document is not active. Status: " + documentStatus);
try {
Thread.sleep(5000);
} catch (InterruptedException e) {
throw new RuntimeException(e);
}
}
}
});
documentActiveFuture.join();
// Create the SendCommandRequest.
SendCommandRequest commandRequest = SendCommandRequest.builder()
.documentName(documentName)
.instanceIds(instanceId)
.build();
// Send the command.
CompletableFuture<SendCommandResponse> commandFuture = getAsyncClient().sendCommand(commandRequest);
final String[] commandId = {null};
commandFuture.whenComplete((commandResponse, ex) -> {
if (commandResponse != null) {
commandId[0] = commandResponse.command().commandId();
System.out.println("Command ID: " + commandId[0]);
// Wait for the command execution to complete.
GetCommandInvocationRequest invocationRequest = GetCommandInvocationRequest.builder()
.commandId(commandId[0])
.instanceId(instanceId)
.build();
try {
System.out.println("Wait 5 secs");
TimeUnit.SECONDS.sleep(5);
// Retrieve the command execution details.
CompletableFuture<GetCommandInvocationResponse> invocationFuture = getAsyncClient().getCommandInvocation(invocationRequest);
invocationFuture.whenComplete((commandInvocationResponse, invocationEx) -> {
if (commandInvocationResponse != null) {
// Check the status of the command execution.
CommandInvocationStatus status = commandInvocationResponse.status();
if (status == CommandInvocationStatus.SUCCESS) {
System.out.println("Command execution successful");
} else {
System.out.println("Command execution failed. Status: " + status);
}
} else {
Throwable invocationCause = (invocationEx instanceof CompletionException) ? invocationEx.getCause() : invocationEx;
throw new CompletionException(invocationCause);
}
}).join();
} catch (InterruptedException e) {
throw new RuntimeException(e);
}
} else {
Throwable cause = (ex instanceof CompletionException) ? ex.getCause() : ex;
if (cause instanceof SsmException) {
throw (SsmException) cause;
} else {
throw new RuntimeException(cause);
}
}
}).join();
return commandId[0];
}
/**
* Creates an AWS SSM document asynchronously.
*
* @param docName The name of the document to create.
* <p>
* This method initiates an asynchronous request to create an SSM document.
* If the request is successful, it prints the document status.
* If an exception occurs, it handles the error appropriately.
*/
public void createSSMDoc(String docName) throws SsmException {
String jsonData = """
{
"schemaVersion": "2.2",
"description": "Run a simple shell command",
"mainSteps": [
{
"action": "aws:runShellScript",
"name": "runEchoCommand",
"inputs": {
"runCommand": [
"echo 'Hello, world!'"
]
}
}
]
}
""";
CreateDocumentRequest request = CreateDocumentRequest.builder()
.content(jsonData)
.name(docName)
.documentType(DocumentType.COMMAND)
.build();
CompletableFuture<CreateDocumentResponse> future = getAsyncClient().createDocument(request);
future.thenAccept(response -> {
System.out.println("The status of the SSM document is " + response.documentDescription().status());
}).exceptionally(ex -> {
Throwable cause = (ex instanceof CompletionException) ? ex.getCause() : ex;
if (cause instanceof DocumentAlreadyExistsException) {
throw new CompletionException(cause);
} else if (cause instanceof SsmException) {
throw new CompletionException(cause);
} else {
throw new RuntimeException(cause);
}
}).join();
}
/**
* Updates an SSM maintenance window asynchronously.
*
* @param id The ID of the maintenance window to update.
* @param name The new name for the maintenance window.
* <p>
* This method initiates an asynchronous request to update an SSM maintenance window.
* If the request is successful, it prints a success message.
* If an exception occurs, it handles the error appropriately.
*/
public void updateSSMMaintenanceWindow(String id, String name) throws SsmException {
UpdateMaintenanceWindowRequest updateRequest = UpdateMaintenanceWindowRequest.builder()
.windowId(id)
.allowUnassociatedTargets(true)
.duration(24)
.enabled(true)
.name(name)
.schedule("cron(0 0 ? * MON *)")
.build();
CompletableFuture<UpdateMaintenanceWindowResponse> future = getAsyncClient().updateMaintenanceWindow(updateRequest);
future.whenComplete((response, ex) -> {
if (response != null) {
System.out.println("The SSM maintenance window was successfully updated");
} else {
Throwable cause = (ex instanceof CompletionException) ? ex.getCause() : ex;
if (cause instanceof SsmException) {
throw new CompletionException(cause);
} else {
throw new RuntimeException(cause);
}
}
}).join();
}
/**
* Creates an SSM maintenance window asynchronously.
*
* @param winName The name of the maintenance window.
* @return The ID of the created or existing maintenance window.
* <p>
* This method initiates an asynchronous request to create an SSM maintenance window.
* If the request is successful, it prints the maintenance window ID.
* If an exception occurs, it handles the error appropriately.
*/
public String createMaintenanceWindow(String winName) throws SsmException, DocumentAlreadyExistsException {
CreateMaintenanceWindowRequest request = CreateMaintenanceWindowRequest.builder()
.name(winName)
.description("This is my maintenance window")
.allowUnassociatedTargets(true)
.duration(2)
.cutoff(1)
.schedule("cron(0 10 ? * MON-FRI *)")
.build();
CompletableFuture<CreateMaintenanceWindowResponse> future = getAsyncClient().createMaintenanceWindow(request);
final String[] windowId = {null};
future.whenComplete((response, ex) -> {
if (response != null) {
String maintenanceWindowId = response.windowId();
System.out.println("The maintenance window id is " + maintenanceWindowId);
windowId[0] = maintenanceWindowId;
} else {
Throwable cause = (ex instanceof CompletionException) ? ex.getCause() : ex;
if (cause instanceof DocumentAlreadyExistsException) {
throw new CompletionException(cause);
} else if (cause instanceof SsmException) {
throw new CompletionException(cause);
} else {
throw new RuntimeException(cause);
}
}
}).join();
if (windowId[0] == null) {
MaintenanceWindowFilter filter = MaintenanceWindowFilter.builder()
.key("name")
.values(winName)
.build();
DescribeMaintenanceWindowsRequest winRequest = DescribeMaintenanceWindowsRequest.builder()
.filters(filter)
.build();
CompletableFuture<DescribeMaintenanceWindowsResponse> describeFuture = getAsyncClient().describeMaintenanceWindows(winRequest);
describeFuture.whenComplete((describeResponse, describeEx) -> {
if (describeResponse != null) {
List<MaintenanceWindowIdentity> windows = describeResponse.windowIdentities();
if (!windows.isEmpty()) {
windowId[0] = windows.get(0).windowId();
System.out.println("Window ID: " + windowId[0]);
} else {
System.out.println("Window not found.");
windowId[0] = "";
}
} else {
Throwable describeCause = (describeEx instanceof CompletionException) ? describeEx.getCause() : describeEx;
throw new RuntimeException("Error describing maintenance windows: " + describeCause.getMessage(), describeCause);
}
}).join();
}
return windowId[0];
}
}
```
+ 如需 API 詳細資訊，請參閱《*AWS SDK for Java 2.x API 參考*》中的下列主題。
+ [CreateDocument](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/CreateDocument)
+ [CreateMaintenanceWindow](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/CreateMaintenanceWindow)
+ [CreateOpsItem](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/CreateOpsItem)
+ [DeleteMaintenanceWindow](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DeleteMaintenanceWindow)
+ [ListCommandInvocations](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/ListCommandInvocations)
+ [SendCommand](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/SendCommand)
+ [UpdateOpsItem](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/UpdateOpsItem)
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ssm#code-examples)中設定和執行。
```
import {
Scenario,
ScenarioAction,
ScenarioInput,
ScenarioOutput,
} from "@aws-doc-sdk-examples/lib/scenario/index.js";
import { fileURLToPath } from "node:url";
import {
CreateDocumentCommand,
CreateMaintenanceWindowCommand,
CreateOpsItemCommand,
DeleteDocumentCommand,
DeleteMaintenanceWindowCommand,
DeleteOpsItemCommand,
DescribeOpsItemsCommand,
DocumentAlreadyExists,
OpsItemStatus,
waitUntilCommandExecuted,
CancelCommandCommand,
paginateListCommandInvocations,
SendCommandCommand,
UpdateMaintenanceWindowCommand,
UpdateOpsItemCommand,
SSMClient,
} from "@aws-sdk/client-ssm";
import { parseArgs } from "node:util";
/**
* @typedef {{
* ssmClient: import('@aws-sdk/client-ssm').SSMClient,
* documentName?: string
* maintenanceWindow?: string
* winId?: int
* ec2InstanceId?: string
* requestedDateTime?: Date
* opsItemId?: string
* askToDeleteResources?: boolean
* }} State
*/
const defaultMaintenanceWindow = "ssm-maintenance-window";
const defaultDocumentName = "ssmdocument";
// The timeout duration is highly dependent on the specific setup and environment necessary. This example handles only the most common error cases, and uses a much shorter duration than most productions systems would use.
const COMMAND_TIMEOUT_DURATION_SECONDS = 30; // 30 seconds
const pressEnter = new ScenarioInput("continue", "Press Enter to continue", {
type: "confirm",
});
const greet = new ScenarioOutput(
"greet",
`Welcome to the AWS Systems Manager SDK Getting Started scenario.
This program demonstrates how to interact with Systems Manager using the AWS SDK for JavaScript V3.
Systems Manager is the operations hub for your AWS applications and resources and a secure end-to-end management solution.
The program's primary functions include creating a maintenance window, creating a document, sending a command to a document,
listing documents, listing commands, creating an OpsItem, modifying an OpsItem, and deleting Systems Manager resources.
Upon completion of the program, all AWS resources are cleaned up.
Let's get started...`,
{ header: true },
);
const createMaintenanceWindow = new ScenarioOutput(
"createMaintenanceWindow",
"Step 1: Create a Systems Manager maintenance window.",
);
const getMaintenanceWindow = new ScenarioInput(
"maintenanceWindow",
"Please enter the maintenance window name:",
{ type: "input", default: defaultMaintenanceWindow },
);
export const sdkCreateMaintenanceWindow = new ScenarioAction(
"sdkCreateMaintenanceWindow",
async (/** @type {State} */ state) => {
try {
const response = await state.ssmClient.send(
new CreateMaintenanceWindowCommand({
Name: state.maintenanceWindow,
Schedule: "cron(0 10 ? * MON-FRI *)", //The schedule of the maintenance window in the form of a cron or rate expression.
Duration: 2, //The duration of the maintenance window in hours.
Cutoff: 1, //The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.
AllowUnassociatedTargets: true, //Allow the maintenance window to run on managed nodes, even if you haven't registered those nodes as targets.
}),
);
state.winId = response.WindowId;
} catch (caught) {
console.error(caught.message);
console.log(
`An error occurred while creating the maintenance window. Please fix the error and try again. Error message: ${caught.message}`,
);
throw caught;
}
},
);
const modifyMaintenanceWindow = new ScenarioOutput(
"modifyMaintenanceWindow",
"Modify the maintenance window by changing the schedule.",
);
const sdkModifyMaintenanceWindow = new ScenarioAction(
"sdkModifyMaintenanceWindow",
async (/** @type {State} */ state) => {
try {
await state.ssmClient.send(
new UpdateMaintenanceWindowCommand({
WindowId: state.winId,
Schedule: "cron(0 0 ? * MON *)",
}),
);
} catch (caught) {
console.error(caught.message);
console.log(
`An error occurred while modifying the maintenance window. Please fix the error and try again. Error message: ${caught.message}`,
);
throw caught;
}
},
);
const createSystemsManagerActions = new ScenarioOutput(
"createSystemsManagerActions",
"Create a document that defines the actions that Systems Manager performs on your EC2 instance.",
);
const getDocumentName = new ScenarioInput(
"documentName",
"Please enter the document: ",
{ type: "input", default: defaultDocumentName },
);
const sdkCreateSSMDoc = new ScenarioAction(
"sdkCreateSSMDoc",
async (/** @type {State} */ state) => {
const contentData = `{
"schemaVersion": "2.2",
"description": "Run a simple shell command",
"mainSteps": [
{
"action": "aws:runShellScript",
"name": "runEchoCommand",
"inputs": {
"runCommand": [
"echo 'Hello, world!'"
]
}
}
]
}`;
try {
await state.ssmClient.send(
new CreateDocumentCommand({
Content: contentData,
Name: state.documentName,
DocumentType: "Command",
}),
);
} catch (caught) {
console.log(`Exception type: (${typeof caught})`);
if (caught instanceof DocumentAlreadyExists) {
console.log("Document already exists. Continuing...\n");
} else {
console.error(caught.message);
console.log(
`An error occurred while creating the document. Please fix the error and try again. Error message: ${caught.message}`,
);
throw caught;
}
}
},
);
const ec2HelloWorld = new ScenarioOutput(
"ec2HelloWorld",
`Now you have the option of running a command on an EC2 instance that echoes 'Hello, world!'. In order to run this command, you must provide the instance ID of a Linux EC2 instance. If you do not already have a running Linux EC2 instance in your account, you can create one using the AWS console. For information about creating an EC2 instance, see https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html.`,
);
const enterIdOrSkipEC2HelloWorld = new ScenarioInput(
"enterIdOrSkipEC2HelloWorld",
"Enter your EC2 InstanceId or press enter to skip this step: ",
{ type: "input", default: "" },
);
const sdkEC2HelloWorld = new ScenarioAction(
"sdkEC2HelloWorld",
async (/** @type {State} */ state) => {
try {
const response = await state.ssmClient.send(
new SendCommandCommand({
DocumentName: state.documentName,
InstanceIds: [state.ec2InstanceId],
TimeoutSeconds: COMMAND_TIMEOUT_DURATION_SECONDS,
}),
);
state.CommandId = response.Command.CommandId;
} catch (caught) {
console.error(caught.message);
console.log(
`An error occurred while sending the command. Please fix the error and try again. Error message: ${caught.message}`,
);
throw caught;
}
},
{
skipWhen: (/** @type {State} */ state) =>
state.enterIdOrSkipEC2HelloWorld === "",
},
);
const sdkGetCommandTime = new ScenarioAction(
"sdkGetCommandTime",
async (/** @type {State} */ state) => {
const listInvocationsPaginated = [];
console.log(
"Let's get the time when the specific command was sent to the specific managed node.",
);
console.log(
`First, we'll wait for the command to finish executing. This may take up to ${COMMAND_TIMEOUT_DURATION_SECONDS} seconds.`,
);
const commandExecutedResult = waitUntilCommandExecuted(
{ client: state.ssmClient },
{
CommandId: state.CommandId,
InstanceId: state.ec2InstanceId,
},
);
// This is necessary because the TimeoutSeconds of SendCommandCommand is only for the delivery, not execution.
try {
await new Promise((_, reject) =>
setTimeout(
reject,
COMMAND_TIMEOUT_DURATION_SECONDS * 1000,
new Error("Command Timed Out"),
),
);
} catch (caught) {
if (caught.message === "Command Timed Out") {
commandExecutedResult.state = "TIMED_OUT";
} else {
throw caught;
}
}
if (commandExecutedResult.state !== "SUCCESS") {
console.log(
`The command with id: ${state.CommandId} did not execute in the allotted time. Canceling command.`,
);
state.ssmClient.send(
new CancelCommandCommand({
CommandId: state.CommandId,
}),
);
state.enterIdOrSkipEC2HelloWorld === "";
return;
}
for await (const page of paginateListCommandInvocations(
{ client: state.ssmClient },
{ CommandId: state.CommandId },
)) {
listInvocationsPaginated.push(...page.CommandInvocations);
}
/**
* @type {import('@aws-sdk/client-ssm').CommandInvocation}
*/
const commandInvocation = listInvocationsPaginated.shift(); // Because the call was made with CommandId, there's only one result, so shift it off.
state.requestedDateTime = commandInvocation.RequestedDateTime;
console.log(
`The command invocation happened at: ${state.requestedDateTime}.`,
);
},
{
skipWhen: (/** @type {State} */ state) =>
state.enterIdOrSkipEC2HelloWorld === "",
},
);
const createSSMOpsItem = new ScenarioOutput(
"createSSMOpsItem",
`Now we will create a Systems Manager OpsItem. An OpsItem is a feature provided by the Systems Manager service. It is a type of operational data item that allows you to manage and track various operational issues, events, or tasks within your AWS environment.
You can create OpsItems to track and manage operational issues as they arise. For example, you could create an OpsItem whenever your application detects a critical error or an anomaly in your infrastructure.`,
);
const sdkCreateSSMOpsItem = new ScenarioAction(
"sdkCreateSSMOpsItem",
async (/** @type {State} */ state) => {
try {
const response = await state.ssmClient.send(
new CreateOpsItemCommand({
Description: "Created by the System Manager Javascript API",
Title: "Disk Space Alert",
Source: "EC2",
Category: "Performance",
Severity: "2",
}),
);
state.opsItemId = response.OpsItemId;
} catch (caught) {
console.error(caught.message);
console.log(
`An error occurred while creating the ops item. Please fix the error and try again. Error message: ${caught.message}`,
);
throw caught;
}
},
);
const updateOpsItem = new ScenarioOutput(
"updateOpsItem",
(/** @type {State} */ state) =>
`Now we will update the OpsItem: ${state.opsItemId}`,
);
const sdkUpdateOpsItem = new ScenarioAction(
"sdkUpdateOpsItem",
async (/** @type {State} */ state) => {
try {
const _response = await state.ssmClient.send(
new UpdateOpsItemCommand({
OpsItemId: state.opsItemId,
Description: `An update to ${state.opsItemId}`,
}),
);
} catch (caught) {
console.error(caught.message);
console.log(
`An error occurred while updating the ops item. Please fix the error and try again. Error message: ${caught.message}`,
);
throw caught;
}
},
);
const getOpsItemStatus = new ScenarioOutput(
"getOpsItemStatus",
(/** @type {State} */ state) =>
`Now we will get the status of the OpsItem: ${state.opsItemId}`,
);
const sdkOpsItemStatus = new ScenarioAction(
"sdkGetOpsItemStatus",
async (/** @type {State} */ state) => {
try {
const response = await state.ssmClient.send(
new DescribeOpsItemsCommand({
OpsItemId: state.opsItemId,
}),
);
state.opsItemStatus = response.OpsItemStatus;
} catch (caught) {
console.error(caught.message);
console.log(
`An error occurred while describing the ops item. Please fix the error and try again. Error message: ${caught.message}`,
);
throw caught;
}
},
);
const resolveOpsItem = new ScenarioOutput(
"resolveOpsItem",
(/** @type {State} */ state) =>
`Now we will resolve the OpsItem: ${state.opsItemId}`,
);
const sdkResolveOpsItem = new ScenarioAction(
"sdkResolveOpsItem",
async (/** @type {State} */ state) => {
try {
const _response = await state.ssmClient.send(
new UpdateOpsItemCommand({
OpsItemId: state.opsItemId,
Status: OpsItemStatus.RESOLVED,
}),
);
} catch (caught) {
console.error(caught.message);
console.log(
`An error occurred while updating the ops item. Please fix the error and try again. Error message: ${caught.message}`,
);
throw caught;
}
},
);
const askToDeleteResources = new ScenarioInput(
"askToDeleteResources",
"Would you like to delete the Systems Manager resources created during this example run?",
{ type: "confirm" },
);
const confirmDeleteChoice = new ScenarioOutput(
"confirmDeleteChoice",
(/** @type {State} */ state) => {
if (state.askToDeleteResources) {
return "You chose to delete the resources.";
}
return "The Systems Manager resources will not be deleted. Please delete them manually to avoid charges.";
},
);
export const sdkDeleteResources = new ScenarioAction(
"sdkDeleteResources",
async (/** @type {State} */ state) => {
try {
await state.ssmClient.send(
new DeleteOpsItemCommand({
OpsItemId: state.opsItemId,
}),
);
console.log(`The ops item: ${state.opsItemId} was successfully deleted.`);
} catch (caught) {
console.log(
`There was a problem deleting the ops item: ${state.opsItemId}. Please delete it manually. Error: ${caught.message}`,
);
}
try {
await state.ssmClient.send(
new DeleteMaintenanceWindowCommand({
Name: state.maintenanceWindow,
WindowId: state.winId,
}),
);
console.log(
`The maintenance window: ${state.maintenanceWindow} was successfully deleted.`,
);
} catch (caught) {
console.log(
`There was a problem deleting the maintenance window: ${state.opsItemId}. Please delete it manually. Error: ${caught.message}`,
);
}
try {
await state.ssmClient.send(
new DeleteDocumentCommand({
Name: state.documentName,
}),
);
console.log(
`The document: ${state.documentName} was successfully deleted.`,
);
} catch (caught) {
console.log(
`There was a problem deleting the document: ${state.documentName}. Please delete it manually. Error: ${caught.message}`,
);
}
},
{ skipWhen: (/** @type {{}} */ state) => !state.askToDeleteResources },
);
const goodbye = new ScenarioOutput(
"goodbye",
"This concludes the Systems Manager Basics scenario for the AWS Javascript SDK v3. Thank you!",
);
const myScenario = new Scenario(
"SSM Basics",
[
greet,
pressEnter,
createMaintenanceWindow,
getMaintenanceWindow,
sdkCreateMaintenanceWindow,
modifyMaintenanceWindow,
pressEnter,
sdkModifyMaintenanceWindow,
createSystemsManagerActions,
getDocumentName,
sdkCreateSSMDoc,
ec2HelloWorld,
enterIdOrSkipEC2HelloWorld,
sdkEC2HelloWorld,
sdkGetCommandTime,
pressEnter,
createSSMOpsItem,
pressEnter,
sdkCreateSSMOpsItem,
updateOpsItem,
pressEnter,
sdkUpdateOpsItem,
getOpsItemStatus,
pressEnter,
sdkOpsItemStatus,
resolveOpsItem,
pressEnter,
sdkResolveOpsItem,
askToDeleteResources,
confirmDeleteChoice,
sdkDeleteResources,
goodbye,
],
{ ssmClient: new SSMClient({}) },
);
/** @type {{ stepHandlerOptions: StepHandlerOptions }} */
export const main = async (stepHandlerOptions) => {
await myScenario.run(stepHandlerOptions);
};
// Invoke main function if this file was run directly.
if (process.argv[1] === fileURLToPath(import.meta.url)) {
const { values } = parseArgs({
options: {
yes: {
type: "boolean",
short: "y",
},
},
});
main({ confirmAll: values.yes });
}
```
+ 如需 API 詳細資訊，請參閱《*適用於 JavaScript 的 AWS SDK API 參考*》中的下列主題。
+ [CreateDocument](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/CreateDocumentCommand)
+ [CreateMaintenanceWindow](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/CreateMaintenanceWindowCommand)
+ [CreateOpsItem](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/CreateOpsItemCommand)
+ [DeleteMaintenanceWindow](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/DeleteMaintenanceWindowCommand)
+ [ListCommandInvocations](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/ListCommandInvocationsCommand)
+ [SendCommand](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/SendCommandCommand)
+ [UpdateOpsItem](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/UpdateOpsItemCommand)
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/ssm#code-examples)中設定和執行。
在命令提示中執行互動式案例。
```
class SystemsManagerScenario:
"""Runs an interactive scenario that shows how to get started using Amazon Systems Manager."""
def __init__(self, document_wrapper, maintenance_window_wrapper, ops_item_wrapper):
"""
:param document_wrapper: An object that wraps Systems Manager document functions.
:param maintenance_window_wrapper: An object that wraps Systems Manager maintenance window functions.
:param ops_item_wrapper: An object that wraps Systems Manager OpsItem functions.
"""
self.document_wrapper = document_wrapper
self.maintenance_window_wrapper = maintenance_window_wrapper
self.ops_item_wrapper = ops_item_wrapper
def run(self):
"""Demonstrates how to use the AWS SDK for Python (Boto3) to get started with Systems Manager."""
try:
print("-" * 88)
print(
"""
Welcome to the AWS Systems Manager SDK Getting Started scenario.
This program demonstrates how to interact with Systems Manager using the AWS SDK for Python (Boto3).
Systems Manager is the operations hub for your AWS applications and resources and a secure end-to-end management
solution. The program's primary functions include creating a maintenance window, creating a document, sending a
command to a document, listing documents, listing commands, creating an OpsItem, modifying an OpsItem, and deleting
Systems Manager resources. Upon completion of the program, all AWS resources are cleaned up.
Let's get started..."""
)
q.ask("Please hit Enter")
print("-" * 88)
print("Create a Systems Manager maintenance window.")
maintenance_window_name = q.ask(
"Please enter the maintenance window name (default is ssm-maintenance-window):",
)
if not maintenance_window_name:
maintenance_window_name = "ssm-maintenance-window"
self.maintenance_window_wrapper.create(
name=maintenance_window_name,
schedule="cron(0 10 ? * MON-FRI *)",
duration=2,
cutoff=1,
allow_unassociated_targets=True,
)
print("-" * 88)
print("Modify the maintenance window by changing the schedule")
q.ask("Please hit Enter")
self.maintenance_window_wrapper.update(
name=maintenance_window_name,
schedule="cron(0 0 ? * MON *)",
duration=24,
cutoff=1,
allow_unassociated_targets=True,
enabled=True,
)
print("-" * 88)
print(
"Create a document that defines the actions that Systems Manager performs on your EC2 instance."
)
document_name = q.ask(
"Please enter the document name (default is ssmdocument):"
)
if not document_name:
document_name = "ssmdocument"
self.document_wrapper.create(
name=document_name,
content="""
{
"schemaVersion": "2.2",
"description": "Run a simple shell command",
"mainSteps": [
{
"action": "aws:runShellScript",
"name": "runEchoCommand",
"inputs": {
"runCommand": [
"echo 'Hello, world!'"
]
}
}
]
}
""",
)
self.document_wrapper.wait_until_active()
print(
"""
Now you have the option of running a command on an EC2 instance that echoes 'Hello, world!'.
In order to run this command, you must provide the instance ID of a Linux EC2 instance. If you do
not already have a running Linux EC2 instance in your account, you can create one using the AWS console.
For information about creating an EC2 instance, see
https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html.
"""
)
if q.ask(
"Would you like to run a command on an EC2 instance? (y/n)",
q.is_yesno,
):
instance_id = q.ask(
"Please enter the instance ID of the EC2 instance:", q.non_empty
)
command_id = self.document_wrapper.send_command(
instance_ids=[instance_id]
)
self.document_wrapper.wait_command_executed(
command_id=command_id, instance_id=instance_id
)
print("-" * 88)
print(
"Lets get the time when the specific command was sent to the specific managed node"
)
q.ask("Please hit Enter")
self.document_wrapper.list_command_invocations(instance_id=instance_id)
print("-" * 88)
print("-" * 88)
print(
"""
Now we will create a Systems Manager OpsItem.
An OpsItem is a feature provided by the Systems Manager service.
It is a type of operational data item that allows you to manage and track various operational issues,
events, or tasks within your AWS environment.
You can create OpsItems to track and manage operational issues as they arise.
For example, you could create an OpsItem whenever your application detects a critical error
or an anomaly in your infrastructure.
"""
)
q.ask("Please hit Enter")
self.ops_item_wrapper.create(
title="Disk Space Alert",
description="Created by the Systems Manager Python (Boto3) API",
source="EC2",
category="Performance",
severity="2",
)
print("-" * 88)
print("-" * 88)
print(f"Now we will update the OpsItem {self.ops_item_wrapper.id}")
q.ask("Please hit Enter")
self.ops_item_wrapper.update(
title="Disk Space Alert",
description=f"An update to {self.ops_item_wrapper.id}",
)
print(
f"Now we will get the status of the OpsItem {self.ops_item_wrapper.id}"
)
q.ask("Please hit Enter")
# It may take a second for the ops item to be available
counter = 0
while not self.ops_item_wrapper.describe() and counter < 5:
counter += 1
time.sleep(1)
print(f"Now we will resolve the OpsItem {self.ops_item_wrapper.id}")
q.ask("Please hit Enter")
self.ops_item_wrapper.update(status="Resolved")
print("-" * 88)
print("-" * 88)
if q.ask(
"Would you like to delete the Systems Manager resources? (y/n)",
q.is_yesno,
):
print("You selected to delete the resources.")
self.cleanup()
else:
print("The Systems Manager resources will not be deleted")
print("-" * 88)
print("This concludes the Systems Manager SDK Getting Started scenario.")
print("-" * 88)
except Exception:
self.cleanup()
raise
def cleanup(self):
self.maintenance_window_wrapper.delete()
self.ops_item_wrapper.delete()
self.document_wrapper.delete()
if __name__ == "__main__":
try:
scenario = SystemsManagerScenario(
DocumentWrapper.from_client(),
MaintenanceWindowWrapper.from_client(),
OpsItemWrapper.from_client(),
)
scenario.run()
except Exception:
logging.exception("Something went wrong with the demo.")
```
定義包裝文件和命令動作的類別。
```
class DocumentWrapper:
"""Encapsulates AWS Systems Manager Document actions."""
def __init__(self, ssm_client):
"""
:param ssm_client: A Boto3 Systems Manager client.
"""
self.ssm_client = ssm_client
self.name = None
@classmethod
def from_client(cls):
ssm_client = boto3.client("ssm")
return cls(ssm_client)
def create(self, content, name):
"""
Creates a document.
:param content: The content of the document.
:param name: The name of the document.
"""
try:
self.ssm_client.create_document(
Name=name, Content=content, DocumentType="Command"
)
self.name = name
except self.ssm_client.exceptions.DocumentAlreadyExists:
print(f"Document {name} already exists.")
self.name = name
except ClientError as err:
logger.error(
"Couldn't create %s. Here's why: %s: %s",
name,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
def delete(self):
"""
Deletes an AWS Systems Manager document.
"""
if self.name is None:
return
try:
self.ssm_client.delete_document(Name=self.name)
print(f"Deleted document {self.name}.")
self.name = None
except ClientError as err:
logger.error(
"Couldn't delete %s. Here's why: %s: %s",
self.name,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
def send_command(self, instance_ids):
"""
Sends a command to one or more instances.
:param instance_ids: The IDs of the instances to send the command to.
:return: The ID of the command.
"""
try:
response = self.ssm_client.send_command(
InstanceIds=instance_ids, DocumentName=self.name, TimeoutSeconds=3600
)
return response["Command"]["CommandId"]
except ClientError as err:
logger.error(
"Couldn't send command to %s. Here's why: %s: %s",
self.name,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
def describe(self):
"""
Describes the document.
:return: Document status.
"""
try:
response = self.ssm_client.describe_document(Name=self.name)
return response["Document"]["Status"]
except ClientError as err:
logger.error(
"Couldn't get %s. Here's why: %s: %s",
self.name,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
def wait_until_active(self, max_attempts=20, delay=5):
"""
Waits until the document is active.
:param max_attempts: The maximum number of attempts for checking the status.
:param delay: The delay in seconds between each check.
"""
attempt = 0
status = ""
while attempt <= max_attempts:
status = self.describe()
if status == "Active":
break
attempt += 1
time.sleep(delay)
if status != "Active":
logger.error("Document is not active.")
else:
logger.info("Document is active.")
def wait_command_executed(self, command_id, instance_id):
"""
Waits until the command is executed on the instance.
:param command_id: The ID of the command.
:param instance_id: The ID of the instance.
"""
waiter = self.ssm_client.get_waiter("command_executed")
waiter.wait(CommandId=command_id, InstanceId=instance_id)
def list_command_invocations(self, instance_id):
"""
Lists the commands for an instance.
:param instance_id: The ID of the instance.
:return: The list of commands.
"""
try:
paginator = self.ssm_client.get_paginator("list_command_invocations")
command_invocations = []
for page in paginator.paginate(InstanceId=instance_id):
command_invocations.extend(page["CommandInvocations"])
num_of_commands = len(command_invocations)
print(
f"{num_of_commands} command invocation(s) found for instance {instance_id}."
)
if num_of_commands > 10:
print("Displaying the first 10 commands:")
num_of_commands = 10
date_format = "%A, %d %B %Y %I:%M%p"
for command in command_invocations[:num_of_commands]:
print(
f" The time of command invocation is {command['RequestedDateTime'].strftime(date_format)}"
)
except ClientError as err:
logger.error(
"Couldn't list commands for %s. Here's why: %s: %s",
instance_id,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
定義包裝 opsitem 動作的類別。
```
class OpsItemWrapper:
"""Encapsulates AWS Systems Manager OpsItem actions."""
def __init__(self, ssm_client):
"""
:param ssm_client: A Boto3 Systems Manager client.
"""
self.ssm_client = ssm_client
self.id = None
@classmethod
def from_client(cls):
"""
:return: A OpsItemWrapper instance.
"""
ssm_client = boto3.client("ssm")
return cls(ssm_client)
def create(self, title, source, category, severity, description):
"""
Create an OpsItem
:param title: The OpsItem title.
:param source: The OpsItem source.
:param category: The OpsItem category.
:param severity: The OpsItem severity.
:param description: The OpsItem description.
"""
try:
response = self.ssm_client.create_ops_item(
Title=title,
Source=source,
Category=category,
Severity=severity,
Description=description,
)
self.id = response["OpsItemId"]
except self.ssm_client.exceptions.OpsItemLimitExceededException as err:
logger.error(
"Couldn't create ops item because you have exceeded your open OpsItem limit. "
"Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
except ClientError as err:
logger.error(
"Couldn't create ops item %s. Here's why: %s: %s",
title,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
def delete(self):
"""
Delete the OpsItem.
"""
if self.id is None:
return
try:
self.ssm_client.delete_ops_item(OpsItemId=self.id)
print(f"Deleted ops item with id {self.id}")
self.id = None
except ClientError as err:
logger.error(
"Couldn't delete ops item %s. Here's why: %s: %s",
self.id,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
def describe(self):
"""
Describe an OpsItem.
"""
try:
paginator = self.ssm_client.get_paginator("describe_ops_items")
ops_items = []
for page in paginator.paginate(
OpsItemFilters=[
{"Key": "OpsItemId", "Values": [self.id], "Operator": "Equal"}
]
):
ops_items.extend(page["OpsItemSummaries"])
for item in ops_items:
print(
f"The item title is {item['Title']} and the status is {item['Status']}"
)
return len(ops_items) > 0
except ClientError as err:
logger.error(
"Couldn't describe ops item %s. Here's why: %s: %s",
self.id,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
def update(self, title=None, description=None, status=None):
"""
Update an OpsItem.
:param title: The new OpsItem title.
:param description: The new OpsItem description.
:param status: The new OpsItem status.
:return:
"""
args = dict(OpsItemId=self.id)
if title is not None:
args["Title"] = title
if description is not None:
args["Description"] = description
if status is not None:
args["Status"] = status
try:
self.ssm_client.update_ops_item(**args)
except ClientError as err:
logger.error(
"Couldn't update ops item %s. Here's why: %s: %s",
self.id,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
定義包裝維護時段動作的類別。
```
class MaintenanceWindowWrapper:
"""Encapsulates AWS Systems Manager maintenance window actions."""
def __init__(self, ssm_client):
"""
:param ssm_client: A Boto3 Systems Manager client.
"""
self.ssm_client = ssm_client
self.window_id = None
self.name = None
@classmethod
def from_client(cls):
ssm_client = boto3.client("ssm")
return cls(ssm_client)
def create(self, name, schedule, duration, cutoff, allow_unassociated_targets):
"""
Create an AWS Systems Manager maintenance window.
:param name: The name of the maintenance window.
:param schedule: The schedule of the maintenance window.
:param duration: The duration of the maintenance window.
:param cutoff: The cutoff time of the maintenance window.
:param allow_unassociated_targets: Allow the maintenance window to run on managed nodes, even
if you haven't registered those nodes as targets.
"""
try:
response = self.ssm_client.create_maintenance_window(
Name=name,
Schedule=schedule,
Duration=duration,
Cutoff=cutoff,
AllowUnassociatedTargets=allow_unassociated_targets,
)
self.window_id = response["WindowId"]
self.name = name
logger.info("Created maintenance window %s.", self.window_id)
except ParamValidationError as error:
logger.error(
"Parameter validation error when trying to create maintenance window %s. Here's why: %s",
self.window_id,
error,
)
raise
except ClientError as err:
logger.error(
"Couldn't create maintenance window %s. Here's why: %s: %s",
name,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
def delete(self):
"""
Delete the associated AWS Systems Manager maintenance window.
"""
if self.window_id is None:
return
try:
self.ssm_client.delete_maintenance_window(WindowId=self.window_id)
logger.info("Deleted maintenance window %s.", self.window_id)
print(f"Deleted maintenance window {self.name}")
self.window_id = None
except ClientError as err:
logger.error(
"Couldn't delete maintenance window %s. Here's why: %s: %s",
self.window_id,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
def update(
self, name, enabled, schedule, duration, cutoff, allow_unassociated_targets
):
"""
Update an AWS Systems Manager maintenance window.
:param name: The name of the maintenance window.
:param enabled: Whether the maintenance window is enabled to run on managed nodes.
:param schedule: The schedule of the maintenance window.
:param duration: The duration of the maintenance window.
:param cutoff: The cutoff time of the maintenance window.
:param allow_unassociated_targets: Allow the maintenance window to run on managed nodes, even
if you haven't registered those nodes as targets.
"""
try:
self.ssm_client.update_maintenance_window(
WindowId=self.window_id,
Name=name,
Enabled=enabled,
Schedule=schedule,
Duration=duration,
Cutoff=cutoff,
AllowUnassociatedTargets=allow_unassociated_targets,
)
self.name = name
logger.info("Updated maintenance window %s.", self.window_id)
except ParamValidationError as error:
logger.error(
"Parameter validation error when trying to update maintenance window %s. Here's why: %s",
self.window_id,
error,
)
raise
except ClientError as err:
logger.error(
"Couldn't update maintenance window %s. Here's why: %s: %s",
self.name,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
+ 如需 API 詳細資訊，請參閱《適用於 Python (Boto3) 的AWS SDK API 參考》**中的下列主題。
+ [CreateDocument](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/CreateDocument)
+ [CreateMaintenanceWindow](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/CreateMaintenanceWindow)
+ [CreateOpsItem](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/CreateOpsItem)
+ [DeleteMaintenanceWindow](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DeleteMaintenanceWindow)
+ [ListCommandInvocations](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/ListCommandInvocations)
+ [SendCommand](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/SendCommand)
+ [UpdateOpsItem](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/UpdateOpsItem)
------
# Systems Manager 使用 AWS SDKs的動作
<a name="ssm_code_examples_actions"></a>
下列程式碼範例示範如何使用 AWS SDKs 執行個別 Systems Manager 動作。每個範例均包含 GitHub 的連結，您可以在連結中找到設定和執行程式碼的相關說明。
下列範例僅包含最常使用的動作。如需完整清單，請參閱《[AWS Systems Manager API 參考](https://docs.aws.amazon.com/systems-manager/latest/APIReference/Welcome.html)》。
**Topics**
+ [`AddTagsToResource`](ssm_example_ssm_AddTagsToResource_section.md)
+ [`CancelCommand`](ssm_example_ssm_CancelCommand_section.md)
+ [`CreateActivation`](ssm_example_ssm_CreateActivation_section.md)
+ [`CreateAssociation`](ssm_example_ssm_CreateAssociation_section.md)
+ [`CreateAssociationBatch`](ssm_example_ssm_CreateAssociationBatch_section.md)
+ [`CreateDocument`](ssm_example_ssm_CreateDocument_section.md)
+ [`CreateMaintenanceWindow`](ssm_example_ssm_CreateMaintenanceWindow_section.md)
+ [`CreateOpsItem`](ssm_example_ssm_CreateOpsItem_section.md)
+ [`CreatePatchBaseline`](ssm_example_ssm_CreatePatchBaseline_section.md)
+ [`DeleteActivation`](ssm_example_ssm_DeleteActivation_section.md)
+ [`DeleteAssociation`](ssm_example_ssm_DeleteAssociation_section.md)
+ [`DeleteDocument`](ssm_example_ssm_DeleteDocument_section.md)
+ [`DeleteMaintenanceWindow`](ssm_example_ssm_DeleteMaintenanceWindow_section.md)
+ [`DeleteOpsItem`](ssm_example_ssm_DeleteOpsItem_section.md)
+ [`DeleteParameter`](ssm_example_ssm_DeleteParameter_section.md)
+ [`DeletePatchBaseline`](ssm_example_ssm_DeletePatchBaseline_section.md)
+ [`DeregisterManagedInstance`](ssm_example_ssm_DeregisterManagedInstance_section.md)
+ [`DeregisterPatchBaselineForPatchGroup`](ssm_example_ssm_DeregisterPatchBaselineForPatchGroup_section.md)
+ [`DeregisterTargetFromMaintenanceWindow`](ssm_example_ssm_DeregisterTargetFromMaintenanceWindow_section.md)
+ [`DeregisterTaskFromMaintenanceWindow`](ssm_example_ssm_DeregisterTaskFromMaintenanceWindow_section.md)
+ [`DescribeActivations`](ssm_example_ssm_DescribeActivations_section.md)
+ [`DescribeAssociation`](ssm_example_ssm_DescribeAssociation_section.md)
+ [`DescribeAssociationExecutionTargets`](ssm_example_ssm_DescribeAssociationExecutionTargets_section.md)
+ [`DescribeAssociationExecutions`](ssm_example_ssm_DescribeAssociationExecutions_section.md)
+ [`DescribeAutomationExecutions`](ssm_example_ssm_DescribeAutomationExecutions_section.md)
+ [`DescribeAutomationStepExecutions`](ssm_example_ssm_DescribeAutomationStepExecutions_section.md)
+ [`DescribeAvailablePatches`](ssm_example_ssm_DescribeAvailablePatches_section.md)
+ [`DescribeDocument`](ssm_example_ssm_DescribeDocument_section.md)
+ [`DescribeDocumentPermission`](ssm_example_ssm_DescribeDocumentPermission_section.md)
+ [`DescribeEffectiveInstanceAssociations`](ssm_example_ssm_DescribeEffectiveInstanceAssociations_section.md)
+ [`DescribeEffectivePatchesForPatchBaseline`](ssm_example_ssm_DescribeEffectivePatchesForPatchBaseline_section.md)
+ [`DescribeInstanceAssociationsStatus`](ssm_example_ssm_DescribeInstanceAssociationsStatus_section.md)
+ [`DescribeInstanceInformation`](ssm_example_ssm_DescribeInstanceInformation_section.md)
+ [`DescribeInstancePatchStates`](ssm_example_ssm_DescribeInstancePatchStates_section.md)
+ [`DescribeInstancePatchStatesForPatchGroup`](ssm_example_ssm_DescribeInstancePatchStatesForPatchGroup_section.md)
+ [`DescribeInstancePatches`](ssm_example_ssm_DescribeInstancePatches_section.md)
+ [`DescribeMaintenanceWindowExecutionTaskInvocations`](ssm_example_ssm_DescribeMaintenanceWindowExecutionTaskInvocations_section.md)
+ [`DescribeMaintenanceWindowExecutionTasks`](ssm_example_ssm_DescribeMaintenanceWindowExecutionTasks_section.md)
+ [`DescribeMaintenanceWindowExecutions`](ssm_example_ssm_DescribeMaintenanceWindowExecutions_section.md)
+ [`DescribeMaintenanceWindowTargets`](ssm_example_ssm_DescribeMaintenanceWindowTargets_section.md)
+ [`DescribeMaintenanceWindowTasks`](ssm_example_ssm_DescribeMaintenanceWindowTasks_section.md)
+ [`DescribeMaintenanceWindows`](ssm_example_ssm_DescribeMaintenanceWindows_section.md)
+ [`DescribeOpsItems`](ssm_example_ssm_DescribeOpsItems_section.md)
+ [`DescribeParameters`](ssm_example_ssm_DescribeParameters_section.md)
+ [`DescribePatchBaselines`](ssm_example_ssm_DescribePatchBaselines_section.md)
+ [`DescribePatchGroupState`](ssm_example_ssm_DescribePatchGroupState_section.md)
+ [`DescribePatchGroups`](ssm_example_ssm_DescribePatchGroups_section.md)
+ [`GetAutomationExecution`](ssm_example_ssm_GetAutomationExecution_section.md)
+ [`GetCommandInvocation`](ssm_example_ssm_GetCommandInvocation_section.md)
+ [`GetConnectionStatus`](ssm_example_ssm_GetConnectionStatus_section.md)
+ [`GetDefaultPatchBaseline`](ssm_example_ssm_GetDefaultPatchBaseline_section.md)
+ [`GetDeployablePatchSnapshotForInstance`](ssm_example_ssm_GetDeployablePatchSnapshotForInstance_section.md)
+ [`GetDocument`](ssm_example_ssm_GetDocument_section.md)
+ [`GetInventory`](ssm_example_ssm_GetInventory_section.md)
+ [`GetInventorySchema`](ssm_example_ssm_GetInventorySchema_section.md)
+ [`GetMaintenanceWindow`](ssm_example_ssm_GetMaintenanceWindow_section.md)
+ [`GetMaintenanceWindowExecution`](ssm_example_ssm_GetMaintenanceWindowExecution_section.md)
+ [`GetMaintenanceWindowExecutionTask`](ssm_example_ssm_GetMaintenanceWindowExecutionTask_section.md)
+ [`GetParameter`](ssm_example_ssm_GetParameter_section.md)
+ [`GetParameterHistory`](ssm_example_ssm_GetParameterHistory_section.md)
+ [`GetParameters`](ssm_example_ssm_GetParameters_section.md)
+ [`GetPatchBaseline`](ssm_example_ssm_GetPatchBaseline_section.md)
+ [`GetPatchBaselineForPatchGroup`](ssm_example_ssm_GetPatchBaselineForPatchGroup_section.md)
+ [`ListAssociationVersions`](ssm_example_ssm_ListAssociationVersions_section.md)
+ [`ListAssociations`](ssm_example_ssm_ListAssociations_section.md)
+ [`ListCommandInvocations`](ssm_example_ssm_ListCommandInvocations_section.md)
+ [`ListCommands`](ssm_example_ssm_ListCommands_section.md)
+ [`ListComplianceItems`](ssm_example_ssm_ListComplianceItems_section.md)
+ [`ListComplianceSummaries`](ssm_example_ssm_ListComplianceSummaries_section.md)
+ [`ListDocumentVersions`](ssm_example_ssm_ListDocumentVersions_section.md)
+ [`ListDocuments`](ssm_example_ssm_ListDocuments_section.md)
+ [`ListInventoryEntries`](ssm_example_ssm_ListInventoryEntries_section.md)
+ [`ListResourceComplianceSummaries`](ssm_example_ssm_ListResourceComplianceSummaries_section.md)
+ [`ListTagsForResource`](ssm_example_ssm_ListTagsForResource_section.md)
+ [`ModifyDocumentPermission`](ssm_example_ssm_ModifyDocumentPermission_section.md)
+ [`PutComplianceItems`](ssm_example_ssm_PutComplianceItems_section.md)
+ [`PutInventory`](ssm_example_ssm_PutInventory_section.md)
+ [`PutParameter`](ssm_example_ssm_PutParameter_section.md)
+ [`RegisterDefaultPatchBaseline`](ssm_example_ssm_RegisterDefaultPatchBaseline_section.md)
+ [`RegisterPatchBaselineForPatchGroup`](ssm_example_ssm_RegisterPatchBaselineForPatchGroup_section.md)
+ [`RegisterTargetWithMaintenanceWindow`](ssm_example_ssm_RegisterTargetWithMaintenanceWindow_section.md)
+ [`RegisterTaskWithMaintenanceWindow`](ssm_example_ssm_RegisterTaskWithMaintenanceWindow_section.md)
+ [`RemoveTagsFromResource`](ssm_example_ssm_RemoveTagsFromResource_section.md)
+ [`SendCommand`](ssm_example_ssm_SendCommand_section.md)
+ [`StartAutomationExecution`](ssm_example_ssm_StartAutomationExecution_section.md)
+ [`StartSession`](ssm_example_ssm_StartSession_section.md)
+ [`StopAutomationExecution`](ssm_example_ssm_StopAutomationExecution_section.md)
+ [`UpdateAssociation`](ssm_example_ssm_UpdateAssociation_section.md)
+ [`UpdateAssociationStatus`](ssm_example_ssm_UpdateAssociationStatus_section.md)
+ [`UpdateDocument`](ssm_example_ssm_UpdateDocument_section.md)
+ [`UpdateDocumentDefaultVersion`](ssm_example_ssm_UpdateDocumentDefaultVersion_section.md)
+ [`UpdateMaintenanceWindow`](ssm_example_ssm_UpdateMaintenanceWindow_section.md)
+ [`UpdateManagedInstanceRole`](ssm_example_ssm_UpdateManagedInstanceRole_section.md)
+ [`UpdateOpsItem`](ssm_example_ssm_UpdateOpsItem_section.md)
+ [`UpdatePatchBaseline`](ssm_example_ssm_UpdatePatchBaseline_section.md)
# 搭配使用 `AddTagsToResource` 與 CLI
<a name="ssm_example_ssm_AddTagsToResource_section"></a>
下列程式碼範例示範如何使用 `AddTagsToResource`。
------
#### [ CLI ]
**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` 範例示範將兩個標籤新增至指定的參數。
```
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"
```
此命令不會產生輸出。
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Tagging Systems Manager resources](https://docs.aws.amazon.com/systems-manager/latest/userguide/tagging-resources.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [AddTagsToResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/add-tags-to-resource.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範使用新標籤更新維護時段。如果命令成功，則無輸出訊息。此範例使用的語法需要 PowerShell 版本 3 或更新版本。**
```
$option1 = @{Key="Stack";Value=@("Production")}
Add-SSMResourceTag -ResourceId "mw-03eb9db42890fb82d" -ResourceType "MaintenanceWindow" -Tag $option1
```
**範例 2：使用 PowerShell 版本 2 時，必須使用 New-Object 來建立每個標籤。如果命令成功，則無輸出訊息。**
```
$tag1 = New-Object Amazon.SimpleSystemsManagement.Model.Tag
$tag1.Key = "Stack"
$tag1.Value = "Production"
Add-SSMResourceTag -ResourceId "mw-03eb9db42890fb82d" -ResourceType "MaintenanceWindow" -Tag $tag1
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [AddTagsToResource](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範使用新標籤更新維護時段。如果命令成功，則無輸出訊息。此範例使用的語法需要 PowerShell 版本 3 或更新版本。**
```
$option1 = @{Key="Stack";Value=@("Production")}
Add-SSMResourceTag -ResourceId "mw-03eb9db42890fb82d" -ResourceType "MaintenanceWindow" -Tag $option1
```
**範例 2：使用 PowerShell 版本 2 時，必須使用 New-Object 來建立每個標籤。如果命令成功，則無輸出訊息。**
```
$tag1 = New-Object Amazon.SimpleSystemsManagement.Model.Tag
$tag1.Key = "Stack"
$tag1.Value = "Production"
Add-SSMResourceTag -ResourceId "mw-03eb9db42890fb82d" -ResourceType "MaintenanceWindow" -Tag $tag1
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [AddTagsToResource](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `CancelCommand` 與 CLI
<a name="ssm_example_ssm_CancelCommand_section"></a>
下列程式碼範例示範如何使用 `CancelCommand`。
------
#### [ CLI ]
**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"
```
此命令不會產生輸出。
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Tagging Systems Manager Parameters](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-tag.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CancelCommand](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/cancel-command.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例嘗試取消命令。如果操作成功，則無輸出訊息。**
```
Stop-SSMCommand -CommandId "9ded293e-e792-4440-8e3e-7b8ec5feaa38"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [CancelCommand](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例嘗試取消命令。如果操作成功，則無輸出訊息。**
```
Stop-SSMCommand -CommandId "9ded293e-e792-4440-8e3e-7b8ec5feaa38"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [CancelCommand](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `CreateActivation` 與 CLI
<a name="ssm_example_ssm_CreateActivation_section"></a>
下列程式碼範例示範如何使用 `CreateActivation`。
------
#### [ CLI ]
**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 使用者指南》**中的 [Step 4: Create a Managed-Instance Activation for a Hybrid Environment](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-managed-instance-activation.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateActivation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/create-activation.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範建立受管執行個體。**
```
New-SSMActivation -DefaultInstanceName "MyWebServers" -IamRole "SSMAutomationRole" -RegistrationLimit 10
```
**輸出：**
```
ActivationCode ActivationId
-------------- ------------
KWChhOxBTiwDcKE9BlKC 08e51e79-1e36-446c-8e63-9458569c1363
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [CreateActivation](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範建立受管執行個體。**
```
New-SSMActivation -DefaultInstanceName "MyWebServers" -IamRole "SSMAutomationRole" -RegistrationLimit 10
```
**輸出：**
```
ActivationCode ActivationId
-------------- ------------
KWChhOxBTiwDcKE9BlKC 08e51e79-1e36-446c-8e63-9458569c1363
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [CreateActivation](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `CreateAssociation` 與 CLI
<a name="ssm_example_ssm_CreateAssociation_section"></a>
下列程式碼範例示範如何使用 `CreateAssociation`。
------
#### [ CLI ]
**AWS CLI**
**範例 1：使用執行個體 ID 關聯文件**
此範例使用執行個體 ID 來關聯組態文件與執行個體。
```
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](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_CreateAssociation.html)。
**範例 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](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_CreateAssociation.html)。
**範例 3：建立僅執行一次的關聯**
此範例建立在指定日期和時間只執行一次的新關聯。以過去或現在的日期建立的關聯 (在處理時，該日期已是過去的日期) 會立即執行。
```
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](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_CreateAssociation.html)，或《AWS Systems Manager 使用者指南》**中的 [Reference: Cron and rate expressions for Systems Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/reference-cron-and-rate-expressions.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/create-association.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例使用執行個體 ID 來關聯組態文件與執行個體。**
```
New-SSMAssociation -InstanceId "i-0cb2b964d3e14fd9f" -Name "AWS-UpdateSSMAgent"
```
**輸出：**
```
Name : AWS-UpdateSSMAgent
InstanceId : i-0000293ffd8c57862
Date : 2/23/2017 6:55:22 PM
Status.Name : Associated
Status.Date : 2/20/2015 8:31:11 AM
Status.Message : Associated with AWS-UpdateSSMAgent
Status.AdditionalInfo :
```
**範例 2：此範例使用目標來關聯組態文件與執行個體。**
```
$target = @{Key="instanceids";Values=@("i-0cb2b964d3e14fd9f")}
New-SSMAssociation -Name "AWS-UpdateSSMAgent" -Target $target
```
**輸出：**
```
Name : AWS-UpdateSSMAgent
InstanceId :
Date : 3/1/2017 6:22:21 PM
Status.Name :
Status.Date :
Status.Message :
Status.AdditionalInfo :
```
**範例 3：此範例使用目標和參數來關聯組態文件與執行個體。**
```
$target = @{Key="instanceids";Values=@("i-0cb2b964d3e14fd9f")}
$params = @{
"action"="configure"
"mode"="ec2"
"optionalConfigurationSource"="ssm"
"optionalConfigurationLocation"=""
"optionalRestart"="yes"
}
New-SSMAssociation -Name "Configure-CloudWatch" -AssociationName "CWConfiguration" -Target $target -Parameter $params
```
**輸出：**
```
Name : Configure-CloudWatch
InstanceId :
Date : 5/17/2018 3:17:44 PM
Status.Name :
Status.Date :
Status.Message :
Status.AdditionalInfo :
```
**範例 4：此範例使用 `AWS-GatherSoftwareInventory` 建立與區域中所有執行個體的關聯。它也提供參數中要收集的自訂檔案和登錄檔位置**
```
$params = [Collections.Generic.Dictionary[String,Collections.Generic.List[String]]]::new()
$params["windowsRegistry"] ='[{"Path":"HKEY_LOCAL_MACHINE\SOFTWARE\Amazon\MachineImage","Recursive":false,"ValueNames":["AMIName"]}]'
$params["files"] = '[{"Path":"C:\Program Files","Pattern":["*.exe"],"Recursive":true}, {"Path":"C:\ProgramData","Pattern":["*.log"],"Recursive":true}]'
New-SSMAssociation -AssociationName new-in-mum -Name AWS-GatherSoftwareInventory -Target @{Key="instanceids";Values="*"} -Parameter $params -region ap-south-1 -ScheduleExpression "rate(720 minutes)"
```
**輸出：**
```
Name : AWS-GatherSoftwareInventory
InstanceId :
Date : 6/9/2019 8:57:56 AM
Status.Name :
Status.Date :
Status.Message :
Status.AdditionalInfo :
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [CreateAssociation](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例使用執行個體 ID 來關聯組態文件與執行個體。**
```
New-SSMAssociation -InstanceId "i-0cb2b964d3e14fd9f" -Name "AWS-UpdateSSMAgent"
```
**輸出：**
```
Name : AWS-UpdateSSMAgent
InstanceId : i-0000293ffd8c57862
Date : 2/23/2017 6:55:22 PM
Status.Name : Associated
Status.Date : 2/20/2015 8:31:11 AM
Status.Message : Associated with AWS-UpdateSSMAgent
Status.AdditionalInfo :
```
**範例 2：此範例使用目標來關聯組態文件與執行個體。**
```
$target = @{Key="instanceids";Values=@("i-0cb2b964d3e14fd9f")}
New-SSMAssociation -Name "AWS-UpdateSSMAgent" -Target $target
```
**輸出：**
```
Name : AWS-UpdateSSMAgent
InstanceId :
Date : 3/1/2017 6:22:21 PM
Status.Name :
Status.Date :
Status.Message :
Status.AdditionalInfo :
```
**範例 3：此範例使用目標和參數來關聯組態文件與執行個體。**
```
$target = @{Key="instanceids";Values=@("i-0cb2b964d3e14fd9f")}
$params = @{
"action"="configure"
"mode"="ec2"
"optionalConfigurationSource"="ssm"
"optionalConfigurationLocation"=""
"optionalRestart"="yes"
}
New-SSMAssociation -Name "Configure-CloudWatch" -AssociationName "CWConfiguration" -Target $target -Parameter $params
```
**輸出：**
```
Name : Configure-CloudWatch
InstanceId :
Date : 5/17/2018 3:17:44 PM
Status.Name :
Status.Date :
Status.Message :
Status.AdditionalInfo :
```
**範例 4：此範例使用 `AWS-GatherSoftwareInventory` 建立與區域中所有執行個體的關聯。它也提供參數中要收集的自訂檔案和登錄檔位置**
```
$params = [Collections.Generic.Dictionary[String,Collections.Generic.List[String]]]::new()
$params["windowsRegistry"] ='[{"Path":"HKEY_LOCAL_MACHINE\SOFTWARE\Amazon\MachineImage","Recursive":false,"ValueNames":["AMIName"]}]'
$params["files"] = '[{"Path":"C:\Program Files","Pattern":["*.exe"],"Recursive":true}, {"Path":"C:\ProgramData","Pattern":["*.log"],"Recursive":true}]'
New-SSMAssociation -AssociationName new-in-mum -Name AWS-GatherSoftwareInventory -Target @{Key="instanceids";Values="*"} -Parameter $params -region ap-south-1 -ScheduleExpression "rate(720 minutes)"
```
**輸出：**
```
Name : AWS-GatherSoftwareInventory
InstanceId :
Date : 6/9/2019 8:57:56 AM
Status.Name :
Status.Date :
Status.Message :
Status.AdditionalInfo :
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [CreateAssociation](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `CreateAssociationBatch` 與 CLI
<a name="ssm_example_ssm_CreateAssociationBatch_section"></a>
下列程式碼範例示範如何使用 `CreateAssociationBatch`。
------
#### [ CLI ]
**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 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateAssociationBatch](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/create-association-batch.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範將組態文件與多個執行個體關聯。輸出會傳回成功操作和失敗操作的清單 (如適用)。**
```
$option1 = @{InstanceId="i-0cb2b964d3e14fd9f";Name=@("AWS-UpdateSSMAgent")}
$option2 = @{InstanceId="i-0000293ffd8c57862";Name=@("AWS-UpdateSSMAgent")}
New-SSMAssociationFromBatch -Entry $option1,$option2
```
**輸出：**
```
Failed Successful
------ ----------
{} {Amazon.SimpleSystemsManagement.Model.FailedCreateAssociation, Amazon.SimpleSystemsManagement.Model.FailedCreateAsso...
```
**範例 2：此範例會顯示成功操作的完整詳細資訊。**
```
$option1 = @{InstanceId="i-0cb2b964d3e14fd9f";Name=@("AWS-UpdateSSMAgent")}
$option2 = @{InstanceId="i-0000293ffd8c57862";Name=@("AWS-UpdateSSMAgent")}
(New-SSMAssociationFromBatch -Entry $option1,$option2).Successful
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [CreateAssociationBatch](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範將組態文件與多個執行個體關聯。輸出會傳回成功操作和失敗操作的清單 (如適用)。**
```
$option1 = @{InstanceId="i-0cb2b964d3e14fd9f";Name=@("AWS-UpdateSSMAgent")}
$option2 = @{InstanceId="i-0000293ffd8c57862";Name=@("AWS-UpdateSSMAgent")}
New-SSMAssociationFromBatch -Entry $option1,$option2
```
**輸出：**
```
Failed Successful
------ ----------
{} {Amazon.SimpleSystemsManagement.Model.FailedCreateAssociation, Amazon.SimpleSystemsManagement.Model.FailedCreateAsso...
```
**範例 2：此範例會顯示成功操作的完整詳細資訊。**
```
$option1 = @{InstanceId="i-0cb2b964d3e14fd9f";Name=@("AWS-UpdateSSMAgent")}
$option2 = @{InstanceId="i-0000293ffd8c57862";Name=@("AWS-UpdateSSMAgent")}
(New-SSMAssociationFromBatch -Entry $option1,$option2).Successful
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [CreateAssociationBatch](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# `CreateDocument` 搭配 AWS SDK 或 CLI 使用
<a name="ssm_example_ssm_CreateDocument_section"></a>
下列程式碼範例示範如何使用 `CreateDocument`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](ssm_example_ssm_Scenario_section.md)
------
#### [ CLI ]
**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": []
}
}
```
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Creating Systems Manager Documents](https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-doc.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateDocument](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/create-document.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/ssm#code-examples)中設定和執行。
```
/**
* Creates an AWS SSM document asynchronously.
*
* @param docName The name of the document to create.
* <p>
* This method initiates an asynchronous request to create an SSM document.
* If the request is successful, it prints the document status.
* If an exception occurs, it handles the error appropriately.
*/
public void createSSMDoc(String docName) throws SsmException {
String jsonData = """
{
"schemaVersion": "2.2",
"description": "Run a simple shell command",
"mainSteps": [
{
"action": "aws:runShellScript",
"name": "runEchoCommand",
"inputs": {
"runCommand": [
"echo 'Hello, world!'"
]
}
}
]
}
""";
CreateDocumentRequest request = CreateDocumentRequest.builder()
.content(jsonData)
.name(docName)
.documentType(DocumentType.COMMAND)
.build();
CompletableFuture<CreateDocumentResponse> future = getAsyncClient().createDocument(request);
future.thenAccept(response -> {
System.out.println("The status of the SSM document is " + response.documentDescription().status());
}).exceptionally(ex -> {
Throwable cause = (ex instanceof CompletionException) ? ex.getCause() : ex;
if (cause instanceof DocumentAlreadyExistsException) {
throw new CompletionException(cause);
} else if (cause instanceof SsmException) {
throw new CompletionException(cause);
} else {
throw new RuntimeException(cause);
}
}).join();
}
```
+ 如需 API 詳細資訊，請參閱《*AWS SDK for Java 2.x API 參考*》中的 [CreateDocument](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/CreateDocument)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ssm#code-examples)中設定和執行。
```
import { CreateDocumentCommand, SSMClient } from "@aws-sdk/client-ssm";
import { parseArgs } from "node:util";
/**
* Create an SSM document.
* @param {{ content: string, name: string, documentType?: DocumentType }}
*/
export const main = async ({ content, name, documentType }) => {
const client = new SSMClient({});
try {
const { documentDescription } = await client.send(
new CreateDocumentCommand({
Content: content, // The content for the new SSM document. The content must not exceed 64KB.
Name: name,
DocumentType: documentType, // Document format type can be JSON, YAML, or TEXT. The default format is JSON.
}),
);
console.log("Document created successfully.");
return { DocumentDescription: documentDescription };
} catch (caught) {
if (caught instanceof Error && caught.name === "DocumentAlreadyExists") {
console.warn(`${caught.message}. Did you provide a new document name?`);
} else {
throw caught;
}
}
};
```
+ 如需 API 詳細資訊，請參閱《*適用於 JavaScript 的 AWS SDK API 參考*》中的 [CreateDocument](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/CreateDocumentCommand)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範在您的帳戶中建立文件。文件必須為 JSON 格式。如需有關撰寫組態文件的詳細資訊，請參閱《SSM API 參考》中的組態文件。**
```
New-SSMDocument -Content (Get-Content -Raw "c:\temp\RunShellScript.json") -Name "RunShellScript" -DocumentType "Command"
```
**輸出：**
```
CreatedDate : 3/1/2017 1:21:33 AM
DefaultVersion : 1
Description : Run an updated script
DocumentType : Command
DocumentVersion : 1
Hash : 1d5ce820e999ff051eb4841ed887593daf77120fd76cae0d18a53cc42e4e22c1
HashType : Sha256
LatestVersion : 1
Name : RunShellScript
Owner : 809632081692
Parameters : {commands}
PlatformTypes : {Linux}
SchemaVersion : 2.0
Sha1 :
Status : Creating
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [CreateDocument](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範在您的帳戶中建立文件。文件必須為 JSON 格式。如需有關撰寫組態文件的詳細資訊，請參閱《SSM API 參考》中的組態文件。**
```
New-SSMDocument -Content (Get-Content -Raw "c:\temp\RunShellScript.json") -Name "RunShellScript" -DocumentType "Command"
```
**輸出：**
```
CreatedDate : 3/1/2017 1:21:33 AM
DefaultVersion : 1
Description : Run an updated script
DocumentType : Command
DocumentVersion : 1
Hash : 1d5ce820e999ff051eb4841ed887593daf77120fd76cae0d18a53cc42e4e22c1
HashType : Sha256
LatestVersion : 1
Name : RunShellScript
Owner : 809632081692
Parameters : {commands}
PlatformTypes : {Linux}
SchemaVersion : 2.0
Sha1 :
Status : Creating
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [CreateDocument](https://docs.aws.amazon.com/powershell/v5/reference)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/ssm#code-examples)中設定和執行。
```
class DocumentWrapper:
"""Encapsulates AWS Systems Manager Document actions."""
def __init__(self, ssm_client):
"""
:param ssm_client: A Boto3 Systems Manager client.
"""
self.ssm_client = ssm_client
self.name = None
@classmethod
def from_client(cls):
ssm_client = boto3.client("ssm")
return cls(ssm_client)
def create(self, content, name):
"""
Creates a document.
:param content: The content of the document.
:param name: The name of the document.
"""
try:
self.ssm_client.create_document(
Name=name, Content=content, DocumentType="Command"
)
self.name = name
except self.ssm_client.exceptions.DocumentAlreadyExists:
print(f"Document {name} already exists.")
self.name = name
except ClientError as err:
logger.error(
"Couldn't create %s. Here's why: %s: %s",
name,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [CreateDocument](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/CreateDocument)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ssm#code-examples)中設定和執行。
```
TRY.
lo_ssm->createdocument(
iv_name = iv_name
iv_content = iv_content
iv_documenttype = 'Command' ).
MESSAGE 'Document created.' TYPE 'I'.
CATCH /aws1/cx_ssmdocalreadyexists.
MESSAGE 'Document already exists.' TYPE 'I'.
CATCH /aws1/cx_ssminvaliddoccontent.
MESSAGE 'Invalid document content.' TYPE 'I'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [CreateDocument](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# `CreateMaintenanceWindow` 搭配 AWS SDK 或 CLI 使用
<a name="ssm_example_ssm_CreateMaintenanceWindow_section"></a>
下列程式碼範例示範如何使用 `CreateMaintenanceWindow`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](ssm_example_ssm_Scenario_section.md)
------
#### [ CLI ]
**AWS CLI**
**範例 1：建立維護時段**
下列 `create-maintenance-window` 範例會建立一個新的維護時段，該維護時段每五分鐘 (最長持續兩個小時，視需要) 防止新任務在維護時段執行結束後一小時內啟動、允許未關聯的目標 (尚未向維護時段註冊的執行個體)，以及透過使用其建立者打算在教學課程中使用的自訂標籤來進行表示。
```
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：建立只執行一次的維護時段**
下列 `create-maintenance-window` 範例會建立只在指定的日期和時間執行一次的新維護時段。
```
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"
}
```
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Maintenance Windows](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-maintenance.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateMaintenanceWindow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/create-maintenance-window.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/ssm#code-examples)中設定和執行。
```
/**
* Creates an SSM maintenance window asynchronously.
*
* @param winName The name of the maintenance window.
* @return The ID of the created or existing maintenance window.
* <p>
* This method initiates an asynchronous request to create an SSM maintenance window.
* If the request is successful, it prints the maintenance window ID.
* If an exception occurs, it handles the error appropriately.
*/
public String createMaintenanceWindow(String winName) throws SsmException, DocumentAlreadyExistsException {
CreateMaintenanceWindowRequest request = CreateMaintenanceWindowRequest.builder()
.name(winName)
.description("This is my maintenance window")
.allowUnassociatedTargets(true)
.duration(2)
.cutoff(1)
.schedule("cron(0 10 ? * MON-FRI *)")
.build();
CompletableFuture<CreateMaintenanceWindowResponse> future = getAsyncClient().createMaintenanceWindow(request);
final String[] windowId = {null};
future.whenComplete((response, ex) -> {
if (response != null) {
String maintenanceWindowId = response.windowId();
System.out.println("The maintenance window id is " + maintenanceWindowId);
windowId[0] = maintenanceWindowId;
} else {
Throwable cause = (ex instanceof CompletionException) ? ex.getCause() : ex;
if (cause instanceof DocumentAlreadyExistsException) {
throw new CompletionException(cause);
} else if (cause instanceof SsmException) {
throw new CompletionException(cause);
} else {
throw new RuntimeException(cause);
}
}
}).join();
if (windowId[0] == null) {
MaintenanceWindowFilter filter = MaintenanceWindowFilter.builder()
.key("name")
.values(winName)
.build();
DescribeMaintenanceWindowsRequest winRequest = DescribeMaintenanceWindowsRequest.builder()
.filters(filter)
.build();
CompletableFuture<DescribeMaintenanceWindowsResponse> describeFuture = getAsyncClient().describeMaintenanceWindows(winRequest);
describeFuture.whenComplete((describeResponse, describeEx) -> {
if (describeResponse != null) {
List<MaintenanceWindowIdentity> windows = describeResponse.windowIdentities();
if (!windows.isEmpty()) {
windowId[0] = windows.get(0).windowId();
System.out.println("Window ID: " + windowId[0]);
} else {
System.out.println("Window not found.");
windowId[0] = "";
}
} else {
Throwable describeCause = (describeEx instanceof CompletionException) ? describeEx.getCause() : describeEx;
throw new RuntimeException("Error describing maintenance windows: " + describeCause.getMessage(), describeCause);
}
}).join();
}
return windowId[0];
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [CreateMaintenanceWindow](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/CreateMaintenanceWindow)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ssm#code-examples)中設定和執行。
```
import { CreateMaintenanceWindowCommand, SSMClient } from "@aws-sdk/client-ssm";
import { parseArgs } from "node:util";
/**
* Create an SSM maintenance window.
* @param {{ name: string, allowUnassociatedTargets: boolean, duration: number, cutoff: number, schedule: string, description?: string }}
*/
export const main = async ({
name,
allowUnassociatedTargets, // Allow the maintenance window to run on managed nodes, even if you haven't registered those nodes as targets.
duration, // The duration of the maintenance window in hours.
cutoff, // The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.
schedule, // The schedule of the maintenance window in the form of a cron or rate expression.
description = undefined,
}) => {
const client = new SSMClient({});
try {
const { windowId } = await client.send(
new CreateMaintenanceWindowCommand({
Name: name,
Description: description,
AllowUnassociatedTargets: allowUnassociatedTargets, // Allow the maintenance window to run on managed nodes, even if you haven't registered those nodes as targets.
Duration: duration, // The duration of the maintenance window in hours.
Cutoff: cutoff, // The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.
Schedule: schedule, // The schedule of the maintenance window in the form of a cron or rate expression.
}),
);
console.log(`Maintenance window created with Id: ${windowId}`);
return { WindowId: windowId };
} catch (caught) {
if (caught instanceof Error && caught.name === "MissingParameter") {
console.warn(`${caught.message}. Did you provide these values?`);
} else {
throw caught;
}
}
};
```
+ 如需 API 詳細資訊，請參閱《適用於 JavaScript 的 AWS SDK API 參考》**中的 [CreateMaintenanceWindow](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/CreateMaintenanceWindowCommand)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例會建立一個具有指定名稱的新維護時段，該維護時段在每個星期二下午 4 點執行 4 小時並有一個 1 小時的截止，而且允許未關聯的目標。**
```
New-SSMMaintenanceWindow -Name "MyMaintenanceWindow" -Duration 4 -Cutoff 1 -AllowUnassociatedTarget $true -Schedule "cron(0 16 ? * TUE *)"
```
**輸出：**
```
mw-03eb53e1ea7383998
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [CreateMaintenanceWindow](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例會建立一個具有指定名稱的新維護時段，該維護時段在每個星期二下午 4 點執行 4 小時並有一個 1 小時的截止，而且允許未關聯的目標。**
```
New-SSMMaintenanceWindow -Name "MyMaintenanceWindow" -Duration 4 -Cutoff 1 -AllowUnassociatedTarget $true -Schedule "cron(0 16 ? * TUE *)"
```
**輸出：**
```
mw-03eb53e1ea7383998
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [CreateMaintenanceWindow](https://docs.aws.amazon.com/powershell/v5/reference)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/ssm#code-examples)中設定和執行。
```
class MaintenanceWindowWrapper:
"""Encapsulates AWS Systems Manager maintenance window actions."""
def __init__(self, ssm_client):
"""
:param ssm_client: A Boto3 Systems Manager client.
"""
self.ssm_client = ssm_client
self.window_id = None
self.name = None
@classmethod
def from_client(cls):
ssm_client = boto3.client("ssm")
return cls(ssm_client)
def create(self, name, schedule, duration, cutoff, allow_unassociated_targets):
"""
Create an AWS Systems Manager maintenance window.
:param name: The name of the maintenance window.
:param schedule: The schedule of the maintenance window.
:param duration: The duration of the maintenance window.
:param cutoff: The cutoff time of the maintenance window.
:param allow_unassociated_targets: Allow the maintenance window to run on managed nodes, even
if you haven't registered those nodes as targets.
"""
try:
response = self.ssm_client.create_maintenance_window(
Name=name,
Schedule=schedule,
Duration=duration,
Cutoff=cutoff,
AllowUnassociatedTargets=allow_unassociated_targets,
)
self.window_id = response["WindowId"]
self.name = name
logger.info("Created maintenance window %s.", self.window_id)
except ParamValidationError as error:
logger.error(
"Parameter validation error when trying to create maintenance window %s. Here's why: %s",
self.window_id,
error,
)
raise
except ClientError as err:
logger.error(
"Couldn't create maintenance window %s. Here's why: %s: %s",
name,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [CreateMaintenanceWindow](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/CreateMaintenanceWindow)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ssm#code-examples)中設定和執行。
```
TRY.
oo_result = lo_ssm->createmaintenancewindow(
iv_name = iv_name
iv_schedule = iv_schedule
iv_duration = iv_duration
iv_cutoff = iv_cutoff
iv_allowunassociatedtargets = iv_allow_unassociated_targets ).
MESSAGE 'Maintenance window created.' TYPE 'I'.
CATCH /aws1/cx_ssmresrclimitexcdex.
MESSAGE 'Resource limit exceeded.' TYPE 'I'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [CreateMaintenanceWindow](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# `CreateOpsItem` 搭配 AWS SDK 或 CLI 使用
<a name="ssm_example_ssm_CreateOpsItem_section"></a>
下列程式碼範例示範如何使用 `CreateOpsItem`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](ssm_example_ssm_Scenario_section.md)
------
#### [ CLI ]
**AWS CLI**
**建立 OpsItems**
下列 `create-ops-item` 範例在 OperationalData 中使用 /aws/resources 索引鍵來建立含 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"
}
```
如需詳細資訊，請參閱**《AWS Systems Manager 使用者指南》中的 [Creating OpsItems](https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-creating-OpsItems.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateOpsItem](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/create-ops-item.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/ssm#code-examples)中設定和執行。
```
/**
* Creates an SSM OpsItem asynchronously.
*
* @param title The title of the OpsItem.
* @param source The source of the OpsItem.
* @param category The category of the OpsItem.
* @param severity The severity of the OpsItem.
* @return The ID of the created OpsItem.
* <p>
* This method initiates an asynchronous request to create an SSM OpsItem.
* If the request is successful, it returns the OpsItem ID.
* If an exception occurs, it handles the error appropriately.
*/
public String createSSMOpsItem(String title, String source, String category, String severity) {
CreateOpsItemRequest opsItemRequest = CreateOpsItemRequest.builder()
.description("Created by the SSM Java API")
.title(title)
.source(source)
.category(category)
.severity(severity)
.build();
CompletableFuture<CreateOpsItemResponse> future = getAsyncClient().createOpsItem(opsItemRequest);
try {
CreateOpsItemResponse response = future.join();
return response.opsItemId();
} catch (CompletionException e) {
Throwable cause = e.getCause();
if (cause instanceof SsmException) {
throw (SsmException) cause;
} else {
throw new RuntimeException(cause);
}
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [CreateOpsItem](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/CreateOpsItem)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ssm#code-examples)中設定和執行。
```
import { CreateOpsItemCommand, SSMClient } from "@aws-sdk/client-ssm";
import { parseArgs } from "node:util";
/**
* Create an SSM OpsItem.
* @param {{ title: string, source: string, category?: string, severity?: string }}
*/
export const main = async ({
title,
source,
category = undefined,
severity = undefined,
}) => {
const client = new SSMClient({});
try {
const { opsItemArn, opsItemId } = await client.send(
new CreateOpsItemCommand({
Title: title,
Source: source, // The origin of the OpsItem, such as Amazon EC2 or Systems Manager.
Category: category,
Severity: severity,
}),
);
console.log(`Ops item created with id: ${opsItemId}`);
return { OpsItemArn: opsItemArn, OpsItemId: opsItemId };
} catch (caught) {
if (caught instanceof Error && caught.name === "MissingParameter") {
console.warn(`${caught.message}. Did you provide these values?`);
} else {
throw caught;
}
}
};
```
+ 如需 API 詳細資訊，請參閱《適用於 JavaScript 的 AWS SDK API 參考》**中的 [CreateOpsItem](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/CreateOpsItemCommand)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/ssm#code-examples)中設定和執行。
```
class OpsItemWrapper:
"""Encapsulates AWS Systems Manager OpsItem actions."""
def __init__(self, ssm_client):
"""
:param ssm_client: A Boto3 Systems Manager client.
"""
self.ssm_client = ssm_client
self.id = None
@classmethod
def from_client(cls):
"""
:return: A OpsItemWrapper instance.
"""
ssm_client = boto3.client("ssm")
return cls(ssm_client)
def create(self, title, source, category, severity, description):
"""
Create an OpsItem
:param title: The OpsItem title.
:param source: The OpsItem source.
:param category: The OpsItem category.
:param severity: The OpsItem severity.
:param description: The OpsItem description.
"""
try:
response = self.ssm_client.create_ops_item(
Title=title,
Source=source,
Category=category,
Severity=severity,
Description=description,
)
self.id = response["OpsItemId"]
except self.ssm_client.exceptions.OpsItemLimitExceededException as err:
logger.error(
"Couldn't create ops item because you have exceeded your open OpsItem limit. "
"Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
except ClientError as err:
logger.error(
"Couldn't create ops item %s. Here's why: %s: %s",
title,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [CreateOpsItem](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/CreateOpsItem)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ssm#code-examples)中設定和執行。
```
TRY.
oo_result = lo_ssm->createopsitem(
iv_title = iv_title
iv_source = iv_source
iv_category = iv_category
iv_severity = iv_severity
iv_description = iv_description ).
MESSAGE 'OpsItem created.' TYPE 'I'.
CATCH /aws1/cx_ssmopsitemlimitexcdex.
MESSAGE 'You have exceeded your open OpsItem limit.' TYPE 'I'.
CATCH /aws1/cx_ssmopsitemalrdyexex.
MESSAGE 'OpsItem already exists.' TYPE 'I'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [CreateOpsItem](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# 搭配使用 `CreatePatchBaseline` 與 CLI
<a name="ssm_example_ssm_CreatePatchBaseline_section"></a>
下列程式碼範例示範如何使用 `CreatePatchBaseline`。
------
#### [ CLI ]
**AWS CLI**
**範例 1：建立具有自動核准的修補基準**
下列 `create-patch-baseline` 範例示範建立 Windows Server 修補基準，該基準會在 Microsoft 發行適用於生產環境的修補程式七天之後對它們進行核准。
```
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` 範例示範建立 Windows Server 修補基準，該基準會對 2020 年 7 月 7 日 (含) 之前發布的適用於生產環境的所有修補程式進行核准。
```
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` 範例示範建立 Amazon Linux 2017.09 修補基準，該基準會在適用於生產環境的修補程式發布 7 天後對它們進行核准、指定修補基準的核准規則，以及指定修補程式的自訂儲存庫。
```
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"
```
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Create a Custom Patch Baseline](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-patch-baseline-console.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreatePatchBaseline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/create-patch-baseline.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範針對在生產環境中執行 Windows Server 2019 的受管執行個體建立修補基準，該修補基準在 Microsoft 發行修補程式七天後對修補程式進行核准。**
```
$rule = New-Object Amazon.SimpleSystemsManagement.Model.PatchRule
$rule.ApproveAfterDays = 7
$ruleFilters = New-Object Amazon.SimpleSystemsManagement.Model.PatchFilterGroup
$patchFilter = New-Object Amazon.SimpleSystemsManagement.Model.PatchFilter
$patchFilter.Key="PRODUCT"
$patchFilter.Values="WindowsServer2019"
$severityFilter = New-Object Amazon.SimpleSystemsManagement.Model.PatchFilter
$severityFilter.Key="MSRC_SEVERITY"
$severityFilter.Values.Add("Critical")
$severityFilter.Values.Add("Important")
$severityFilter.Values.Add("Moderate")
$classificationFilter = New-Object Amazon.SimpleSystemsManagement.Model.PatchFilter
$classificationFilter.Key = "CLASSIFICATION"
$classificationFilter.Values.Add( "SecurityUpdates" )
$classificationFilter.Values.Add( "Updates" )
$classificationFilter.Values.Add( "UpdateRollups" )
$classificationFilter.Values.Add( "CriticalUpdates" )
$ruleFilters.PatchFilters.Add($severityFilter)
$ruleFilters.PatchFilters.Add($classificationFilter)
$ruleFilters.PatchFilters.Add($patchFilter)
$rule.PatchFilterGroup = $ruleFilters
New-SSMPatchBaseline -Name "Production-Baseline-Windows2019" -Description "Baseline containing all updates approved for production systems" -ApprovalRules_PatchRule $rule
```
**輸出：**
```
pb-0z4z6221c4296b23z
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [CreatePatchBaseline](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範針對在生產環境中執行 Windows Server 2019 的受管執行個體建立修補基準，該修補基準在 Microsoft 發行修補程式七天後對修補程式進行核准。**
```
$rule = New-Object Amazon.SimpleSystemsManagement.Model.PatchRule
$rule.ApproveAfterDays = 7
$ruleFilters = New-Object Amazon.SimpleSystemsManagement.Model.PatchFilterGroup
$patchFilter = New-Object Amazon.SimpleSystemsManagement.Model.PatchFilter
$patchFilter.Key="PRODUCT"
$patchFilter.Values="WindowsServer2019"
$severityFilter = New-Object Amazon.SimpleSystemsManagement.Model.PatchFilter
$severityFilter.Key="MSRC_SEVERITY"
$severityFilter.Values.Add("Critical")
$severityFilter.Values.Add("Important")
$severityFilter.Values.Add("Moderate")
$classificationFilter = New-Object Amazon.SimpleSystemsManagement.Model.PatchFilter
$classificationFilter.Key = "CLASSIFICATION"
$classificationFilter.Values.Add( "SecurityUpdates" )
$classificationFilter.Values.Add( "Updates" )
$classificationFilter.Values.Add( "UpdateRollups" )
$classificationFilter.Values.Add( "CriticalUpdates" )
$ruleFilters.PatchFilters.Add($severityFilter)
$ruleFilters.PatchFilters.Add($classificationFilter)
$ruleFilters.PatchFilters.Add($patchFilter)
$rule.PatchFilterGroup = $ruleFilters
New-SSMPatchBaseline -Name "Production-Baseline-Windows2019" -Description "Baseline containing all updates approved for production systems" -ApprovalRules_PatchRule $rule
```
**輸出：**
```
pb-0z4z6221c4296b23z
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [CreatePatchBaseline](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DeleteActivation` 與 CLI
<a name="ssm_example_ssm_DeleteActivation_section"></a>
下列程式碼範例示範如何使用 `DeleteActivation`。
------
#### [ CLI ]
**AWS CLI**
**刪除受管執行個體啟用**
下列 `delete-activation` 範例示範刪除受管執行個體啟用。
```
aws ssm delete-activation \
--activation-id "aa673477-d926-42c1-8757-1358cEXAMPLE"
```
此命令不會產生輸出。
如需詳細資訊，請參閱《[AWS Systems Manager 使用者指南》中的設定混合環境的](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances.html) *AWS Systems Manager*。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteActivation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/delete-activation.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範刪除啟用。如果命令成功，則無輸出訊息。**
```
Remove-SSMActivation -ActivationId "08e51e79-1e36-446c-8e63-9458569c1363"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DeleteActivation](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範刪除啟用。如果命令成功，則無輸出訊息。**
```
Remove-SSMActivation -ActivationId "08e51e79-1e36-446c-8e63-9458569c1363"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DeleteActivation](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DeleteAssociation` 與 CLI
<a name="ssm_example_ssm_DeleteAssociation_section"></a>
下列程式碼範例示範如何使用 `DeleteAssociation`。
------
#### [ CLI ]
**AWS CLI**
**範例 1：使用關聯 ID 來刪除關聯**
下列 `delete-association` 範例示範刪除指定關聯 ID 的關聯。如果命令成功，則無輸出訊息。
```
aws ssm delete-association \
--association-id "8dfe3659-4309-493a-8755-0123456789ab"
```
此命令不會產生輸出。
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南*》*中的 [Editing and creating a new version of an association](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-state-assoc-edit.html)。
**範例 2：刪除關聯**
下列 `delete-association` 範例示範刪除執行個體與文件之間的關聯。如果命令成功，則無輸出訊息。
```
aws ssm delete-association \
--instance-id "i-1234567890abcdef0" \
--name "AWS-UpdateSSMAgent"
```
此命令不會產生輸出。
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Working with associations in Systems Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-associations.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/delete-association.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範刪除執行個體與文件之間的關聯。如果命令成功，則無輸出訊息。**
```
Remove-SSMAssociation -InstanceId "i-0cb2b964d3e14fd9f" -Name "AWS-UpdateSSMAgent"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DeleteAssociation](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範刪除執行個體與文件之間的關聯。如果命令成功，則無輸出訊息。**
```
Remove-SSMAssociation -InstanceId "i-0cb2b964d3e14fd9f" -Name "AWS-UpdateSSMAgent"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DeleteAssociation](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# `DeleteDocument` 搭配 AWS SDK 或 CLI 使用
<a name="ssm_example_ssm_DeleteDocument_section"></a>
下列程式碼範例示範如何使用 `DeleteDocument`。
------
#### [ CLI ]
**AWS CLI**
**刪除文件**
下列 `delete-document` 範例示範刪除 Systems Manager 文件。
```
aws ssm delete-document \
--name "Example"
```
此命令不會產生輸出。
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Creating Systems Manager Documents](https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-doc.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteDocument](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/delete-document.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/ssm#code-examples)中設定和執行。
```
/**
* Deletes an AWS SSM document asynchronously.
*
* @param documentName The name of the document to delete.
* <p>
* This method initiates an asynchronous request to delete an SSM document.
* If an exception occurs, it handles the error appropriately.
*/
public void deleteDoc(String documentName) {
DeleteDocumentRequest documentRequest = DeleteDocumentRequest.builder()
.name(documentName)
.build();
CompletableFuture<Void> future = CompletableFuture.runAsync(() -> {
getAsyncClient().deleteDocument(documentRequest)
.thenAccept(response -> {
System.out.println("The SSM document was successfully deleted.");
})
.exceptionally(ex -> {
throw new CompletionException(ex);
}).join();
}).exceptionally(ex -> {
Throwable cause = (ex instanceof CompletionException) ? ex.getCause() : ex;
if (cause instanceof SsmException) {
throw new RuntimeException("SSM error: " + cause.getMessage(), cause);
} else {
throw new RuntimeException("Unexpected error: " + cause.getMessage(), cause);
}
});
try {
future.join();
} catch (CompletionException ex) {
throw ex.getCause() instanceof RuntimeException ? (RuntimeException) ex.getCause() : ex;
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [DeleteDocument](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DeleteDocument)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ssm#code-examples)中設定和執行。
```
import { DeleteDocumentCommand, SSMClient } from "@aws-sdk/client-ssm";
import { parseArgs } from "node:util";
/**
* Delete an SSM document.
* @param {{ documentName: string }}
*/
export const main = async ({ documentName }) => {
const client = new SSMClient({});
try {
await client.send(new DeleteDocumentCommand({ Name: documentName }));
console.log(`Document '${documentName}' deleted.`);
return { Deleted: true };
} catch (caught) {
if (caught instanceof Error && caught.name === "MissingParameter") {
console.warn(`${caught.message}. Did you provide this value?`);
} else {
throw caught;
}
}
};
```
+ 如需 API 詳細資訊，請參閱《適用於 JavaScript 的 AWS SDK API 參考》**中的 [DeleteDocument](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/DeleteDocumentCommand)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範刪除文件。如果命令成功，則無輸出訊息。**
```
Remove-SSMDocument -Name "RunShellScript"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DeleteDocument](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範刪除文件。如果命令成功，則無輸出訊息。**
```
Remove-SSMDocument -Name "RunShellScript"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DeleteDocument](https://docs.aws.amazon.com/powershell/v5/reference)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/ssm#code-examples)中設定和執行。
```
class DocumentWrapper:
"""Encapsulates AWS Systems Manager Document actions."""
def __init__(self, ssm_client):
"""
:param ssm_client: A Boto3 Systems Manager client.
"""
self.ssm_client = ssm_client
self.name = None
@classmethod
def from_client(cls):
ssm_client = boto3.client("ssm")
return cls(ssm_client)
def delete(self):
"""
Deletes an AWS Systems Manager document.
"""
if self.name is None:
return
try:
self.ssm_client.delete_document(Name=self.name)
print(f"Deleted document {self.name}.")
self.name = None
except ClientError as err:
logger.error(
"Couldn't delete %s. Here's why: %s: %s",
self.name,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [DeleteDocument](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DeleteDocument)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ssm#code-examples)中設定和執行。
```
TRY.
lo_ssm->deletedocument( iv_name = iv_name ).
MESSAGE 'Document deleted.' TYPE 'I'.
CATCH /aws1/cx_ssminvaliddocument.
MESSAGE 'Invalid document.' TYPE 'I'.
CATCH /aws1/cx_ssmassocdinstances.
MESSAGE 'Document has associated instances.' TYPE 'I'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [DeleteDocument](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# `DeleteMaintenanceWindow` 搭配 AWS SDK 或 CLI 使用
<a name="ssm_example_ssm_DeleteMaintenanceWindow_section"></a>
下列程式碼範例示範如何使用 `DeleteMaintenanceWindow`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](ssm_example_ssm_Scenario_section.md)
------
#### [ CLI ]
**AWS CLI**
**刪除維護時段**
此 `delete-maintenance-window` 範例示範移除指定的維護時段。
```
aws ssm delete-maintenance-window \
--window-id "mw-1a2b3c4d5e6f7g8h9"
```
輸出：
```
{
"WindowId":"mw-1a2b3c4d5e6f7g8h9"
}
```
如需詳細資訊，請參閱 *AWS Systems Manager 使用者指南*中的[刪除維護時段 (AWS CLI)](https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-delete-mw.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteMaintenanceWindow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/delete-maintenance-window.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/ssm#code-examples)中設定和執行。
```
/**
* Deletes an AWS SSM Maintenance Window asynchronously.
*
* @param winId The ID of the Maintenance Window to delete.
* <p>
* This method initiates an asynchronous request to delete an SSM Maintenance Window.
* If an exception occurs, it handles the error appropriately.
*/
public void deleteMaintenanceWindow(String winId) {
DeleteMaintenanceWindowRequest windowRequest = DeleteMaintenanceWindowRequest.builder()
.windowId(winId)
.build();
CompletableFuture<Void> future = CompletableFuture.runAsync(() -> {
getAsyncClient().deleteMaintenanceWindow(windowRequest)
.thenAccept(response -> {
System.out.println("The maintenance window was successfully deleted.");
})
.exceptionally(ex -> {
throw new CompletionException(ex);
}).join();
}).exceptionally(ex -> {
Throwable cause = (ex instanceof CompletionException) ? ex.getCause() : ex;
if (cause instanceof SsmException) {
throw new RuntimeException("SSM error: " + cause.getMessage(), cause);
} else {
throw new RuntimeException("Unexpected error: " + cause.getMessage(), cause);
}
});
try {
future.join();
} catch (CompletionException ex) {
throw ex.getCause() instanceof RuntimeException ? (RuntimeException) ex.getCause() : ex;
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [DeleteMaintenanceWindow](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DeleteMaintenanceWindow)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ssm#code-examples)中設定和執行。
```
import { DeleteMaintenanceWindowCommand, SSMClient } from "@aws-sdk/client-ssm";
import { parseArgs } from "node:util";
/**
* Delete an SSM maintenance window.
* @param {{ windowId: string }}
*/
export const main = async ({ windowId }) => {
const client = new SSMClient({});
try {
await client.send(
new DeleteMaintenanceWindowCommand({ WindowId: windowId }),
);
console.log(`Maintenance window '${windowId}' deleted.`);
return { Deleted: true };
} catch (caught) {
if (caught instanceof Error && caught.name === "MissingParameter") {
console.warn(`${caught.message}. Did you provide this value?`);
} else {
throw caught;
}
}
};
```
+ 如需 API 詳細資訊，請參閱《適用於 JavaScript 的 AWS SDK API 參考》**中的 [DeleteMaintenanceWindow](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/DeleteMaintenanceWindowCommand)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範移除維護時段。**
```
Remove-SSMMaintenanceWindow -WindowId "mw-06d59c1a07c022145"
```
**輸出：**
```
mw-06d59c1a07c022145
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DeleteMaintenanceWindow](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範移除維護時段。**
```
Remove-SSMMaintenanceWindow -WindowId "mw-06d59c1a07c022145"
```
**輸出：**
```
mw-06d59c1a07c022145
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DeleteMaintenanceWindow](https://docs.aws.amazon.com/powershell/v5/reference)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/ssm#code-examples)中設定和執行。
```
class MaintenanceWindowWrapper:
"""Encapsulates AWS Systems Manager maintenance window actions."""
def __init__(self, ssm_client):
"""
:param ssm_client: A Boto3 Systems Manager client.
"""
self.ssm_client = ssm_client
self.window_id = None
self.name = None
@classmethod
def from_client(cls):
ssm_client = boto3.client("ssm")
return cls(ssm_client)
def delete(self):
"""
Delete the associated AWS Systems Manager maintenance window.
"""
if self.window_id is None:
return
try:
self.ssm_client.delete_maintenance_window(WindowId=self.window_id)
logger.info("Deleted maintenance window %s.", self.window_id)
print(f"Deleted maintenance window {self.name}")
self.window_id = None
except ClientError as err:
logger.error(
"Couldn't delete maintenance window %s. Here's why: %s: %s",
self.window_id,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [DeleteMaintenanceWindow](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DeleteMaintenanceWindow)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ssm#code-examples)中設定和執行。
```
TRY.
lo_ssm->deletemaintenancewindow( iv_windowid = iv_window_id ).
MESSAGE 'Maintenance window deleted.' TYPE 'I'.
CATCH /aws1/cx_ssminternalservererr.
MESSAGE 'Internal server error occurred.' TYPE 'I'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [DeleteMaintenanceWindow](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# `DeleteOpsItem` 搭配 AWS SDK 使用
<a name="ssm_example_ssm_DeleteOpsItem_section"></a>
下列程式碼範例示範如何使用 `DeleteOpsItem`。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/ssm#code-examples)中設定和執行。
```
class OpsItemWrapper:
"""Encapsulates AWS Systems Manager OpsItem actions."""
def __init__(self, ssm_client):
"""
:param ssm_client: A Boto3 Systems Manager client.
"""
self.ssm_client = ssm_client
self.id = None
@classmethod
def from_client(cls):
"""
:return: A OpsItemWrapper instance.
"""
ssm_client = boto3.client("ssm")
return cls(ssm_client)
def delete(self):
"""
Delete the OpsItem.
"""
if self.id is None:
return
try:
self.ssm_client.delete_ops_item(OpsItemId=self.id)
print(f"Deleted ops item with id {self.id}")
self.id = None
except ClientError as err:
logger.error(
"Couldn't delete ops item %s. Here's why: %s: %s",
self.id,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [DeleteOpsItem](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DeleteOpsItem)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ssm#code-examples)中設定和執行。
```
TRY.
lo_ssm->deleteopsitem( iv_opsitemid = iv_ops_item_id ).
MESSAGE 'OpsItem deleted.' TYPE 'I'.
CATCH /aws1/cx_ssmopsiteminvparamex.
MESSAGE 'Invalid OpsItem parameter.' TYPE 'I'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [DeleteOpsItem](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# 搭配使用 `DeleteParameter` 與 CLI
<a name="ssm_example_ssm_DeleteParameter_section"></a>
下列程式碼範例示範如何使用 `DeleteParameter`。
------
#### [ CLI ]
**AWS CLI**
**刪除參數**
下列 `delete-parameter` 範例示範刪除指定的單個參數。
```
aws ssm delete-parameter \
--name "MyParameter"
```
此命令不會產生輸出。
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Working with Parameter Store](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-working-with.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteParameter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/delete-parameter.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範刪除參數。如果命令成功，則無輸出訊息。**
```
Remove-SSMParameter -Name "helloWorld"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DeleteParameter](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範刪除參數。如果命令成功，則無輸出訊息。**
```
Remove-SSMParameter -Name "helloWorld"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DeleteParameter](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DeletePatchBaseline` 與 CLI
<a name="ssm_example_ssm_DeletePatchBaseline_section"></a>
下列程式碼範例示範如何使用 `DeletePatchBaseline`。
------
#### [ CLI ]
**AWS CLI**
**刪除修補基準**
下列 `delete-patch-baseline` 範例示範刪除指定的修補基準。
```
aws ssm delete-patch-baseline \
--baseline-id "pb-045f10b4f382baeda"
```
輸出：
```
{
"BaselineId": "pb-045f10b4f382baeda"
}
```
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Update or Delete a Patch Baseline (Console)](https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-baseline-update-or-delete.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeletePatchBaseline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/delete-patch-baseline.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範刪除修補基準。**
```
Remove-SSMPatchBaseline -BaselineId "pb-045f10b4f382baeda"
```
**輸出：**
```
pb-045f10b4f382baeda
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DeletePatchBaseline](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範刪除修補基準。**
```
Remove-SSMPatchBaseline -BaselineId "pb-045f10b4f382baeda"
```
**輸出：**
```
pb-045f10b4f382baeda
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DeletePatchBaseline](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DeregisterManagedInstance` 與 CLI
<a name="ssm_example_ssm_DeregisterManagedInstance_section"></a>
下列程式碼範例示範如何使用 `DeregisterManagedInstance`。
------
#### [ CLI ]
**AWS CLI**
**取消註冊受管執行個體**
下列 `deregister-managed-instance` 範例示範取消註冊指定的受管執行個體。
```
aws ssm deregister-managed-instance \
--instance-id 'mi-08ab247cdfEXAMPLE'
```
此命令不會產生輸出。
如需詳細資訊，請參閱《*AWS Systems Manager 使用者指南*》中的[取消註冊混合與多重雲端環境中的受管節點](https://docs.aws.amazon.com/systems-manager/latest/userguide/fleet-manager-deregister-hybrid-nodes.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeregisterManagedInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/deregister-managed-instance.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範取消註冊受管執行個體。如果命令成功，則無輸出訊息。**
```
Unregister-SSMManagedInstance -InstanceId "mi-08ab247cdf1046573"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DeregisterManagedInstance](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範取消註冊受管執行個體。如果命令成功，則無輸出訊息。**
```
Unregister-SSMManagedInstance -InstanceId "mi-08ab247cdf1046573"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DeregisterManagedInstance](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DeregisterPatchBaselineForPatchGroup` 與 CLI
<a name="ssm_example_ssm_DeregisterPatchBaselineForPatchGroup_section"></a>
下列程式碼範例示範如何使用 `DeregisterPatchBaselineForPatchGroup`。
------
#### [ CLI ]
**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"
}
```
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Add a Patch Group to a Patch Baseline](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-patch-group-patchbaseline.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeregisterPatchBaselineForPatchGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/deregister-patch-baseline-for-patch-group.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範從修補基準中取消註冊修補程式群組。**
```
Unregister-SSMPatchBaselineForPatchGroup -BaselineId "pb-045f10b4f382baeda" -PatchGroup "Production"
```
**輸出：**
```
BaselineId PatchGroup
---------- ----------
pb-045f10b4f382baeda Production
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DeregisterPatchBaselineForPatchGroup](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範從修補基準中取消註冊修補程式群組。**
```
Unregister-SSMPatchBaselineForPatchGroup -BaselineId "pb-045f10b4f382baeda" -PatchGroup "Production"
```
**輸出：**
```
BaselineId PatchGroup
---------- ----------
pb-045f10b4f382baeda Production
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DeregisterPatchBaselineForPatchGroup](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DeregisterTargetFromMaintenanceWindow` 與 CLI
<a name="ssm_example_ssm_DeregisterTargetFromMaintenanceWindow_section"></a>
下列程式碼範例示範如何使用 `DeregisterTargetFromMaintenanceWindow`。
------
#### [ CLI ]
**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"
}
```
如需詳細資訊，請參閱 *AWS Systems Manager 使用者指南*中的[更新維護時段 (AWS CLI)](https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-cli-tutorials-update.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeregisterTargetFromMaintenanceWindow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/deregister-target-from-maintenance-window.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範從維護時段中移除目標。**
```
Unregister-SSMTargetFromMaintenanceWindow -WindowTargetId "6ab5c208-9fc4-4697-84b7-b02a6cc25f7d" -WindowId "mw-06cf17cbefcb4bf4f"
```
**輸出：**
```
WindowId WindowTargetId
-------- --------------
mw-06cf17cbefcb4bf4f 6ab5c208-9fc4-4697-84b7-b02a6cc25f7d
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DeregisterTargetFromMaintenanceWindow](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範從維護時段中移除目標。**
```
Unregister-SSMTargetFromMaintenanceWindow -WindowTargetId "6ab5c208-9fc4-4697-84b7-b02a6cc25f7d" -WindowId "mw-06cf17cbefcb4bf4f"
```
**輸出：**
```
WindowId WindowTargetId
-------- --------------
mw-06cf17cbefcb4bf4f 6ab5c208-9fc4-4697-84b7-b02a6cc25f7d
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DeregisterTargetFromMaintenanceWindow](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DeregisterTaskFromMaintenanceWindow` 與 CLI
<a name="ssm_example_ssm_DeregisterTaskFromMaintenanceWindow_section"></a>
下列程式碼範例示範如何使用 `DeregisterTaskFromMaintenanceWindow`。
------
#### [ CLI ]
**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 維護 Windows 教學課程 (AWS CLI)](https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-tutorials.html)。 *AWS *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeregisterTaskFromMaintenanceWindow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/deregister-task-from-maintenance-window.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範從維護時段中移除任務。**
```
Unregister-SSMTaskFromMaintenanceWindow -WindowTaskId "f34a2c47-ddfd-4c85-a88d-72366b69af1b" -WindowId "mw-03a342e62c96d31b0"
```
**輸出：**
```
WindowId WindowTaskId
-------- ------------
mw-03a342e62c96d31b0 f34a2c47-ddfd-4c85-a88d-72366b69af1b
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DeregisterTaskFromMaintenanceWindow](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範從維護時段中移除任務。**
```
Unregister-SSMTaskFromMaintenanceWindow -WindowTaskId "f34a2c47-ddfd-4c85-a88d-72366b69af1b" -WindowId "mw-03a342e62c96d31b0"
```
**輸出：**
```
WindowId WindowTaskId
-------- ------------
mw-03a342e62c96d31b0 f34a2c47-ddfd-4c85-a88d-72366b69af1b
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DeregisterTaskFromMaintenanceWindow](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DescribeActivations` 與 CLI
<a name="ssm_example_ssm_DescribeActivations_section"></a>
下列程式碼範例示範如何使用 `DescribeActivations`。
------
#### [ CLI ]
**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 使用者指南》**中的 [Step 4: Create a Managed-Instance Activation for a Hybrid Environment](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-managed-instance-activation.html)。
+ 如需 API 詳細資訊，請參閱*《AWS CLI 命令參考》*中的 [DescribeActivations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/describe-activations.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例提供有關您帳戶中啟用的詳細資訊。**
```
Get-SSMActivation
```
**輸出：**
```
ActivationId : 08e51e79-1e36-446c-8e63-9458569c1363
CreatedDate : 3/1/2017 12:01:51 AM
DefaultInstanceName : MyWebServers
Description :
ExpirationDate : 3/2/2017 12:01:51 AM
Expired : False
IamRole : AutomationRole
RegistrationLimit : 10
RegistrationsCount : 0
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeActivations](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例提供有關您帳戶中啟用的詳細資訊。**
```
Get-SSMActivation
```
**輸出：**
```
ActivationId : 08e51e79-1e36-446c-8e63-9458569c1363
CreatedDate : 3/1/2017 12:01:51 AM
DefaultInstanceName : MyWebServers
Description :
ExpirationDate : 3/2/2017 12:01:51 AM
Expired : False
IamRole : AutomationRole
RegistrationLimit : 10
RegistrationsCount : 0
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeActivations](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DescribeAssociation` 與 CLI
<a name="ssm_example_ssm_DescribeAssociation_section"></a>
下列程式碼範例示範如何使用 `DescribeAssociation`。
------
#### [ CLI ]
**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"
}
}
```
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南*》*中的 [Editing and creating a new version of an association](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-state-assoc-edit.html)。
**範例 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"
}
]
}
}
```
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南*》*中的 [Editing and creating a new version of an association](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-state-assoc-edit.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/describe-association.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例說明執行個體與文件之間的關聯。**
```
Get-SSMAssociation -InstanceId "i-0000293ffd8c57862" -Name "AWS-UpdateSSMAgent"
```
**輸出：**
```
Name : AWS-UpdateSSMAgent
InstanceId : i-0000293ffd8c57862
Date : 2/23/2017 6:55:22 PM
Status.Name : Pending
Status.Date : 2/20/2015 8:31:11 AM
Status.Message : temp_status_change
Status.AdditionalInfo : Additional-Config-Needed
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeAssociation](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例說明執行個體與文件之間的關聯。**
```
Get-SSMAssociation -InstanceId "i-0000293ffd8c57862" -Name "AWS-UpdateSSMAgent"
```
**輸出：**
```
Name : AWS-UpdateSSMAgent
InstanceId : i-0000293ffd8c57862
Date : 2/23/2017 6:55:22 PM
Status.Name : Pending
Status.Date : 2/20/2015 8:31:11 AM
Status.Message : temp_status_change
Status.AdditionalInfo : Additional-Config-Needed
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeAssociation](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DescribeAssociationExecutionTargets` 與 CLI
<a name="ssm_example_ssm_DescribeAssociationExecutionTargets_section"></a>
下列程式碼範例示範如何使用 `DescribeAssociationExecutionTargets`。
------
#### [ CLI ]
**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"
}
}
]
}
```
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Viewing association histories](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-state-assoc-history.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeAssociationExecutionTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/describe-association-execution-targets.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例顯示資源 ID 及其執行狀態，它們是關聯執行目標的一部分**
```
Get-SSMAssociationExecutionTarget -AssociationId 123a45a0-c678-9012-3456-78901234db5e -ExecutionId 123a45a0-c678-9012-3456-78901234db5e | Select-Object ResourceId, Status
```
**輸出：**
```
ResourceId Status
---------- ------
i-0b1b2a3456f7a890b Success
i-01c12a45d6fc7a89f Success
i-0a1caf234f56d7dc8 Success
i-012a3fd45af6dbcfe Failed
i-0ddc1df23c4a5fb67 Success
```
**範例 2：此命令會檢查自昨天以來特定自動化的特定執行，其中關聯有命令文件。它會進一步檢查關聯執行是否失敗，如果是，則會顯示該執行的命令調用詳細資訊以及執行個體 ID**
```
$AssociationExecution= Get-SSMAssociationExecutionTarget -AssociationId 1c234567-890f-1aca-a234-5a678d901cb0 -ExecutionId 12345ca12-3456-2345-2b45-23456789012 |
Where-Object {$_.LastExecutionDate -gt (Get-Date -Hour 00 -Minute 00).AddDays(-1)}
foreach ($execution in $AssociationExecution) {
if($execution.Status -ne 'Success'){
Write-Output "There was an issue executing the association $($execution.AssociationId) on $($execution.ResourceId)"
Get-SSMCommandInvocation -CommandId $execution.OutputSource.OutputSourceId -Detail:$true | Select-Object -ExpandProperty CommandPlugins
}
}
```
**輸出：**
```
There was an issue executing the association 1c234567-890f-1aca-a234-5a678d901cb0 on i-0a1caf234f56d7dc8
Name : aws:runPowerShellScript
Output :
----------ERROR-------
failed to run commands: exit status 1
OutputS3BucketName :
OutputS3KeyPrefix :
OutputS3Region : eu-west-1
ResponseCode : 1
ResponseFinishDateTime : 5/29/2019 11:04:49 AM
ResponseStartDateTime : 5/29/2019 11:04:49 AM
StandardErrorUrl :
StandardOutputUrl :
Status : Failed
StatusDetails : Failed
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeAssociationExecutionTargets](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例顯示資源 ID 及其執行狀態，它們是關聯執行目標的一部分**
```
Get-SSMAssociationExecutionTarget -AssociationId 123a45a0-c678-9012-3456-78901234db5e -ExecutionId 123a45a0-c678-9012-3456-78901234db5e | Select-Object ResourceId, Status
```
**輸出：**
```
ResourceId Status
---------- ------
i-0b1b2a3456f7a890b Success
i-01c12a45d6fc7a89f Success
i-0a1caf234f56d7dc8 Success
i-012a3fd45af6dbcfe Failed
i-0ddc1df23c4a5fb67 Success
```
**範例 2：此命令會檢查自昨天以來特定自動化的特定執行，其中關聯有命令文件。它會進一步檢查關聯執行是否失敗，如果是，則會顯示該執行的命令調用詳細資訊以及執行個體 ID**
```
$AssociationExecution= Get-SSMAssociationExecutionTarget -AssociationId 1c234567-890f-1aca-a234-5a678d901cb0 -ExecutionId 12345ca12-3456-2345-2b45-23456789012 |
Where-Object {$_.LastExecutionDate -gt (Get-Date -Hour 00 -Minute 00).AddDays(-1)}
foreach ($execution in $AssociationExecution) {
if($execution.Status -ne 'Success'){
Write-Output "There was an issue executing the association $($execution.AssociationId) on $($execution.ResourceId)"
Get-SSMCommandInvocation -CommandId $execution.OutputSource.OutputSourceId -Detail:$true | Select-Object -ExpandProperty CommandPlugins
}
}
```
**輸出：**
```
There was an issue executing the association 1c234567-890f-1aca-a234-5a678d901cb0 on i-0a1caf234f56d7dc8
Name : aws:runPowerShellScript
Output :
----------ERROR-------
failed to run commands: exit status 1
OutputS3BucketName :
OutputS3KeyPrefix :
OutputS3Region : eu-west-1
ResponseCode : 1
ResponseFinishDateTime : 5/29/2019 11:04:49 AM
ResponseStartDateTime : 5/29/2019 11:04:49 AM
StandardErrorUrl :
StandardOutputUrl :
Status : Failed
StatusDetails : Failed
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeAssociationExecutionTargets](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DescribeAssociationExecutions` 與 CLI
<a name="ssm_example_ssm_DescribeAssociationExecutions_section"></a>
下列程式碼範例示範如何使用 `DescribeAssociationExecutions`。
------
#### [ CLI ]
**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}"
},
...
]
}
```
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Viewing association histories](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-state-assoc-history.html)。
**範例 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}"
},
...
]
}
```
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Viewing association histories](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-state-assoc-history.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeAssociationExecutions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/describe-association-executions.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例傳回所提供關聯 ID 的執行**
```
Get-SSMAssociationExecution -AssociationId 123a45a0-c678-9012-3456-78901234db5e
```
**輸出：**
```
AssociationId : 123a45a0-c678-9012-3456-78901234db5e
AssociationVersion : 2
CreatedTime : 3/2/2019 8:53:29 AM
DetailedStatus :
ExecutionId : 123a45a0-c678-9012-3456-78901234db5e
LastExecutionDate : 1/1/0001 12:00:00 AM
ResourceCountByStatus : {Success=4}
Status : Success
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeAssociationExecutions](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例傳回所提供關聯 ID 的執行**
```
Get-SSMAssociationExecution -AssociationId 123a45a0-c678-9012-3456-78901234db5e
```
**輸出：**
```
AssociationId : 123a45a0-c678-9012-3456-78901234db5e
AssociationVersion : 2
CreatedTime : 3/2/2019 8:53:29 AM
DetailedStatus :
ExecutionId : 123a45a0-c678-9012-3456-78901234db5e
LastExecutionDate : 1/1/0001 12:00:00 AM
ResourceCountByStatus : {Success=4}
Status : Success
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeAssociationExecutions](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DescribeAutomationExecutions` 與 CLI
<a name="ssm_example_ssm_DescribeAutomationExecutions_section"></a>
下列程式碼範例示範如何使用 `DescribeAutomationExecutions`。
------
#### [ CLI ]
**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"
}
]
}
```
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Running a Simple Automation Workflow](https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-working-executing.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeAutomationExecutions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/describe-automation-executions.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例說明與帳戶關聯的所有作用中和已終止的自動化執行。**
```
Get-SSMAutomationExecutionList
```
**輸出：**
```
AutomationExecutionId : 4105a4fc-f944-11e6-9d32-8fb2db27a909
AutomationExecutionStatus : Failed
DocumentName : AWS-UpdateLinuxAmi
DocumentVersion : 1
ExecutedBy : admin
ExecutionEndTime : 2/22/2017 9:17:08 PM
ExecutionStartTime : 2/22/2017 9:17:02 PM
LogFile :
Outputs : {[createImage.ImageId, Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]]}
```
**範例 2：此範例顯示具有 AutomationExecutionStatus 而非 "Success" 之執行的 ExecutionID、文件、執行開始/結束時間戳記**
```
Get-SSMAutomationExecutionList | Where-Object AutomationExecutionStatus -ne "Success" | Select-Object AutomationExecutionId, DocumentName, AutomationExecutionStatus, ExecutionStartTime, ExecutionEndTime | Format-Table -AutoSize
```
**輸出：**
```
AutomationExecutionId DocumentName AutomationExecutionStatus ExecutionStartTime ExecutionEndTime
--------------------- ------------ ------------------------- ------------------ ----------------
e1d2bad3-4567-8901-ae23-456c7c8901be AWS-UpdateWindowsAmi Cancelled 4/16/2019 5:37:04 AM 4/16/2019 5:47:29 AM
61234567-a7f8-90e1-2b34-567b8bf9012c Fixed-UpdateAmi Cancelled 4/16/2019 5:33:04 AM 4/16/2019 5:40:15 AM
91234d56-7e89-0ac1-2aee-34ea5d6a7c89 AWS-UpdateWindowsAmi Failed 4/16/2019 5:22:46 AM 4/16/2019 5:27:29 AM
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeAutomationExecutions](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例說明與帳戶關聯的所有作用中和已終止的自動化執行。**
```
Get-SSMAutomationExecutionList
```
**輸出：**
```
AutomationExecutionId : 4105a4fc-f944-11e6-9d32-8fb2db27a909
AutomationExecutionStatus : Failed
DocumentName : AWS-UpdateLinuxAmi
DocumentVersion : 1
ExecutedBy : admin
ExecutionEndTime : 2/22/2017 9:17:08 PM
ExecutionStartTime : 2/22/2017 9:17:02 PM
LogFile :
Outputs : {[createImage.ImageId, Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]]}
```
**範例 2：此範例顯示具有 AutomationExecutionStatus 而非 "Success" 之執行的 ExecutionID、文件、執行開始/結束時間戳記**
```
Get-SSMAutomationExecutionList | Where-Object AutomationExecutionStatus -ne "Success" | Select-Object AutomationExecutionId, DocumentName, AutomationExecutionStatus, ExecutionStartTime, ExecutionEndTime | Format-Table -AutoSize
```
**輸出：**
```
AutomationExecutionId DocumentName AutomationExecutionStatus ExecutionStartTime ExecutionEndTime
--------------------- ------------ ------------------------- ------------------ ----------------
e1d2bad3-4567-8901-ae23-456c7c8901be AWS-UpdateWindowsAmi Cancelled 4/16/2019 5:37:04 AM 4/16/2019 5:47:29 AM
61234567-a7f8-90e1-2b34-567b8bf9012c Fixed-UpdateAmi Cancelled 4/16/2019 5:33:04 AM 4/16/2019 5:40:15 AM
91234d56-7e89-0ac1-2aee-34ea5d6a7c89 AWS-UpdateWindowsAmi Failed 4/16/2019 5:22:46 AM 4/16/2019 5:27:29 AM
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeAutomationExecutions](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DescribeAutomationStepExecutions` 與 CLI
<a name="ssm_example_ssm_DescribeAutomationStepExecutions_section"></a>
下列程式碼範例示範如何使用 `DescribeAutomationStepExecutions`。
------
#### [ CLI ]
**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
```
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Running an Automation Workflow Step by Step (Command Line)](https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-working-executing-manually.html#automation-working-executing-manually-commandline)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeAutomationStepExecutions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/describe-automation-step-executions.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例顯示有關自動化工作流程中所有作用中和已終止之步驟執行的資訊。**
```
Get-SSMAutomationStepExecution -AutomationExecutionId e1d2bad3-4567-8901-ae23-456c7c8901be | Select-Object StepName, Action, StepStatus
```
**輸出：**
```
StepName Action StepStatus
-------- ------ ----------
LaunchInstance aws:runInstances Success
OSCompatibilityCheck aws:runCommand Success
RunPreUpdateScript aws:runCommand Success
UpdateEC2Config aws:runCommand Cancelled
UpdateSSMAgent aws:runCommand Pending
UpdateAWSPVDriver aws:runCommand Pending
UpdateAWSEnaNetworkDriver aws:runCommand Pending
UpdateAWSNVMe aws:runCommand Pending
InstallWindowsUpdates aws:runCommand Pending
RunPostUpdateScript aws:runCommand Pending
RunSysprepGeneralize aws:runCommand Pending
StopInstance aws:changeInstanceState Pending
CreateImage aws:createImage Pending
TerminateInstance aws:changeInstanceState Pending
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeAutomationStepExecutions](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例顯示有關自動化工作流程中所有作用中和已終止之步驟執行的資訊。**
```
Get-SSMAutomationStepExecution -AutomationExecutionId e1d2bad3-4567-8901-ae23-456c7c8901be | Select-Object StepName, Action, StepStatus
```
**輸出：**
```
StepName Action StepStatus
-------- ------ ----------
LaunchInstance aws:runInstances Success
OSCompatibilityCheck aws:runCommand Success
RunPreUpdateScript aws:runCommand Success
UpdateEC2Config aws:runCommand Cancelled
UpdateSSMAgent aws:runCommand Pending
UpdateAWSPVDriver aws:runCommand Pending
UpdateAWSEnaNetworkDriver aws:runCommand Pending
UpdateAWSNVMe aws:runCommand Pending
InstallWindowsUpdates aws:runCommand Pending
RunPostUpdateScript aws:runCommand Pending
RunSysprepGeneralize aws:runCommand Pending
StopInstance aws:changeInstanceState Pending
CreateImage aws:createImage Pending
TerminateInstance aws:changeInstanceState Pending
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeAutomationStepExecutions](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DescribeAvailablePatches` 與 CLI
<a name="ssm_example_ssm_DescribeAvailablePatches_section"></a>
下列程式碼範例示範如何使用 `DescribeAvailablePatches`。
------
#### [ CLI ]
**AWS CLI**
**取得可用的修補程式**
下列 `describe-available-patches` 範例擷取有關適用於 Windows Server 2019 的所有可用修補程式的詳細資訊，這些修補程式的 MSRC 嚴重性為「關鍵」。
```
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"
}
]
}
```
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [How Patch Manager Operations Work](https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-how-it-works.html)。
+ 如需 API 詳細資訊，請參閱*《AWS CLI 命令參考》*中的 [DescribeAvailablePatches](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/describe-available-patches.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範取得適用於 Windows Server 2012 的所有可用修補程式，這些修補程式的 MSRC 嚴重性為「關鍵」。此範例使用的語法需要 PowerShell 版本 3 或更新版本。**
```
$filter1 = @{Key="PRODUCT";Values=@("WindowsServer2012")}
$filter2 = @{Key="MSRC_SEVERITY";Values=@("Critical")}
Get-SSMAvailablePatch -Filter $filter1,$filter2
```
**輸出：**
```
Classification : SecurityUpdates
ContentUrl : https://support.microsoft.com/en-us/kb/2727528
Description : A security issue has been identified that could allow an unauthenticated remote attacker to compromise your system and gain control
over it. You can help protect your system by installing this update from Microsoft. After you install this update, you may have to
restart your system.
Id : 1eb507be-2040-4eeb-803d-abc55700b715
KbNumber : KB2727528
Language : All
MsrcNumber : MS12-072
MsrcSeverity : Critical
Product : WindowsServer2012
ProductFamily : Windows
ReleaseDate : 11/13/2012 6:00:00 PM
Title : Security Update for Windows Server 2012 (KB2727528)
Vendor : Microsoft
...
```
**範例 2：使用 PowerShell 版本 2 時，必須使用 New-Object 來建立每個篩選條件。**
```
$filter1 = New-Object Amazon.SimpleSystemsManagement.Model.PatchOrchestratorFilter
$filter1.Key = "PRODUCT"
$filter1.Values = "WindowsServer2012"
$filter2 = New-Object Amazon.SimpleSystemsManagement.Model.PatchOrchestratorFilter
$filter2.Key = "MSRC_SEVERITY"
$filter2.Values = "Critical"
Get-SSMAvailablePatch -Filter $filter1,$filter2
```
**範例 3：此範例示範擷取過去 20 天內發行並適用於符合 WindowsServer2019 的產品的所有更新**
```
Get-SSMAvailablePatch | Where-Object ReleaseDate -ge (Get-Date).AddDays(-20) | Where-Object Product -eq "WindowsServer2019" | Select-Object ReleaseDate, Product, Title
```
**輸出：**
```
ReleaseDate Product Title
----------- ------- -----
4/9/2019 5:00:12 PM WindowsServer2019 2019-04 Security Update for Adobe Flash Player for Windows Server 2019 for x64-based Systems (KB4493478)
4/9/2019 5:00:06 PM WindowsServer2019 2019-04 Cumulative Update for Windows Server 2019 for x64-based Systems (KB4493509)
4/2/2019 5:00:06 PM WindowsServer2019 2019-03 Servicing Stack Update for Windows Server 2019 for x64-based Systems (KB4493510)
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeAvailablePatches](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範取得適用於 Windows Server 2012 的所有可用修補程式，這些修補程式的 MSRC 嚴重性為「關鍵」。此範例使用的語法需要 PowerShell 版本 3 或更新版本。**
```
$filter1 = @{Key="PRODUCT";Values=@("WindowsServer2012")}
$filter2 = @{Key="MSRC_SEVERITY";Values=@("Critical")}
Get-SSMAvailablePatch -Filter $filter1,$filter2
```
**輸出：**
```
Classification : SecurityUpdates
ContentUrl : https://support.microsoft.com/en-us/kb/2727528
Description : A security issue has been identified that could allow an unauthenticated remote attacker to compromise your system and gain control
over it. You can help protect your system by installing this update from Microsoft. After you install this update, you may have to
restart your system.
Id : 1eb507be-2040-4eeb-803d-abc55700b715
KbNumber : KB2727528
Language : All
MsrcNumber : MS12-072
MsrcSeverity : Critical
Product : WindowsServer2012
ProductFamily : Windows
ReleaseDate : 11/13/2012 6:00:00 PM
Title : Security Update for Windows Server 2012 (KB2727528)
Vendor : Microsoft
...
```
**範例 2：使用 PowerShell 版本 2 時，必須使用 New-Object 來建立每個篩選條件。**
```
$filter1 = New-Object Amazon.SimpleSystemsManagement.Model.PatchOrchestratorFilter
$filter1.Key = "PRODUCT"
$filter1.Values = "WindowsServer2012"
$filter2 = New-Object Amazon.SimpleSystemsManagement.Model.PatchOrchestratorFilter
$filter2.Key = "MSRC_SEVERITY"
$filter2.Values = "Critical"
Get-SSMAvailablePatch -Filter $filter1,$filter2
```
**範例 3：此範例示範擷取過去 20 天內發行並適用於符合 WindowsServer2019 的產品的所有更新**
```
Get-SSMAvailablePatch | Where-Object ReleaseDate -ge (Get-Date).AddDays(-20) | Where-Object Product -eq "WindowsServer2019" | Select-Object ReleaseDate, Product, Title
```
**輸出：**
```
ReleaseDate Product Title
----------- ------- -----
4/9/2019 5:00:12 PM WindowsServer2019 2019-04 Security Update for Adobe Flash Player for Windows Server 2019 for x64-based Systems (KB4493478)
4/9/2019 5:00:06 PM WindowsServer2019 2019-04 Cumulative Update for Windows Server 2019 for x64-based Systems (KB4493509)
4/2/2019 5:00:06 PM WindowsServer2019 2019-03 Servicing Stack Update for Windows Server 2019 for x64-based Systems (KB4493510)
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeAvailablePatches](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# `DescribeDocument` 搭配 AWS SDK 或 CLI 使用
<a name="ssm_example_ssm_DescribeDocument_section"></a>
下列程式碼範例示範如何使用 `DescribeDocument`。
------
#### [ CLI ]
**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": []
}
}
```
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Creating Systems Manager Documents](https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-doc.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeDocument](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/describe-document.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例傳回文件的相關資訊。**
```
Get-SSMDocumentDescription -Name "RunShellScript"
```
**輸出：**
```
CreatedDate : 2/24/2017 5:25:13 AM
DefaultVersion : 1
Description : Run an updated script
DocumentType : Command
DocumentVersion : 1
Hash : f775e5df4904c6fa46686c4722fae9de1950dace25cd9608ff8d622046b68d9b
HashType : Sha256
LatestVersion : 1
Name : RunShellScript
Owner : 123456789012
Parameters : {commands}
PlatformTypes : {Linux}
SchemaVersion : 2.0
Sha1 :
Status : Active
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeDocument](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例傳回文件的相關資訊。**
```
Get-SSMDocumentDescription -Name "RunShellScript"
```
**輸出：**
```
CreatedDate : 2/24/2017 5:25:13 AM
DefaultVersion : 1
Description : Run an updated script
DocumentType : Command
DocumentVersion : 1
Hash : f775e5df4904c6fa46686c4722fae9de1950dace25cd9608ff8d622046b68d9b
HashType : Sha256
LatestVersion : 1
Name : RunShellScript
Owner : 123456789012
Parameters : {commands}
PlatformTypes : {Linux}
SchemaVersion : 2.0
Sha1 :
Status : Active
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeDocument](https://docs.aws.amazon.com/powershell/v5/reference)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ssm#code-examples)中設定和執行。
```
TRY.
DATA(lo_result) = lo_ssm->describedocument( iv_name = iv_name ).
DATA(lo_document) = lo_result->get_document( ).
IF lo_document IS BOUND.
rv_status = lo_document->get_status( ).
MESSAGE |Document status: { rv_status }| TYPE 'I'.
ENDIF.
CATCH /aws1/cx_ssminvaliddocument.
MESSAGE 'Invalid document.' TYPE 'I'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [DescribeDocument](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# 搭配使用 `DescribeDocumentPermission` 與 CLI
<a name="ssm_example_ssm_DescribeDocumentPermission_section"></a>
下列程式碼範例示範如何使用 `DescribeDocumentPermission`。
------
#### [ CLI ]
**AWS CLI**
**描述文件許可**
下列 `describe-document-permission` 範例顯示有關公開共用之 Systems Manager 文件的許可詳細資訊。
```
aws ssm describe-document-permission \
--name "Example" \
--permission-type "Share"
```
輸出：
```
{
"AccountIds": [
"all"
],
"AccountSharingInfoList": [
{
"AccountId": "all",
"SharedDocumentVersion": "$DEFAULT"
}
]
}
```
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Share a Systems Manager Document](https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-how-to-share.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeDocumentPermission](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/describe-document-permission.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例列出了文件的所有版本。**
```
Get-SSMDocumentVersionList -Name "RunShellScript"
```
**輸出：**
```
CreatedDate DocumentVersion IsDefaultVersion Name
----------- --------------- ---------------- ----
2/24/2017 5:25:13 AM 1 True RunShellScript
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeDocumentPermission](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例列出了文件的所有版本。**
```
Get-SSMDocumentVersionList -Name "RunShellScript"
```
**輸出：**
```
CreatedDate DocumentVersion IsDefaultVersion Name
----------- --------------- ---------------- ----
2/24/2017 5:25:13 AM 1 True RunShellScript
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeDocumentPermission](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DescribeEffectiveInstanceAssociations` 與 CLI
<a name="ssm_example_ssm_DescribeEffectiveInstanceAssociations_section"></a>
下列程式碼範例示範如何使用 `DescribeEffectiveInstanceAssociations`。
------
#### [ CLI ]
**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"
}
]
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeEffectiveInstanceAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/describe-effective-instance-associations.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例說明執行個體的有效關聯。**
```
Get-SSMEffectiveInstanceAssociationList -InstanceId "i-0000293ffd8c57862" -MaxResult 5
```
**輸出：**
```
AssociationId Content
------------- -------
d8617c07-2079-4c18-9847-1655fc2698b0 {...
```
**範例 2：此範例顯示執行個體有效關聯的內容。**
```
(Get-SSMEffectiveInstanceAssociationList -InstanceId "i-0000293ffd8c57862" -MaxResult 5).Content
```
**輸出：**
```
{
"schemaVersion": "1.2",
"description": "Update the Amazon SSM Agent to the latest version or specified version.",
"parameters": {
"version": {
"default": "",
"description": "(Optional) A specific version of the Amazon SSM Agent to install. If not specified, the agen
t will be updated to the latest version.",
"type": "String"
},
"allowDowngrade": {
"default": "false",
"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.",
"type": "String",
"allowedValues": [
"true",
"false"
]
}
},
"runtimeConfig": {
"aws:updateSsmAgent": {
"properties": [
{
"agentName": "amazon-ssm-agent",
"source": "https://s3.{Region}.amazonaws.com/amazon-ssm-{Region}/ssm-agent-manifest.json",
"allowDowngrade": "{{ allowDowngrade }}",
"targetVersion": "{{ version }}"
}
]
}
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeEffectiveInstanceAssociations](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例說明執行個體的有效關聯。**
```
Get-SSMEffectiveInstanceAssociationList -InstanceId "i-0000293ffd8c57862" -MaxResult 5
```
**輸出：**
```
AssociationId Content
------------- -------
d8617c07-2079-4c18-9847-1655fc2698b0 {...
```
**範例 2：此範例顯示執行個體有效關聯的內容。**
```
(Get-SSMEffectiveInstanceAssociationList -InstanceId "i-0000293ffd8c57862" -MaxResult 5).Content
```
**輸出：**
```
{
"schemaVersion": "1.2",
"description": "Update the Amazon SSM Agent to the latest version or specified version.",
"parameters": {
"version": {
"default": "",
"description": "(Optional) A specific version of the Amazon SSM Agent to install. If not specified, the agen
t will be updated to the latest version.",
"type": "String"
},
"allowDowngrade": {
"default": "false",
"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.",
"type": "String",
"allowedValues": [
"true",
"false"
]
}
},
"runtimeConfig": {
"aws:updateSsmAgent": {
"properties": [
{
"agentName": "amazon-ssm-agent",
"source": "https://s3.{Region}.amazonaws.com/amazon-ssm-{Region}/ssm-agent-manifest.json",
"allowDowngrade": "{{ allowDowngrade }}",
"targetVersion": "{{ version }}"
}
]
}
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeEffectiveInstanceAssociations](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DescribeEffectivePatchesForPatchBaseline` 與 CLI
<a name="ssm_example_ssm_DescribeEffectivePatchesForPatchBaseline_section"></a>
下列程式碼範例示範如何使用 `DescribeEffectivePatchesForPatchBaseline`。
------
#### [ CLI ]
**AWS CLI**
**範例 1：取得由自訂修補基準定義的所有修補程式**
下列`describe-effective-patches-for-patch-baseline`範例會傳回目前 AWS 帳戶中自訂修補程式基準定義的修補程式。請注意，對於自訂基準，`--baseline-id` 只需要 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 使用者指南》**中的 [How Security Patches Are Selected](https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-how-it-works-selection.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeEffectivePatchesForPatchBaseline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/describe-effective-patches-for-patch-baseline.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例列出了所有修補基準，結果清單上限為 1。**
```
Get-SSMEffectivePatchesForPatchBaseline -BaselineId "pb-0a2f1059b670ebd31" -MaxResult 1
```
**輸出：**
```
Patch PatchStatus
----- -----------
Amazon.SimpleSystemsManagement.Model.Patch Amazon.SimpleSystemsManagement.Model.PatchStatus
```
**範例 2：此範例顯示所有修補基準的修補程式狀態，結果清單上限為 1。**
```
(Get-SSMEffectivePatchesForPatchBaseline -BaselineId "pb-0a2f1059b670ebd31" -MaxResult 1).PatchStatus
```
**輸出：**
```
ApprovalDate DeploymentStatus
------------ ----------------
12/21/2010 6:00:00 PM APPROVED
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeEffectivePatchesForPatchBaseline](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例列出了所有修補基準，結果清單上限為 1。**
```
Get-SSMEffectivePatchesForPatchBaseline -BaselineId "pb-0a2f1059b670ebd31" -MaxResult 1
```
**輸出：**
```
Patch PatchStatus
----- -----------
Amazon.SimpleSystemsManagement.Model.Patch Amazon.SimpleSystemsManagement.Model.PatchStatus
```
**範例 2：此範例顯示所有修補基準的修補程式狀態，結果清單上限為 1。**
```
(Get-SSMEffectivePatchesForPatchBaseline -BaselineId "pb-0a2f1059b670ebd31" -MaxResult 1).PatchStatus
```
**輸出：**
```
ApprovalDate DeploymentStatus
------------ ----------------
12/21/2010 6:00:00 PM APPROVED
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeEffectivePatchesForPatchBaseline](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DescribeInstanceAssociationsStatus` 與 CLI
<a name="ssm_example_ssm_DescribeInstanceAssociationsStatus_section"></a>
下列程式碼範例示範如何使用 `DescribeInstanceAssociationsStatus`。
------
#### [ CLI ]
**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"
}
]
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeInstanceAssociationsStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/describe-instance-associations-status.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例顯示執行個體關聯的詳細資訊。**
```
Get-SSMInstanceAssociationsStatus -InstanceId "i-0000293ffd8c57862"
```
**輸出：**
```
AssociationId : d8617c07-2079-4c18-9847-1655fc2698b0
DetailedStatus : Pending
DocumentVersion : 1
ErrorCode :
ExecutionDate : 2/20/2015 8:31:11 AM
ExecutionSummary : temp_status_change
InstanceId : i-0000293ffd8c57862
Name : AWS-UpdateSSMAgent
OutputUrl :
Status : Pending
```
**範例 2：此範例檢查指定執行個體 ID 的執行個體關聯狀態，並進一步顯示這些關聯的執行狀態**
```
Get-SSMInstanceAssociationsStatus -InstanceId i-012e3cb4df567e8aa | ForEach-Object {Get-SSMAssociationExecution -AssociationId .AssociationId}
```
**輸出：**
```
AssociationId : 512a34a5-c678-1234-1234-12345678db9e
AssociationVersion : 2
CreatedTime : 3/2/2019 8:53:29 AM
DetailedStatus :
ExecutionId : 512a34a5-c678-1234-1234-12345678db9e
LastExecutionDate : 1/1/0001 12:00:00 AM
ResourceCountByStatus : {Success=9}
Status : Success
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeInstanceAssociationsStatus](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例顯示執行個體關聯的詳細資訊。**
```
Get-SSMInstanceAssociationsStatus -InstanceId "i-0000293ffd8c57862"
```
**輸出：**
```
AssociationId : d8617c07-2079-4c18-9847-1655fc2698b0
DetailedStatus : Pending
DocumentVersion : 1
ErrorCode :
ExecutionDate : 2/20/2015 8:31:11 AM
ExecutionSummary : temp_status_change
InstanceId : i-0000293ffd8c57862
Name : AWS-UpdateSSMAgent
OutputUrl :
Status : Pending
```
**範例 2：此範例檢查指定執行個體 ID 的執行個體關聯狀態，並進一步顯示這些關聯的執行狀態**
```
Get-SSMInstanceAssociationsStatus -InstanceId i-012e3cb4df567e8aa | ForEach-Object {Get-SSMAssociationExecution -AssociationId .AssociationId}
```
**輸出：**
```
AssociationId : 512a34a5-c678-1234-1234-12345678db9e
AssociationVersion : 2
CreatedTime : 3/2/2019 8:53:29 AM
DetailedStatus :
ExecutionId : 512a34a5-c678-1234-1234-12345678db9e
LastExecutionDate : 1/1/0001 12:00:00 AM
ResourceCountByStatus : {Success=9}
Status : Success
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeInstanceAssociationsStatus](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DescribeInstanceInformation` 與 CLI
<a name="ssm_example_ssm_DescribeInstanceInformation_section"></a>
下列程式碼範例示範如何使用 `DescribeInstanceInformation`。
------
#### [ CLI ]
**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 使用者指南》**中的 [Managed Instances](https://docs.aws.amazon.com/systems-manager/latest/userguide/managed_instances.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeInstanceInformation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/describe-instance-information.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例顯示每個執行個體的詳細資訊。**
```
Get-SSMInstanceInformation
```
**輸出：**
```
ActivationId :
AgentVersion : 2.0.672.0
AssociationOverview : Amazon.SimpleSystemsManagement.Model.InstanceAggregatedAssociationOverview
AssociationStatus : Success
ComputerName : ip-172-31-44-222.us-west-2.compute.internal
IamRole :
InstanceId : i-0cb2b964d3e14fd9f
IPAddress : 172.31.44.222
IsLatestVersion : True
LastAssociationExecutionDate : 2/24/2017 3:18:09 AM
LastPingDateTime : 2/24/2017 3:35:03 AM
LastSuccessfulAssociationExecutionDate : 2/24/2017 3:18:09 AM
Name :
PingStatus : ConnectionLost
PlatformName : Amazon Linux AMI
PlatformType : Linux
PlatformVersion : 2016.09
RegistrationDate : 1/1/0001 12:00:00 AM
ResourceType : EC2Instance
```
**範例 2：此範例示範如何使用 -Filter 參數，將結果篩選為`us-east-1`具有 之 區域中`AgentVersion`的 AWS Systems Manager 執行個體`2.2.800.0`。InstanceInformation API 參考主題中提供了有效的 -Filter 鍵值清單 (https://docs.aws.amazon.com/systems-manager/latest/APIReference/API\$1InstanceInformation.html\$1systemsmanager-Type-InstanceInformation-ActivationId)。**
```
$Filters = @{
Key="AgentVersion"
Values="2.2.800.0"
}
Get-SSMInstanceInformation -Region us-east-1 -Filter $Filters
```
**輸出：**
```
ActivationId :
AgentVersion : 2.2.800.0
AssociationOverview : Amazon.SimpleSystemsManagement.Model.InstanceAggregatedAssociationOverview
AssociationStatus : Success
ComputerName : EXAMPLE-EXAMPLE.WORKGROUP
IamRole :
InstanceId : i-EXAMPLEb0792d98ce
IPAddress : 10.0.0.01
IsLatestVersion : False
LastAssociationExecutionDate : 8/16/2018 12:02:50 AM
LastPingDateTime : 8/16/2018 7:40:27 PM
LastSuccessfulAssociationExecutionDate : 8/16/2018 12:02:50 AM
Name :
PingStatus : Online
PlatformName : Microsoft Windows Server 2016 Datacenter
PlatformType : Windows
PlatformVersion : 10.0.14393
RegistrationDate : 1/1/0001 12:00:00 AM
ResourceType : EC2Instance
ActivationId :
AgentVersion : 2.2.800.0
AssociationOverview : Amazon.SimpleSystemsManagement.Model.InstanceAggregatedAssociationOverview
AssociationStatus : Success
ComputerName : EXAMPLE-EXAMPLE.WORKGROUP
IamRole :
InstanceId : i-EXAMPLEac7501d023
IPAddress : 10.0.0.02
IsLatestVersion : False
LastAssociationExecutionDate : 8/16/2018 12:00:20 AM
LastPingDateTime : 8/16/2018 7:40:35 PM
LastSuccessfulAssociationExecutionDate : 8/16/2018 12:00:20 AM
Name :
PingStatus : Online
PlatformName : Microsoft Windows Server 2016 Datacenter
PlatformType : Windows
PlatformVersion : 10.0.14393
RegistrationDate : 1/1/0001 12:00:00 AM
ResourceType : EC2Instance
```
**範例 3：此範例示範如何使用 -InstanceInformationFilterList 參數，將結果篩選為 `Windows`或 區域中`us-east-1``PlatformTypes`的 AWS Systems Manager 執行個體`Linux`。InstanceInformation API 參考主題中提供了有效的 -InstanceInformationFilterList 鍵值清單 (https://docs.aws.amazon.com/systems-manager/latest/APIReference/API\$1InstanceInformationFilter.html)。**
```
$Filters = @{
Key="PlatformTypes"
ValueSet=("Windows","Linux")
}
Get-SSMInstanceInformation -Region us-east-1 -InstanceInformationFilterList $Filters
```
**輸出：**
```
ActivationId :
AgentVersion : 2.2.800.0
AssociationOverview : Amazon.SimpleSystemsManagement.Model.InstanceAggregatedAssociationOverview
AssociationStatus : Success
ComputerName : EXAMPLE-EXAMPLE.WORKGROUP
IamRole :
InstanceId : i-EXAMPLEb0792d98ce
IPAddress : 10.0.0.27
IsLatestVersion : False
LastAssociationExecutionDate : 8/16/2018 12:02:50 AM
LastPingDateTime : 8/16/2018 7:40:27 PM
LastSuccessfulAssociationExecutionDate : 8/16/2018 12:02:50 AM
Name :
PingStatus : Online
PlatformName : Ubuntu Server 18.04 LTS
PlatformType : Linux
PlatformVersion : 18.04
RegistrationDate : 1/1/0001 12:00:00 AM
ResourceType : EC2Instance
ActivationId :
AgentVersion : 2.2.800.0
AssociationOverview : Amazon.SimpleSystemsManagement.Model.InstanceAggregatedAssociationOverview
AssociationStatus : Success
ComputerName : EXAMPLE-EXAMPLE.WORKGROUP
IamRole :
InstanceId : i-EXAMPLEac7501d023
IPAddress : 10.0.0.100
IsLatestVersion : False
LastAssociationExecutionDate : 8/16/2018 12:00:20 AM
LastPingDateTime : 8/16/2018 7:40:35 PM
LastSuccessfulAssociationExecutionDate : 8/16/2018 12:00:20 AM
Name :
PingStatus : Online
PlatformName : Microsoft Windows Server 2016 Datacenter
PlatformType : Windows
PlatformVersion : 10.0.14393
RegistrationDate : 1/1/0001 12:00:00 AM
ResourceType : EC2Instance
```
**範例 4：此範例列出了 ssm 受管執行個體，並將 InstanceId、PingStatus、LastPingDateTime 和 PlatformName 匯出至 csv 檔案。**
```
Get-SSMInstanceInformation | Select-Object InstanceId, PingStatus, LastPingDateTime, PlatformName | Export-Csv Instance-details.csv -NoTypeInformation
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeInstanceInformation](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例顯示每個執行個體的詳細資訊。**
```
Get-SSMInstanceInformation
```
**輸出：**
```
ActivationId :
AgentVersion : 2.0.672.0
AssociationOverview : Amazon.SimpleSystemsManagement.Model.InstanceAggregatedAssociationOverview
AssociationStatus : Success
ComputerName : ip-172-31-44-222.us-west-2.compute.internal
IamRole :
InstanceId : i-0cb2b964d3e14fd9f
IPAddress : 172.31.44.222
IsLatestVersion : True
LastAssociationExecutionDate : 2/24/2017 3:18:09 AM
LastPingDateTime : 2/24/2017 3:35:03 AM
LastSuccessfulAssociationExecutionDate : 2/24/2017 3:18:09 AM
Name :
PingStatus : ConnectionLost
PlatformName : Amazon Linux AMI
PlatformType : Linux
PlatformVersion : 2016.09
RegistrationDate : 1/1/0001 12:00:00 AM
ResourceType : EC2Instance
```
**範例 2：此範例示範如何使用 -Filter 參數，僅篩選`us-east-1`區域中具有 `AgentVersion`之 的 AWS Systems Manager 執行個體的結果`2.2.800.0`。InstanceInformation API 參考主題中提供了有效的 -Filter 鍵值清單 (https://docs.aws.amazon.com/systems-manager/latest/APIReference/API\$1InstanceInformation.html\$1systemsmanager-Type-InstanceInformation-ActivationId)。**
```
$Filters = @{
Key="AgentVersion"
Values="2.2.800.0"
}
Get-SSMInstanceInformation -Region us-east-1 -Filter $Filters
```
**輸出：**
```
ActivationId :
AgentVersion : 2.2.800.0
AssociationOverview : Amazon.SimpleSystemsManagement.Model.InstanceAggregatedAssociationOverview
AssociationStatus : Success
ComputerName : EXAMPLE-EXAMPLE.WORKGROUP
IamRole :
InstanceId : i-EXAMPLEb0792d98ce
IPAddress : 10.0.0.01
IsLatestVersion : False
LastAssociationExecutionDate : 8/16/2018 12:02:50 AM
LastPingDateTime : 8/16/2018 7:40:27 PM
LastSuccessfulAssociationExecutionDate : 8/16/2018 12:02:50 AM
Name :
PingStatus : Online
PlatformName : Microsoft Windows Server 2016 Datacenter
PlatformType : Windows
PlatformVersion : 10.0.14393
RegistrationDate : 1/1/0001 12:00:00 AM
ResourceType : EC2Instance
ActivationId :
AgentVersion : 2.2.800.0
AssociationOverview : Amazon.SimpleSystemsManagement.Model.InstanceAggregatedAssociationOverview
AssociationStatus : Success
ComputerName : EXAMPLE-EXAMPLE.WORKGROUP
IamRole :
InstanceId : i-EXAMPLEac7501d023
IPAddress : 10.0.0.02
IsLatestVersion : False
LastAssociationExecutionDate : 8/16/2018 12:00:20 AM
LastPingDateTime : 8/16/2018 7:40:35 PM
LastSuccessfulAssociationExecutionDate : 8/16/2018 12:00:20 AM
Name :
PingStatus : Online
PlatformName : Microsoft Windows Server 2016 Datacenter
PlatformType : Windows
PlatformVersion : 10.0.14393
RegistrationDate : 1/1/0001 12:00:00 AM
ResourceType : EC2Instance
```
**範例 3：此範例示範如何使用 -InstanceInformationFilterList 參數，將結果篩選為 `Windows`或 區域中`us-east-1``PlatformTypes`的 AWS Systems Manager 執行個體`Linux`。InstanceInformation API 參考主題中提供了有效的 -InstanceInformationFilterList 鍵值清單 (https://docs.aws.amazon.com/systems-manager/latest/APIReference/API\$1InstanceInformationFilter.html)。**
```
$Filters = @{
Key="PlatformTypes"
ValueSet=("Windows","Linux")
}
Get-SSMInstanceInformation -Region us-east-1 -InstanceInformationFilterList $Filters
```
**輸出：**
```
ActivationId :
AgentVersion : 2.2.800.0
AssociationOverview : Amazon.SimpleSystemsManagement.Model.InstanceAggregatedAssociationOverview
AssociationStatus : Success
ComputerName : EXAMPLE-EXAMPLE.WORKGROUP
IamRole :
InstanceId : i-EXAMPLEb0792d98ce
IPAddress : 10.0.0.27
IsLatestVersion : False
LastAssociationExecutionDate : 8/16/2018 12:02:50 AM
LastPingDateTime : 8/16/2018 7:40:27 PM
LastSuccessfulAssociationExecutionDate : 8/16/2018 12:02:50 AM
Name :
PingStatus : Online
PlatformName : Ubuntu Server 18.04 LTS
PlatformType : Linux
PlatformVersion : 18.04
RegistrationDate : 1/1/0001 12:00:00 AM
ResourceType : EC2Instance
ActivationId :
AgentVersion : 2.2.800.0
AssociationOverview : Amazon.SimpleSystemsManagement.Model.InstanceAggregatedAssociationOverview
AssociationStatus : Success
ComputerName : EXAMPLE-EXAMPLE.WORKGROUP
IamRole :
InstanceId : i-EXAMPLEac7501d023
IPAddress : 10.0.0.100
IsLatestVersion : False
LastAssociationExecutionDate : 8/16/2018 12:00:20 AM
LastPingDateTime : 8/16/2018 7:40:35 PM
LastSuccessfulAssociationExecutionDate : 8/16/2018 12:00:20 AM
Name :
PingStatus : Online
PlatformName : Microsoft Windows Server 2016 Datacenter
PlatformType : Windows
PlatformVersion : 10.0.14393
RegistrationDate : 1/1/0001 12:00:00 AM
ResourceType : EC2Instance
```
**範例 4：此範例列出了 ssm 受管執行個體，並將 InstanceId、PingStatus、LastPingDateTime 和 PlatformName 匯出至 csv 檔案。**
```
Get-SSMInstanceInformation | Select-Object InstanceId, PingStatus, LastPingDateTime, PlatformName | Export-Csv Instance-details.csv -NoTypeInformation
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeInstanceInformation](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DescribeInstancePatchStates` 與 CLI
<a name="ssm_example_ssm_DescribeInstancePatchStates_section"></a>
下列程式碼範例示範如何使用 `DescribeInstancePatchStates`。
------
#### [ CLI ]
**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"
}
]
}
```
如需詳細資訊，請參閱《AWS 使用者指南》**中的 [About Patch Compliance](https://docs.aws.amazon.com/systems-manager/latest/userguide/about-patch-compliance.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeInstancePatchStates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/describe-instance-patch-states.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範取得一個執行個體的修補程式摘要狀態。**
```
Get-SSMInstancePatchState -InstanceId "i-08ee91c0b17045407"
```
**範例 2：此範例示範取得兩個執行個體的修補程式摘要狀態。**
```
Get-SSMInstancePatchState -InstanceId "i-08ee91c0b17045407","i-09a618aec652973a9"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeInstancePatchStates](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範取得一個執行個體的修補程式摘要狀態。**
```
Get-SSMInstancePatchState -InstanceId "i-08ee91c0b17045407"
```
**範例 2：此範例示範取得兩個執行個體的修補程式摘要狀態。**
```
Get-SSMInstancePatchState -InstanceId "i-08ee91c0b17045407","i-09a618aec652973a9"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeInstancePatchStates](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DescribeInstancePatchStatesForPatchGroup` 與 CLI
<a name="ssm_example_ssm_DescribeInstancePatchStatesForPatchGroup_section"></a>
下列程式碼範例示範如何使用 `DescribeInstancePatchStatesForPatchGroup`。
------
#### [ CLI ]
**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：取得缺少超過五個修補程式之修補程式群組的執行個體狀態**
下列 `describe-instance-patch-states-for-patch-group` 範例針對缺少超過五個修補程式的執行個體，擷取有關指定修補程式群組之修補程式摘要狀態的詳細資訊。
```
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：取得修補程式群組的執行個體狀態，其中需要重新啟動的執行個體少於十個**
下列 `describe-instance-patch-states-for-patch-group` 範例示範擷取有關執行個體的指定修補程式群組之修補程式摘要狀態的詳細資訊，其中需要重新啟動的執行個體少於十個。
```
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
}
]
}
```
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Understanding patch compliance state values](https://docs.aws.amazon.com/systems-manager/latest/userguide/about-patch-compliance-states.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeInstancePatchStatesForPatchGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/describe-instance-patch-states-for-patch-group.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範取得修補程式群組中每個執行個體的修補程式摘要狀態。**
```
Get-SSMInstancePatchStatesForPatchGroup -PatchGroup "Production"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeInstancePatchStatesForPatchGroup](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範取得修補程式群組中每個執行個體的修補程式摘要狀態。**
```
Get-SSMInstancePatchStatesForPatchGroup -PatchGroup "Production"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeInstancePatchStatesForPatchGroup](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DescribeInstancePatches` 與 CLI
<a name="ssm_example_ssm_DescribeInstancePatches_section"></a>
下列程式碼範例示範如何使用 `DescribeInstancePatches`。
------
#### [ CLI ]
**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：取得狀態為「缺少」的執行個體修補程式清單**
下列 `describe-instance-patches` 範例示範擷取有關指定執行個體處於「缺少」狀態的修補程式資訊。
```
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--"
}
```
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [About Patch Compliance States](https://docs.aws.amazon.com/systems-manager/latest/userguide/about-patch-compliance-states.html)。
**範例 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 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeInstancePatches](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/describe-instance-patches.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範取得執行個體的修補程式合規性詳細資訊。**
```
Get-SSMInstancePatch -InstanceId "i-08ee91c0b17045407"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeInstancePatches](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範取得執行個體的修補程式合規性詳細資訊。**
```
Get-SSMInstancePatch -InstanceId "i-08ee91c0b17045407"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeInstancePatches](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DescribeMaintenanceWindowExecutionTaskInvocations` 與 CLI
<a name="ssm_example_ssm_DescribeMaintenanceWindowExecutionTaskInvocations_section"></a>
下列程式碼範例示範如何使用 `DescribeMaintenanceWindowExecutionTaskInvocations`。
------
#### [ CLI ]
**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) 的相關資訊](https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-task-info.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeMaintenanceWindowExecutionTaskInvocations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/describe-maintenance-window-execution-task-invocations.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例列出了作為維護時段執行的一部分執行之任務的調用。**
```
Get-SSMMaintenanceWindowExecutionTaskInvocationList -TaskId "ac0c6ae1-daa3-4a89-832e-d384503b6586" -WindowExecutionId "518d5565-5969-4cca-8f0e-da3b2a638355"
```
**輸出：**
```
EndTime : 2/21/2017 4:00:34 PM
ExecutionId :
InvocationId : e274b6e1-fe56-4e32-bd2a-8073c6381d8b
OwnerInformation :
Parameters : {"documentName":"AWS-RunShellScript","instanceIds":["i-0000293ffd8c57862"],"parameters":{"commands":["df"]},"maxConcurrency":"1",
"maxErrors":"1"}
StartTime : 2/21/2017 4:00:34 PM
Status : FAILED
StatusDetails : The instance IDs list contains an invalid entry.
TaskExecutionId : ac0c6ae1-daa3-4a89-832e-d384503b6586
WindowExecutionId : 518d5565-5969-4cca-8f0e-da3b2a638355
WindowTargetId :
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeMaintenanceWindowExecutionTaskInvocations](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例列出了作為維護時段執行的一部分執行之任務的調用。**
```
Get-SSMMaintenanceWindowExecutionTaskInvocationList -TaskId "ac0c6ae1-daa3-4a89-832e-d384503b6586" -WindowExecutionId "518d5565-5969-4cca-8f0e-da3b2a638355"
```
**輸出：**
```
EndTime : 2/21/2017 4:00:34 PM
ExecutionId :
InvocationId : e274b6e1-fe56-4e32-bd2a-8073c6381d8b
OwnerInformation :
Parameters : {"documentName":"AWS-RunShellScript","instanceIds":["i-0000293ffd8c57862"],"parameters":{"commands":["df"]},"maxConcurrency":"1",
"maxErrors":"1"}
StartTime : 2/21/2017 4:00:34 PM
Status : FAILED
StatusDetails : The instance IDs list contains an invalid entry.
TaskExecutionId : ac0c6ae1-daa3-4a89-832e-d384503b6586
WindowExecutionId : 518d5565-5969-4cca-8f0e-da3b2a638355
WindowTargetId :
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeMaintenanceWindowExecutionTaskInvocations](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DescribeMaintenanceWindowExecutionTasks` 與 CLI
<a name="ssm_example_ssm_DescribeMaintenanceWindowExecutionTasks_section"></a>
下列程式碼範例示範如何使用 `DescribeMaintenanceWindowExecutionTasks`。
------
#### [ CLI ]
**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) 的相關資訊](https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-task-info.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeMaintenanceWindowExecutionTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/describe-maintenance-window-execution-tasks.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例列出了與維護時段執行關聯的任務。**
```
Get-SSMMaintenanceWindowExecutionTaskList -WindowExecutionId "518d5565-5969-4cca-8f0e-da3b2a638355"
```
**輸出：**
```
EndTime : 2/21/2017 4:00:35 PM
StartTime : 2/21/2017 4:00:34 PM
Status : SUCCESS
TaskArn : AWS-RunShellScript
TaskExecutionId : ac0c6ae1-daa3-4a89-832e-d384503b6586
TaskType : RUN_COMMAND
WindowExecutionId : 518d5565-5969-4cca-8f0e-da3b2a638355
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeMaintenanceWindowExecutionTasks](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例列出了與維護時段執行關聯的任務。**
```
Get-SSMMaintenanceWindowExecutionTaskList -WindowExecutionId "518d5565-5969-4cca-8f0e-da3b2a638355"
```
**輸出：**
```
EndTime : 2/21/2017 4:00:35 PM
StartTime : 2/21/2017 4:00:34 PM
Status : SUCCESS
TaskArn : AWS-RunShellScript
TaskExecutionId : ac0c6ae1-daa3-4a89-832e-d384503b6586
TaskType : RUN_COMMAND
WindowExecutionId : 518d5565-5969-4cca-8f0e-da3b2a638355
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeMaintenanceWindowExecutionTasks](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DescribeMaintenanceWindowExecutions` 與 CLI
<a name="ssm_example_ssm_DescribeMaintenanceWindowExecutions_section"></a>
下列程式碼範例示範如何使用 `DescribeMaintenanceWindowExecutions`。
------
#### [ CLI ]
**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) 的相關資訊](https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-task-info.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeMaintenanceWindowExecutions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/describe-maintenance-window-executions.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例列出了維護時段的所有執行。**
```
Get-SSMMaintenanceWindowExecutionList -WindowId "mw-03eb9db42890fb82d"
```
**輸出：**
```
EndTime : 2/20/2017 6:30:17 PM
StartTime : 2/20/2017 6:30:16 PM
Status : FAILED
StatusDetails : One or more tasks in the orchestration failed.
WindowExecutionId : 6f3215cf-4101-4fa0-9b7b-9523269599c7
WindowId : mw-03eb9db42890fb82d
```
**範例 2：此範例列出了指定日期之前維護時段的所有執行。**
```
$option1 = @{Key="ExecutedBefore";Values=@("2016-11-04T05:00:00Z")}
Get-SSMMaintenanceWindowExecutionList -WindowId "mw-03eb9db42890fb82d" -Filter $option1
```
**範例 3：此範例列出了指定日期之後維護時段的所有執行。**
```
$option1 = @{Key="ExecutedAfter";Values=@("2016-11-04T05:00:00Z")}
Get-SSMMaintenanceWindowExecutionList -WindowId "mw-03eb9db42890fb82d" -Filter $option1
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeMaintenanceWindowExecutions](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例列出了維護時段的所有執行。**
```
Get-SSMMaintenanceWindowExecutionList -WindowId "mw-03eb9db42890fb82d"
```
**輸出：**
```
EndTime : 2/20/2017 6:30:17 PM
StartTime : 2/20/2017 6:30:16 PM
Status : FAILED
StatusDetails : One or more tasks in the orchestration failed.
WindowExecutionId : 6f3215cf-4101-4fa0-9b7b-9523269599c7
WindowId : mw-03eb9db42890fb82d
```
**範例 2：此範例列出了指定日期之前維護時段的所有執行。**
```
$option1 = @{Key="ExecutedBefore";Values=@("2016-11-04T05:00:00Z")}
Get-SSMMaintenanceWindowExecutionList -WindowId "mw-03eb9db42890fb82d" -Filter $option1
```
**範例 3：此範例列出了指定日期之後維護時段的所有執行。**
```
$option1 = @{Key="ExecutedAfter";Values=@("2016-11-04T05:00:00Z")}
Get-SSMMaintenanceWindowExecutionList -WindowId "mw-03eb9db42890fb82d" -Filter $option1
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeMaintenanceWindowExecutions](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DescribeMaintenanceWindowTargets` 與 CLI
<a name="ssm_example_ssm_DescribeMaintenanceWindowTargets_section"></a>
下列程式碼範例示範如何使用 `DescribeMaintenanceWindowTargets`。
------
#### [ CLI ]
**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"
}
]
}
```
如需詳細資訊，請參閱 *AWS Systems Manager 使用者指南*中的[檢視維護 Windows (AWS CLI) 的相關資訊](https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-cli-tutorials-describe.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeMaintenanceWindowTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/describe-maintenance-window-targets.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例列出了維護時段的所有目標。**
```
Get-SSMMaintenanceWindowTarget -WindowId "mw-06cf17cbefcb4bf4f"
```
**輸出：**
```
OwnerInformation : Single instance
ResourceType : INSTANCE
Targets : {InstanceIds}
WindowId : mw-06cf17cbefcb4bf4f
WindowTargetId : 350d44e6-28cc-44e2-951f-4b2c985838f6
OwnerInformation : Two instances in a list
ResourceType : INSTANCE
Targets : {InstanceIds}
WindowId : mw-06cf17cbefcb4bf4f
WindowTargetId : e078a987-2866-47be-bedd-d9cf49177d3a
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeMaintenanceWindowTargets](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例列出了維護時段的所有目標。**
```
Get-SSMMaintenanceWindowTarget -WindowId "mw-06cf17cbefcb4bf4f"
```
**輸出：**
```
OwnerInformation : Single instance
ResourceType : INSTANCE
Targets : {InstanceIds}
WindowId : mw-06cf17cbefcb4bf4f
WindowTargetId : 350d44e6-28cc-44e2-951f-4b2c985838f6
OwnerInformation : Two instances in a list
ResourceType : INSTANCE
Targets : {InstanceIds}
WindowId : mw-06cf17cbefcb4bf4f
WindowTargetId : e078a987-2866-47be-bedd-d9cf49177d3a
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeMaintenanceWindowTargets](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DescribeMaintenanceWindowTasks` 與 CLI
<a name="ssm_example_ssm_DescribeMaintenanceWindowTasks_section"></a>
下列程式碼範例示範如何使用 `DescribeMaintenanceWindowTasks`。
------
#### [ CLI ]
**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：列出優先順序為 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：列出優先順序為 1 且使用 Run Command 的維護時段的所有任務**
此 `describe-maintenance-window-tasks` 範例列出了 `Priority` 為 `1` 且使用 `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"
}
]
}
```
如需詳細資訊，請參閱 *AWS Systems Manager 使用者指南*中的[檢視維護時段 (AWS CLI) 的相關資訊](https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-cli-tutorials-describe.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeMaintenanceWindowTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/describe-maintenance-window-tasks.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例列出了維護時段的所有任務。**
```
Get-SSMMaintenanceWindowTaskList -WindowId "mw-06cf17cbefcb4bf4f"
```
**輸出：**
```
LoggingInfo :
MaxConcurrency : 1
MaxErrors : 1
Priority : 10
ServiceRoleArn : arn:aws:iam::123456789012:role/MaintenanceWindowsRole
Targets : {InstanceIds}
TaskArn : AWS-RunShellScript
TaskParameters : {[commands, Amazon.SimpleSystemsManagement.Model.MaintenanceWindowTaskParameterValueExpression]}
Type : RUN_COMMAND
WindowId : mw-06cf17cbefcb4bf4f
WindowTaskId : a23e338d-ff30-4398-8aa3-09cd052ebf17
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeMaintenanceWindowTasks](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例列出了維護時段的所有任務。**
```
Get-SSMMaintenanceWindowTaskList -WindowId "mw-06cf17cbefcb4bf4f"
```
**輸出：**
```
LoggingInfo :
MaxConcurrency : 1
MaxErrors : 1
Priority : 10
ServiceRoleArn : arn:aws:iam::123456789012:role/MaintenanceWindowsRole
Targets : {InstanceIds}
TaskArn : AWS-RunShellScript
TaskParameters : {[commands, Amazon.SimpleSystemsManagement.Model.MaintenanceWindowTaskParameterValueExpression]}
Type : RUN_COMMAND
WindowId : mw-06cf17cbefcb4bf4f
WindowTaskId : a23e338d-ff30-4398-8aa3-09cd052ebf17
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeMaintenanceWindowTasks](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DescribeMaintenanceWindows` 與 CLI
<a name="ssm_example_ssm_DescribeMaintenanceWindows_section"></a>
下列程式碼範例示範如何使用 `DescribeMaintenanceWindows`。
------
#### [ CLI ]
**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"
},
]
}
```
**列出所有已啟用的維護時段**
下列 `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"
```
如需詳細資訊，請參閱 *AWS Systems Manager 使用者指南*中的[檢視維護 Windows (AWS CLI) 的相關資訊](https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-cli-tutorials-describe.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeMaintenanceWindows](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/describe-maintenance-windows.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例列出了帳戶的所有維護時段。**
```
Get-SSMMaintenanceWindowList
```
**輸出：**
```
Cutoff : 1
Duration : 4
Enabled : True
Name : My-First-Maintenance-Window
WindowId : mw-06d59c1a07c022145
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeMaintenanceWindows](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例列出了帳戶的所有維護時段。**
```
Get-SSMMaintenanceWindowList
```
**輸出：**
```
Cutoff : 1
Duration : 4
Enabled : True
Name : My-First-Maintenance-Window
WindowId : mw-06d59c1a07c022145
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeMaintenanceWindows](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# `DescribeOpsItems` 搭配 AWS SDK 或 CLI 使用
<a name="ssm_example_ssm_DescribeOpsItems_section"></a>
下列程式碼範例示範如何使用 `DescribeOpsItems`。
------
#### [ CLI ]
**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"
}
]
}
```
如需詳細資訊，請參閱**《AWS Systems Manager 使用者指南》中的 [Working with OpsItems](https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-working-with-OpsItems.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeOpsItems](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/describe-ops-items.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/ssm#code-examples)中設定和執行。
```
/**
* Describes AWS SSM OpsItems asynchronously.
*
* @param key The key to filter OpsItems by (e.g., OPS_ITEM_ID).
*
* This method initiates an asynchronous request to describe SSM OpsItems.
* If the request is successful, it prints the title and status of each OpsItem.
* If an exception occurs, it handles the error appropriately.
*/
public void describeOpsItems(String key) {
OpsItemFilter filter = OpsItemFilter.builder()
.key(OpsItemFilterKey.OPS_ITEM_ID)
.values(key)
.operator(OpsItemFilterOperator.EQUAL)
.build();
DescribeOpsItemsRequest itemsRequest = DescribeOpsItemsRequest.builder()
.maxResults(10)
.opsItemFilters(filter)
.build();
CompletableFuture<Void> future = CompletableFuture.runAsync(() -> {
getAsyncClient().describeOpsItems(itemsRequest)
.thenAccept(itemsResponse -> {
List<OpsItemSummary> items = itemsResponse.opsItemSummaries();
for (OpsItemSummary item : items) {
System.out.println("The item title is " + item.title() + " and the status is " + item.status().toString());
}
})
.exceptionally(ex -> {
throw new CompletionException(ex);
}).join();
}).exceptionally(ex -> {
Throwable cause = (ex instanceof CompletionException) ? ex.getCause() : ex;
if (cause instanceof SsmException) {
throw new RuntimeException("SSM error: " + cause.getMessage(), cause);
} else {
throw new RuntimeException("Unexpected error: " + cause.getMessage(), cause);
}
});
try {
future.join();
} catch (CompletionException ex) {
throw ex.getCause() instanceof RuntimeException ? (RuntimeException) ex.getCause() : ex;
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [DescribeOpsItems](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribeOpsItems)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ssm#code-examples)中設定和執行。
```
import {
OpsItemFilterOperator,
OpsItemFilterKey,
paginateDescribeOpsItems,
SSMClient,
} from "@aws-sdk/client-ssm";
import { parseArgs } from "node:util";
/**
* Describe SSM OpsItems.
* @param {{ opsItemId: string }}
*/
export const main = async ({ opsItemId }) => {
const client = new SSMClient({});
try {
const describeOpsItemsPaginated = [];
for await (const page of paginateDescribeOpsItems(
{ client },
{
OpsItemFilters: {
Key: OpsItemFilterKey.OPSITEM_ID,
Operator: OpsItemFilterOperator.EQUAL,
Values: opsItemId,
},
},
)) {
describeOpsItemsPaginated.push(...page.OpsItemSummaries);
}
console.log("Here are the ops items:");
console.log(describeOpsItemsPaginated);
return { OpsItemSummaries: describeOpsItemsPaginated };
} catch (caught) {
if (caught instanceof Error && caught.name === "MissingParameter") {
console.warn(`${caught.message}. Did you provide this value?`);
}
throw caught;
}
};
```
+ 如需 API 詳細資訊，請參閱《適用於 JavaScript 的 AWS SDK API 參考》**中的 [DescribeOpsItems](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/DescribeOpsItemsCommand)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/ssm#code-examples)中設定和執行。
```
class OpsItemWrapper:
"""Encapsulates AWS Systems Manager OpsItem actions."""
def __init__(self, ssm_client):
"""
:param ssm_client: A Boto3 Systems Manager client.
"""
self.ssm_client = ssm_client
self.id = None
@classmethod
def from_client(cls):
"""
:return: A OpsItemWrapper instance.
"""
ssm_client = boto3.client("ssm")
return cls(ssm_client)
def describe(self):
"""
Describe an OpsItem.
"""
try:
paginator = self.ssm_client.get_paginator("describe_ops_items")
ops_items = []
for page in paginator.paginate(
OpsItemFilters=[
{"Key": "OpsItemId", "Values": [self.id], "Operator": "Equal"}
]
):
ops_items.extend(page["OpsItemSummaries"])
for item in ops_items:
print(
f"The item title is {item['Title']} and the status is {item['Status']}"
)
return len(ops_items) > 0
except ClientError as err:
logger.error(
"Couldn't describe ops item %s. Here's why: %s: %s",
self.id,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [DescribeOpsItems](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/DescribeOpsItems)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ssm#code-examples)中設定和執行。
```
TRY.
" Create filter for OpsItem ID
DATA(lt_filters) = VALUE /aws1/cl_ssmopsitemfilter=>tt_opsitemfilters(
( NEW /aws1/cl_ssmopsitemfilter(
iv_key = 'OpsItemId'
it_values = VALUE /aws1/cl_ssmopsitemfiltvals_w=>tt_opsitemfiltervalues(
( NEW /aws1/cl_ssmopsitemfiltvals_w( iv_value = iv_ops_item_id ) )
)
iv_operator = 'Equal'
) )
).
" Use paginator to get all results
DATA(lo_paginator) = lo_ssm->get_paginator( ).
DATA(lo_iterator) = lo_paginator->describeopsitems(
it_opsitemfilters = lt_filters ).
rv_found = abap_false.
WHILE lo_iterator->has_next( ).
DATA(lo_result) = CAST /aws1/cl_ssmdescropsitemsrsp( lo_iterator->get_next( ) ).
LOOP AT lo_result->get_opsitemsummaries( ) INTO DATA(lo_item).
DATA(lv_title) = lo_item->get_title( ).
DATA(lv_status) = lo_item->get_status( ).
MESSAGE |The OpsItem title is { lv_title } and the status is { lv_status }| TYPE 'I'.
rv_found = abap_true.
ENDLOOP.
ENDWHILE.
CATCH /aws1/cx_ssminternalservererr.
MESSAGE 'Internal server error occurred.' TYPE 'I'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [DescribeOpsItems](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# `DescribeParameters` 搭配 AWS SDK 或 CLI 使用
<a name="ssm_example_ssm_DescribeParameters_section"></a>
下列程式碼範例示範如何使用 `DescribeParameters`。
------
#### [ CLI ]
**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 使用者指南》**中的 [Searching for Systems Manager Parameters](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-search.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeParameter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/describe-parameters.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/ssm#code-examples)中設定和執行。
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.ssm.SsmClient;
import software.amazon.awssdk.services.ssm.model.GetParameterRequest;
import software.amazon.awssdk.services.ssm.model.GetParameterResponse;
import software.amazon.awssdk.services.ssm.model.SsmException;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class GetParameter {
public static void main(String[] args) {
final String usage = """
Usage:
<paraName>
Where:
paraName - The name of the parameter.
""";
if (args.length != 1) {
System.out.println(usage);
System.exit(1);
}
String paraName = args[0];
Region region = Region.US_EAST_1;
SsmClient ssmClient = SsmClient.builder()
.region(region)
.build();
getParaValue(ssmClient, paraName);
ssmClient.close();
}
public static void getParaValue(SsmClient ssmClient, String paraName) {
try {
GetParameterRequest parameterRequest = GetParameterRequest.builder()
.name(paraName)
.build();
GetParameterResponse parameterResponse = ssmClient.getParameter(parameterRequest);
System.out.println("The parameter value is " + parameterResponse.parameter().value());
} catch (SsmException e) {
System.err.println(e.getMessage());
System.exit(1);
}
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [DescribeParameters](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DescribeParameters)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例列出了所有參數。**
```
Get-SSMParameterList
```
**輸出：**
```
Description :
KeyId :
LastModifiedDate : 3/3/2017 6:58:23 PM
LastModifiedUser : arn:aws:iam::123456789012:user/admin
Name : Welcome
Type : String
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeParameters](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例列出了所有參數。**
```
Get-SSMParameterList
```
**輸出：**
```
Description :
KeyId :
LastModifiedDate : 3/3/2017 6:58:23 PM
LastModifiedUser : arn:aws:iam::123456789012:user/admin
Name : Welcome
Type : String
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeParameters](https://docs.aws.amazon.com/powershell/v5/reference)。
------
#### [ Rust ]
**適用於 Rust 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/ssm#code-examples)中設定和執行。
```
async fn show_parameters(client: &Client) -> Result<(), Error> {
let resp = client.describe_parameters().send().await?;
for param in resp.parameters() {
println!(" {}", param.name().unwrap_or_default());
}
Ok(())
}
```
+ 如需 API 詳細資訊，請參閱《適用於 Rust 的AWS SDK API 參考》**中的 [DescribeParameters](https://docs.rs/aws-sdk-ssm/latest/aws_sdk_ssm/client/struct.Client.html#method.describe_parameters)。
------
# 搭配使用 `DescribePatchBaselines` 與 CLI
<a name="ssm_example_ssm_DescribePatchBaselines_section"></a>
下列程式碼範例示範如何使用 `DescribePatchBaselines`。
------
#### [ CLI ]
**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 使用者指南》**中的 [About Predefined and Custom Patch Baselines](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-patch-baselines.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribePatchBaselines](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/describe-patch-baselines.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例列出了所有修補基準。**
```
Get-SSMPatchBaseline
```
**輸出：**
```
BaselineDescription BaselineId BaselineName
------------------- ---------- ------------
Default Patch Baseline Provided by AWS. arn:aws:ssm:us-west-2:123456789012:patchbaseline/pb-04fb4ae6142167966 AWS-DefaultP...
Baseline containing all updates approved for production systems pb-045f10b4f382baeda Production-B...
Baseline containing all updates approved for production systems pb-0a2f1059b670ebd31 Production-B...
```
**範例 2：此範例列出 提供的所有修補程式基準 AWS。此範例使用的語法需要 PowerShell 版本 3 或更新版本。**
```
$filter1 = @{Key="OWNER";Values=@("AWS")}
```
**輸出：**
```
Get-SSMPatchBaseline -Filter $filter1
```
**範例 3：此範例列出了您作為擁有者的所有修補基準。此範例使用的語法需要 PowerShell 版本 3 或更新版本。**
```
$filter1 = @{Key="OWNER";Values=@("Self")}
```
**輸出：**
```
Get-SSMPatchBaseline -Filter $filter1
```
**範例 4：使用 PowerShell 版本 2 時，必須使用 New-Object 來建立每個標籤。**
```
$filter1 = New-Object Amazon.SimpleSystemsManagement.Model.PatchOrchestratorFilter
$filter1.Key = "OWNER"
$filter1.Values = "AWS"
Get-SSMPatchBaseline -Filter $filter1
```
**輸出：**
```
BaselineDescription BaselineId BaselineName DefaultBaselin
e
------------------- ---------- ------------ --------------
Default Patch Baseline Provided by AWS. arn:aws:ssm:us-west-2:123456789012:patchbaseline/pb-04fb4ae6142167966 AWS-DefaultPatchBaseline True
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribePatchBaselines](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例列出了所有修補基準。**
```
Get-SSMPatchBaseline
```
**輸出：**
```
BaselineDescription BaselineId BaselineName
------------------- ---------- ------------
Default Patch Baseline Provided by AWS. arn:aws:ssm:us-west-2:123456789012:patchbaseline/pb-04fb4ae6142167966 AWS-DefaultP...
Baseline containing all updates approved for production systems pb-045f10b4f382baeda Production-B...
Baseline containing all updates approved for production systems pb-0a2f1059b670ebd31 Production-B...
```
**範例 2：此範例列出 提供的所有修補程式基準 AWS。此範例使用的語法需要 PowerShell 版本 3 或更新版本。**
```
$filter1 = @{Key="OWNER";Values=@("AWS")}
```
**輸出：**
```
Get-SSMPatchBaseline -Filter $filter1
```
**範例 3：此範例列出了您作為擁有者的所有修補基準。此範例使用的語法需要 PowerShell 版本 3 或更新版本。**
```
$filter1 = @{Key="OWNER";Values=@("Self")}
```
**輸出：**
```
Get-SSMPatchBaseline -Filter $filter1
```
**範例 4：使用 PowerShell 版本 2 時，必須使用 New-Object 來建立每個標籤。**
```
$filter1 = New-Object Amazon.SimpleSystemsManagement.Model.PatchOrchestratorFilter
$filter1.Key = "OWNER"
$filter1.Values = "AWS"
Get-SSMPatchBaseline -Filter $filter1
```
**輸出：**
```
BaselineDescription BaselineId BaselineName DefaultBaselin
e
------------------- ---------- ------------ --------------
Default Patch Baseline Provided by AWS. arn:aws:ssm:us-west-2:123456789012:patchbaseline/pb-04fb4ae6142167966 AWS-DefaultPatchBaseline True
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribePatchBaselines](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DescribePatchGroupState` 與 CLI
<a name="ssm_example_ssm_DescribePatchGroupState_section"></a>
下列程式碼範例示範如何使用 `DescribePatchGroupState`。
------
#### [ CLI ]
**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 使用者指南》**中的 About patch groups <https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-patch-patchgroups.html>\$1\$1 和 [Understanding patch compliance state values](https://docs.aws.amazon.com/systems-manager/latest/userguide/about-patch-compliance-states.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribePatchGroupState](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/describe-patch-group-state.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範取得修補程式群組的高階修補程式合規摘要。**
```
Get-SSMPatchGroupState -PatchGroup "Production"
```
**輸出：**
```
Instances : 4
InstancesWithFailedPatches : 1
InstancesWithInstalledOtherPatches : 4
InstancesWithInstalledPatches : 3
InstancesWithMissingPatches : 0
InstancesWithNotApplicablePatches : 0
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribePatchGroupState](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範取得修補程式群組的高階修補程式合規摘要。**
```
Get-SSMPatchGroupState -PatchGroup "Production"
```
**輸出：**
```
Instances : 4
InstancesWithFailedPatches : 1
InstancesWithInstalledOtherPatches : 4
InstancesWithInstalledPatches : 3
InstancesWithMissingPatches : 0
InstancesWithNotApplicablePatches : 0
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribePatchGroupState](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DescribePatchGroups` 與 CLI
<a name="ssm_example_ssm_DescribePatchGroups_section"></a>
下列程式碼範例示範如何使用 `DescribePatchGroups`。
------
#### [ CLI ]
**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>\$1\$1 和 [Add a Patch Group to a Patch Baseline](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-patch-group-patchbaseline.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribePatchGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/describe-patch-groups.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例列出了修補程式群組註冊。**
```
Get-SSMPatchGroup
```
**輸出：**
```
BaselineIdentity PatchGroup
---------------- ----------
Amazon.SimpleSystemsManagement.Model.PatchBaselineIdentity Production
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribePatchGroups](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例列出了修補程式群組註冊。**
```
Get-SSMPatchGroup
```
**輸出：**
```
BaselineIdentity PatchGroup
---------------- ----------
Amazon.SimpleSystemsManagement.Model.PatchBaselineIdentity Production
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribePatchGroups](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `GetAutomationExecution` 與 CLI
<a name="ssm_example_ssm_GetAutomationExecution_section"></a>
下列程式碼範例示範如何使用 `GetAutomationExecution`。
------
#### [ CLI ]
**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
}
}
}
```
如需詳細資訊，請參閱 *AWS Systems Manager 使用者指南*中的[逐步解說：修補 Linux AMI (AWS CLI)](https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-walk-patch-linux-ami-cli.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetAutomationExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/get-automation-execution.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例顯示自動化執行的詳細資訊。**
```
Get-SSMAutomationExecution -AutomationExecutionId "4105a4fc-f944-11e6-9d32-8fb2db27a909"
```
**輸出：**
```
AutomationExecutionId : 4105a4fc-f944-11e6-9d32-8fb2db27a909
AutomationExecutionStatus : Failed
DocumentName : AWS-UpdateLinuxAmi
DocumentVersion : 1
ExecutionEndTime : 2/22/2017 9:17:08 PM
ExecutionStartTime : 2/22/2017 9:17:02 PM
FailureMessage : Step launchInstance failed maximum allowed times. You are not authorized to perform this operation. Encoded
authorization failure message: B_V2QyyN7NhSZQYpmVzpEc4oSnj2GLTNYnXUHsTbqJkNMoDgubmbtthLmZyaiUYekORIrA42-fv1x-04q5Fjff6glh
Yb6TI5b0GQeeNrpwNvpDzmO-PSR1swlAbg9fdM9BcNjyrznspUkWpuKu9EC1Ou6v3OXU1KC9nZ7mPlWMFZNkSioQqpwWEvMw-GZktsQzm67qOhUhBNOLWYhbS
pkfiqzY-5nw3S0obx30fhd3EJa5O_-GjV_a0nFXQJa70ik40bFOrEh3MtCSbrQT6--DvFy_FQ8TKvkIXadyVskeJI84XOF5WmA60f1pi5GI08i-nRfZS6oDeU
gELBjjoFKD8s3L2aI0B6umWVxnQOjqhQRxwJ53b54sZJ2PW3v_mtg9-q0CK0ezS3xfh_y0ilaUGOAZG-xjQFuvU_JZedWpla3xi-MZsmblAifBI
(Service: AmazonEC2; Status Code: 403; Error Code: UnauthorizedOperation; Request ID:
6a002f94-ba37-43fd-99e6-39517715fce5)
Outputs : {[createImage.ImageId, Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]]}
Parameters : {[AutomationAssumeRole, Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]], [InstanceIamRole,
Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]], [SourceAmiId,
Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]]}
StepExecutions : {launchInstance, updateOSSoftware, stopInstance, createImage...}
```
**範例 2：此範例列出了指定自動化執行 ID 的步驟詳細資訊**
```
Get-SSMAutomationExecution -AutomationExecutionId e1d2bad3-4567-8901-ae23-456c7c8901be | Select-Object -ExpandProperty StepExecutions | Select-Object StepName, Action, StepStatus, ValidNextSteps
```
**輸出：**
```
StepName Action StepStatus ValidNextSteps
-------- ------ ---------- --------------
LaunchInstance aws:runInstances Success {OSCompatibilityCheck}
OSCompatibilityCheck aws:runCommand Success {RunPreUpdateScript}
RunPreUpdateScript aws:runCommand Success {UpdateEC2Config}
UpdateEC2Config aws:runCommand Cancelled {}
UpdateSSMAgent aws:runCommand Pending {}
UpdateAWSPVDriver aws:runCommand Pending {}
UpdateAWSEnaNetworkDriver aws:runCommand Pending {}
UpdateAWSNVMe aws:runCommand Pending {}
InstallWindowsUpdates aws:runCommand Pending {}
RunPostUpdateScript aws:runCommand Pending {}
RunSysprepGeneralize aws:runCommand Pending {}
StopInstance aws:changeInstanceState Pending {}
CreateImage aws:createImage Pending {}
TerminateInstance aws:changeInstanceState Pending {}
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetAutomationExecution](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例顯示自動化執行的詳細資訊。**
```
Get-SSMAutomationExecution -AutomationExecutionId "4105a4fc-f944-11e6-9d32-8fb2db27a909"
```
**輸出：**
```
AutomationExecutionId : 4105a4fc-f944-11e6-9d32-8fb2db27a909
AutomationExecutionStatus : Failed
DocumentName : AWS-UpdateLinuxAmi
DocumentVersion : 1
ExecutionEndTime : 2/22/2017 9:17:08 PM
ExecutionStartTime : 2/22/2017 9:17:02 PM
FailureMessage : Step launchInstance failed maximum allowed times. You are not authorized to perform this operation. Encoded
authorization failure message: B_V2QyyN7NhSZQYpmVzpEc4oSnj2GLTNYnXUHsTbqJkNMoDgubmbtthLmZyaiUYekORIrA42-fv1x-04q5Fjff6glh
Yb6TI5b0GQeeNrpwNvpDzmO-PSR1swlAbg9fdM9BcNjyrznspUkWpuKu9EC1Ou6v3OXU1KC9nZ7mPlWMFZNkSioQqpwWEvMw-GZktsQzm67qOhUhBNOLWYhbS
pkfiqzY-5nw3S0obx30fhd3EJa5O_-GjV_a0nFXQJa70ik40bFOrEh3MtCSbrQT6--DvFy_FQ8TKvkIXadyVskeJI84XOF5WmA60f1pi5GI08i-nRfZS6oDeU
gELBjjoFKD8s3L2aI0B6umWVxnQOjqhQRxwJ53b54sZJ2PW3v_mtg9-q0CK0ezS3xfh_y0ilaUGOAZG-xjQFuvU_JZedWpla3xi-MZsmblAifBI
(Service: AmazonEC2; Status Code: 403; Error Code: UnauthorizedOperation; Request ID:
6a002f94-ba37-43fd-99e6-39517715fce5)
Outputs : {[createImage.ImageId, Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]]}
Parameters : {[AutomationAssumeRole, Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]], [InstanceIamRole,
Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]], [SourceAmiId,
Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]]}
StepExecutions : {launchInstance, updateOSSoftware, stopInstance, createImage...}
```
**範例 2：此範例列出了指定自動化執行 ID 的步驟詳細資訊**
```
Get-SSMAutomationExecution -AutomationExecutionId e1d2bad3-4567-8901-ae23-456c7c8901be | Select-Object -ExpandProperty StepExecutions | Select-Object StepName, Action, StepStatus, ValidNextSteps
```
**輸出：**
```
StepName Action StepStatus ValidNextSteps
-------- ------ ---------- --------------
LaunchInstance aws:runInstances Success {OSCompatibilityCheck}
OSCompatibilityCheck aws:runCommand Success {RunPreUpdateScript}
RunPreUpdateScript aws:runCommand Success {UpdateEC2Config}
UpdateEC2Config aws:runCommand Cancelled {}
UpdateSSMAgent aws:runCommand Pending {}
UpdateAWSPVDriver aws:runCommand Pending {}
UpdateAWSEnaNetworkDriver aws:runCommand Pending {}
UpdateAWSNVMe aws:runCommand Pending {}
InstallWindowsUpdates aws:runCommand Pending {}
RunPostUpdateScript aws:runCommand Pending {}
RunSysprepGeneralize aws:runCommand Pending {}
StopInstance aws:changeInstanceState Pending {}
CreateImage aws:createImage Pending {}
TerminateInstance aws:changeInstanceState Pending {}
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetAutomationExecution](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `GetCommandInvocation` 與 CLI
<a name="ssm_example_ssm_GetCommandInvocation_section"></a>
下列程式碼範例示範如何使用 `GetCommandInvocation`。
------
#### [ CLI ]
**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 使用者指南》**中的 [Understanding Command Statuses](https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetCommandInvocation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/get-command-invocation.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例顯示執行個體上所執行之命令的詳細資訊。**
```
Get-SSMCommandInvocationDetail -InstanceId "i-0cb2b964d3e14fd9f" -CommandId "b8eac879-0541-439d-94ec-47a80d554f44"
```
**輸出：**
```
CommandId : b8eac879-0541-439d-94ec-47a80d554f44
Comment : IP config
DocumentName : AWS-RunShellScript
ExecutionElapsedTime : PT0.004S
ExecutionEndDateTime : 2017-02-22T20:13:16.651Z
ExecutionStartDateTime : 2017-02-22T20:13:16.651Z
InstanceId : i-0cb2b964d3e14fd9f
PluginName : aws:runShellScript
ResponseCode : 0
StandardErrorContent :
StandardErrorUrl :
StandardOutputContent :
StandardOutputUrl :
Status : Success
StatusDetails : Success
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetCommandInvocation](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例顯示執行個體上所執行之命令的詳細資訊。**
```
Get-SSMCommandInvocationDetail -InstanceId "i-0cb2b964d3e14fd9f" -CommandId "b8eac879-0541-439d-94ec-47a80d554f44"
```
**輸出：**
```
CommandId : b8eac879-0541-439d-94ec-47a80d554f44
Comment : IP config
DocumentName : AWS-RunShellScript
ExecutionElapsedTime : PT0.004S
ExecutionEndDateTime : 2017-02-22T20:13:16.651Z
ExecutionStartDateTime : 2017-02-22T20:13:16.651Z
InstanceId : i-0cb2b964d3e14fd9f
PluginName : aws:runShellScript
ResponseCode : 0
StandardErrorContent :
StandardErrorUrl :
StandardOutputContent :
StandardOutputUrl :
Status : Success
StatusDetails : Success
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetCommandInvocation](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `GetConnectionStatus` 與 CLI
<a name="ssm_example_ssm_GetConnectionStatus_section"></a>
下列程式碼範例示範如何使用 `GetConnectionStatus`。
------
#### [ CLI ]
**AWS CLI**
**顯示受管執行個體的連線狀態**
此 `get-connection-status` 範例傳回指定受管執行個體的連線狀態。
```
aws ssm get-connection-status \
--target i-1234567890abcdef0
```
輸出：
```
{
"Target": "i-1234567890abcdef0",
"Status": "connected"
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetConnectionStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/get-connection-status.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範擷取執行個體的 Session Manager 連線狀態，以判斷執行個體是否已連線並準備好接收 Session Manager 連線。**
```
Get-SSMConnectionStatus -Target i-0a1caf234f12d3dc4
```
**輸出：**
```
Status Target
------ ------
Connected i-0a1caf234f12d3dc4
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetConnectionStatus](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範擷取執行個體的 Session Manager 連線狀態，以判斷執行個體是否已連線並準備好接收 Session Manager 連線。**
```
Get-SSMConnectionStatus -Target i-0a1caf234f12d3dc4
```
**輸出：**
```
Status Target
------ ------
Connected i-0a1caf234f12d3dc4
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetConnectionStatus](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `GetDefaultPatchBaseline` 與 CLI
<a name="ssm_example_ssm_GetDefaultPatchBaseline_section"></a>
下列程式碼範例示範如何使用 `GetDefaultPatchBaseline`。
------
#### [ CLI ]
**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 使用者指南》**中的 About Predefined and Custom Patch Baselines <https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-patch-baselines.html>\$1\$1 和 [Set an Existing Patch Baseline as the Default](https://docs.aws.amazon.com/systems-manager/latest/userguide/set-default-patch-baseline.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetDefaultPatchBaseline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/get-default-patch-baseline.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例顯示預設修補基準。**
```
Get-SSMDefaultPatchBaseline
```
**輸出：**
```
arn:aws:ssm:us-west-2:123456789012:patchbaseline/pb-04fb4ae6142167966
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetDefaultPatchBaseline](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例顯示預設修補基準。**
```
Get-SSMDefaultPatchBaseline
```
**輸出：**
```
arn:aws:ssm:us-west-2:123456789012:patchbaseline/pb-04fb4ae6142167966
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetDefaultPatchBaseline](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `GetDeployablePatchSnapshotForInstance` 與 CLI
<a name="ssm_example_ssm_GetDeployablePatchSnapshotForInstance_section"></a>
下列程式碼範例示範如何使用 `GetDeployablePatchSnapshotForInstance`。
------
#### [ CLI ]
**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 使用者指南》**中的 [Parameter name: Snapshot ID](https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-about-aws-runpatchbaseline.html#patch-manager-about-aws-runpatchbaseline-parameters-snapshot-id)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetDeployablePatchSnapshotForInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/get-deployable-patch-snapshot-for-instance.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例顯示執行個體所用之修補基準的目前快照。此命令必須使用執行個體憑證從執行個體執行。為確保它使用執行個體憑證，範例會將 `Amazon.Runtime.InstanceProfileAWSCredentials` 物件傳遞至憑證參數。**
```
$credentials = [Amazon.Runtime.InstanceProfileAWSCredentials]::new()
Get-SSMDeployablePatchSnapshotForInstance -SnapshotId "4681775b-098f-4435-a956-0ef33373ac11" -InstanceId "i-0cb2b964d3e14fd9f" -Credentials $credentials
```
**輸出：**
```
InstanceId SnapshotDownloadUrl
---------- -------------------
i-0cb2b964d3e14fd9f https://patch-baseline-snapshot-us-west-2.s3-us-west-2.amazonaws.com/853d0d3db0f0cafe...1692/4681775b-098f-4435...
```
**範例 2：此範例顯示如何取得完整的 SnapshotDownloadUrl。此命令必須使用執行個體憑證從執行個體執行。為確保它使用執行個體憑證，此範例會將 PowerShell 工作階段設定為使用 `Amazon.Runtime.InstanceProfileAWSCredentials` 物件。**
```
Set-AWSCredential -Credential ([Amazon.Runtime.InstanceProfileAWSCredentials]::new())
(Get-SSMDeployablePatchSnapshotForInstance -SnapshotId "4681775b-098f-4435-a956-0ef33373ac11" -InstanceId "i-0cb2b964d3e14fd9f").SnapshotDownloadUrl
```
**輸出：**
```
https://patch-baseline-snapshot-us-west-2.s3-us-west-2.amazonaws.com/853d0d3db0f0cafe...
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetDeployablePatchSnapshotForInstance](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例顯示執行個體所用之修補基準的目前快照。此命令必須使用執行個體憑證從執行個體執行。為確保它使用執行個體憑證，範例會將 `Amazon.Runtime.InstanceProfileAWSCredentials` 物件傳遞至憑證參數。**
```
$credentials = [Amazon.Runtime.InstanceProfileAWSCredentials]::new()
Get-SSMDeployablePatchSnapshotForInstance -SnapshotId "4681775b-098f-4435-a956-0ef33373ac11" -InstanceId "i-0cb2b964d3e14fd9f" -Credentials $credentials
```
**輸出：**
```
InstanceId SnapshotDownloadUrl
---------- -------------------
i-0cb2b964d3e14fd9f https://patch-baseline-snapshot-us-west-2.s3-us-west-2.amazonaws.com/853d0d3db0f0cafe...1692/4681775b-098f-4435...
```
**範例 2：此範例顯示如何取得完整的 SnapshotDownloadUrl。此命令必須使用執行個體憑證從執行個體執行。為確保它使用執行個體憑證，此範例會將 PowerShell 工作階段設定為使用 `Amazon.Runtime.InstanceProfileAWSCredentials` 物件。**
```
Set-AWSCredential -Credential ([Amazon.Runtime.InstanceProfileAWSCredentials]::new())
(Get-SSMDeployablePatchSnapshotForInstance -SnapshotId "4681775b-098f-4435-a956-0ef33373ac11" -InstanceId "i-0cb2b964d3e14fd9f").SnapshotDownloadUrl
```
**輸出：**
```
https://patch-baseline-snapshot-us-west-2.s3-us-west-2.amazonaws.com/853d0d3db0f0cafe...
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetDeployablePatchSnapshotForInstance](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `GetDocument` 與 CLI
<a name="ssm_example_ssm_GetDocument_section"></a>
下列程式碼範例示範如何使用 `GetDocument`。
------
#### [ CLI ]
**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 Documents](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-ssm-docs.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetDocument](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/get-document.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例傳回文件的內容。**
```
Get-SSMDocument -Name "RunShellScript"
```
**輸出：**
```
Content
-------
{...
```
**範例 2：此範例顯示文件的完整內容。**
```
(Get-SSMDocument -Name "RunShellScript").Content
{
"schemaVersion":"2.0",
"description":"Run an updated script",
"parameters":{
"commands":{
"type":"StringList",
"description":"(Required) Specify a shell script or a command to run.",
"minItems":1,
"displayType":"textarea"
}
},
"mainSteps":[
{
"action":"aws:runShellScript",
"name":"runShellScript",
"inputs":{
"commands":"{{ commands }}"
}
},
{
"action":"aws:runPowerShellScript",
"name":"runPowerShellScript",
"inputs":{
"commands":"{{ commands }}"
}
}
]
}
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetDocument](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例傳回文件的內容。**
```
Get-SSMDocument -Name "RunShellScript"
```
**輸出：**
```
Content
-------
{...
```
**範例 2：此範例顯示文件的完整內容。**
```
(Get-SSMDocument -Name "RunShellScript").Content
{
"schemaVersion":"2.0",
"description":"Run an updated script",
"parameters":{
"commands":{
"type":"StringList",
"description":"(Required) Specify a shell script or a command to run.",
"minItems":1,
"displayType":"textarea"
}
},
"mainSteps":[
{
"action":"aws:runShellScript",
"name":"runShellScript",
"inputs":{
"commands":"{{ commands }}"
}
},
{
"action":"aws:runPowerShellScript",
"name":"runPowerShellScript",
"inputs":{
"commands":"{{ commands }}"
}
}
]
}
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetDocument](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `GetInventory` 與 CLI
<a name="ssm_example_ssm_GetInventory_section"></a>
下列程式碼範例示範如何使用 `GetInventory`。
------
#### [ CLI ]
**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 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetInventory](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/get-inventory.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範取得庫存的自訂中繼資料。**
```
Get-SSMInventory
```
**輸出：**
```
Data Id
---- --
{[AWS:InstanceInformation, Amazon.SimpleSystemsManagement.Model.InventoryResultItem]} i-0cb2b964d3e14fd9f
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetInventory](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範取得庫存的自訂中繼資料。**
```
Get-SSMInventory
```
**輸出：**
```
Data Id
---- --
{[AWS:InstanceInformation, Amazon.SimpleSystemsManagement.Model.InventoryResultItem]} i-0cb2b964d3e14fd9f
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetInventory](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `GetInventorySchema` 與 CLI
<a name="ssm_example_ssm_GetInventorySchema_section"></a>
下列程式碼範例示範如何使用 `GetInventorySchema`。
------
#### [ CLI ]
**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元件庫存類型的庫存結構描述。
命令：
```
aws ssm get-inventory-schema --type-name "AWS:AWSComponent"
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetInventorySchema](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/get-inventory-schema.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例傳回帳戶的庫存類型名稱清單。**
```
Get-SSMInventorySchema
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetInventorySchema](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例傳回帳戶的庫存類型名稱清單。**
```
Get-SSMInventorySchema
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetInventorySchema](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `GetMaintenanceWindow` 與 CLI
<a name="ssm_example_ssm_GetMaintenanceWindow_section"></a>
下列程式碼範例示範如何使用 `GetMaintenanceWindow`。
------
#### [ CLI ]
**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"
}
```
如需詳細資訊，請參閱 *AWS Systems Manager 使用者指南*中的[檢視維護時段 (AWS CLI) 的相關資訊](https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-cli-tutorials-describe.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetMaintenanceWindow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/get-maintenance-window.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範取得有關維護時段的詳細資訊。**
```
Get-SSMMaintenanceWindow -WindowId "mw-03eb9db42890fb82d"
```
**輸出：**
```
AllowUnassociatedTargets : False
CreatedDate : 2/20/2017 6:14:05 PM
Cutoff : 1
Duration : 2
Enabled : True
ModifiedDate : 2/20/2017 6:14:05 PM
Name : TestMaintWin
Schedule : cron(0 */30 * * * ? *)
WindowId : mw-03eb9db42890fb82d
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetMaintenanceWindow](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範取得有關維護時段的詳細資訊。**
```
Get-SSMMaintenanceWindow -WindowId "mw-03eb9db42890fb82d"
```
**輸出：**
```
AllowUnassociatedTargets : False
CreatedDate : 2/20/2017 6:14:05 PM
Cutoff : 1
Duration : 2
Enabled : True
ModifiedDate : 2/20/2017 6:14:05 PM
Name : TestMaintWin
Schedule : cron(0 */30 * * * ? *)
WindowId : mw-03eb9db42890fb82d
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetMaintenanceWindow](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `GetMaintenanceWindowExecution` 與 CLI
<a name="ssm_example_ssm_GetMaintenanceWindowExecution_section"></a>
下列程式碼範例示範如何使用 `GetMaintenanceWindowExecution`。
------
#### [ CLI ]
**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) 的相關資訊](https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-task-info.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetMaintenanceWindowExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/get-maintenance-window-execution.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例列出了作為維護時段執行的一部分執行之任務的資訊。**
```
Get-SSMMaintenanceWindowExecution -WindowExecutionId "518d5565-5969-4cca-8f0e-da3b2a638355"
```
**輸出：**
```
EndTime : 2/21/2017 4:00:35 PM
StartTime : 2/21/2017 4:00:34 PM
Status : FAILED
StatusDetails : One or more tasks in the orchestration failed.
TaskIds : {ac0c6ae1-daa3-4a89-832e-d384503b6586}
WindowExecutionId : 518d5565-5969-4cca-8f0e-da3b2a638355
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetMaintenanceWindowExecution](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例列出了作為維護時段執行的一部分執行之任務的資訊。**
```
Get-SSMMaintenanceWindowExecution -WindowExecutionId "518d5565-5969-4cca-8f0e-da3b2a638355"
```
**輸出：**
```
EndTime : 2/21/2017 4:00:35 PM
StartTime : 2/21/2017 4:00:34 PM
Status : FAILED
StatusDetails : One or more tasks in the orchestration failed.
TaskIds : {ac0c6ae1-daa3-4a89-832e-d384503b6586}
WindowExecutionId : 518d5565-5969-4cca-8f0e-da3b2a638355
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetMaintenanceWindowExecution](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `GetMaintenanceWindowExecutionTask` 與 CLI
<a name="ssm_example_ssm_GetMaintenanceWindowExecutionTask_section"></a>
下列程式碼範例示範如何使用 `GetMaintenanceWindowExecutionTask`。
------
#### [ CLI ]
**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) 的相關資訊](https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-task-info.html)。
+ 如需 API 詳細資訊，請參閱《*AWS CLI 命令參考*》中的 [GetMaintenanceWindowExecutionTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/get-maintenance-window-execution-task.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例列出了有關屬於維護時段執行之任務的資訊。**
```
Get-SSMMaintenanceWindowExecutionTask -TaskId "ac0c6ae1-daa3-4a89-832e-d384503b6586" -WindowExecutionId "518d5565-5969-4cca-8f0e-da3b2a638355"
```
**輸出：**
```
EndTime : 2/21/2017 4:00:35 PM
MaxConcurrency : 1
MaxErrors : 1
Priority : 10
ServiceRole : arn:aws:iam::123456789012:role/MaintenanceWindowsRole
StartTime : 2/21/2017 4:00:34 PM
Status : FAILED
StatusDetails : The maximum error count was exceeded.
TaskArn : AWS-RunShellScript
TaskExecutionId : ac0c6ae1-daa3-4a89-832e-d384503b6586
TaskParameters : {Amazon.Runtime.Internal.Util.AlwaysSendDictionary`2[System.String,Amazon.SimpleSystemsManagement.Model.MaintenanceWindowTaskPara
meterValueExpression]}
Type : RUN_COMMAND
WindowExecutionId : 518d5565-5969-4cca-8f0e-da3b2a638355
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetMaintenanceWindowExecutionTask](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例列出了有關屬於維護時段執行之任務的資訊。**
```
Get-SSMMaintenanceWindowExecutionTask -TaskId "ac0c6ae1-daa3-4a89-832e-d384503b6586" -WindowExecutionId "518d5565-5969-4cca-8f0e-da3b2a638355"
```
**輸出：**
```
EndTime : 2/21/2017 4:00:35 PM
MaxConcurrency : 1
MaxErrors : 1
Priority : 10
ServiceRole : arn:aws:iam::123456789012:role/MaintenanceWindowsRole
StartTime : 2/21/2017 4:00:34 PM
Status : FAILED
StatusDetails : The maximum error count was exceeded.
TaskArn : AWS-RunShellScript
TaskExecutionId : ac0c6ae1-daa3-4a89-832e-d384503b6586
TaskParameters : {Amazon.Runtime.Internal.Util.AlwaysSendDictionary`2[System.String,Amazon.SimpleSystemsManagement.Model.MaintenanceWindowTaskPara
meterValueExpression]}
Type : RUN_COMMAND
WindowExecutionId : 518d5565-5969-4cca-8f0e-da3b2a638355
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetMaintenanceWindowExecutionTask](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# `GetParameter` 搭配 AWS SDK 或 CLI 使用
<a name="ssm_example_ssm_GetParameter_section"></a>
下列程式碼範例示範如何使用 `GetParameter`。
------
#### [ CLI ]
**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"
}
}
```
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Working with Parameter Store](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-working-with.html)。
**範例 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"
}
}
```
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Working with Parameter Store](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-working-with.html)。
**範例 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"
}
}
```
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Working with parameter labels](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-labels.html)。
**範例 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"
}
}
```
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Working with parameter labels](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-labels.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetParameter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/get-parameter.html)。
------
#### [ Rust ]
**適用於 Rust 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/ssm#code-examples)中設定和執行。
```
pub async fn list_path(&self, path: &str) -> Result<Vec<Parameter>, EC2Error> {
let maybe_params: Vec<Result<Parameter, _>> = TryFlatMap::new(
self.inner
.get_parameters_by_path()
.path(path)
.into_paginator()
.send(),
)
.flat_map(|item| item.parameters.unwrap_or_default())
.collect()
.await;
// Fail on the first error
let params = maybe_params
.into_iter()
.collect::<Result<Vec<Parameter>, _>>()?;
Ok(params)
}
```
+ 如需 API 詳細資訊，請參閱《適用於 Rust 的AWS SDK API 參考》**中的 [GetParameter](https://docs.rs/aws-sdk-ssm/latest/aws_sdk_ssm/client/struct.Client.html#method.get_parameter)。
------
# 搭配使用 `GetParameterHistory` 與 CLI
<a name="ssm_example_ssm_GetParameterHistory_section"></a>
下列程式碼範例示範如何使用 `GetParameterHistory`。
------
#### [ CLI ]
**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": []
}
]
}
```
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Working with parameter versions](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-versions.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetParameterHistory](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/get-parameter-history.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例列出了參數的值歷史記錄。**
```
Get-SSMParameterHistory -Name "Welcome"
```
**輸出：**
```
Description :
KeyId :
LastModifiedDate : 3/3/2017 6:55:25 PM
LastModifiedUser : arn:aws:iam::123456789012:user/admin
Name : Welcome
Type : String
Value : helloWorld
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetParameterHistory](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例列出了參數的值歷史記錄。**
```
Get-SSMParameterHistory -Name "Welcome"
```
**輸出：**
```
Description :
KeyId :
LastModifiedDate : 3/3/2017 6:55:25 PM
LastModifiedUser : arn:aws:iam::123456789012:user/admin
Name : Welcome
Type : String
Value : helloWorld
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetParameterHistory](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `GetParameters` 與 CLI
<a name="ssm_example_ssm_GetParameters_section"></a>
下列程式碼範例示範如何使用 `GetParameters`。
------
#### [ CLI ]
**AWS CLI**
**範例 1：列出參數的值**
下列 `get-parameters` 範例列出了三個指定參數的值。
```
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"
]
}
```
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Working with Parameter Store](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-working-with.html)。
**範例 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"
}
]
```
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Working with Parameter Store](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-working-with.html)。
**範例 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": []
}
```
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Working with parameter labels](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-labels.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/get-parameters.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例列出了參數的多個值。**
```
Get-SSMParameterValue -Name "Welcome"
```
**輸出：**
```
InvalidParameters Parameters
----------------- ----------
{} {Welcome}
```
**範例 2：此範例列出了值的詳細資訊。**
```
(Get-SSMParameterValue -Name "Welcome").Parameters
```
**輸出：**
```
Name Type Value
---- ---- -----
Welcome String Good day, Sunshine!
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetParameters](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例列出了參數的多個值。**
```
Get-SSMParameterValue -Name "Welcome"
```
**輸出：**
```
InvalidParameters Parameters
----------------- ----------
{} {Welcome}
```
**範例 2：此範例列出了值的詳細資訊。**
```
(Get-SSMParameterValue -Name "Welcome").Parameters
```
**輸出：**
```
Name Type Value
---- ---- -----
Welcome String Good day, Sunshine!
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetParameters](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `GetPatchBaseline` 與 CLI
<a name="ssm_example_ssm_GetPatchBaseline_section"></a>
下列程式碼範例示範如何使用 `GetPatchBaseline`。
------
#### [ CLI ]
**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 使用者指南》**中的 [About Patch Baselines](https://docs.aws.amazon.com/systems-manager/latest/userguide/about-patch-baselines.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetPatchBaseline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/get-patch-baseline.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例顯示修補基準的詳細資訊。**
```
Get-SSMPatchBaselineDetail -BaselineId "pb-03da896ca3b68b639"
```
**輸出：**
```
ApprovalRules : Amazon.SimpleSystemsManagement.Model.PatchRuleGroup
ApprovedPatches : {}
BaselineId : pb-03da896ca3b68b639
CreatedDate : 3/3/2017 5:02:19 PM
Description : Baseline containing all updates approved for production systems
GlobalFilters : Amazon.SimpleSystemsManagement.Model.PatchFilterGroup
ModifiedDate : 3/3/2017 5:02:19 PM
Name : Production-Baseline
PatchGroups : {}
RejectedPatches : {}
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetPatchBaseline](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例顯示修補基準的詳細資訊。**
```
Get-SSMPatchBaselineDetail -BaselineId "pb-03da896ca3b68b639"
```
**輸出：**
```
ApprovalRules : Amazon.SimpleSystemsManagement.Model.PatchRuleGroup
ApprovedPatches : {}
BaselineId : pb-03da896ca3b68b639
CreatedDate : 3/3/2017 5:02:19 PM
Description : Baseline containing all updates approved for production systems
GlobalFilters : Amazon.SimpleSystemsManagement.Model.PatchFilterGroup
ModifiedDate : 3/3/2017 5:02:19 PM
Name : Production-Baseline
PatchGroups : {}
RejectedPatches : {}
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetPatchBaseline](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `GetPatchBaselineForPatchGroup` 與 CLI
<a name="ssm_example_ssm_GetPatchBaselineForPatchGroup_section"></a>
下列程式碼範例示範如何使用 `GetPatchBaselineForPatchGroup`。
------
#### [ CLI ]
**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>\$1\$1 和 [Add a Patch Group to a Patch Baseline](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-patch-group-patchbaseline.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetPatchBaselineForPatchGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/get-patch-baseline-for-patch-group.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例顯示修補程式群組的修補基準。**
```
Get-SSMPatchBaselineForPatchGroup -PatchGroup "Production"
```
**輸出：**
```
BaselineId PatchGroup
---------- ----------
pb-045f10b4f382baeda Production
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetPatchBaselineForPatchGroup](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例顯示修補程式群組的修補基準。**
```
Get-SSMPatchBaselineForPatchGroup -PatchGroup "Production"
```
**輸出：**
```
BaselineId PatchGroup
---------- ----------
pb-045f10b4f382baeda Production
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetPatchBaselineForPatchGroup](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `ListAssociationVersions` 與 CLI
<a name="ssm_example_ssm_ListAssociationVersions_section"></a>
下列程式碼範例示範如何使用 `ListAssociationVersions`。
------
#### [ CLI ]
**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"
}
]
}
```
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Working with associations in Systems Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-associations.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListAssociationVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/list-association-versions.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範擷取所提供之關聯的所有版本。**
```
Get-SSMAssociationVersionList -AssociationId 123a45a0-c678-9012-3456-78901234db5e
```
**輸出：**
```
AssociationId : 123a45a0-c678-9012-3456-78901234db5e
AssociationName :
AssociationVersion : 2
ComplianceSeverity :
CreatedDate : 3/12/2019 9:21:01 AM
DocumentVersion :
MaxConcurrency :
MaxErrors :
Name : AWS-GatherSoftwareInventory
OutputLocation :
Parameters : {}
ScheduleExpression :
Targets : {InstanceIds}
AssociationId : 123a45a0-c678-9012-3456-78901234db5e
AssociationName : test-case-1234567890
AssociationVersion : 1
ComplianceSeverity :
CreatedDate : 3/2/2019 8:53:29 AM
DocumentVersion :
MaxConcurrency :
MaxErrors :
Name : AWS-GatherSoftwareInventory
OutputLocation :
Parameters : {}
ScheduleExpression : rate(30minutes)
Targets : {InstanceIds}
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [ListAssociationVersions](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範擷取所提供之關聯的所有版本。**
```
Get-SSMAssociationVersionList -AssociationId 123a45a0-c678-9012-3456-78901234db5e
```
**輸出：**
```
AssociationId : 123a45a0-c678-9012-3456-78901234db5e
AssociationName :
AssociationVersion : 2
ComplianceSeverity :
CreatedDate : 3/12/2019 9:21:01 AM
DocumentVersion :
MaxConcurrency :
MaxErrors :
Name : AWS-GatherSoftwareInventory
OutputLocation :
Parameters : {}
ScheduleExpression :
Targets : {InstanceIds}
AssociationId : 123a45a0-c678-9012-3456-78901234db5e
AssociationName : test-case-1234567890
AssociationVersion : 1
ComplianceSeverity :
CreatedDate : 3/2/2019 8:53:29 AM
DocumentVersion :
MaxConcurrency :
MaxErrors :
Name : AWS-GatherSoftwareInventory
OutputLocation :
Parameters : {}
ScheduleExpression : rate(30minutes)
Targets : {InstanceIds}
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [ListAssociationVersions](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `ListAssociations` 與 CLI
<a name="ssm_example_ssm_ListAssociations_section"></a>
下列程式碼範例示範如何使用 `ListAssociations`。
------
#### [ CLI ]
**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 使用者指南》**中的 [Working with associations in Systems Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-associations.html)。
**範例 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 使用者指南》**中的 [Working with associations in Systems Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-associations.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/list-associations.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例列出了執行個體的所有關聯。此範例使用的語法需要 PowerShell 版本 3 或更新版本。**
```
$filter1 = @{Key="InstanceId";Value=@("i-0000293ffd8c57862")}
Get-SSMAssociationList -AssociationFilterList $filter1
```
**輸出：**
```
AssociationId : d8617c07-2079-4c18-9847-1655fc2698b0
DocumentVersion :
InstanceId : i-0000293ffd8c57862
LastExecutionDate : 2/20/2015 8:31:11 AM
Name : AWS-UpdateSSMAgent
Overview : Amazon.SimpleSystemsManagement.Model.AssociationOverview
ScheduleExpression :
Targets : {InstanceIds}
```
**範例 2：此範例列出了組態文件的所有關聯。此範例使用的語法需要 PowerShell 版本 3 或更新版本。**
```
$filter2 = @{Key="Name";Value=@("AWS-UpdateSSMAgent")}
Get-SSMAssociationList -AssociationFilterList $filter2
```
**輸出：**
```
AssociationId : d8617c07-2079-4c18-9847-1655fc2698b0
DocumentVersion :
InstanceId : i-0000293ffd8c57862
LastExecutionDate : 2/20/2015 8:31:11 AM
Name : AWS-UpdateSSMAgent
Overview : Amazon.SimpleSystemsManagement.Model.AssociationOverview
ScheduleExpression :
Targets : {InstanceIds}
```
**範例 3：使用 PowerShell 版本 2 時，必須使用 New-Object 來建立每個篩選條件。**
```
$filter1 = New-Object Amazon.SimpleSystemsManagement.Model.AssociationFilter
$filter1.Key = "InstanceId"
$filter1.Value = "i-0000293ffd8c57862"
Get-SSMAssociationList -AssociationFilterList $filter1
```
**輸出：**
```
AssociationId : d8617c07-2079-4c18-9847-1655fc2698b0
DocumentVersion :
InstanceId : i-0000293ffd8c57862
LastExecutionDate : 2/20/2015 8:31:11 AM
Name : AWS-UpdateSSMAgent
Overview : Amazon.SimpleSystemsManagement.Model.AssociationOverview
ScheduleExpression :
Targets : {InstanceIds}
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [ListAssociations](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例列出了執行個體的所有關聯。此範例使用的語法需要 PowerShell 版本 3 或更新版本。**
```
$filter1 = @{Key="InstanceId";Value=@("i-0000293ffd8c57862")}
Get-SSMAssociationList -AssociationFilterList $filter1
```
**輸出：**
```
AssociationId : d8617c07-2079-4c18-9847-1655fc2698b0
DocumentVersion :
InstanceId : i-0000293ffd8c57862
LastExecutionDate : 2/20/2015 8:31:11 AM
Name : AWS-UpdateSSMAgent
Overview : Amazon.SimpleSystemsManagement.Model.AssociationOverview
ScheduleExpression :
Targets : {InstanceIds}
```
**範例 2：此範例列出了組態文件的所有關聯。此範例使用的語法需要 PowerShell 版本 3 或更新版本。**
```
$filter2 = @{Key="Name";Value=@("AWS-UpdateSSMAgent")}
Get-SSMAssociationList -AssociationFilterList $filter2
```
**輸出：**
```
AssociationId : d8617c07-2079-4c18-9847-1655fc2698b0
DocumentVersion :
InstanceId : i-0000293ffd8c57862
LastExecutionDate : 2/20/2015 8:31:11 AM
Name : AWS-UpdateSSMAgent
Overview : Amazon.SimpleSystemsManagement.Model.AssociationOverview
ScheduleExpression :
Targets : {InstanceIds}
```
**範例 3：使用 PowerShell 版本 2 時，必須使用 New-Object 來建立每個篩選條件。**
```
$filter1 = New-Object Amazon.SimpleSystemsManagement.Model.AssociationFilter
$filter1.Key = "InstanceId"
$filter1.Value = "i-0000293ffd8c57862"
Get-SSMAssociationList -AssociationFilterList $filter1
```
**輸出：**
```
AssociationId : d8617c07-2079-4c18-9847-1655fc2698b0
DocumentVersion :
InstanceId : i-0000293ffd8c57862
LastExecutionDate : 2/20/2015 8:31:11 AM
Name : AWS-UpdateSSMAgent
Overview : Amazon.SimpleSystemsManagement.Model.AssociationOverview
ScheduleExpression :
Targets : {InstanceIds}
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [ListAssociations](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# `ListCommandInvocations` 搭配 AWS SDK 或 CLI 使用
<a name="ssm_example_ssm_ListCommandInvocations_section"></a>
下列程式碼範例示範如何使用 `ListCommandInvocations`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](ssm_example_ssm_Scenario_section.md)
------
#### [ CLI ]
**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 使用者指南》**中的 [Understanding Command Statuses](https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListCommandInvocations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/list-command-invocations.html)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ssm#code-examples)中設定和執行。
```
import { paginateListCommandInvocations, SSMClient } from "@aws-sdk/client-ssm";
import { parseArgs } from "node:util";
/**
* List SSM command invocations on an instance.
* @param {{ instanceId: string }}
*/
export const main = async ({ instanceId }) => {
const client = new SSMClient({});
try {
const listCommandInvocationsPaginated = [];
// The paginate function is a wrapper around the base command.
const paginator = paginateListCommandInvocations(
{ client },
{
InstanceId: instanceId,
},
);
for await (const page of paginator) {
listCommandInvocationsPaginated.push(...page.CommandInvocations);
}
console.log("Here is the list of command invocations:");
console.log(listCommandInvocationsPaginated);
return { CommandInvocations: listCommandInvocationsPaginated };
} catch (caught) {
if (caught instanceof Error && caught.name === "ValidationError") {
console.warn(`${caught.message}. Did you provide a valid instance ID?`);
}
throw caught;
}
};
```
+ 如需 API 詳細資訊，請參閱《適用於 JavaScript 的 AWS SDK API 參考》**中的 [ListCommandInvocations](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/ListCommandInvocationsCommand)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例列出了命令的所有調用。**
```
Get-SSMCommandInvocation -CommandId "b8eac879-0541-439d-94ec-47a80d554f44" -Detail $true
```
**輸出：**
```
CommandId : b8eac879-0541-439d-94ec-47a80d554f44
CommandPlugins : {aws:runShellScript}
Comment : IP config
DocumentName : AWS-RunShellScript
InstanceId : i-0cb2b964d3e14fd9f
InstanceName :
NotificationConfig : Amazon.SimpleSystemsManagement.Model.NotificationConfig
RequestedDateTime : 2/22/2017 8:13:16 PM
ServiceRole :
StandardErrorUrl :
StandardOutputUrl :
Status : Success
StatusDetails : Success
TraceOutput :
```
**範例 2：此範例列出了用於調用命令 ID 為 e1eb2e3c-ed4c-5123-45c1-234f5612345f 的 CommandPlugins**
```
Get-SSMCommandInvocation -CommandId e1eb2e3c-ed4c-5123-45c1-234f5612345f -Detail:$true | Select-Object -ExpandProperty CommandPlugins
```
**輸出：**
```
Name : aws:runPowerShellScript
Output : Completed 17.7 KiB/17.7 KiB (40.1 KiB/s) with 1 file(s) remainingdownload: s3://dd-aess-r-ctmer/KUMO.png to ..\..\programdata\KUMO.png
kumo available
OutputS3BucketName :
OutputS3KeyPrefix :
OutputS3Region : eu-west-1
ResponseCode : 0
ResponseFinishDateTime : 4/3/2019 11:53:23 AM
ResponseStartDateTime : 4/3/2019 11:53:21 AM
StandardErrorUrl :
StandardOutputUrl :
Status : Success
StatusDetails : Success
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [ListCommandInvocations](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例列出了命令的所有調用。**
```
Get-SSMCommandInvocation -CommandId "b8eac879-0541-439d-94ec-47a80d554f44" -Detail $true
```
**輸出：**
```
CommandId : b8eac879-0541-439d-94ec-47a80d554f44
CommandPlugins : {aws:runShellScript}
Comment : IP config
DocumentName : AWS-RunShellScript
InstanceId : i-0cb2b964d3e14fd9f
InstanceName :
NotificationConfig : Amazon.SimpleSystemsManagement.Model.NotificationConfig
RequestedDateTime : 2/22/2017 8:13:16 PM
ServiceRole :
StandardErrorUrl :
StandardOutputUrl :
Status : Success
StatusDetails : Success
TraceOutput :
```
**範例 2：此範例列出了用於調用命令 ID 為 e1eb2e3c-ed4c-5123-45c1-234f5612345f 的 CommandPlugins**
```
Get-SSMCommandInvocation -CommandId e1eb2e3c-ed4c-5123-45c1-234f5612345f -Detail:$true | Select-Object -ExpandProperty CommandPlugins
```
**輸出：**
```
Name : aws:runPowerShellScript
Output : Completed 17.7 KiB/17.7 KiB (40.1 KiB/s) with 1 file(s) remainingdownload: s3://dd-aess-r-ctmer/KUMO.png to ..\..\programdata\KUMO.png
kumo available
OutputS3BucketName :
OutputS3KeyPrefix :
OutputS3Region : eu-west-1
ResponseCode : 0
ResponseFinishDateTime : 4/3/2019 11:53:23 AM
ResponseStartDateTime : 4/3/2019 11:53:21 AM
StandardErrorUrl :
StandardOutputUrl :
Status : Success
StatusDetails : Success
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [ListCommandInvocations](https://docs.aws.amazon.com/powershell/v5/reference)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/ssm#code-examples)中設定和執行。
```
class DocumentWrapper:
"""Encapsulates AWS Systems Manager Document actions."""
def __init__(self, ssm_client):
"""
:param ssm_client: A Boto3 Systems Manager client.
"""
self.ssm_client = ssm_client
self.name = None
@classmethod
def from_client(cls):
ssm_client = boto3.client("ssm")
return cls(ssm_client)
def list_command_invocations(self, instance_id):
"""
Lists the commands for an instance.
:param instance_id: The ID of the instance.
:return: The list of commands.
"""
try:
paginator = self.ssm_client.get_paginator("list_command_invocations")
command_invocations = []
for page in paginator.paginate(InstanceId=instance_id):
command_invocations.extend(page["CommandInvocations"])
num_of_commands = len(command_invocations)
print(
f"{num_of_commands} command invocation(s) found for instance {instance_id}."
)
if num_of_commands > 10:
print("Displaying the first 10 commands:")
num_of_commands = 10
date_format = "%A, %d %B %Y %I:%M%p"
for command in command_invocations[:num_of_commands]:
print(
f" The time of command invocation is {command['RequestedDateTime'].strftime(date_format)}"
)
except ClientError as err:
logger.error(
"Couldn't list commands for %s. Here's why: %s: %s",
instance_id,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) 的 API 參考》**中的 [ListCommandInvocations](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/ListCommandInvocations)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ssm#code-examples)中設定和執行。
```
TRY.
" Use paginator to get all results
DATA(lo_paginator) = lo_ssm->get_paginator( ).
DATA(lo_iterator) = lo_paginator->listcommandinvocations(
iv_instanceid = iv_instance_id ).
DATA lv_count TYPE i VALUE 0.
WHILE lo_iterator->has_next( ).
DATA(lo_result) = CAST /aws1/cl_ssmlistcmdinvcsresult( lo_iterator->get_next( ) ).
LOOP AT lo_result->get_commandinvocations( ) INTO DATA(lo_invocation).
lv_count = lv_count + 1.
DATA(lv_requested_datetime) = lo_invocation->get_requesteddatetime( ).
MESSAGE |Command invocation requested at: { lv_requested_datetime }| TYPE 'I'.
ENDLOOP.
ENDWHILE.
MESSAGE |{ lv_count } command invocation(s) found for instance { iv_instance_id }.| TYPE 'I'.
CATCH /aws1/cx_ssminvalidinstanceid.
MESSAGE 'Invalid instance ID.' TYPE 'I'.
CATCH /aws1/cx_ssminvalidcommandid.
MESSAGE 'Invalid command ID.' TYPE 'I'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [ListCommandInvocations](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# 搭配使用 `ListCommands` 與 CLI
<a name="ssm_example_ssm_ListCommands_section"></a>
下列程式碼範例示範如何使用 `ListCommands`。
------
#### [ CLI ]
**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
}
}
]
}
```
如需詳細資訊，請參閱*《AWS Systems Manager 使用者指南》*中的 [Running Commands Using Systems Manager Run Command](https://docs.aws.amazon.com/systems-manager/latest/userguide/run-command.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListCommands](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/list-commands.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例列出了所請求的所有命令。**
```
Get-SSMCommand
```
**輸出：**
```
CommandId : 4b75a163-d39a-4d97-87c9-98ae52c6be35
Comment : Apply association with id at update time: 4cc73e42-d5ae-4879-84f8-57e09c0efcd0
CompletedCount : 1
DocumentName : AWS-RefreshAssociation
ErrorCount : 0
ExpiresAfter : 2/24/2017 3:19:08 AM
InstanceIds : {i-0cb2b964d3e14fd9f}
MaxConcurrency : 50
MaxErrors : 0
NotificationConfig : Amazon.SimpleSystemsManagement.Model.NotificationConfig
OutputS3BucketName :
OutputS3KeyPrefix :
OutputS3Region :
Parameters : {[associationIds, Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]]}
RequestedDateTime : 2/24/2017 3:18:08 AM
ServiceRole :
Status : Success
StatusDetails : Success
TargetCount : 1
Targets : {}
```
**範例 2：此範例示範取得特定命令的狀態。**
```
Get-SSMCommand -CommandId "4b75a163-d39a-4d97-87c9-98ae52c6be35"
```
**範例 3：此範例示範擷取在 2019-04-01T00:00:00Z 之後調用的所有 SSM 命令**
```
Get-SSMCommand -Filter @{Key="InvokedAfter";Value="2019-04-01T00:00:00Z"} | Select-Object CommandId, DocumentName, Status, RequestedDateTime | Sort-Object -Property RequestedDateTime -Descending
```
**輸出：**
```
CommandId DocumentName Status RequestedDateTime
--------- ------------ ------ -----------------
edb1b23e-456a-7adb-aef8-90e-012ac34f AWS-RunPowerShellScript Cancelled 4/16/2019 5:45:23 AM
1a2dc3fb-4567-890d-a1ad-234b5d6bc7d9 AWS-ConfigureAWSPackage Success 4/6/2019 9:19:42 AM
12c3456c-7e90-4f12-1232-1234f5b67893 KT-Retrieve-Cloud-Type-Win Failed 4/2/2019 4:13:07 AM
fe123b45-240c-4123-a2b3-234bdd567ecf AWS-RunInspecChecks Failed 4/1/2019 2:27:31 PM
1eb23aa4-567d-4123-12a3-4c1c2ab34561 AWS-RunPowerShellScript Success 4/1/2019 1:05:55 PM
1c2f3bb4-ee12-4bc1-1a23-12345eea123e AWS-RunInspecChecks Failed 4/1/2019 11:13:09 AM
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [ListCommands](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例列出了所請求的所有命令。**
```
Get-SSMCommand
```
**輸出：**
```
CommandId : 4b75a163-d39a-4d97-87c9-98ae52c6be35
Comment : Apply association with id at update time: 4cc73e42-d5ae-4879-84f8-57e09c0efcd0
CompletedCount : 1
DocumentName : AWS-RefreshAssociation
ErrorCount : 0
ExpiresAfter : 2/24/2017 3:19:08 AM
InstanceIds : {i-0cb2b964d3e14fd9f}
MaxConcurrency : 50
MaxErrors : 0
NotificationConfig : Amazon.SimpleSystemsManagement.Model.NotificationConfig
OutputS3BucketName :
OutputS3KeyPrefix :
OutputS3Region :
Parameters : {[associationIds, Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]]}
RequestedDateTime : 2/24/2017 3:18:08 AM
ServiceRole :
Status : Success
StatusDetails : Success
TargetCount : 1
Targets : {}
```
**範例 2：此範例示範取得特定命令的狀態。**
```
Get-SSMCommand -CommandId "4b75a163-d39a-4d97-87c9-98ae52c6be35"
```
**範例 3：此範例示範擷取在 2019-04-01T00:00:00Z 之後調用的所有 SSM 命令**
```
Get-SSMCommand -Filter @{Key="InvokedAfter";Value="2019-04-01T00:00:00Z"} | Select-Object CommandId, DocumentName, Status, RequestedDateTime | Sort-Object -Property RequestedDateTime -Descending
```
**輸出：**
```
CommandId DocumentName Status RequestedDateTime
--------- ------------ ------ -----------------
edb1b23e-456a-7adb-aef8-90e-012ac34f AWS-RunPowerShellScript Cancelled 4/16/2019 5:45:23 AM
1a2dc3fb-4567-890d-a1ad-234b5d6bc7d9 AWS-ConfigureAWSPackage Success 4/6/2019 9:19:42 AM
12c3456c-7e90-4f12-1232-1234f5b67893 KT-Retrieve-Cloud-Type-Win Failed 4/2/2019 4:13:07 AM
fe123b45-240c-4123-a2b3-234bdd567ecf AWS-RunInspecChecks Failed 4/1/2019 2:27:31 PM
1eb23aa4-567d-4123-12a3-4c1c2ab34561 AWS-RunPowerShellScript Success 4/1/2019 1:05:55 PM
1c2f3bb4-ee12-4bc1-1a23-12345eea123e AWS-RunInspecChecks Failed 4/1/2019 11:13:09 AM
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [ListCommands](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `ListComplianceItems` 與 CLI
<a name="ssm_example_ssm_ListComplianceItems_section"></a>
下列程式碼範例示範如何使用 `ListComplianceItems`。
------
#### [ CLI ]
**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 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListComplianceItems](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/list-compliance-items.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例列出了指定資源 ID 和類型的合規項目清單，篩選合規類型為「關聯」**
```
Get-SSMComplianceItemList -ResourceId i-1a2caf345f67d0dc2 -ResourceType ManagedInstance -Filter @{Key="ComplianceType";Values="Association"}
```
**輸出：**
```
ComplianceType : Association
Details : {[DocumentName, AWS-GatherSoftwareInventory], [DocumentVersion, 1]}
ExecutionSummary : Amazon.SimpleSystemsManagement.Model.ComplianceExecutionSummary
Id : 123a45a1-c234-1234-1245-67891236db4e
ResourceId : i-1a2caf345f67d0dc2
ResourceType : ManagedInstance
Severity : UNSPECIFIED
Status : COMPLIANT
Title :
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [ListComplianceItems](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例列出了指定資源 ID 和類型的合規項目清單，篩選合規類型為「關聯」**
```
Get-SSMComplianceItemList -ResourceId i-1a2caf345f67d0dc2 -ResourceType ManagedInstance -Filter @{Key="ComplianceType";Values="Association"}
```
**輸出：**
```
ComplianceType : Association
Details : {[DocumentName, AWS-GatherSoftwareInventory], [DocumentVersion, 1]}
ExecutionSummary : Amazon.SimpleSystemsManagement.Model.ComplianceExecutionSummary
Id : 123a45a1-c234-1234-1245-67891236db4e
ResourceId : i-1a2caf345f67d0dc2
ResourceType : ManagedInstance
Severity : UNSPECIFIED
Status : COMPLIANT
Title :
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [ListComplianceItems](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `ListComplianceSummaries` 與 CLI
<a name="ssm_example_ssm_ListComplianceSummaries_section"></a>
下列程式碼範例示範如何使用 `ListComplianceSummaries`。
------
#### [ CLI ]
**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 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListComplianceSummaries](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/list-compliance-summaries.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例傳回所有合規類型的合規與不合規資源計數摘要。**
```
Get-SSMComplianceSummaryList
```
**輸出：**
```
ComplianceType CompliantSummary NonCompliantSummary
-------------- ---------------- -------------------
FleetTotal Amazon.SimpleSystemsManagement.Model.CompliantSummary Amazon.SimpleSystemsManagement.Model.NonCompliantSummary
Association Amazon.SimpleSystemsManagement.Model.CompliantSummary Amazon.SimpleSystemsManagement.Model.NonCompliantSummary
Custom:InSpec Amazon.SimpleSystemsManagement.Model.CompliantSummary Amazon.SimpleSystemsManagement.Model.NonCompliantSummary
Patch Amazon.SimpleSystemsManagement.Model.CompliantSummary Amazon.SimpleSystemsManagement.Model.NonCompliantSummary
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [ListComplianceSummaries](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例傳回所有合規類型的合規與不合規資源計數摘要。**
```
Get-SSMComplianceSummaryList
```
**輸出：**
```
ComplianceType CompliantSummary NonCompliantSummary
-------------- ---------------- -------------------
FleetTotal Amazon.SimpleSystemsManagement.Model.CompliantSummary Amazon.SimpleSystemsManagement.Model.NonCompliantSummary
Association Amazon.SimpleSystemsManagement.Model.CompliantSummary Amazon.SimpleSystemsManagement.Model.NonCompliantSummary
Custom:InSpec Amazon.SimpleSystemsManagement.Model.CompliantSummary Amazon.SimpleSystemsManagement.Model.NonCompliantSummary
Patch Amazon.SimpleSystemsManagement.Model.CompliantSummary Amazon.SimpleSystemsManagement.Model.NonCompliantSummary
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [ListComplianceSummaries](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `ListDocumentVersions` 與 CLI
<a name="ssm_example_ssm_ListDocumentVersions_section"></a>
下列程式碼範例示範如何使用 `ListDocumentVersions`。
------
#### [ CLI ]
**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 使用者指南》**中的 [Sending Commands that Use the Document Version Parameter](https://docs.aws.amazon.com/systems-manager/latest/userguide/run-command-version.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListDocumentVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/list-document-versions.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例列出了文件的所有版本。**
```
Get-SSMDocumentVersionList -Name "AWS-UpdateSSMAgent"
```
**輸出：**
```
CreatedDate : 6/1/2021 5:19:10 PM
DocumentFormat : JSON
DocumentVersion : 1
IsDefaultVersion : True
Name : AWS-UpdateSSMAgent
Status : Active
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [ListDocumentVersions](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例列出了文件的所有版本。**
```
Get-SSMDocumentVersionList -Name "AWS-UpdateSSMAgent"
```
**輸出：**
```
CreatedDate : 6/1/2021 5:19:10 PM
DocumentFormat : JSON
DocumentVersion : 1
IsDefaultVersion : True
Name : AWS-UpdateSSMAgent
Status : Active
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [ListDocumentVersions](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `ListDocuments` 與 CLI
<a name="ssm_example_ssm_ListDocuments_section"></a>
下列程式碼範例示範如何使用 `ListDocuments`。
------
#### [ CLI ]
**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 Documents](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-ssm-docs.html)。
**範例 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 Documents](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-ssm-docs.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListDocuments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/list-documents.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：列出帳戶中的所有組態文件。**
```
Get-SSMDocumentList
```
**輸出：**
```
DocumentType : Command
DocumentVersion : 1
Name : AWS-ApplyPatchBaseline
Owner : Amazon
PlatformTypes : {Windows}
SchemaVersion : 1.2
DocumentType : Command
DocumentVersion : 1
Name : AWS-ConfigureAWSPackage
Owner : Amazon
PlatformTypes : {Windows, Linux}
SchemaVersion : 2.0
DocumentType : Command
DocumentVersion : 1
Name : AWS-ConfigureCloudWatch
Owner : Amazon
PlatformTypes : {Windows}
SchemaVersion : 1.2
...
```
**範例 2：此範例示範擷取名稱符合 "Platform" 的所有自動化文件**
```
Get-SSMDocumentList -DocumentFilterList @{Key="DocumentType";Value="Automation"} | Where-Object Name -Match "Platform"
```
**輸出：**
```
DocumentFormat : JSON
DocumentType : Automation
DocumentVersion : 7
Name : KT-Get-Platform
Owner : 987654123456
PlatformTypes : {Windows, Linux}
SchemaVersion : 0.3
Tags : {}
TargetType :
VersionName :
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [ListDocuments](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：列出帳戶中的所有組態文件。**
```
Get-SSMDocumentList
```
**輸出：**
```
DocumentType : Command
DocumentVersion : 1
Name : AWS-ApplyPatchBaseline
Owner : Amazon
PlatformTypes : {Windows}
SchemaVersion : 1.2
DocumentType : Command
DocumentVersion : 1
Name : AWS-ConfigureAWSPackage
Owner : Amazon
PlatformTypes : {Windows, Linux}
SchemaVersion : 2.0
DocumentType : Command
DocumentVersion : 1
Name : AWS-ConfigureCloudWatch
Owner : Amazon
PlatformTypes : {Windows}
SchemaVersion : 1.2
...
```
**範例 2：此範例示範擷取名稱符合 "Platform" 的所有自動化文件**
```
Get-SSMDocumentList -DocumentFilterList @{Key="DocumentType";Value="Automation"} | Where-Object Name -Match "Platform"
```
**輸出：**
```
DocumentFormat : JSON
DocumentType : Automation
DocumentVersion : 7
Name : KT-Get-Platform
Owner : 987654123456
PlatformTypes : {Windows, Linux}
SchemaVersion : 0.3
Tags : {}
TargetType :
VersionName :
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [ListDocuments](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `ListInventoryEntries` 與 CLI
<a name="ssm_example_ssm_ListInventoryEntries_section"></a>
下列程式碼範例示範如何使用 `ListInventoryEntries`。
------
#### [ CLI ]
**AWS CLI**
**範例 1：檢視執行個體的特定庫存類型項目**
下列`list-inventory-entries`範例列出特定執行個體上 AWS：應用程式庫存類型的庫存項目。
```
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 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListInventoryEntries](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/list-inventory-entries.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例列出了執行個體的所有自訂庫存項目。**
```
Get-SSMInventoryEntriesList -InstanceId "i-0cb2b964d3e14fd9f" -TypeName "Custom:RackInfo"
```
**輸出：**
```
CaptureTime : 2016-08-22T10:01:01Z
Entries : {Amazon.Runtime.Internal.Util.AlwaysSendDictionary`2[System.String,System.String]}
InstanceId : i-0cb2b964d3e14fd9f
NextToken :
SchemaVersion : 1.0
TypeName : Custom:RackInfo
```
**範例 2：此範例列出了詳細資訊。**
```
(Get-SSMInventoryEntriesList -InstanceId "i-0cb2b964d3e14fd9f" -TypeName "Custom:RackInfo").Entries
```
**輸出：**
```
Key Value
--- -----
RackLocation Bay B/Row C/Rack D/Shelf E
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [ListInventoryEntries](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例列出了執行個體的所有自訂庫存項目。**
```
Get-SSMInventoryEntriesList -InstanceId "i-0cb2b964d3e14fd9f" -TypeName "Custom:RackInfo"
```
**輸出：**
```
CaptureTime : 2016-08-22T10:01:01Z
Entries : {Amazon.Runtime.Internal.Util.AlwaysSendDictionary`2[System.String,System.String]}
InstanceId : i-0cb2b964d3e14fd9f
NextToken :
SchemaVersion : 1.0
TypeName : Custom:RackInfo
```
**範例 2：此範例列出了詳細資訊。**
```
(Get-SSMInventoryEntriesList -InstanceId "i-0cb2b964d3e14fd9f" -TypeName "Custom:RackInfo").Entries
```
**輸出：**
```
Key Value
--- -----
RackLocation Bay B/Row C/Rack D/Shelf E
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [ListInventoryEntries](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `ListResourceComplianceSummaries` 與 CLI
<a name="ssm_example_ssm_ListResourceComplianceSummaries_section"></a>
下列程式碼範例示範如何使用 `ListResourceComplianceSummaries`。
------
#### [ CLI ]
**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"
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListResourceComplianceSummaries](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/list-resource-compliance-summaries.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範取得資源層級摘要計數。摘要包含有關合規和不合規狀態的資訊，以及符合 "Windows10" 之產品的詳細合規項目嚴重性計數。由於未不指定該參數時，MaxResult 預設為 100，且該值無效，因此新增 MaxResult 參數，並將該值設定為 50。**
```
$FilterValues = @{
"Key"="Product"
"Type"="EQUAL"
"Values"="Windows10"
}
Get-SSMResourceComplianceSummaryList -Filter $FilterValues -MaxResult 50
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [ListResourceComplianceSummaries](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範取得資源層級摘要計數。摘要包含有關合規和不合規狀態的資訊，以及符合 "Windows10" 之產品的詳細合規項目嚴重性計數。由於未不指定該參數時，MaxResult 預設為 100，且該值無效，因此新增 MaxResult 參數，並將該值設定為 50。**
```
$FilterValues = @{
"Key"="Product"
"Type"="EQUAL"
"Values"="Windows10"
}
Get-SSMResourceComplianceSummaryList -Filter $FilterValues -MaxResult 50
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [ListResourceComplianceSummaries](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `ListTagsForResource` 與 CLI
<a name="ssm_example_ssm_ListTagsForResource_section"></a>
下列程式碼範例示範如何使用 `ListTagsForResource`。
------
#### [ CLI ]
**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 資源](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/list-tags-for-resource.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例列出了維護時段的標籤。**
```
Get-SSMResourceTag -ResourceId "mw-03eb9db42890fb82d" -ResourceType "MaintenanceWindow"
```
**輸出：**
```
Key Value
--- -----
Stack Production
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [ListTagsForResource](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例列出了維護時段的標籤。**
```
Get-SSMResourceTag -ResourceId "mw-03eb9db42890fb82d" -ResourceType "MaintenanceWindow"
```
**輸出：**
```
Key Value
--- -----
Stack Production
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [ListTagsForResource](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `ModifyDocumentPermission` 與 CLI
<a name="ssm_example_ssm_ModifyDocumentPermission_section"></a>
下列程式碼範例示範如何使用 `ModifyDocumentPermission`。
------
#### [ CLI ]
**AWS CLI**
**修改文件許可**
下列 `modify-document-permission` 範例公開共用 Systems Manager 文件。
```
aws ssm modify-document-permission \
--name "Example" \
--permission-type "Share" \
--account-ids-to-add "All"
```
此命令不會產生輸出。
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Share a Systems Manager Document](https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-how-to-share.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ModifyDocumentPermission](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/modify-document-permission.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例將文件的「共用」許可新增至所有帳戶。如果命令成功，則無輸出訊息。**
```
Edit-SSMDocumentPermission -Name "RunShellScript" -PermissionType "Share" -AccountIdsToAdd all
```
**範例 2：此範例將文件的「共用」許可新增至特定帳戶。如果命令成功，則無輸出訊息。**
```
Edit-SSMDocumentPermission -Name "RunShellScriptNew" -PermissionType "Share" -AccountIdsToAdd "123456789012"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [ModifyDocumentPermission](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例將文件的「共用」許可新增至所有帳戶。如果命令成功，則無輸出訊息。**
```
Edit-SSMDocumentPermission -Name "RunShellScript" -PermissionType "Share" -AccountIdsToAdd all
```
**範例 2：此範例將文件的「共用」許可新增至特定帳戶。如果命令成功，則無輸出訊息。**
```
Edit-SSMDocumentPermission -Name "RunShellScriptNew" -PermissionType "Share" -AccountIdsToAdd "123456789012"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [ModifyDocumentPermission](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `PutComplianceItems` 與 CLI
<a name="ssm_example_ssm_PutComplianceItems_section"></a>
下列程式碼範例示範如何使用 `PutComplianceItems`。
------
#### [ CLI ]
**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 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [PutComplianceItems](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/put-compliance-items.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例為指定的受管執行個體撰寫自訂合規項目**
```
$item = [Amazon.SimpleSystemsManagement.Model.ComplianceItemEntry]::new()
$item.Id = "07Jun2019-3"
$item.Severity="LOW"
$item.Status="COMPLIANT"
$item.Title="Fin-test-1 - custom"
Write-SSMComplianceItem -ResourceId mi-012dcb3ecea45b678 -ComplianceType Custom:VSSCompliant2 -ResourceType ManagedInstance -Item $item -ExecutionSummary_ExecutionTime "07-Jun-2019"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [PutComplianceItems](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例為指定的受管執行個體撰寫自訂合規項目**
```
$item = [Amazon.SimpleSystemsManagement.Model.ComplianceItemEntry]::new()
$item.Id = "07Jun2019-3"
$item.Severity="LOW"
$item.Status="COMPLIANT"
$item.Title="Fin-test-1 - custom"
Write-SSMComplianceItem -ResourceId mi-012dcb3ecea45b678 -ComplianceType Custom:VSSCompliant2 -ResourceType ManagedInstance -Item $item -ExecutionSummary_ExecutionTime "07-Jun-2019"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [PutComplianceItems](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `PutInventory` 與 CLI
<a name="ssm_example_ssm_PutInventory_section"></a>
下列程式碼範例示範如何使用 `PutInventory`。
------
#### [ CLI ]
**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 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [PutInventory](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/put-inventory.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範將機架位置資訊指派給執行個體。如果命令成功，則無輸出訊息。**
```
$data = New-Object "System.Collections.Generic.Dictionary[System.String,System.String]"
$data.Add("RackLocation", "Bay B/Row C/Rack D/Shelf F")
$items = New-Object "System.Collections.Generic.List[System.Collections.Generic.Dictionary[System.String, System.String]]"
$items.Add($data)
$customInventoryItem = New-Object Amazon.SimpleSystemsManagement.Model.InventoryItem
$customInventoryItem.CaptureTime = "2016-08-22T10:01:01Z"
$customInventoryItem.Content = $items
$customInventoryItem.TypeName = "Custom:TestRackInfo2"
$customInventoryItem.SchemaVersion = "1.0"
$inventoryItems = @($customInventoryItem)
Write-SSMInventory -InstanceId "i-0cb2b964d3e14fd9f" -Item $inventoryItems
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [PutInventory](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範將機架位置資訊指派給執行個體。如果命令成功，則無輸出訊息。**
```
$data = New-Object "System.Collections.Generic.Dictionary[System.String,System.String]"
$data.Add("RackLocation", "Bay B/Row C/Rack D/Shelf F")
$items = New-Object "System.Collections.Generic.List[System.Collections.Generic.Dictionary[System.String, System.String]]"
$items.Add($data)
$customInventoryItem = New-Object Amazon.SimpleSystemsManagement.Model.InventoryItem
$customInventoryItem.CaptureTime = "2016-08-22T10:01:01Z"
$customInventoryItem.Content = $items
$customInventoryItem.TypeName = "Custom:TestRackInfo2"
$customInventoryItem.SchemaVersion = "1.0"
$inventoryItems = @($customInventoryItem)
Write-SSMInventory -InstanceId "i-0cb2b964d3e14fd9f" -Item $inventoryItems
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [PutInventory](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# `PutParameter` 搭配 AWS SDK 或 CLI 使用
<a name="ssm_example_ssm_PutParameter_section"></a>
下列程式碼範例示範如何使用 `PutParameter`。
------
#### [ CLI ]
**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/param-create-cli.html)、[管理參數層](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html)和[使用參數政策](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.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/param-create-cli.html)、[管理參數層](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html)和[使用參數政策](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.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/param-create-cli.html)、[管理參數層](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html)和[使用參數政策](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.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/param-create-cli.html)、[管理參數層](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html)和[使用參數政策](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.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/param-create-cli.html)、[管理參數層](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html)和[使用參數政策](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html)。 *AWS *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [PutParameter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/put-parameter.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/ssm#code-examples)中設定和執行。
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.ssm.SsmClient;
import software.amazon.awssdk.services.ssm.model.ParameterType;
import software.amazon.awssdk.services.ssm.model.PutParameterRequest;
import software.amazon.awssdk.services.ssm.model.SsmException;
public class PutParameter {
public static void main(String[] args) {
final String usage = """
Usage:
<paraName>
Where:
paraName - The name of the parameter.
paraValue - The value of the parameter.
""";
if (args.length != 2) {
System.out.println(usage);
System.exit(1);
}
String paraName = args[0];
String paraValue = args[1];
Region region = Region.US_EAST_1;
SsmClient ssmClient = SsmClient.builder()
.region(region)
.build();
putParaValue(ssmClient, paraName, paraValue);
ssmClient.close();
}
public static void putParaValue(SsmClient ssmClient, String paraName, String value) {
try {
PutParameterRequest parameterRequest = PutParameterRequest.builder()
.name(paraName)
.type(ParameterType.STRING)
.value(value)
.build();
ssmClient.putParameter(parameterRequest);
System.out.println("The parameter was successfully added.");
} catch (SsmException e) {
System.err.println(e.getMessage());
System.exit(1);
}
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [PutParameter](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/PutParameter)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範建立參數。如果命令成功，則無輸出訊息。**
```
Write-SSMParameter -Name "Welcome" -Type "String" -Value "helloWorld"
```
**範例 2：此範例示範變更參數。如果命令成功，則無輸出訊息。**
```
Write-SSMParameter -Name "Welcome" -Type "String" -Value "Good day, Sunshine!" -Overwrite $true
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [PutParameter](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範建立參數。如果命令成功，則無輸出訊息。**
```
Write-SSMParameter -Name "Welcome" -Type "String" -Value "helloWorld"
```
**範例 2：此範例示範變更參數。如果命令成功，則無輸出訊息。**
```
Write-SSMParameter -Name "Welcome" -Type "String" -Value "Good day, Sunshine!" -Overwrite $true
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [PutParameter](https://docs.aws.amazon.com/powershell/v5/reference)。
------
#### [ Rust ]
**適用於 Rust 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/ssm#code-examples)中設定和執行。
```
async fn make_parameter(
client: &Client,
name: &str,
value: &str,
description: &str,
) -> Result<(), Error> {
let resp = client
.put_parameter()
.overwrite(true)
.r#type(ParameterType::String)
.name(name)
.value(value)
.description(description)
.send()
.await?;
println!("Success! Parameter now has version: {}", resp.version());
Ok(())
}
```
+ 如需 API 詳細資訊，請參閱《適用於 Rust 的AWS SDK API 參考》**中的 [PutParameter](https://docs.rs/aws-sdk-ssm/latest/aws_sdk_ssm/client/struct.Client.html#method.put_parameter)。
------
# 搭配使用 `RegisterDefaultPatchBaseline` 與 CLI
<a name="ssm_example_ssm_RegisterDefaultPatchBaseline_section"></a>
下列程式碼範例示範如何使用 `RegisterDefaultPatchBaseline`。
------
#### [ CLI ]
**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 使用者指南》**中的 [About Predefined and Custom Patch Baselines](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-patch-baselines.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [RegisterDefaultPatchBaseline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/register-default-patch-baseline.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範將修補基準註冊為預設修補基準。**
```
Register-SSMDefaultPatchBaseline -BaselineId "pb-03da896ca3b68b639"
```
**輸出：**
```
pb-03da896ca3b68b639
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [RegisterDefaultPatchBaseline](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範將修補基準註冊為預設修補基準。**
```
Register-SSMDefaultPatchBaseline -BaselineId "pb-03da896ca3b68b639"
```
**輸出：**
```
pb-03da896ca3b68b639
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [RegisterDefaultPatchBaseline](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `RegisterPatchBaselineForPatchGroup` 與 CLI
<a name="ssm_example_ssm_RegisterPatchBaselineForPatchGroup_section"></a>
下列程式碼範例示範如何使用 `RegisterPatchBaselineForPatchGroup`。
------
#### [ CLI ]
**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>\$1\$1 和 [Add a Patch Group to a Patch Baseline](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-patch-group-patchbaseline.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [RegisterPatchBaselineForPatchGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/register-patch-baseline-for-patch-group.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範註冊修補程式群組的修補基準。**
```
Register-SSMPatchBaselineForPatchGroup -BaselineId "pb-03da896ca3b68b639" -PatchGroup "Production"
```
**輸出：**
```
BaselineId PatchGroup
---------- ----------
pb-03da896ca3b68b639 Production
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [RegisterPatchBaselineForPatchGroup](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範註冊修補程式群組的修補基準。**
```
Register-SSMPatchBaselineForPatchGroup -BaselineId "pb-03da896ca3b68b639" -PatchGroup "Production"
```
**輸出：**
```
BaselineId PatchGroup
---------- ----------
pb-03da896ca3b68b639 Production
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [RegisterPatchBaselineForPatchGroup](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `RegisterTargetWithMaintenanceWindow` 與 CLI
<a name="ssm_example_ssm_RegisterTargetWithMaintenanceWindow_section"></a>
下列程式碼範例示範如何使用 `RegisterTargetWithMaintenanceWindow`。
------
#### [ CLI ]
**AWS CLI**
**範例 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：使用執行個體 ID 向維護時段註冊多個目標**
下列 `register-target-with-maintenance-window` 範例示範透過指定執行個體 ID，向維護時段註冊兩個執行個體。
```
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` 範例示範註冊執行個體，這些執行個體擁有一個或多個標指派的標籤索引鍵，無論其索引鍵值為何。
```
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"
}
```
如需詳細資訊，請參閱 *AWS Systems Manager 使用者指南*中的[向維護時段 (AWS CLI) 註冊目標執行個體](https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-targets.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [RegisterTargetWithMaintenanceWindow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/register-target-with-maintenance-window.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範向維護時段註冊執行個體。**
```
$option1 = @{Key="InstanceIds";Values=@("i-0000293ffd8c57862")}
Register-SSMTargetWithMaintenanceWindow -WindowId "mw-06cf17cbefcb4bf4f" -Target $option1 -OwnerInformation "Single instance" -ResourceType "INSTANCE"
```
**輸出：**
```
d8e47760-23ed-46a5-9f28-927337725398
```
**範例 2：此範例示範向維護時段註冊多個執行個體。**
```
$option1 = @{Key="InstanceIds";Values=@("i-0000293ffd8c57862","i-0cb2b964d3e14fd9f")}
Register-SSMTargetWithMaintenanceWindow -WindowId "mw-06cf17cbefcb4bf4f" -Target $option1 -OwnerInformation "Single instance" -ResourceType "INSTANCE"
```
**輸出：**
```
6ab5c208-9fc4-4697-84b7-b02a6cc25f7d
```
**範例 3：此範例示範使用 EC2 標籤向維護時段註冊執行個體。**
```
$option1 = @{Key="tag:Environment";Values=@("Production")}
Register-SSMTargetWithMaintenanceWindow -WindowId "mw-06cf17cbefcb4bf4f" -Target $option1 -OwnerInformation "Production Web Servers" -ResourceType "INSTANCE"
```
**輸出：**
```
2994977e-aefb-4a71-beac-df620352f184
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [RegisterTargetWithMaintenanceWindow](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範向維護時段註冊執行個體。**
```
$option1 = @{Key="InstanceIds";Values=@("i-0000293ffd8c57862")}
Register-SSMTargetWithMaintenanceWindow -WindowId "mw-06cf17cbefcb4bf4f" -Target $option1 -OwnerInformation "Single instance" -ResourceType "INSTANCE"
```
**輸出：**
```
d8e47760-23ed-46a5-9f28-927337725398
```
**範例 2：此範例示範向維護時段註冊多個執行個體。**
```
$option1 = @{Key="InstanceIds";Values=@("i-0000293ffd8c57862","i-0cb2b964d3e14fd9f")}
Register-SSMTargetWithMaintenanceWindow -WindowId "mw-06cf17cbefcb4bf4f" -Target $option1 -OwnerInformation "Single instance" -ResourceType "INSTANCE"
```
**輸出：**
```
6ab5c208-9fc4-4697-84b7-b02a6cc25f7d
```
**範例 3：此範例示範使用 EC2 標籤向維護時段註冊執行個體。**
```
$option1 = @{Key="tag:Environment";Values=@("Production")}
Register-SSMTargetWithMaintenanceWindow -WindowId "mw-06cf17cbefcb4bf4f" -Target $option1 -OwnerInformation "Production Web Servers" -ResourceType "INSTANCE"
```
**輸出：**
```
2994977e-aefb-4a71-beac-df620352f184
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [RegisterTargetWithMaintenanceWindow](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `RegisterTaskWithMaintenanceWindow` 與 CLI
<a name="ssm_example_ssm_RegisterTaskWithMaintenanceWindow_section"></a>
下列程式碼範例示範如何使用 `RegisterTaskWithMaintenanceWindow`。
------
#### [ CLI ]
**AWS CLI**
**範例 1：向維護時段註冊 Automation 任務**
下列 `register-task-with-maintenance-window` 範例示範向以執行個體為目標的維護時段註冊 Automation 任務。
```
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"
}
```
如需詳細資訊，請參閱 *AWS Systems Manager 使用者指南*中的[向維護時段 (AWS CLI) 註冊任務](https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-tasks.html)。
**範例 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"
}
```
如需詳細資訊，請參閱 *AWS Systems Manager 使用者指南*中的[向維護時段 (AWS CLI) 註冊任務](https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-tasks.html)。
**範例 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"
}
```
如需詳細資訊，請參閱 *AWS Systems Manager 使用者指南*中的[向維護時段 (AWS CLI) 註冊任務](https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-tasks.html)。
**範例 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"
}
```
如需詳細資訊，請參閱 *AWS Systems Manager 使用者指南*中的[向維護時段 (AWS CLI) 註冊任務](https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-tasks.html)。
**範例 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"
}
```
如需詳細資訊，請參閱 *AWS Systems Manager 使用者指南*中的[向維護時段 (AWS CLI) 註冊任務](https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-tasks.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [RegisterTaskWithMaintenanceWindow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/register-task-with-maintenance-window.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範使用執行個體 ID 向維護時段註冊任務。輸出為任務 ID。**
```
$parameters = @{}
$parameterValues = New-Object Amazon.SimpleSystemsManagement.Model.MaintenanceWindowTaskParameterValueExpression
$parameterValues.Values = @("Install")
$parameters.Add("Operation", $parameterValues)
Register-SSMTaskWithMaintenanceWindow -WindowId "mw-03a342e62c96d31b0" -ServiceRoleArn "arn:aws:iam::123456789012:role/MaintenanceWindowsRole" -MaxConcurrency 1 -MaxError 1 -TaskArn "AWS-RunShellScript" -Target @{ Key="InstanceIds";Values="i-0000293ffd8c57862" } -TaskType "RUN_COMMAND" -Priority 10 -TaskParameter $parameters
```
**輸出：**
```
f34a2c47-ddfd-4c85-a88d-72366b69af1b
```
**範例 2：此範例示範使用目標 ID 向維護時段註冊任務。輸出為任務 ID。**
```
$parameters = @{}
$parameterValues = New-Object Amazon.SimpleSystemsManagement.Model.MaintenanceWindowTaskParameterValueExpression
$parameterValues.Values = @("Install")
$parameters.Add("Operation", $parameterValues)
register-ssmtaskwithmaintenancewindow -WindowId "mw-03a342e62c96d31b0" -ServiceRoleArn "arn:aws:iam::123456789012:role/MaintenanceWindowsRole" -MaxConcurrency 1 -MaxError 1 -TaskArn "AWS-RunShellScript" -Target @{ Key="WindowTargetIds";Values="350d44e6-28cc-44e2-951f-4b2c985838f6" } -TaskType "RUN_COMMAND" -Priority 10 -TaskParameter $parameters
```
**輸出：**
```
f34a2c47-ddfd-4c85-a88d-72366b69af1b
```
**範例 3：此範例示範建立 Run Command 文件 `AWS-RunPowerShellScript` 的參數物件，並使用目標 ID 向指定維護時段建立任務。傳回輸出為任務 ID。**
```
$parameters = [Collections.Generic.Dictionary[String,Collections.Generic.List[String]]]::new()
$parameters.Add("commands",@("ipconfig","dir env:\computername"))
$parameters.Add("executionTimeout",@(3600))
$props = @{
WindowId = "mw-0123e4cce56ff78ae"
ServiceRoleArn = "arn:aws:iam::123456789012:role/MaintenanceWindowsRole"
MaxConcurrency = 1
MaxError = 1
TaskType = "RUN_COMMAND"
TaskArn = "AWS-RunPowerShellScript"
Target = @{Key="WindowTargetIds";Values="fe1234ea-56d7-890b-12f3-456b789bee0f"}
Priority = 1
RunCommand_Parameter = $parameters
Name = "set-via-cmdlet"
}
Register-SSMTaskWithMaintenanceWindow @props
```
**輸出：**
```
f1e2ef34-5678-12e3-456a-12334c5c6cbe
```
**範例 4：此範例會使用名為 的文件來註冊 AWS Systems Manager Automation 任務`Create-Snapshots`。**
```
$automationParameters = @{}
$automationParameters.Add( "instanceId", @("{{ TARGET_ID }}") )
$automationParameters.Add( "AutomationAssumeRole", @("{arn:aws:iam::111111111111:role/AutomationRole}") )
$automationParameters.Add( "SnapshotTimeout", @("PT20M") )
Register-SSMTaskWithMaintenanceWindow -WindowId mw-123EXAMPLE456`
-ServiceRoleArn "arn:aws:iam::123456789012:role/MW-Role"`
-MaxConcurrency 1 -MaxError 1 -TaskArn "CreateVolumeSnapshots"`
-Target @{ Key="WindowTargetIds";Values="4b5acdf4-946c-4355-bd68-4329a43a5fd1" }`
-TaskType "AUTOMATION"`
-Priority 4`
-Automation_DocumentVersion '$DEFAULT' -Automation_Parameter $automationParameters -Name "Create-Snapshots"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [RegisterTaskWithMaintenanceWindow](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範使用執行個體 ID 向維護時段註冊任務。輸出為任務 ID。**
```
$parameters = @{}
$parameterValues = New-Object Amazon.SimpleSystemsManagement.Model.MaintenanceWindowTaskParameterValueExpression
$parameterValues.Values = @("Install")
$parameters.Add("Operation", $parameterValues)
Register-SSMTaskWithMaintenanceWindow -WindowId "mw-03a342e62c96d31b0" -ServiceRoleArn "arn:aws:iam::123456789012:role/MaintenanceWindowsRole" -MaxConcurrency 1 -MaxError 1 -TaskArn "AWS-RunShellScript" -Target @{ Key="InstanceIds";Values="i-0000293ffd8c57862" } -TaskType "RUN_COMMAND" -Priority 10 -TaskParameter $parameters
```
**輸出：**
```
f34a2c47-ddfd-4c85-a88d-72366b69af1b
```
**範例 2：此範例示範使用目標 ID 向維護時段註冊任務。輸出為任務 ID。**
```
$parameters = @{}
$parameterValues = New-Object Amazon.SimpleSystemsManagement.Model.MaintenanceWindowTaskParameterValueExpression
$parameterValues.Values = @("Install")
$parameters.Add("Operation", $parameterValues)
register-ssmtaskwithmaintenancewindow -WindowId "mw-03a342e62c96d31b0" -ServiceRoleArn "arn:aws:iam::123456789012:role/MaintenanceWindowsRole" -MaxConcurrency 1 -MaxError 1 -TaskArn "AWS-RunShellScript" -Target @{ Key="WindowTargetIds";Values="350d44e6-28cc-44e2-951f-4b2c985838f6" } -TaskType "RUN_COMMAND" -Priority 10 -TaskParameter $parameters
```
**輸出：**
```
f34a2c47-ddfd-4c85-a88d-72366b69af1b
```
**範例 3：此範例示範建立 Run Command 文件 `AWS-RunPowerShellScript` 的參數物件，並使用目標 ID 向指定維護時段建立任務。傳回輸出為任務 ID。**
```
$parameters = [Collections.Generic.Dictionary[String,Collections.Generic.List[String]]]::new()
$parameters.Add("commands",@("ipconfig","dir env:\computername"))
$parameters.Add("executionTimeout",@(3600))
$props = @{
WindowId = "mw-0123e4cce56ff78ae"
ServiceRoleArn = "arn:aws:iam::123456789012:role/MaintenanceWindowsRole"
MaxConcurrency = 1
MaxError = 1
TaskType = "RUN_COMMAND"
TaskArn = "AWS-RunPowerShellScript"
Target = @{Key="WindowTargetIds";Values="fe1234ea-56d7-890b-12f3-456b789bee0f"}
Priority = 1
RunCommand_Parameter = $parameters
Name = "set-via-cmdlet"
}
Register-SSMTaskWithMaintenanceWindow @props
```
**輸出：**
```
f1e2ef34-5678-12e3-456a-12334c5c6cbe
```
**範例 4：此範例會使用名為 的文件來註冊 AWS Systems Manager Automation 任務`Create-Snapshots`。**
```
$automationParameters = @{}
$automationParameters.Add( "instanceId", @("{{ TARGET_ID }}") )
$automationParameters.Add( "AutomationAssumeRole", @("{arn:aws:iam::111111111111:role/AutomationRole}") )
$automationParameters.Add( "SnapshotTimeout", @("PT20M") )
Register-SSMTaskWithMaintenanceWindow -WindowId mw-123EXAMPLE456`
-ServiceRoleArn "arn:aws:iam::123456789012:role/MW-Role"`
-MaxConcurrency 1 -MaxError 1 -TaskArn "CreateVolumeSnapshots"`
-Target @{ Key="WindowTargetIds";Values="4b5acdf4-946c-4355-bd68-4329a43a5fd1" }`
-TaskType "AUTOMATION"`
-Priority 4`
-Automation_DocumentVersion '$DEFAULT' -Automation_Parameter $automationParameters -Name "Create-Snapshots"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [RegisterTaskWithMaintenanceWindow](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `RemoveTagsFromResource` 與 CLI
<a name="ssm_example_ssm_RemoveTagsFromResource_section"></a>
下列程式碼範例示範如何使用 `RemoveTagsFromResource`。
------
#### [ CLI ]
**AWS CLI**
**從修補基準中移除標籤**
下列 `remove-tags-from-resource` 範例示範從修補基準中移除標籤。
```
aws ssm remove-tags-from-resource \
--resource-type "PatchBaseline" \
--resource-id "pb-0123456789abcdef0" \
--tag-keys "Region"
```
此命令不會產生輸出。
如需詳細資訊，請參閱《 *AWS 一般參考*》中的[標記 AWS 資源](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [RemoveTagsFromResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/remove-tags-from-resource.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範從維護時段中移除標籤。如果命令成功，則無輸出訊息。**
```
Remove-SSMResourceTag -ResourceId "mw-03eb9db42890fb82d" -ResourceType "MaintenanceWindow" -TagKey "Production"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [RemoveTagsFromResource](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範從維護時段中移除標籤。如果命令成功，則無輸出訊息。**
```
Remove-SSMResourceTag -ResourceId "mw-03eb9db42890fb82d" -ResourceType "MaintenanceWindow" -TagKey "Production"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [RemoveTagsFromResource](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# `SendCommand` 搭配 AWS SDK 或 CLI 使用
<a name="ssm_example_ssm_SendCommand_section"></a>
下列程式碼範例示範如何使用 `SendCommand`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](ssm_example_ssm_Scenario_section.md)
------
#### [ CLI ]
**AWS CLI**
**範例 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
}
}
}
```
如需詳細資訊，請參閱*《AWS Systems Manager 使用者指南》*中的 [Running Commands Using Systems Manager Run Command](https://docs.aws.amazon.com/systems-manager/latest/userguide/run-command.html)。
**範例 2：取得執行個體的 IP 資訊**
以下 `send-command` 範例示範擷取有關執行個體的 IP 資訊。
```
aws ssm send-command \
--instance-ids "i-1234567890abcdef0" \
--document-name "AWS-RunShellScript" \
--comment "IP config" \
--parameters "commands=ifconfig"
```
如需範例輸出，請參閱範例 1。
如需詳細資訊，請參閱*《AWS Systems Manager 使用者指南》*中的 [Running Commands Using Systems Manager Run Command](https://docs.aws.amazon.com/systems-manager/latest/userguide/run-command.html)。
**範例 3：在具有特定標籤的執行個體上執行命令**
下列 `send-command` 範例示範在具有標籤索引鍵「ENV」和值「Dev」的執行個體上執行命令。
```
aws ssm send-command \
--targets "Key=tag:ENV,Values=Dev" \
--document-name "AWS-RunShellScript" \
--parameters "commands=ifconfig"
```
如需範例輸出，請參閱範例 1。
如需詳細資訊，請參閱*《AWS Systems Manager 使用者指南》*中的 [Running Commands Using Systems Manager Run Command](https://docs.aws.amazon.com/systems-manager/latest/userguide/run-command.html)。
**範例 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。
如需詳細資訊，請參閱*《AWS Systems Manager 使用者指南》*中的 [Running Commands Using Systems Manager Run Command](https://docs.aws.amazon.com/systems-manager/latest/userguide/run-command.html)。
**範例 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。
如需詳細資訊，請參閱*《AWS Systems Manager 使用者指南》*中的 [Running Commands Using Systems Manager Run Command](https://docs.aws.amazon.com/systems-manager/latest/userguide/run-command.html)。
**範例 6：在具有不同標籤的多個執行個體上執行命令**
下列 `send-command` 範例示範在具有兩個不同標籤索引鍵和值的執行個體上執行命令。
```
aws ssm send-command \
--document-name "AWS-RunPowerShellScript" \
--parameters commands=["echo helloWorld"] \
--targets Key=tag:Env,Values=Dev Key=tag:Role,Values=WebServers
```
如需範例輸出，請參閱範例 1。
如需詳細資訊，請參閱*《AWS Systems Manager 使用者指南》*中的 [Running Commands Using Systems Manager Run Command](https://docs.aws.amazon.com/systems-manager/latest/userguide/run-command.html)。
**範例 7：將具有相同標籤索引鍵的多個執行個體設定為目標**
下列 `send-command` 範例示範在具有相同標籤索引鍵但值不同的執行個體上執行命令。
```
aws ssm send-command \
--document-name "AWS-RunPowerShellScript" \
--parameters commands=["echo helloWorld"] \
--targets Key=tag:Env,Values=Dev,Test
```
如需範例輸出，請參閱範例 1。
如需詳細資訊，請參閱*《AWS Systems Manager 使用者指南》*中的 [Running Commands Using Systems Manager Run Command](https://docs.aws.amazon.com/systems-manager/latest/userguide/run-command.html)。
**範例 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。
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Using shared SSM documents](https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [SendCommand](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/send-command.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/ssm#code-examples)中設定和執行。
```
/**
* Sends a SSM command to a managed node asynchronously.
*
* @param documentName The name of the document to use.
* @param instanceId The ID of the instance to send the command to.
* @return The command ID.
* <p>
* This method initiates asynchronous requests to send a SSM command to a managed node.
* It waits until the document is active, sends the command, and checks the command execution status.
*/
public String sendSSMCommand(String documentName, String instanceId) throws InterruptedException, SsmException {
// Before we use Document to send a command - make sure it is active.
CompletableFuture<Void> documentActiveFuture = CompletableFuture.runAsync(() -> {
boolean isDocumentActive = false;
DescribeDocumentRequest request = DescribeDocumentRequest.builder()
.name(documentName)
.build();
while (!isDocumentActive) {
CompletableFuture<DescribeDocumentResponse> response = getAsyncClient().describeDocument(request);
String documentStatus = response.join().document().statusAsString();
if (documentStatus.equals("Active")) {
System.out.println("The SSM document is active and ready to use.");
isDocumentActive = true;
} else {
System.out.println("The SSM document is not active. Status: " + documentStatus);
try {
Thread.sleep(5000);
} catch (InterruptedException e) {
throw new RuntimeException(e);
}
}
}
});
documentActiveFuture.join();
// Create the SendCommandRequest.
SendCommandRequest commandRequest = SendCommandRequest.builder()
.documentName(documentName)
.instanceIds(instanceId)
.build();
// Send the command.
CompletableFuture<SendCommandResponse> commandFuture = getAsyncClient().sendCommand(commandRequest);
final String[] commandId = {null};
commandFuture.whenComplete((commandResponse, ex) -> {
if (commandResponse != null) {
commandId[0] = commandResponse.command().commandId();
System.out.println("Command ID: " + commandId[0]);
// Wait for the command execution to complete.
GetCommandInvocationRequest invocationRequest = GetCommandInvocationRequest.builder()
.commandId(commandId[0])
.instanceId(instanceId)
.build();
try {
System.out.println("Wait 5 secs");
TimeUnit.SECONDS.sleep(5);
// Retrieve the command execution details.
CompletableFuture<GetCommandInvocationResponse> invocationFuture = getAsyncClient().getCommandInvocation(invocationRequest);
invocationFuture.whenComplete((commandInvocationResponse, invocationEx) -> {
if (commandInvocationResponse != null) {
// Check the status of the command execution.
CommandInvocationStatus status = commandInvocationResponse.status();
if (status == CommandInvocationStatus.SUCCESS) {
System.out.println("Command execution successful");
} else {
System.out.println("Command execution failed. Status: " + status);
}
} else {
Throwable invocationCause = (invocationEx instanceof CompletionException) ? invocationEx.getCause() : invocationEx;
throw new CompletionException(invocationCause);
}
}).join();
} catch (InterruptedException e) {
throw new RuntimeException(e);
}
} else {
Throwable cause = (ex instanceof CompletionException) ? ex.getCause() : ex;
if (cause instanceof SsmException) {
throw (SsmException) cause;
} else {
throw new RuntimeException(cause);
}
}
}).join();
return commandId[0];
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [SendCommand](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/SendCommand)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ssm#code-examples)中設定和執行。
```
import { SendCommandCommand, SSMClient } from "@aws-sdk/client-ssm";
import { parseArgs } from "node:util";
/**
* Send an SSM command to a managed node.
* @param {{ documentName: string }}
*/
export const main = async ({ documentName }) => {
const client = new SSMClient({});
try {
await client.send(
new SendCommandCommand({
DocumentName: documentName,
}),
);
console.log("Command sent successfully.");
return { Success: true };
} catch (caught) {
if (caught instanceof Error && caught.name === "ValidationError") {
console.warn(`${caught.message}. Did you provide a valid document name?`);
} else {
throw caught;
}
}
};
```
+ 如需 API 詳細資訊，請參閱《適用於 JavaScript 的 AWS SDK API 參考》**中的 [SendCommand](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/SendCommandCommand)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範在目標執行個體上執行 echo 命令。**
```
Send-SSMCommand -DocumentName "AWS-RunPowerShellScript" -Parameter @{commands = "echo helloWorld"} -Target @{Key="instanceids";Values=@("i-0cb2b964d3e14fd9f")}
```
**輸出：**
```
CommandId : d8d190fc-32c1-4d65-a0df-ff5ff3965524
Comment :
CompletedCount : 0
DocumentName : AWS-RunPowerShellScript
ErrorCount : 0
ExpiresAfter : 3/7/2017 10:48:37 PM
InstanceIds : {}
MaxConcurrency : 50
MaxErrors : 0
NotificationConfig : Amazon.SimpleSystemsManagement.Model.NotificationConfig
OutputS3BucketName :
OutputS3KeyPrefix :
OutputS3Region :
Parameters : {[commands, Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]]}
RequestedDateTime : 3/7/2017 9:48:37 PM
ServiceRole :
Status : Pending
StatusDetails : Pending
TargetCount : 0
Targets : {instanceids}
```
**範例 2：此範例顯示如何執行接受巢狀參數的命令。**
```
Send-SSMCommand -DocumentName "AWS-RunRemoteScript" -Parameter @{ sourceType="GitHub";sourceInfo='{"owner": "me","repository": "amazon-ssm","path": "Examples/Install-Win32OpenSSH"}'; "commandLine"=".\Install-Win32OpenSSH.ps1"} -InstanceId i-0cb2b964d3e14fd9f
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [SendCommand](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範在目標執行個體上執行 echo 命令。**
```
Send-SSMCommand -DocumentName "AWS-RunPowerShellScript" -Parameter @{commands = "echo helloWorld"} -Target @{Key="instanceids";Values=@("i-0cb2b964d3e14fd9f")}
```
**輸出：**
```
CommandId : d8d190fc-32c1-4d65-a0df-ff5ff3965524
Comment :
CompletedCount : 0
DocumentName : AWS-RunPowerShellScript
ErrorCount : 0
ExpiresAfter : 3/7/2017 10:48:37 PM
InstanceIds : {}
MaxConcurrency : 50
MaxErrors : 0
NotificationConfig : Amazon.SimpleSystemsManagement.Model.NotificationConfig
OutputS3BucketName :
OutputS3KeyPrefix :
OutputS3Region :
Parameters : {[commands, Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]]}
RequestedDateTime : 3/7/2017 9:48:37 PM
ServiceRole :
Status : Pending
StatusDetails : Pending
TargetCount : 0
Targets : {instanceids}
```
**範例 2：此範例顯示如何執行接受巢狀參數的命令。**
```
Send-SSMCommand -DocumentName "AWS-RunRemoteScript" -Parameter @{ sourceType="GitHub";sourceInfo='{"owner": "me","repository": "amazon-ssm","path": "Examples/Install-Win32OpenSSH"}'; "commandLine"=".\Install-Win32OpenSSH.ps1"} -InstanceId i-0cb2b964d3e14fd9f
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [SendCommand](https://docs.aws.amazon.com/powershell/v5/reference)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/ssm#code-examples)中設定和執行。
```
class DocumentWrapper:
"""Encapsulates AWS Systems Manager Document actions."""
def __init__(self, ssm_client):
"""
:param ssm_client: A Boto3 Systems Manager client.
"""
self.ssm_client = ssm_client
self.name = None
@classmethod
def from_client(cls):
ssm_client = boto3.client("ssm")
return cls(ssm_client)
def send_command(self, instance_ids):
"""
Sends a command to one or more instances.
:param instance_ids: The IDs of the instances to send the command to.
:return: The ID of the command.
"""
try:
response = self.ssm_client.send_command(
InstanceIds=instance_ids, DocumentName=self.name, TimeoutSeconds=3600
)
return response["Command"]["CommandId"]
except ClientError as err:
logger.error(
"Couldn't send command to %s. Here's why: %s: %s",
self.name,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [SendCommand](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/SendCommand)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ssm#code-examples)中設定和執行。
```
TRY.
DATA(lo_result) = lo_ssm->sendcommand(
it_instanceids = it_instance_ids
iv_documentname = iv_document_name
iv_timeoutseconds = 3600 ).
DATA(lo_command) = lo_result->get_command( ).
IF lo_command IS BOUND.
rv_command_id = lo_command->get_commandid( ).
MESSAGE 'Command sent successfully.' TYPE 'I'.
ENDIF.
CATCH /aws1/cx_ssminvaliddocument.
MESSAGE 'Invalid document.' TYPE 'I'.
CATCH /aws1/cx_ssminvalidinstanceid.
MESSAGE 'Invalid instance ID.' TYPE 'I'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [SendCommand](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# 搭配使用 `StartAutomationExecution` 與 CLI
<a name="ssm_example_ssm_StartAutomationExecution_section"></a>
下列程式碼範例示範如何使用 `StartAutomationExecution`。
------
#### [ CLI ]
**AWS CLI**
**範例 1：執行 Automation 文件**
下列 `start-automation-execution` 範例示範執行 Automation 文件。
```
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 使用者指南》**中的 [Running an Automation Workflow Manually](https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-working-executing-manually.html)。
**範例 2：執行共用 Automation 文件**
下列 `start-automation-execution` 範例示範執行共用的 Automation 文件。
```
aws ssm start-automation-execution \
--document-name "arn:aws:ssm:us-east-1:123456789012:document/ExampleDocument"
```
輸出：
```
{
"AutomationExecutionId": "4105a4fc-f944-11e6-9d32-0a1b2EXAMPLE"
}
```
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Using shared SSM documents](https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [StartAutomationExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/start-automation-execution.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範執行指定自動化角色、AMI 來源 ID 和 Amazon EC2 執行個體角色的文件。**
```
Start-SSMAutomationExecution -DocumentName AWS-UpdateLinuxAmi -Parameter @{'AutomationAssumeRole'='arn:aws:iam::123456789012:role/SSMAutomationRole';'SourceAmiId'='ami-f173cc91';'InstanceIamRole'='EC2InstanceRole'}
```
**輸出：**
```
3a532a4f-0382-11e7-9df7-6f11185f6dd1
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [StartAutomationExecution](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範執行指定自動化角色、AMI 來源 ID 和 Amazon EC2 執行個體角色的文件。**
```
Start-SSMAutomationExecution -DocumentName AWS-UpdateLinuxAmi -Parameter @{'AutomationAssumeRole'='arn:aws:iam::123456789012:role/SSMAutomationRole';'SourceAmiId'='ami-f173cc91';'InstanceIamRole'='EC2InstanceRole'}
```
**輸出：**
```
3a532a4f-0382-11e7-9df7-6f11185f6dd1
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [StartAutomationExecution](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `StartSession` 與 CLI
<a name="ssm_example_ssm_StartSession_section"></a>
下列程式碼範例示範如何使用 `StartSession`。
------
#### [ CLI ]
**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 使用者指南中的[啟動工作階段](https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-sessions-start.html)和安裝 CLI 的 Session Manager 外掛程式。 [AWS](https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html) *AWS *
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [StartSession](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/start-session.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範啟動與 Session Manager 工作階段目標的連線，以啟用連接埠轉送。**
```
Start-SSMSession -Target 'i-064578e5e7454488f' -DocumentName 'AWS-StartPortForwardingSession' -Parameter @{ localPortNumber = '8080'; portNumber = '80' }
```
**輸出：**
```
SessionId StreamUrl
---------- ----------
random-id0 wss://ssmmessages.amazonaws.com/v1/data-channel/random-id
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [StartSession](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範啟動與 Session Manager 工作階段目標的連線，以啟用連接埠轉送。注意：如果尚未使用 AWSCredentials 設定區域參數，則需要新增區域參數。**
```
Start-SSMSession -Target 'i-064578e5e7454488f' -DocumentName 'AWS-StartPortForwardingSession' -Parameter @{ localPortNumber = '8080'; portNumber = '80' } -Region 'us-west-1'
```
**輸出：**
```
Starting session with SessionId: testUser-xi4glew849asyeryde34u4dfsdfy
Port 8080 opened for sessionId testUser-xi4glew849asyeryde34u4dfsdfy.
Waiting for connections...
```
**範例 2：此範例為 Session Manager 工作階段，與指定執行個體建立互動式工作階段。**
```
Start-SSMSession -Target 'i-1234567890abcdef0' -Region 'us-west-1'
```
**輸出：**
```
Starting session with SessionId : testUser-xi4glew849asyeryde34u4dfsdfy
Windows PowerShell
Copyright (C) Microsoft Corporation. All rights reserved.
Install the latest PowerShell for new features and improvements!
PS C:\Windows\system32> whoami
ec2amaz-fnsdrwv\ec2-test-user
PS C:\Windows\system32>
```
**範例 3：此範例會在不連線的情況下建立工作階段，並傳回連線至工作階段所需的 SessionId、StreamUrl 和 TokenValue 屬性。**
```
Start-SSMSession -Target 'i-1234567890abcdef0' -Region 'us-west-1' -DisablePluginInvocation
```
**輸出：**
```
SessionId : testUser-xi4glew849asyeryde34u4dfsdfy
StreamUrl : {StreamUrl value redacted}
TokenValue : {Token value redacted}
ContentLength : 1207
HttpStatusCode : OK
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [StartSession](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `StopAutomationExecution` 與 CLI
<a name="ssm_example_ssm_StopAutomationExecution_section"></a>
下列程式碼範例示範如何使用 `StopAutomationExecution`。
------
#### [ CLI ]
**AWS CLI**
**停止自動化執行**
下列 `stop-automation-execution` 範例示範停止執行 Automation 文件。
```
aws ssm stop-automation-execution
--automation-execution-id "4105a4fc-f944-11e6-9d32-0a1b2EXAMPLE"
```
此命令不會產生輸出。
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Running an Automation Workflow Manually](https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-working-executing-manually.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [StopAutomationExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/stop-automation-execution.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範停止自動化執行。如果命令成功，則無輸出訊息。**
```
Stop-SSMAutomationExecution -AutomationExecutionId "4105a4fc-f944-11e6-9d32-8fb2db27a909"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [StopAutomationExecution](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範停止自動化執行。如果命令成功，則無輸出訊息。**
```
Stop-SSMAutomationExecution -AutomationExecutionId "4105a4fc-f944-11e6-9d32-8fb2db27a909"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [StopAutomationExecution](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `UpdateAssociation` 與 CLI
<a name="ssm_example_ssm_UpdateAssociation_section"></a>
下列程式碼範例示範如何使用 `UpdateAssociation`。
------
#### [ CLI ]
**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
}
}
```
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南*》*中的 [Editing and creating a new version of an association](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-state-assoc-edit.html)。
**範例 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
}
}
```
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南*》*中的 [Editing and creating a new version of an association](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-state-assoc-edit.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [UpdateAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/update-association.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範以新文件版本更新關聯。**
```
Update-SSMAssociation -AssociationId "93285663-92df-44cb-9f26-2292d4ecc439" -DocumentVersion "1"
```
**輸出：**
```
Name : AWS-UpdateSSMAgent
InstanceId :
Date : 3/1/2017 6:22:21 PM
Status.Name :
Status.Date :
Status.Message :
Status.AdditionalInfo :
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [UpdateAssociation](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範以新文件版本更新關聯。**
```
Update-SSMAssociation -AssociationId "93285663-92df-44cb-9f26-2292d4ecc439" -DocumentVersion "1"
```
**輸出：**
```
Name : AWS-UpdateSSMAgent
InstanceId :
Date : 3/1/2017 6:22:21 PM
Status.Name :
Status.Date :
Status.Message :
Status.AdditionalInfo :
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [UpdateAssociation](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `UpdateAssociationStatus` 與 CLI
<a name="ssm_example_ssm_UpdateAssociationStatus_section"></a>
下列程式碼範例示範如何使用 `UpdateAssociationStatus`。
------
#### [ CLI ]
**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
}
}
```
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Working with associations in Systems Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-associations.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [UpdateAssociationStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/update-association-status.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範更新執行個體與組態文件之間的關聯狀態。**
```
Update-SSMAssociationStatus -Name "AWS-UpdateSSMAgent" -InstanceId "i-0000293ffd8c57862" -AssociationStatus_Date "2015-02-20T08:31:11Z" -AssociationStatus_Name "Pending" -AssociationStatus_Message "temporary_status_change" -AssociationStatus_AdditionalInfo "Additional-Config-Needed"
```
**輸出：**
```
Name : AWS-UpdateSSMAgent
InstanceId : i-0000293ffd8c57862
Date : 2/23/2017 6:55:22 PM
Status.Name : Pending
Status.Date : 2/20/2015 8:31:11 AM
Status.Message : temporary_status_change
Status.AdditionalInfo : Additional-Config-Needed
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [UpdateAssociationStatus](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範更新執行個體與組態文件之間的關聯狀態。**
```
Update-SSMAssociationStatus -Name "AWS-UpdateSSMAgent" -InstanceId "i-0000293ffd8c57862" -AssociationStatus_Date "2015-02-20T08:31:11Z" -AssociationStatus_Name "Pending" -AssociationStatus_Message "temporary_status_change" -AssociationStatus_AdditionalInfo "Additional-Config-Needed"
```
**輸出：**
```
Name : AWS-UpdateSSMAgent
InstanceId : i-0000293ffd8c57862
Date : 2/23/2017 6:55:22 PM
Status.Name : Pending
Status.Date : 2/20/2015 8:31:11 AM
Status.Message : temporary_status_change
Status.AdditionalInfo : Additional-Config-Needed
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [UpdateAssociationStatus](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `UpdateDocument` 與 CLI
<a name="ssm_example_ssm_UpdateDocument_section"></a>
下列程式碼範例示範如何使用 `UpdateDocument`。
------
#### [ CLI ]
**AWS CLI**
**建立新版本的文件**
下列 `update-document` 範例示範在 Windows 電腦上執行時建立新版本的文件。`--document` 指定的文件必須為 JSON 格式。請注意，必須參考 `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 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [UpdateDocument](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/update-document.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範建立新版本的文件，其中包含您指定的 json 檔案的更新內容。文件必須為 JSON 格式。您可以使用 "Get-SSMDocumentVersionList" cmdlet 取得文件版本。**
```
Update-SSMDocument -Name RunShellScript -DocumentVersion "1" -Content (Get-Content -Raw "c:\temp\RunShellScript.json")
```
**輸出：**
```
CreatedDate : 3/1/2017 2:59:17 AM
DefaultVersion : 1
Description : Run an updated script
DocumentType : Command
DocumentVersion : 2
Hash : 1d5ce820e999ff051eb4841ed887593daf77120fd76cae0d18a53cc42e4e22c1
HashType : Sha256
LatestVersion : 2
Name : RunShellScript
Owner : 809632081692
Parameters : {commands}
PlatformTypes : {Linux}
SchemaVersion : 2.0
Sha1 :
Status : Updating
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [UpdateDocument](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範建立新版本的文件，其中包含您指定的 json 檔案的更新內容。文件必須為 JSON 格式。您可以使用 "Get-SSMDocumentVersionList" cmdlet 取得文件版本。**
```
Update-SSMDocument -Name RunShellScript -DocumentVersion "1" -Content (Get-Content -Raw "c:\temp\RunShellScript.json")
```
**輸出：**
```
CreatedDate : 3/1/2017 2:59:17 AM
DefaultVersion : 1
Description : Run an updated script
DocumentType : Command
DocumentVersion : 2
Hash : 1d5ce820e999ff051eb4841ed887593daf77120fd76cae0d18a53cc42e4e22c1
HashType : Sha256
LatestVersion : 2
Name : RunShellScript
Owner : 809632081692
Parameters : {commands}
PlatformTypes : {Linux}
SchemaVersion : 2.0
Sha1 :
Status : Updating
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [UpdateDocument](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `UpdateDocumentDefaultVersion` 與 CLI
<a name="ssm_example_ssm_UpdateDocumentDefaultVersion_section"></a>
下列程式碼範例示範如何使用 `UpdateDocumentDefaultVersion`。
------
#### [ CLI ]
**AWS CLI**
**更新文件的預設版本**
下列 `update-document-default-version` 範例示範更新 Systems Manager 文件的預設版本。
```
aws ssm update-document-default-version \
--name "Example" \
--document-version "2"
```
輸出：
```
{
"Description": {
"Name": "Example",
"DefaultVersion": "2"
}
}
```
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Writing SSM Document Content](https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-doc.html#writing-ssm-doc-content)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [UpdateDocumentDefaultVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/update-document-default-version.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範更新文件的預設版本。您可以使用 "Get-SSMDocumentVersionList" cmdlet 取得可用的文件版本。**
```
Update-SSMDocumentDefaultVersion -Name "RunShellScript" -DocumentVersion "2"
```
**輸出：**
```
DefaultVersion Name
-------------- ----
2 RunShellScript
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [UpdateDocumentDefaultVersion](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範更新文件的預設版本。您可以使用 "Get-SSMDocumentVersionList" cmdlet 取得可用的文件版本。**
```
Update-SSMDocumentDefaultVersion -Name "RunShellScript" -DocumentVersion "2"
```
**輸出：**
```
DefaultVersion Name
-------------- ----
2 RunShellScript
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [UpdateDocumentDefaultVersion](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# `UpdateMaintenanceWindow` 搭配 AWS SDK 或 CLI 使用
<a name="ssm_example_ssm_UpdateMaintenanceWindow_section"></a>
下列程式碼範例示範如何使用 `UpdateMaintenanceWindow`。
------
#### [ CLI ]
**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
```
如需詳細資訊，請參閱 *AWS Systems Manager 使用者指南*中的[更新維護時段 (AWS CLI)](https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-cli-tutorials-update.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [UpdateMaintenanceWindow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/update-maintenance-window.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/ssm#code-examples)中設定和執行。
```
/**
* Updates an SSM maintenance window asynchronously.
*
* @param id The ID of the maintenance window to update.
* @param name The new name for the maintenance window.
* <p>
* This method initiates an asynchronous request to update an SSM maintenance window.
* If the request is successful, it prints a success message.
* If an exception occurs, it handles the error appropriately.
*/
public void updateSSMMaintenanceWindow(String id, String name) throws SsmException {
UpdateMaintenanceWindowRequest updateRequest = UpdateMaintenanceWindowRequest.builder()
.windowId(id)
.allowUnassociatedTargets(true)
.duration(24)
.enabled(true)
.name(name)
.schedule("cron(0 0 ? * MON *)")
.build();
CompletableFuture<UpdateMaintenanceWindowResponse> future = getAsyncClient().updateMaintenanceWindow(updateRequest);
future.whenComplete((response, ex) -> {
if (response != null) {
System.out.println("The SSM maintenance window was successfully updated");
} else {
Throwable cause = (ex instanceof CompletionException) ? ex.getCause() : ex;
if (cause instanceof SsmException) {
throw new CompletionException(cause);
} else {
throw new RuntimeException(cause);
}
}
}).join();
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [UpdateMaintenanceWindow](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/UpdateMaintenanceWindow)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ssm#code-examples)中設定和執行。
```
import { UpdateMaintenanceWindowCommand, SSMClient } from "@aws-sdk/client-ssm";
import { parseArgs } from "node:util";
/**
* Update an SSM maintenance window.
* @param {{ windowId: string, allowUnassociatedTargets?: boolean, duration?: number, enabled?: boolean, name?: string, schedule?: string }}
*/
export const main = async ({
windowId,
allowUnassociatedTargets = undefined, //Allow the maintenance window to run on managed nodes, even if you haven't registered those nodes as targets.
duration = undefined, //The duration of the maintenance window in hours.
enabled = undefined,
name = undefined,
schedule = undefined, //The schedule of the maintenance window in the form of a cron or rate expression.
}) => {
const client = new SSMClient({});
try {
const { opsItemArn, opsItemId } = await client.send(
new UpdateMaintenanceWindowCommand({
WindowId: windowId,
AllowUnassociatedTargets: allowUnassociatedTargets,
Duration: duration,
Enabled: enabled,
Name: name,
Schedule: schedule,
}),
);
console.log("Maintenance window updated.");
return { OpsItemArn: opsItemArn, OpsItemId: opsItemId };
} catch (caught) {
if (caught instanceof Error && caught.name === "ValidationError") {
console.warn(`${caught.message}. Are these values correct?`);
} else {
throw caught;
}
}
};
```
+ 如需 API 詳細資訊，請參閱《適用於 JavaScript 的 AWS SDK API 參考》**中的 [UpdateMaintenanceWindow](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/UpdateMaintenanceWindowCommand)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範更新維護時段的名稱。**
```
Update-SSMMaintenanceWindow -WindowId "mw-03eb9db42890fb82d" -Name "My-Renamed-MW"
```
**輸出：**
```
AllowUnassociatedTargets : False
Cutoff : 1
Duration : 2
Enabled : True
Name : My-Renamed-MW
Schedule : cron(0 */30 * * * ? *)
WindowId : mw-03eb9db42890fb82d
```
**範例 2：此範例示範啟用維護時段。**
```
Update-SSMMaintenanceWindow -WindowId "mw-03eb9db42890fb82d" -Enabled $true
```
**輸出：**
```
AllowUnassociatedTargets : False
Cutoff : 1
Duration : 2
Enabled : True
Name : My-Renamed-MW
Schedule : cron(0 */30 * * * ? *)
WindowId : mw-03eb9db42890fb82d
```
**範例 3：此範例示範停用維護時段。**
```
Update-SSMMaintenanceWindow -WindowId "mw-03eb9db42890fb82d" -Enabled $false
```
**輸出：**
```
AllowUnassociatedTargets : False
Cutoff : 1
Duration : 2
Enabled : False
Name : My-Renamed-MW
Schedule : cron(0 */30 * * * ? *)
WindowId : mw-03eb9db42890fb82d
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [UpdateMaintenanceWindow](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範更新維護時段的名稱。**
```
Update-SSMMaintenanceWindow -WindowId "mw-03eb9db42890fb82d" -Name "My-Renamed-MW"
```
**輸出：**
```
AllowUnassociatedTargets : False
Cutoff : 1
Duration : 2
Enabled : True
Name : My-Renamed-MW
Schedule : cron(0 */30 * * * ? *)
WindowId : mw-03eb9db42890fb82d
```
**範例 2：此範例示範啟用維護時段。**
```
Update-SSMMaintenanceWindow -WindowId "mw-03eb9db42890fb82d" -Enabled $true
```
**輸出：**
```
AllowUnassociatedTargets : False
Cutoff : 1
Duration : 2
Enabled : True
Name : My-Renamed-MW
Schedule : cron(0 */30 * * * ? *)
WindowId : mw-03eb9db42890fb82d
```
**範例 3：此範例示範停用維護時段。**
```
Update-SSMMaintenanceWindow -WindowId "mw-03eb9db42890fb82d" -Enabled $false
```
**輸出：**
```
AllowUnassociatedTargets : False
Cutoff : 1
Duration : 2
Enabled : False
Name : My-Renamed-MW
Schedule : cron(0 */30 * * * ? *)
WindowId : mw-03eb9db42890fb82d
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [UpdateMaintenanceWindow](https://docs.aws.amazon.com/powershell/v5/reference)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/ssm#code-examples)中設定和執行。
```
class MaintenanceWindowWrapper:
"""Encapsulates AWS Systems Manager maintenance window actions."""
def __init__(self, ssm_client):
"""
:param ssm_client: A Boto3 Systems Manager client.
"""
self.ssm_client = ssm_client
self.window_id = None
self.name = None
@classmethod
def from_client(cls):
ssm_client = boto3.client("ssm")
return cls(ssm_client)
def update(
self, name, enabled, schedule, duration, cutoff, allow_unassociated_targets
):
"""
Update an AWS Systems Manager maintenance window.
:param name: The name of the maintenance window.
:param enabled: Whether the maintenance window is enabled to run on managed nodes.
:param schedule: The schedule of the maintenance window.
:param duration: The duration of the maintenance window.
:param cutoff: The cutoff time of the maintenance window.
:param allow_unassociated_targets: Allow the maintenance window to run on managed nodes, even
if you haven't registered those nodes as targets.
"""
try:
self.ssm_client.update_maintenance_window(
WindowId=self.window_id,
Name=name,
Enabled=enabled,
Schedule=schedule,
Duration=duration,
Cutoff=cutoff,
AllowUnassociatedTargets=allow_unassociated_targets,
)
self.name = name
logger.info("Updated maintenance window %s.", self.window_id)
except ParamValidationError as error:
logger.error(
"Parameter validation error when trying to update maintenance window %s. Here's why: %s",
self.window_id,
error,
)
raise
except ClientError as err:
logger.error(
"Couldn't update maintenance window %s. Here's why: %s: %s",
self.name,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [UpdateMaintenanceWindow](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/UpdateMaintenanceWindow)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ssm#code-examples)中設定和執行。
```
TRY.
lo_ssm->updatemaintenancewindow(
iv_windowid = iv_window_id
iv_name = iv_name
iv_enabled = iv_enabled
iv_schedule = iv_schedule
iv_duration = iv_duration
iv_cutoff = iv_cutoff
iv_allowunassociatedtargets = iv_allow_unassociated_targets ).
MESSAGE 'Maintenance window updated.' TYPE 'I'.
CATCH /aws1/cx_ssmdoesnotexistex.
MESSAGE 'Maintenance window does not exist.' TYPE 'I'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [UpdateMaintenanceWindow](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# 搭配使用 `UpdateManagedInstanceRole` 與 CLI
<a name="ssm_example_ssm_UpdateManagedInstanceRole_section"></a>
下列程式碼範例示範如何使用 `UpdateManagedInstanceRole`。
------
#### [ CLI ]
**AWS CLI**
**更新受管執行個體的 IAM 角色**
下列 `update-managed-instance-role` 範例示範更新受管執行個體的 IAM 執行個體設定檔。
```
aws ssm update-managed-instance-role \
--instance-id "mi-08ab247cdfEXAMPLE" \
--iam-role "ExampleRole"
```
此命令不會產生輸出。
如需詳細資訊，請參閱《AWS Systems Manager 使用者指南》**中的 [Step 4: Create an IAM Instance Profile for Systems Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/setup-instance-profile.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [UpdateManagedInstanceRole](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/update-managed-instance-role.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範更新受管執行個體的角色。如果命令成功，則無輸出訊息。**
```
Update-SSMManagedInstanceRole -InstanceId "mi-08ab247cdf1046573" -IamRole "AutomationRole"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [UpdateManagedInstanceRole](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範更新受管執行個體的角色。如果命令成功，則無輸出訊息。**
```
Update-SSMManagedInstanceRole -InstanceId "mi-08ab247cdf1046573" -IamRole "AutomationRole"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [UpdateManagedInstanceRole](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# `UpdateOpsItem` 搭配 AWS SDK 或 CLI 使用
<a name="ssm_example_ssm_UpdateOpsItem_section"></a>
下列程式碼範例示範如何使用 `UpdateOpsItem`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](ssm_example_ssm_Scenario_section.md)
------
#### [ CLI ]
**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.
```
如需詳細資訊，請參閱**《AWS Systems Manager 使用者指南》中的 [Working with OpsItems](https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-working-with-OpsItems.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [UpdateOpsItem](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/update-ops-item.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/ssm#code-examples)中設定和執行。
```
/**
* Resolves an AWS SSM OpsItem asynchronously.
*
* @param opsID The ID of the OpsItem to resolve.
* <p>
* This method initiates an asynchronous request to resolve an SSM OpsItem.
* If an exception occurs, it handles the error appropriately.
*/
public void resolveOpsItem(String opsID) {
UpdateOpsItemRequest opsItemRequest = UpdateOpsItemRequest.builder()
.opsItemId(opsID)
.status(OpsItemStatus.RESOLVED)
.build();
CompletableFuture<Void> future = CompletableFuture.runAsync(() -> {
getAsyncClient().updateOpsItem(opsItemRequest)
.thenAccept(response -> {
System.out.println("OpsItem resolved successfully.");
})
.exceptionally(ex -> {
throw new CompletionException(ex);
}).join();
}).exceptionally(ex -> {
Throwable cause = (ex instanceof CompletionException) ? ex.getCause() : ex;
if (cause instanceof SsmException) {
throw new RuntimeException("SSM error: " + cause.getMessage(), cause);
} else {
throw new RuntimeException("Unexpected error: " + cause.getMessage(), cause);
}
});
try {
future.join();
} catch (CompletionException ex) {
throw ex.getCause() instanceof RuntimeException ? (RuntimeException) ex.getCause() : ex;
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [UpdateOpsItem](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/UpdateOpsItem)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ssm#code-examples)中設定和執行。
```
import { UpdateOpsItemCommand, SSMClient } from "@aws-sdk/client-ssm";
import { parseArgs } from "node:util";
/**
* Update an SSM OpsItem.
* @param {{ opsItemId: string, status?: OpsItemStatus }}
*/
export const main = async ({
opsItemId,
status = undefined, // The OpsItem status. Status can be Open, In Progress, or Resolved
}) => {
const client = new SSMClient({});
try {
await client.send(
new UpdateOpsItemCommand({
OpsItemId: opsItemId,
Status: status,
}),
);
console.log("Ops item updated.");
return { Success: true };
} catch (caught) {
if (
caught instanceof Error &&
caught.name === "OpsItemLimitExceededException"
) {
console.warn(
`Couldn't create ops item because you have exceeded your open OpsItem limit. ${caught.message}.`,
);
} else {
throw caught;
}
}
};
```
+ 如需 API 詳細資訊，請參閱《適用於 JavaScript 的 AWS SDK API 參考》**中的 [UpdateOpsItem](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/UpdateOpsItemCommand)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/ssm#code-examples)中設定和執行。
```
class OpsItemWrapper:
"""Encapsulates AWS Systems Manager OpsItem actions."""
def __init__(self, ssm_client):
"""
:param ssm_client: A Boto3 Systems Manager client.
"""
self.ssm_client = ssm_client
self.id = None
@classmethod
def from_client(cls):
"""
:return: A OpsItemWrapper instance.
"""
ssm_client = boto3.client("ssm")
return cls(ssm_client)
def update(self, title=None, description=None, status=None):
"""
Update an OpsItem.
:param title: The new OpsItem title.
:param description: The new OpsItem description.
:param status: The new OpsItem status.
:return:
"""
args = dict(OpsItemId=self.id)
if title is not None:
args["Title"] = title
if description is not None:
args["Description"] = description
if status is not None:
args["Status"] = status
try:
self.ssm_client.update_ops_item(**args)
except ClientError as err:
logger.error(
"Couldn't update ops item %s. Here's why: %s: %s",
self.id,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [UpdateOpsItem](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/UpdateOpsItem)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ssm#code-examples)中設定和執行。
```
TRY.
lo_ssm->updateopsitem(
iv_opsitemid = iv_ops_item_id
iv_title = iv_title
iv_description = iv_description
iv_status = iv_status ).
MESSAGE 'OpsItem updated.' TYPE 'I'.
CATCH /aws1/cx_ssmopsitemnotfoundex.
MESSAGE 'OpsItem not found.' TYPE 'I'.
CATCH /aws1/cx_ssmopsiteminvparamex.
MESSAGE 'Invalid OpsItem parameter.' TYPE 'I'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [UpdateOpsItem](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# 搭配使用 `UpdatePatchBaseline` 與 CLI
<a name="ssm_example_ssm_UpdatePatchBaseline_section"></a>
下列程式碼範例示範如何使用 `UpdatePatchBaseline`。
------
#### [ CLI ]
**AWS CLI**
**範例 1：更新修補基準**
下列 `update-patch-baseline` 範例示範將指定修補程式新增到指定修補基準，兩個修補程式新增為已拒絕，一個修補程式新增為已核准。
```
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 使用者指南》**中的 Update or Delete a Patch Baseline <https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-baseline-update-or-delete.html>`\$1\$1。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [UpdatePatchBaseline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/update-patch-baseline.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例示範將修補程式新增到現有修補基準，兩個修補程式新增為已拒絕，一個修補程式新增為已核准。**
```
Update-SSMPatchBaseline -BaselineId "pb-03da896ca3b68b639" -RejectedPatch "KB2032276","MS10-048" -ApprovedPatch "KB2124261"
```
**輸出：**
```
ApprovalRules : Amazon.SimpleSystemsManagement.Model.PatchRuleGroup
ApprovedPatches : {KB2124261}
BaselineId : pb-03da896ca3b68b639
CreatedDate : 3/3/2017 5:02:19 PM
Description : Baseline containing all updates approved for production systems
GlobalFilters : Amazon.SimpleSystemsManagement.Model.PatchFilterGroup
ModifiedDate : 3/3/2017 5:22:10 PM
Name : Production-Baseline
RejectedPatches : {KB2032276, MS10-048}
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [UpdatePatchBaseline](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例示範將修補程式新增到現有修補基準，兩個修補程式新增為已拒絕，一個修補程式新增為已核准。**
```
Update-SSMPatchBaseline -BaselineId "pb-03da896ca3b68b639" -RejectedPatch "KB2032276","MS10-048" -ApprovedPatch "KB2124261"
```
**輸出：**
```
ApprovalRules : Amazon.SimpleSystemsManagement.Model.PatchRuleGroup
ApprovedPatches : {KB2124261}
BaselineId : pb-03da896ca3b68b639
CreatedDate : 3/3/2017 5:02:19 PM
Description : Baseline containing all updates approved for production systems
GlobalFilters : Amazon.SimpleSystemsManagement.Model.PatchFilterGroup
ModifiedDate : 3/3/2017 5:22:10 PM
Name : Production-Baseline
RejectedPatches : {KB2032276, MS10-048}
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [UpdatePatchBaseline](https://docs.aws.amazon.com/powershell/v5/reference)。
------